From f7e07eafc88128a556efbc94a9b062fd48ad91f4 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Fri, 6 Jun 2003 20:07:16 +0000 Subject: - Regenerate docs - Fix db2latex (it depended on the $Id$ tags) - Fix CUPS-Printing syntax - Update instructions in docbook.txt (This used to be commit 8d7c96a4e267c5546518d097edbe03e27b1ad073) --- docs/htmldocs/Samba-Developers-Guide.html | 10559 +++------------ docs/htmldocs/bugreport.html | 411 +- docs/htmldocs/diagnosis.html | 835 +- docs/htmldocs/findsmb.1.html | 307 +- docs/htmldocs/groupmapping.html | 412 +- docs/htmldocs/install.html | 1039 +- docs/htmldocs/integrate-ms-networks.html | 1221 +- docs/htmldocs/introduction.html | 424 +- docs/htmldocs/lmhosts.5.html | 215 +- docs/htmldocs/msdfs.html | 359 +- docs/htmldocs/net.8.html | 545 +- docs/htmldocs/nmbd.8.html | 821 +- docs/htmldocs/nmblookup.1.html | 467 +- docs/htmldocs/optional.html | 924 +- docs/htmldocs/pam.html | 861 +- docs/htmldocs/pdbedit.8.html | 680 +- docs/htmldocs/printing.html | 3604 +++-- docs/htmldocs/rpcclient.1.html | 871 +- docs/htmldocs/samba-bdc.html | 592 +- docs/htmldocs/samba-pdc.html | 3070 +---- docs/htmldocs/samba.7.html | 427 +- docs/htmldocs/smb.conf.5.html | 19827 +--------------------------- docs/htmldocs/smbcacls.1.html | 460 +- docs/htmldocs/smbclient.1.html | 1747 +-- docs/htmldocs/smbcontrol.1.html | 444 +- docs/htmldocs/smbd.8.html | 807 +- docs/htmldocs/smbmnt.8.html | 197 +- docs/htmldocs/smbmount.8.html | 482 +- docs/htmldocs/smbpasswd.5.html | 342 +- docs/htmldocs/smbpasswd.8.html | 663 +- docs/htmldocs/smbsh.1.html | 551 +- docs/htmldocs/smbspool.8.html | 232 +- docs/htmldocs/smbstatus.1.html | 257 +- docs/htmldocs/smbtar.1.html | 375 +- docs/htmldocs/smbumount.8.html | 145 +- docs/htmldocs/speed.html | 504 +- docs/htmldocs/swat.8.html | 486 +- docs/htmldocs/testparm.1.html | 331 +- docs/htmldocs/testprns.1.html | 265 +- docs/htmldocs/type.html | 398 +- docs/htmldocs/vfstest.1.html | 502 +- docs/htmldocs/wbinfo.1.html | 408 +- docs/htmldocs/winbind.html | 1897 +-- docs/htmldocs/winbindd.8.html | 999 +- 44 files changed, 9196 insertions(+), 51767 deletions(-) (limited to 'docs/htmldocs') diff --git a/docs/htmldocs/Samba-Developers-Guide.html b/docs/htmldocs/Samba-Developers-Guide.html index b90d99bf66..86de03d627 100644 --- a/docs/htmldocs/Samba-Developers-Guide.html +++ b/docs/htmldocs/Samba-Developers-Guide.html @@ -1,1091 +1,193 @@ - -SAMBA Developers Guide

SAMBA Developers Guide

SAMBA Team

Abstract

Last Update : Mon Sep 30 15:23:53 CDT 2002

This book is a collection of documents that might be useful for +SAMBA Developers Guidehttp://devel.samba.org/. -Please send updates to jelmer@samba.org.

This documentation is distributed under the GNU General Public License (GPL) +can be found at http://devel.samba.org/. +Please send updates to Jelmer Vernooij. + +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 http://www.fsf.org/licenses/gpl.txt

Table of Contents
1. Definition of NetBIOS Protocol and Name Resolution Modes
1.1. NETBIOS
1.2. BROADCAST NetBIOS
1.3. NBNS NetBIOS
2. Samba Architecture
2.1. Introduction
2.2. Multithreading and Samba
2.3. Threading smbd
2.4. Threading nmbd
2.5. nbmd Design
3. The samba DEBUG system
3.1. New Output Syntax
3.2. The DEBUG() Macro
3.3. The DEBUGADD() Macro
3.4. The DEBUGLVL() Macro
3.5. New Functions
3.5.1. dbgtext()
3.5.2. dbghdr()
3.5.3. format_debug_text()
4. Coding Suggestions
5. Samba Internals
5.1. Character Handling
5.2. The new functions
5.3. Macros in byteorder.h
5.3.1. CVAL(buf,pos)
5.3.2. PVAL(buf,pos)
5.3.3. SCVAL(buf,pos,val)
5.3.4. SVAL(buf,pos)
5.3.5. IVAL(buf,pos)
5.3.6. SVALS(buf,pos)
5.3.7. IVALS(buf,pos)
5.3.8. SSVAL(buf,pos,val)
5.3.9. SIVAL(buf,pos,val)
5.3.10. SSVALS(buf,pos,val)
5.3.11. SIVALS(buf,pos,val)
5.3.12. RSVAL(buf,pos)
5.3.13. RIVAL(buf,pos)
5.3.14. RSSVAL(buf,pos,val)
5.3.15. RSIVAL(buf,pos,val)
5.4. LAN Manager Samba API
5.4.1. Parameters
5.4.2. Return value
5.5. Code character table
6. The smb.conf file
6.1. Lexical Analysis
6.1.1. Handling of Whitespace
6.1.2. Handling of Line Continuation
6.1.3. Line Continuation Quirks
6.2. Syntax
6.2.1. About params.c
7. NetBIOS in a Unix World
7.1. Introduction
7.2. Usernames
7.3. File Ownership
7.4. Passwords
7.5. Locking
7.6. Deny Modes
7.7. Trapdoor UIDs
7.8. Port numbers
7.9. Protocol Complexity
8. Tracing samba system calls
9. NT Domain RPC's
9.1. Introduction
9.1.1. Sources
9.1.2. Credits
9.2. Notes and Structures
9.2.1. Notes
9.2.2. Enumerations
9.2.3. Structures
9.3. MSRPC over Transact Named Pipe
9.3.1. MSRPC Pipes
9.3.2. Header
9.3.3. Tail
9.3.4. RPC Bind / Bind Ack
9.3.5. NTLSA Transact Named Pipe
9.3.6. LSA Open Policy
9.3.7. LSA Query Info Policy
9.3.8. LSA Enumerate Trusted Domains
9.3.9. LSA Open Secret
9.3.10. LSA Close
9.3.11. LSA Lookup SIDS
9.3.12. LSA Lookup Names
9.4. NETLOGON rpc Transact Named Pipe
9.4.1. LSA Request Challenge
9.4.2. LSA Authenticate 2
9.4.3. LSA Server Password Set
9.4.4. LSA SAM Logon
9.4.5. LSA SAM Logoff
9.5. \\MAILSLOT\NET\NTLOGON
9.5.1. Query for PDC
9.5.2. SAM Logon
9.6. SRVSVC Transact Named Pipe
9.6.1. Net Share Enum
9.6.2. Net Server Get Info
9.7. Cryptographic side of NT Domain Authentication
9.7.1. Definitions
9.7.2. Protocol
9.7.3. Comments
9.8. SIDs and RIDs
9.8.1. Well-known SIDs
9.8.2. Well-known RIDS
10. Samba Printing Internals
10.1. Abstract
10.2. Printing Interface to Various Back ends
10.3. Print Queue TDB's
10.4. ChangeID & Client Caching of Printer Information
10.5. Windows NT/2K Printer Change Notify
11. Samba WINS Internals
11.1. WINS Failover
12. The Upcoming SAM System
12.1. Security in the 'new SAM'
12.2. Standalone from UNIX
12.3. Handles and Races in the new SAM
12.4. Layers
12.4.1. Application
12.4.2. SAM Interface
12.4.3. SAM Modules
12.5. SAM Modules
12.5.1. Special Module: sam_passdb
12.5.2. sam_ads
12.6. Memory Management
12.7. Testing
13. LanMan and NT Password Encryption
13.1. Introduction
13.2. How does it work?
13.3. The smbpasswd file

Chapter 1. Definition of NetBIOS Protocol and Name Resolution Modes

1.1. NETBIOS

NetBIOS runs over the following tranports: TCP/IP; NetBEUI and IPX/SPX. +distribution. A copy can be found on-line at http://www.fsf.org/licenses/gpl.txt +">

SAMBA Developers Guide

SAMBA Team

Attributions.  +

Definition of NetBIOS Protocol and Name Resolution Modes

  • Luke Leighton

Samba Architecture

  • Dan Shearer

The samba DEBUG system

  • Chris Hertel

Coding Suggestions

  • Steve French

  • Simo Sorce

  • Andrew Bartlett

  • Tim Potter

  • Martin Pool

Samba Internals
The smb.conf file

  • Chris Hertel

NetBIOS in a Unix World

  • Andrew Tridgell

Tracing samba system calls

  • Andrew Tridgell

NT Domain RPC's
Samba Printing Internals

  • Gerald Carter

Samba WINS Internals

  • Gerald Carter

The Upcoming SAM System

  • Andrew Bartlett

LanMan and NT Password Encryption
Modules
RPC Pluggable Modules
VFS Modules
Notes to packagers

  • Jelmer Vernooij

Contributing code

+ +

Abstract

+Last Update : Fri Jun 6 00:45:54 CEST 2003 +

+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 http://devel.samba.org/. +Please send updates to Jelmer Vernooij. +

+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 http://www.fsf.org/licenses/gpl.txt +

Table of Contents

1. Definition of NetBIOS Protocol and Name Resolution Modes
NETBIOS
BROADCAST NetBIOS
NBNS NetBIOS
2. Samba Architecture
Introduction
Multithreading and Samba
Threading smbd
Threading nmbd
nbmd Design
3. The samba DEBUG system
New Output Syntax
The DEBUG() Macro
The DEBUGADD() Macro
The DEBUGLVL() Macro
New Functions
dbgtext()
dbghdr()
format_debug_text()
4. Coding Suggestions
5. Samba Internals
Character Handling
The new functions
Macros in byteorder.h
CVAL(buf,pos)
PVAL(buf,pos)
SCVAL(buf,pos,val)
SVAL(buf,pos)
IVAL(buf,pos)
SVALS(buf,pos)
IVALS(buf,pos)
SSVAL(buf,pos,val)
SIVAL(buf,pos,val)
SSVALS(buf,pos,val)
SIVALS(buf,pos,val)
RSVAL(buf,pos)
RIVAL(buf,pos)
RSSVAL(buf,pos,val)
RSIVAL(buf,pos,val)
LAN Manager Samba API
Parameters
Return value
Code character table
6. The smb.conf file
Lexical Analysis
Handling of Whitespace
Handling of Line Continuation
Line Continuation Quirks
Syntax
About params.c
7. NetBIOS in a Unix World
Introduction
Usernames
File Ownership
Passwords
Locking
Deny Modes
Trapdoor UIDs
Port numbers
Protocol Complexity
8. Tracing samba system calls
9. NT Domain RPC's
Introduction
Sources
Credits
Notes and Structures
Notes
Enumerations
Structures
MSRPC over Transact Named Pipe
MSRPC Pipes
Header
Tail
RPC Bind / Bind Ack
NTLSA Transact Named Pipe
LSA Open Policy
LSA Query Info Policy
LSA Enumerate Trusted Domains
LSA Open Secret
LSA Close
LSA Lookup SIDS
LSA Lookup Names
NETLOGON rpc Transact Named Pipe
LSA Request Challenge
LSA Authenticate 2
LSA Server Password Set
LSA SAM Logon
LSA SAM Logoff
\\MAILSLOT\NET\NTLOGON
Query for PDC
SAM Logon
SRVSVC Transact Named Pipe
Net Share Enum
Net Server Get Info
Cryptographic side of NT Domain Authentication
Definitions
Protocol
Comments
SIDs and RIDs
Well-known SIDs
Well-known RIDS
10. Samba Printing Internals
Abstract
+Printing Interface to Various Back ends +
+Print Queue TDB's +
+ChangeID and Client Caching of Printer Information +
+Windows NT/2K Printer Change Notify +
11. Samba WINS Internals
WINS Failover
12. The Upcoming SAM System
Security in the 'new SAM'
Standalone from UNIX
Handles and Races in the new SAM
Layers
Application
SAM Interface
SAM Modules
SAM Modules
Special Module: sam_passdb
sam_ads
Memory Management
Testing
13. LanMan and NT Password Encryption
Introduction
How does it work?
The smbpasswd file
14. Modules
Advantages
Loading modules
Static modules
Shared modules
Writing modules
Static/Shared selection in configure.in
15. RPC Pluggable Modules
About
General Overview
16. VFS Modules
The Samba (Posix) VFS layer
The general interface
Possible VFS operation layers
The Interaction between the Samba VFS subsystem and the modules
Initialization and registration
How the Modules handle per connection data
Upgrading to the New VFS Interface
Upgrading from 2.2.* and 3.0aplha modules
Some Notes
Implement TRANSPARENT functions
Implement OPAQUE functions
17. Notes to packagers
Versioning
Modules
18. Contributing code

Chapter 1. Definition of NetBIOS Protocol and Name Resolution Modes

Luke Leighton

12 June 1997

Table of Contents

NETBIOS
BROADCAST NetBIOS
NBNS NetBIOS

NETBIOS

+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.

+rfc1001.txt and rfc1002.txt. +

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.

+is preferable NOT to install NetBEUI if it can be avoided. +

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'.

[When installing Windows 95, you will find that NetBEUI and IPX/SPX are +'NetBIOS over IPX/SPX'. +

+[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].

+to manage: no Windows 95 user-configuration is required]. +

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.

+and the client can then commence. +

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.

+services on different port numbers. +

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.

+or a Wide Area Network. +

NetBIOS names are either UNIQUE or GROUP. Only one application can claim a -UNIQUE NetBIOS name on a network.

There are two kinds of NetBIOS Name resolution: Broadcast and Point-to-Point.

1.2. BROADCAST NetBIOS

+UNIQUE NetBIOS name on a network. +

+There are two kinds of NetBIOS Name resolution: Broadcast and Point-to-Point. +

BROADCAST NetBIOS

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.

+your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139. +

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!].

1.3. NBNS NetBIOS

rfc1001.txt describes, amongst other things, the implementation and use +every twelve minutes, great swathes of broadcast traffic!]. +

NBNS NetBIOS

+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. +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).

+details). +

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.

When you have a WINS server on your LAN, WINS clients will be able to +or WAN, while avoiding the use of TCP/IP broadcast packets. +

+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.

This provides some confusion for lots of people, and is worth mentioning +the most part, NetBIOS names are registered dynamically. +

+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].

Clients can claim names, and therefore offer services on successfully claimed +because a Browse Server is a WINS client, which is _not_ the same thing]. +

+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.

+WINS was developed to minimise the necessity of broadcast traffic. +

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.

Chapter 2. Samba Architecture

2.1. Introduction

This document gives a general overview of how Samba works +contact the WINS server to resolve a NetBIOS name. +

Chapter 2. Samba Architecture

Dan Shearer

November 1997

Table of Contents

Introduction
Multithreading and Samba
Threading smbd
Threading nmbd
nbmd Design

Introduction

+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.

It also tries to answer some of the frequently asked questions such as:

  1. Is Samba secure when running on Unix? The xyz platform? - What about the root priveliges issue?

  2. Pros and cons of multithreading in various parts of Samba

  3. Why not have a separate process for name resolution, WINS, and browsing?

2.2. Multithreading and Samba

People sometimes tout threads as a uniformly good thing. They are very +protocol. +

+It also tries to answer some of the frequently asked questions such as: +

  1. + Is Samba secure when running on Unix? The xyz platform? + What about the root priveliges issue? +

  2. Pros and cons of multithreading in various parts of Samba

  3. Why not have a separate process for name resolution, WINS, and browsing?

Multithreading and Samba

+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.

The short version is that smbd is not multithreaded, and alternative +another matter, and multi-threading it would be very nice. +

+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.)

The longer versions is that there are very good reasons for not making +or more platforms. (This drawback also applies to threading smbd.) +

+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.

2.3. Threading smbd

A few problems that would arise from a threaded smbd are:

  1. It's not only to create threads instead of processes, but you +biggest advantages. +

Threading smbd

+A few problems that would arise from a threaded smbd are: +

  1. + 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).

  2. if one thread dies (eg. a seg fault) then all threads die. We can - immediately throw robustness out the window.

  3. many of the system calls we make are blocking. Non-blocking + (currently they would be global). +

  4. + if one thread dies (eg. a seg fault) then all threads die. We can + immediately throw robustness out the window. +

  5. + 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.

  6. you can't run as a different uid in different threads. This means + are fast, we will end up slowing all clients to the speed of NFS. +

  7. + 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.

  8. the per process file descriptor limit would mean that we could only - support a limited number of clients.

  9. we couldn't use the system locking calls as the locking context of - fcntl() is a process, not a thread.

2.4. Threading nmbd

This would be ideal, but gets sunk by portability requirements.

Andrew tried to write a test threads library for nmbd that used only + horrendously slow. +

  • + the per process file descriptor limit would mean that we could only + support a limited number of clients. +

  • + we couldn't use the system locking calls as the locking context of + fcntl() is a process, not a thread. +

    • Threading nmbd

    +This would be ideal, but gets sunk by portability requirements. +

    +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 @@ -1095,31 +197,22 @@ 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)

    Chris tried to spec out a general design that would abstract threading +other method) +

    +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?)

    A fork() is cheap, but not nearly cheap enough to do on every UDP +clumsy, and besides the fork() type model would never work on Unix. (Is there an OS that it would work on, for nmbd?) +

    +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.

    2.5. nbmd Design

    Originally Andrew used recursion to simulate a multi-threaded +platform having a shared memory system. +

    nbmd Design

    +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 @@ -1131,37 +224,18 @@ 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.

    Then Jeremy rewrote nmbd. The packet data in nmbd isn't what's on the +a single process. +

    +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 +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.

    Chapter 3. The samba DEBUG system

    3.1. New Output Syntax

    The syntax of a debugging log file is represented as:

      >debugfile< :== { >debugmsg< }
+for browsing and WINS support. 
+

    Chapter 3. The samba DEBUG system

    Chris Hertel

    July 1998

    Table of Contents

    New Output Syntax
    The DEBUG() Macro
    The DEBUGADD() Macro
    The DEBUGLVL() Macro
    New Functions
    dbgtext()
    dbghdr()
    format_debug_text()

    New Output Syntax

    + The syntax of a debugging log file is represented as: +

    +  >debugfile< :== { >debugmsg< }
 
   >debugmsg<  :== >debughdr< '\n' >debugtext<
 
@@ -1169,323 +243,178 @@ CLASS="PROGRAMLISTING"
 
   >debugtext< :== { >debugline< }
 
-  >debugline< :== TEXT '\n'

    TEXT is a string of characters excluding the newline character.

    LEVEL is the DEBUG level of the message (an integer in the range - 0..10).

    TIME is a timestamp.

    FILE is the name of the file from which the debug message was -generated.

    FUNCTION is the function from which the debug message was generated.

    LINE is the line number of the debug statement that generated the -message.

    Basically, what that all means is:

    1. A debugging log file is made up of debug messages.

    2. Each debug message is made up of a header and text. The header is -separated from the text by a newline.

    3. The header begins with the timestamp and debug level of the + >debugline< :== TEXT '\n' +

      +TEXT is a string of characters excluding the newline character. +

      +LEVEL is the DEBUG level of the message (an integer in the range + 0..10). +

      +TIME is a timestamp. +

      +FILE is the name of the file from which the debug message was +generated. +

      +FUNCTION is the function from which the debug message was generated. +

      +LINE is the line number of the debug statement that generated the +message. +

      Basically, what that all means is:

      1. +A debugging log file is made up of debug messages. +

      2. +Each debug message is made up of a header and text. The header is +separated from the text by a newline. +

      3. +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).

      4. The message text is made up of zero or more lines, each terminated -by a newline.

      Here's some example output:

          [1998/08/03 12:55:25, 1] nmbd.c:(659)
+__FUNCTION__ macro, which is not universally implemented, dangit).
+

    4. +The message text is made up of zero or more lines, each terminated +by a newline. +

    Here's some example output:

    +    [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

    Note that in the above example the function names are not listed on + Initializing global parameters +

    +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.

    3.2. The DEBUG() Macro

    Use of the DEBUG() macro is unchanged. DEBUG() takes two parameters. +SGI Indy, and the SGI compiler doesn't support the __FUNCTION__ macro. +

    The DEBUG() Macro

    +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.

    That's confusing.

    Here's an example which may help a bit. If you would write

    printf( "This is a %s message.\n", "debug" );

    to send the output to stdout, then you would write

    DEBUG( 0, ( "This is a %s message.\n", "debug" ) );

    to send the output to the debug file. All of the normal printf() -formatting escapes work.

    Note that in the above example the DEBUG message level is set to 0. +call to the Debug1() function. +

    That's confusing.

    Here's an example which may help a bit. If you would write

    +printf( "This is a %s message.\n", "debug" );
+

    +to send the output to stdout, then you would write +

    +DEBUG( 0, ( "This is a %s message.\n", "debug" ) );
+

    +to send the output to the debug file. All of the normal printf() +formatting escapes work. +

    +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.

    The output of the above example would be something like:

        [1998/07/30 16:00:51, 0] file.c:function(128)
-      This is a debug message.

    Each call to DEBUG() creates a new header *unless* the output produced +statement is processed. +

    +The output of the above example would be something like: +

    +    [1998/07/30 16:00:51, 0] file.c:function(128)
+      This is a debug message.
+

    +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.

    ...but that's really just a Kludge. It was put in place because +DEBUG() is called, the new input is simply appended. +

    +...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:

        DEBUG( 0, ("The test returned " ) );
+example of the kind of thing I'm talking about:
+
    +    DEBUG( 0, ("The test returned " ) );
     if( test() )
-      DEBUG(0, ("True") );
+      DEBUG(0, ("True") );
     else
-      DEBUG(0, ("False") );
-    DEBUG(0, (".\n") );
    Without the format buffer, the output (assuming test() returned true)
-would look like this:
        [1998/07/30 16:00:51, 0] file.c:function(256)
+      DEBUG(0, ("False") );
+    DEBUG(0, (".\n") );
+
    
+Without the format buffer, the output (assuming test() returned true)
+would look like this:
+
    +    [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)
-      .
    Which isn't much use. The format buffer kludge fixes this problem.

    3.3. The DEBUGADD() Macro

    In addition to the kludgey solution to the broken line problem + . +

    Which isn't much use. The format buffer kludge fixes this problem. +

    The DEBUGADD() Macro

    +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.

        DEBUG( 0, ("This is the first line.\n" ) );
-    DEBUGADD( 0, ("This is the second line.\nThis is the third line.\n" ) );

    Produces

        [1998/07/30 16:00:51, 0] file.c:function(512)
+DEBUGADD() macro is the same as that of the DEBUG() macro.
+
    +    DEBUG( 0, ("This is the first line.\n" ) );
+    DEBUGADD( 0, ("This is the second line.\nThis is the third line.\n" ) );
+
    Produces
    +    [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.

    3.4. The DEBUGLVL() Macro

    One of the problems with the DEBUG() macro was that DEBUG() lines + This is the third line. +

    The DEBUGLVL() Macro

    +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:

      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));

    One solution to this is to break it down using DEBUG() and DEBUGADD(), -as follows:

      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 ) );

    A similar, but arguably nicer approach is to use the DEBUGLVL() macro. +nmbd_sendannounce.c: +

    +  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));
+

    +One solution to this is to break it down using DEBUG() and DEBUGADD(), +as follows: +

    +  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 ) );
+

    +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:

      if( DEBUGLVL( 3 ) )
+the global DEBUGLEVEL value, so:
+
    +  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 );
-    }
    (The dbgtext() function is explained below.)
    There are a few advantages to this scheme:
    1. The test is performed only once.
    2. You can allocate variables off of the stack that will only be used
-within the DEBUGLVL() block.
    3. Processing that is only relevant to debug output can be contained
-within the DEBUGLVL() block.

    3.5. New Functions

    3.5.1. dbgtext()

    This function prints debug message text to the debug file (and + 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 ); + } +

    (The dbgtext() function is explained below.)

    There are a few advantages to this scheme:

    1. +The test is performed only once. +

    2. +You can allocate variables off of the stack that will only be used +within the DEBUGLVL() block. +

    3. +Processing that is only relevant to debug output can be contained +within the DEBUGLVL() block. +

    New Functions

    dbgtext()

    +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().

    3.5.2. dbghdr()

    This is the function that writes a debug message header. +message using dbgtext(). +

    dbghdr()

    +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.

    It is not likely that this function will be called directly. It -is used by DEBUG() and DEBUGADD().

    3.5.3. format_debug_text()

    This is a static function in debug.c. It stores the output text +produce any output. See the comments in dbghdr() for more info. +

    +It is not likely that this function will be called directly. It +is used by DEBUG() and DEBUGADD(). +

    format_debug_text()

    +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).

    Chapter 4. Coding Suggestions

    So you want to add code to Samba ...

    One of the daunting tasks facing a programmer attempting to write code for +syslog output). +

    Chapter 4. Coding Suggestions

    Steve French

    Simo Sorce

    Andrew Bartlett

    Tim Potter

    Martin Pool

    +So you want to add code to Samba ... +

    +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 @@ -1493,305 +422,181 @@ 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 -samba/source/internals.doc and -samba/source/architecture.doc provide -additional information.

    The loosely related question of coding style is very personal and this +samba/source/internals.doc and +samba/source/architecture.doc provide +additional information. +

    +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:

    http://lxr.linux.no/source/Documentation/CodingStyle

    http://www.fsf.org/prep/standards_toc.html

    But note that coding style in Samba varies due to the many different -programmers who have contributed.

    Following are some considerations you should use when adding new code to -Samba. First and foremost remember that:

    Portability is a primary consideration in adding function, as is network +documents are: +

    +http://lxr.linux.no/source/Documentation/CodingStyle +

    +http://www.fsf.org/prep/standards_toc.html +

    +But note that coding style in Samba varies due to the many different +programmers who have contributed. +

    +Following are some considerations you should use when adding new code to +Samba. First and foremost remember that: +

    +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.

    Here are some other suggestions:

    1. use d_printf instead of printf for display text - reason: enable auto-substitution of translated language text

    2. use SAFE_FREE instead of free - reason: reduce traps due to null pointers

    3. don't use bzero use memset, or ZERO_STRUCT and ZERO_STRUCTP macros - reason: not POSIX

    4. don't use strcpy and strlen (use safe_* equivalents) - reason: to avoid traps due to buffer overruns

    5. don't use getopt_long, use popt functions instead - reason: portability

    6. explicitly add const qualifiers on parm passing in functions where parm - is input only (somewhat controversial but const can be #defined away)

    7. when passing a va_list as an arg, or assigning one to another +Standard) perfectly. +

      +Here are some other suggestions: +

      1. + use d_printf instead of printf for display text + reason: enable auto-substitution of translated language text +

      2. + use SAFE_FREE instead of free + reason: reduce traps due to null pointers +

      3. + don't use bzero use memset, or ZERO_STRUCT and ZERO_STRUCTP macros + reason: not POSIX +

      4. + don't use strcpy and strlen (use safe_* equivalents) + reason: to avoid traps due to buffer overruns +

      5. + don't use getopt_long, use popt functions instead + reason: portability +

      6. + explicitly add const qualifiers on parm passing in functions where parm + is input only (somewhat controversial but const can be #defined away) +

      7. + 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.

      8. discourage use of threads - reason: portability (also see architecture.doc)

      9. don't explicitly include new header files in C files - new h files + initialized in each function...can SEGV if you don't. +

      10. + discourage use of threads + reason: portability (also see architecture.doc) +

      11. + 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

      12. don't explicitly extern functions (they are autogenerated by - "make proto" into proto.h) - reason: consistency

      13. use endian safe macros when unpacking SMBs (see byteorder.h and + reason: consistency +

      14. + don't explicitly extern functions (they are autogenerated by + "make proto" into proto.h) + reason: consistency +

      15. + use endian safe macros when unpacking SMBs (see byteorder.h and internals.doc) - reason: not everyone uses Intel

      16. Note Unicode implications of charset handling (see internals.doc). See + reason: not everyone uses Intel +

      17. + Note Unicode implications of charset handling (see internals.doc). See pull_* and push_* and convert_string functions. - reason: Internationalization

      18. Don't assume English only - reason: See above

      19. Try to avoid using in/out parameters (functions that return data which + reason: Internationalization +

      20. + Don't assume English only + reason: See above +

      21. + Try to avoid using in/out parameters (functions that return data which overwrites input parameters) - reason: Can cause stability problems

      22. Ensure copyright notices are correct, don't append Tridge's name to code + reason: Can cause stability problems +

      23. + 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.

      24. Consider usage of DATA_BLOBs for length specified byte-data. - reason: stability

      25. Take advantage of tdbs for database like function - reason: consistency

      26. Don't access the SAM_ACCOUNT structure directly, they should be accessed + can coexist with the rest of the Samba GPLed code. +

      27. + Consider usage of DATA_BLOBs for length specified byte-data. + reason: stability +

      28. + Take advantage of tdbs for database like function + reason: consistency +

      29. + Don't access the SAM_ACCOUNT structure directly, they should be accessed via pdb_get...() and pdb_set...() functions. - reason: stability, consistency

      30. Don't check a password directly against the passdb, always use the + reason: stability, consistency +

      31. + Don't check a password directly against the passdb, always use the check_password() interface. - reason: long term pluggability

      32. Try to use asprintf rather than pstrings and fstrings where possible

      33. Use normal C comments / * instead of C++ comments // like + reason: long term pluggability +

      34. + Try to use asprintf rather than pstrings and fstrings where possible +

      35. + 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.

      36. Try to write documentation for API functions and structures + standard, some older vendor C compilers do not accept it. +

      37. + 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.

      38. Keep the scope narrow. This means making functions/variables + this file. +

      39. + 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.

      40. Use function pointers to keep knowledge about particular pieces of + visible functions or variables. +

      41. + 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.

      42. Think carefully about what it will be like for someone else to add + interpreters. +

      43. + 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.

      The suggestions above are simply that, suggestions, but the information may + maintain then do it another way. +

    +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.

    Chapter 5. Samba Internals

    5.1. Character Handling

    This section describes character set handling in Samba, as implemented in -Samba 3.0 and above

    In the past Samba had very ad-hoc character set handling. Scattered +added. +

    Chapter 5. Samba Internals

    8 May 1996

    Table of Contents

    Character Handling
    The new functions
    Macros in byteorder.h
    CVAL(buf,pos)
    PVAL(buf,pos)
    SCVAL(buf,pos,val)
    SVAL(buf,pos)
    IVAL(buf,pos)
    SVALS(buf,pos)
    IVALS(buf,pos)
    SSVAL(buf,pos,val)
    SIVAL(buf,pos,val)
    SSVALS(buf,pos,val)
    SIVALS(buf,pos,val)
    RSVAL(buf,pos)
    RIVAL(buf,pos)
    RSSVAL(buf,pos,val)
    RSIVAL(buf,pos,val)
    LAN Manager Samba API
    Parameters
    Return value
    Code character table

    Character Handling

    +This section describes character set handling in Samba, as implemented in +Samba 3.0 and above +

    +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.

    5.2. The new functions

    The new system works like this:

    1. 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.

    2. there is no single fixed character set for unix strings, but any +particular cases without handlingt the general case. +

    The new functions

    +The new system works like this: +

    1. + 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. +

    2. + there is no single fixed character set for unix strings, but any character set that is used does need the following properties: -

      1. must not contain NULLs except for termination -

      2. must be 7-bit compatible with C strings, so that a constant +

        1. + must not contain NULLs except for termination +

        2. + 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. -

        3. when you uppercase or lowercase a string it does not become +

        4. + when you uppercase or lowercase a string it does not become longer than the original string -

        5. must be able to correctly hold all characters that your client +

        6. + must be able to correctly hold all characters that your client will throw at it -

        For example, UTF-8 is fine, and most multi-byte asian character sets +

    + 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. -

  • when you need to put a string into a buffer that will be sent on the +

  • + 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.

  • the two main pull_ and push_ functions you need to understand are + push a string out to a wire buffer. +

  • + 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 @@ -1801,953 +606,426 @@ TYPE="a" 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. -

    You may also call the pull_ascii/pull_ucs2 or push_ascii/push_ucs2 +

    + 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() -

  • The biggest thing to remember is that internal (unix) strings in Samba +

  • + 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.

  • all lp_ functions now return unix strings. The magic "DOS" flag on - parameters is gone.

  • all vfs functions take unix strings. Don't convert when passing to them

    • 5.3. Macros in byteorder.h

    This section describes the macros defined in byteorder.h. These macros -are used extensively in the Samba code.

    5.3.1. CVAL(buf,pos)

    returns the byte at offset pos within buffer buf as an unsigned character.

    5.3.2. PVAL(buf,pos)

    returns the value of CVAL(buf,pos) cast to type unsigned integer.

    5.3.3. SCVAL(buf,pos,val)

    sets the byte at offset pos within buffer buf to value val.

    5.3.4. SVAL(buf,pos)

    returns the value of the unsigned short (16 bit) little-endian integer at + speed it up but right now we want this stuff correct not fast. +

  • + all lp_ functions now return unix strings. The magic "DOS" flag on + parameters is gone. +

  • + all vfs functions take unix strings. Don't convert when passing to them +

    • Macros in byteorder.h

    +This section describes the macros defined in byteorder.h. These macros +are used extensively in the Samba code. +

    CVAL(buf,pos)

    +returns the byte at offset pos within buffer buf as an unsigned character. +

    PVAL(buf,pos)

    returns the value of CVAL(buf,pos) cast to type unsigned integer.

    SCVAL(buf,pos,val)

    sets the byte at offset pos within buffer buf to value val.

    SVAL(buf,pos)

    + 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".

    5.3.5. IVAL(buf,pos)

    returns the value of the unsigned 32 bit little-endian integer at offset -pos within buffer buf.

    5.3.6. SVALS(buf,pos)

    returns the value of the signed short (16 bit) little-endian integer at -offset pos within buffer buf.

    5.3.7. IVALS(buf,pos)

    returns the value of the signed 32 bit little-endian integer at offset pos -within buffer buf.

    5.3.8. SSVAL(buf,pos,val)

    sets the unsigned short (16 bit) little-endian integer at offset pos within -buffer buf to value val.

    5.3.9. SIVAL(buf,pos,val)

    sets the unsigned 32 bit little-endian integer at offset pos within buffer -buf to the value val.

    5.3.10. SSVALS(buf,pos,val)

    sets the short (16 bit) signed little-endian integer at offset pos within -buffer buf to the value val.

    5.3.11. SIVALS(buf,pos,val)

    sets the signed 32 bit little-endian integer at offset pos withing buffer -buf to the value val.

    5.3.12. RSVAL(buf,pos)

    returns the value of the unsigned short (16 bit) big-endian integer at -offset pos within buffer buf.

    5.3.13. RIVAL(buf,pos)

    returns the value of the unsigned 32 bit big-endian integer at offset -pos within buffer buf.

    5.3.14. RSSVAL(buf,pos,val)

    sets the value of the unsigned short (16 bit) big-endian integer at + refered to as "USHORT". +

    IVAL(buf,pos)

    returns the value of the unsigned 32 bit little-endian integer at offset +pos within buffer buf.

    SVALS(buf,pos)

    returns the value of the signed short (16 bit) little-endian integer at +offset pos within buffer buf.

    IVALS(buf,pos)

    returns the value of the signed 32 bit little-endian integer at offset pos +within buffer buf.

    SSVAL(buf,pos,val)

    sets the unsigned short (16 bit) little-endian integer at offset pos within +buffer buf to value val.

    SIVAL(buf,pos,val)

    sets the unsigned 32 bit little-endian integer at offset pos within buffer +buf to the value val.

    SSVALS(buf,pos,val)

    sets the short (16 bit) signed little-endian integer at offset pos within +buffer buf to the value val.

    SIVALS(buf,pos,val)

    sets the signed 32 bit little-endian integer at offset pos withing buffer +buf to the value val.

    RSVAL(buf,pos)

    returns the value of the unsigned short (16 bit) big-endian integer at +offset pos within buffer buf.

    RIVAL(buf,pos)

    returns the value of the unsigned 32 bit big-endian integer at offset +pos within buffer buf.

    RSSVAL(buf,pos,val)

    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".

    5.3.15. RSIVAL(buf,pos,val)

    sets the value of the unsigned 32 bit big-endian integer at offset -pos within buffer buf to value val.

    5.4. LAN Manager Samba API

    This section describes the functions need to make a LAN Manager RPC call. +refered to as "USHORT".

    RSIVAL(buf,pos,val)

    sets the value of the unsigned 32 bit big-endian integer at offset +pos within buffer buf to value val.

    LAN Manager Samba API

    +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.

    call_api(int prcnt, int drcnt, int mprcnt, int mdrcnt, 
-	char *param, char *data, char **rparam, char **rdata);

    This function is defined in client.c. It uses an SMB transaction to call a -remote api.

    5.4.1. Parameters

    The parameters are as follows:

    1. prcnt: the number of bytes of parameters begin sent.

    2. drcnt: the number of bytes of data begin sent.

    3. mprcnt: the maximum number of bytes of parameters which should be returned

    4. mdrcnt: the maximum number of bytes of data which should be returned

    5. param: a pointer to the parameters to be sent.

    6. data: a pointer to the data to be sent.

    7. 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.

    8. 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.

    These are the parameters which you ought to send, in the order of their -appearance in the parameter block:

    1. An unsigned 16 bit integer API number. You should set this value with -SSVAL(). I do not know where these numbers are described.

    2. An ASCIIZ string describing the parameters to the API function as defined +reliable. +

      +

      +call_api(int prcnt, int drcnt, int mprcnt, int mdrcnt, 
+	char *param, char *data, char **rparam, char **rdata);
+

      +

      +This function is defined in client.c. It uses an SMB transaction to call a +remote api. +

      Parameters

      The parameters are as follows:

      1. + prcnt: the number of bytes of parameters begin sent. +

      2. + drcnt: the number of bytes of data begin sent. +

      3. + mprcnt: the maximum number of bytes of parameters which should be returned +

      4. + mdrcnt: the maximum number of bytes of data which should be returned +

      5. + param: a pointer to the parameters to be sent. +

      6. + data: a pointer to the data to be sent. +

      7. + 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. +

      8. + 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. +

      +These are the parameters which you ought to send, in the order of their +appearance in the parameter block: +

      1. +An unsigned 16 bit integer API number. You should set this value with +SSVAL(). I do not know where these numbers are described. +

      2. +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.

      3. An ASCIIZ string describing the data structure which ought to be returned.

      4. 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.

      5. An unsigned 16 bit integer which gives the size in bytes of the buffer we +in the manual, not the data which is actually passed. +

      6. +An ASCIIZ string describing the data structure which ought to be returned. +

      7. +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. +

      8. +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().

      9. An ASCIIZ string describing substructures which should be returned. If no -substructures apply, this string is of zero length.

      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.

      5.4.2. Return value

      The returned parameters (pointed to by rparam), in their order of appearance -are:

      1. An unsigned 16 bit integer which contains the API function's return code. -This value should be read with SVAL().

      2. An adjustment which tells the amount by which pointers in the returned +should be the same as mdrcnt. This value should be set with SSVAL(). +

      3. +An ASCIIZ string describing substructures which should be returned. If no +substructures apply, this string is of zero length. +

      +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. +

      Return value

      +The returned parameters (pointed to by rparam), in their order of appearance +are:

      1. +An unsigned 16 bit integer which contains the API function's return code. +This value should be read with SVAL(). +

      2. +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.

      3. 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.

      When call_api() returns, rparam points to the returned parameters. The +order to obtain the currect offset into the returned data buffer. +

    3. +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. +

    +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)".

    The second parameter may be read as "SVAL(rparam,2)". It is a 16 bit offset +suceeded. This value by be read with "SVAL(rparam,0)". +

    +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.

    The returned data buffer contains the array of returned data structures. +use. +

    +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.

    The third parameter (which may be read as "SVAL(rparam,4)") has something to +fix_char_ptr() in client.c can be used for this purpose. +

    +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.

    5.5. Code character table

    Certain data structures are described by means of ASCIIz strings containing -code characters. These are the code characters:

    1. W a type byte little-endian unsigned integer

    2. N a count of substructures which follow

    3. D a four byte little-endian unsigned integer

    4. B a byte (with optional count expressed as trailing ASCII digits)

    5. z a four byte offset to a NULL terminated string

    6. l a four byte offset to non-string user data

    7. b an offset to data (with count expressed as trailing ASCII digits)

    8. r pointer to returned data buffer???

    9. L length in bytes of returned data buffer???

    10. h number of bytes of information available???

    Chapter 6. The smb.conf file

    6.1. Lexical Analysis

    Basically, the file is processed on a line by line basis. There are +data which can be returned if enough buffer space is allowed. +

    Code character table

    +Certain data structures are described by means of ASCIIz strings containing +code characters. These are the code characters: +

    1. +W a type byte little-endian unsigned integer +

    2. +N a count of substructures which follow +

    3. +D a four byte little-endian unsigned integer +

    4. +B a byte (with optional count expressed as trailing ASCII digits) +

    5. +z a four byte offset to a NULL terminated string +

    6. +l a four byte offset to non-string user data +

    7. +b an offset to data (with count expressed as trailing ASCII digits) +

    8. +r pointer to returned data buffer??? +

    9. +L length in bytes of returned data buffer??? +

    10. +h number of bytes of information available??? +

    Chapter 6. The smb.conf file

    Chris Hertel

    November 1997

    Table of Contents

    Lexical Analysis
    Handling of Whitespace
    Handling of Line Continuation
    Line Continuation Quirks
    Syntax
    About params.c

    Lexical Analysis

    +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):

    1. Blank lines - Lines containing only whitespace.

    2. Comment lines - Lines beginning with either a semi-colon or a -pound sign (';' or '#').

    3. Section header lines - Lines beginning with an open square bracket ('[').

    4. Parameter lines - Lines beginning with any other character. -(The default line type.)

    The first two are handled exclusively by the lexical analyzer, which -ignores them. The latter two line types are scanned for

    1. - Section names

    2. - Parameter names

    3. - Parameter values

    These are the only tokens passed to the parameter loader +(params.c): +

    1. +Blank lines - Lines containing only whitespace. +

    2. +Comment lines - Lines beginning with either a semi-colon or a +pound sign (';' or '#'). +

    3. +Section header lines - Lines beginning with an open square bracket ('['). +

    4. +Parameter lines - Lines beginning with any other character. +(The default line type.) +

    +The first two are handled exclusively by the lexical analyzer, which +ignores them. The latter two line types are scanned for +

    1. + - Section names +

    2. + - Parameter names +

    3. + - Parameter values +

    +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: '='.

    6.1.1. Handling of Whitespace

    Whitespace is defined as all characters recognized by the isspace() +another by an equal sign: '='. +

    Handling of Whitespace

    +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.

    1. The lexical analyzer scans past white space at the beginning of a line.

    2. Section and parameter names may contain internal white space. All -whitespace within a name is compressed to a single space character.

    3. Internal whitespace within a parameter value is kept verbatim with +The newline is excluded because it identifies the end of the line. +

      1. +The lexical analyzer scans past white space at the beginning of a line. +

      2. +Section and parameter names may contain internal white space. All +whitespace within a name is compressed to a single space character. +

      3. +Internal whitespace within a parameter value is kept verbatim with the exception of carriage return characters ('\r'), all of which -are removed.

      4. Leading and trailing whitespace is removed from names and values.

      6.1.2. Handling of Line Continuation

      Long section header and parameter lines may be extended across +are removed. +

    4. +Leading and trailing whitespace is removed from names and values. +

    Handling of Line Continuation

    +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.

    If the last (non-whitespace) character within a section header or on +continuation is ignored for blank and comment lines. +

    +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:

    	param name = parameter value string \
-	with line continuation.

    Would be read as

        param name = parameter value string     with line continuation.

    Note that there are five spaces following the word 'string', +analyzer. For example: +

    +	param name = parameter value string \
+	with line continuation.
+

    Would be read as

    +    param name = parameter value string     with line continuation.
+

    +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.)

    Line continuation characters are ignored on blank lines and at the end +(Yes, I'm counting the indentation.) +

    +Line continuation characters are ignored on blank lines and at the end of comments. They are *only* recognized within section and parameter -lines.

    6.1.3. Line Continuation Quirks

    Note the following example:

    	param name = parameter value string \
+lines.
+

    Line Continuation Quirks

    Note the following example:

    +	param name = parameter value string \
     \
-    with line continuation.

    The middle line is *not* parsed as a blank line because it is first -concatonated with the top line. The result is

    param name = parameter value string         with line continuation.

    The same is true for comment lines.

    	param name = parameter value string \
+    with line continuation.
+

    +The middle line is *not* parsed as a blank line because it is first +concatonated with the top line. The result is +

    +param name = parameter value string         with line continuation.
+

    The same is true for comment lines.

    +	param name = parameter value string \
 	; comment \
-    with a comment.

    This becomes:

    param name = parameter value string     ; comment     with a comment.

    On a section header line, the closing bracket (']') is considered a -terminating character, and the rest of the line is ignored. The lines

    	[ section   name ] garbage \
-    param  name  = value

    are read as

    	[section name]
-    param name = value

    6.2. Syntax

    The syntax of the smb.conf file is as follows:

      <file>            :==  { <section> } EOF
+    with a comment.
+

    This becomes:

    +param name = parameter value string     ; comment     with a comment.
+

    +On a section header line, the closing bracket (']') is considered a +terminating character, and the rest of the line is ignored. The lines +

    +	[ section   name ] garbage \
+    param  name  = value
+

    are read as

    +	[section name]
+    param name = value
+

    Syntax

    The syntax of the smb.conf file is as follows:

    +  <file>            :==  { <section> } EOF
   <section>         :==  <section header> { <parameter line> }
   <section header>  :==  '[' NAME ']'
-  <parameter line>  :==  NAME '=' VALUE NL

    Basically, this means that

    1. a file is made up of zero or more sections, and is terminated by - an EOF (we knew that).

    2. A section is made up of a section header followed by zero or more - parameter lines.

    3. A section header is identified by an opening bracket and + <parameter line> :== NAME '=' VALUE NL +

      Basically, this means that

      1. + a file is made up of zero or more sections, and is terminated by + an EOF (we knew that). +

      2. + A section is made up of a section header followed by zero or more + parameter lines. +

      3. + A section header is identified by an opening bracket and terminated by the closing bracket. The enclosed NAME identifies - the section.

      4. A parameter line is divided into a NAME and a VALUE. The *first* + the section. +

      5. + 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').

      6.2.1. About params.c

      The parsing of the config file is a bit unusual if you are used to + VALUE is terminated by a newline character (NL = '\n'). +

    About params.c

    +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.

    Chapter 7. NetBIOS in a Unix World

    7.1. Introduction

    This is a short document that describes some of the issues that +loadparm.c. +

    Chapter 7. NetBIOS in a Unix World

    Andrew Tridgell

    April 1995

    Table of Contents

    Introduction
    Usernames
    File Ownership
    Passwords
    Locking
    Deny Modes
    Trapdoor UIDs
    Port numbers
    Protocol Complexity

    Introduction

    +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.

    It was written to help out a person who was writing a paper on unix to -PC connectivity.

    7.2. Usernames

    The SMB protocol has only a loose username concept. Early SMB +them. They may help people who are looking at unix<->PC +interoperability. +

    +It was written to help out a person who was writing a paper on unix to +PC connectivity. +

    Usernames

    +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.

    Unix security is based around username/password pairs. A unix box +on the server. +

    +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.

    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 +sort of validation. +

    +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.

    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 +inconvenient in many sites. +

    +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.

    The user often chooses a totally different username for their login as +"logged onto" the PC (this assumes Windows for Workgroups). The +password is the one they chose when connecting to the disk or printer. +

    +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.

    Samba tries to avoid this problem using several methods. These succeed +divining the correct username to combine with each password. +

    +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).

    7.3. File Ownership

    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.

    This brings up all sorts of interesting problems. For example, when +(either directly or via the user= option). +

    File Ownership

    +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. +

    +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.

    There are several possible solutions to this problem, including +up shared development diectories as programs like "make" will not get +file time comparisons right. +

    +There are several possible solutions to this problem, including username mapping, and forcing a specific username for particular -shares.

    7.4. Passwords

    Many SMB clients uppercase passwords before sending them. I have no +shares. +

    Passwords

    +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.

    Unix passwords are case sensitive. So if users use mixed case -passwords they are in trouble.

    Samba can try to cope with this by either using the "password level" +obviously it isn't just the data entry routines that are to blame. +

    +Unix passwords are case sensitive. So if users use mixed case +passwords they are in trouble. +

    +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" +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).

    Samba supports the password encryption method used by SMB +(typically a WinNT server). +

    +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". +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.

    7.5. Locking

    Since samba 2.2, samba supports other types of locking as well. This -section is outdated.

    The locking calls available under a DOS/Windows environment are much +details. +

    Locking

    +Since samba 2.2, samba supports other types of locking as well. This +section is outdated. +

    +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.

    One major problem is that dos locks can be in a 32 bit (unsigned) +to implement SMB locking has to improvise a bit. +

    +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.

    To work around this problem Samba compresses the 32 bit range into 31 +locking range used for OLE semaphores. +

    +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.

    It also doesn't help that many unix lockd daemons are very buggy and +with the problem. +

    +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.

    The second major problem is the "opportunistic locking" requested by +clients can kill the daemon on some systems. +

    +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.

    7.6. Deny Modes

    When a SMB client opens a file it asks for a particular "deny mode" to +opportunistic locking, and currently Samba has no support for it. +

    Deny Modes

    +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.

    Unix has no equivalent notion. To implement this Samba uses either lock +the file for reading should fail. +

    +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.

    7.7. Trapdoor UIDs

    A SMB session can run with several uids on the one socket. This +by default for those systems that support it. +

    Trapdoor UIDs

    +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.

    Note that you can also get the "trapdoor uid" message for other -reasons. Please see the FAQ for details.

    7.8. Port numbers

    There is a convention that clients on sockets use high "unprivilaged" -port numbers (>1000) and connect to servers on low "privilaged" port +a single uid. +

    +Note that you can also get the "trapdoor uid" message for other +reasons. Please see the FAQ for details. +

    Port numbers

    +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.

    Most PC based SMB clients (such as WfWg and WinNT) don't follow this +socket for listening on port numbers less than 1000. +

    +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.

    The problem is more severe with netbios node status queries. I've +low port based firewall. +

    +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 @@ -2755,421 +1033,179 @@ 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.

    7.9. Protocol Complexity

    There are many "protocol levels" in the SMB protocol. It seems that +responses back to the source port in the request. +

    Protocol Complexity

    +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.

    This means the protocol is very "rich", offering many ways of doing +protocol to "externalise" the new capabilities. +

    +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.

    There are about 65 "top level" operations in the SMB protocol (things +SMB calls that are available. +

    +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 +"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.

    Samba currently supports up to the "NT LM 0.12" protocol, which is the +doesn't support them all. +

    +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 +"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.

    There is also a problem with the SMB specications. SMB is a X/Open +this protocol level much easier. +

    +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.

    Chapter 8. Tracing samba system calls

    This file describes how to do a system call trace on Samba to work out +mailing list hosted by Microsft. +

    Chapter 8. Tracing samba system calls

    Andrew Tridgell

    Samba Team

    +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.

    Actually its not as bad as the the above makes it sound, just don't -expect the output to be very pretty :-)

    Ok, down to business. One of the big advantages of unix systems is +are reading this then you are probably desperate. +

    +Actually its not as bad as the the above makes it sound, just don't +expect the output to be very pretty :-) +

    +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.

    The system trace utility is called different things on different +without any special compilation options. +

    +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.

    The first thing you should do is read the man page for your native +truss. Under many BSD systems its called ktrace. +

    +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.

    Next, try using strace on some simple commands. For example, strace -ls or strace echo hello.

    +features. +

    +Next, try using strace on some simple commands. For example, strace +ls or strace echo hello. +

    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!)

    For example, the only line that really matters in the strace echo -hello output is:

    write(1, "hello\n", 6)                  = 6

    all the rest is just setting up to run the program.

    Ok, now you're familiar with strace. To use it on Samba you need to +"preamble" stuff showing the loading of shared libraries etc. Ignore +this (unless its going wrong!) +

    +For example, the only line that really matters in the strace echo +hello output is: +

    +write(1, "hello\n", 6)                  = 6
+

    all the rest is just setting up to run the program.

    +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 -strace -p PID to attach to that process. I normally redirect the +strace -p PID 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:

    strace -f -p 3872 >& strace.out

    or with a sh style shell:

    strace -f -p 3872 > strace.out 2>&1

    Note the "-f" option. This is only available on some systems, and +example, if I'm using a csh style shell: +

    strace -f -p 3872 >& strace.out

    or with a sh style shell:

    strace -f -p 3872 > strace.out 2>&1

    +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.

    Once you are attached you then can do whatever it is on the client +"print command" being wrong. +

    +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.

    So how do you interpret the results? Generally I search through the +that smbd makes. +

    +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.

    Beyond this you will have to use your initiative. To give you an idea +numbers and "follow" what happens to an open file until it is closed. +

    +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 /dev/null is not world writeable, which -causes printing to fail with Samba:

    [pid 28268] open("/dev/null", O_RDWR)   = -1 EACCES (Permission denied)
-[pid 28268] open("/dev/null", O_WRONLY) = -1 EACCES (Permission denied)

    The process is trying to first open /dev/null read-write -then read-only. Both fail. This means /dev/null has -incorrect permissions.

    Chapter 9. NT Domain RPC's

    9.1. Introduction

    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 http://mailhost.cb1.com/~lkcl/cifsntdomain.txt, controlled by Luke.

    It should be possible to select a domain instead of a workgroup (in the NT +shows that /dev/null is not world writeable, which +causes printing to fail with Samba: +

    +[pid 28268] open("/dev/null", O_RDWR)   = -1 EACCES (Permission denied)
+[pid 28268] open("/dev/null", O_WRONLY) = -1 EACCES (Permission denied)
+

    +The process is trying to first open /dev/null read-write +then read-only. Both fail. This means /dev/null has +incorrect permissions. +

    Chapter 9. NT Domain RPC's

    Luke Leighton

    Duncan Stansfield

    01 November 97(version 0.0.24)

    Table of Contents

    Introduction
    Sources
    Credits
    Notes and Structures
    Notes
    Enumerations
    Structures
    MSRPC over Transact Named Pipe
    MSRPC Pipes
    Header
    Tail
    RPC Bind / Bind Ack
    NTLSA Transact Named Pipe
    LSA Open Policy
    LSA Query Info Policy
    LSA Enumerate Trusted Domains
    LSA Open Secret
    LSA Close
    LSA Lookup SIDS
    LSA Lookup Names
    NETLOGON rpc Transact Named Pipe
    LSA Request Challenge
    LSA Authenticate 2
    LSA Server Password Set
    LSA SAM Logon
    LSA SAM Logoff
    \\MAILSLOT\NET\NTLOGON
    Query for PDC
    SAM Logon
    SRVSVC Transact Named Pipe
    Net Share Enum
    Net Server Get Info
    Cryptographic side of NT Domain Authentication
    Definitions
    Protocol
    Comments
    SIDs and RIDs
    Well-known SIDs
    Well-known RIDS

    Introduction

    +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 http://mailhost.cb1.com/~lkcl/cifsntdomain.txt, controlled by Luke. +

    +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.

    The packets described here can be easily derived from (and are probably +comments, corrections and additions to this document. +

    +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.

    Also needed, to fully implement NT Domain Login Services, is the +instructive than this document. +

    +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.

    A copy is available from:

    http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935

    http://mailhost.cb1.com/~lkcl/crypt.html

    A c-code implementation, provided by Linus Nordberg -of this protocol is available from:

    http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html

    http://mailhost.cb1.com/~lkcl/crypt.txt

    Also used to provide debugging information is the Check Build version of +digest and from the samba digest, amongst other sources. +

    +A copy is available from: +

    http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935

    http://mailhost.cb1.com/~lkcl/crypt.html

    +A c-code implementation, provided by Linus Nordberg +of this protocol is available from: +

    http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html

    http://mailhost.cb1.com/~lkcl/crypt.txt

    +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:

    HKLM\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters

    Incorrect direct editing of the registry can cause your +achieved by setting the following REG_SZ registry key to 0x1ffffff: +

    HKLM\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters

    Incorrect direct editing of the registry can cause your machine to fail. Then again, so can incorrect implementation of this -protocol. See "Liability:" above.

    Bear in mind that each packet over-the-wire will have its origin in an +protocol. See "Liability:" above.

    +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.

    This document is by no means complete or authoritative. Missing sections -include, but are not limited to:

    1. Mappings of RIDs to usernames (and vice-versa).

    2. What a User ID is and what a Group ID is.

    3. The exact meaning/definition of various magic constants or enumerations.

    4. The reply error code and use of that error code when a +and defines that are usefully documented elsewhere. +

      +This document is by no means complete or authoritative. Missing sections +include, but are not limited to: +

      1. Mappings of RIDs to usernames (and vice-versa).

      2. What a User ID is and what a Group ID is.

      3. The exact meaning/definition of various magic constants or enumerations.

      4. 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.

      5. the cryptographic side of the NetrServerPasswordSet command, +that it is already a member of the domain.

      6. 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].

      9.1.1. Sources

      cket Traces from Netmonitor (Service Pack 1 and above)
      ul Ashton and Luke Leighton's other "NT Domain" doc.
      FS documentation - cifs6.txt
      FS documentation - cifsrap2.txt

      9.1.2. Credits

      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.
      Duncan Stansfield: low-level analysis of MSRPC Pipes.
      Linus Nordberg: producing c-code from Paul's crypto spec.
      Windows Sourcer development team

      9.2. Notes and Structures

      9.2.1. Notes

      1. In the SMB Transact pipes, some "Structures", described here, appear to be +command, and keep the default workstation password].

      Sources

      cket Traces from Netmonitor (Service Pack 1 and above)
      ul Ashton and Luke Leighton's other "NT Domain" doc.
      FS documentation - cifs6.txt
      FS documentation - cifsrap2.txt

      Credits

      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.
      Duncan Stansfield: low-level analysis of MSRPC Pipes.
      Linus Nordberg: producing c-code from Paul's crypto spec.
      Windows Sourcer development team

      Notes and Structures

      Notes

      1. +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.

      2. In the UDP NTLOGON Mailslots, some "Structures", described here, appear to be -2-byte aligned with the start of the mailslot, at their start.

      3. 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.

      4. any undocumented buffer pointers must be non-zero if the string buffer it +"Structures" need aligning is not precisely known or documented. +

      5. +In the UDP NTLOGON Mailslots, some "Structures", described here, appear to be +2-byte aligned with the start of the mailslot, at their start. +

      6. +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. +

      7. +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. @@ -3178,3707 +1214,90 @@ 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.

      8. an array of structures (a container) appears to have a count and a pointer. +is not known, although an educated guess can be made. +

      9. +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.

      9.2.2. Enumerations

      9.2.2.1. MSRPC Header type

      command number in the msrpc packet header

      MSRPC_Request:

      0x00

      MSRPC_Response:

      0x02

      MSRPC_Bind:

      0x0B

      MSRPC_BindAck:

      0x0C

      9.2.2.2. MSRPC Packet info

      The meaning of these flags is undocumented

      FirstFrag:

      0x01

      LastFrag:

      0x02

      NotaFrag:

      0x04

      RecRespond:

      0x08

      NoMultiplex:

      0x10

      NotForIdemp:

      0x20

      NotforBcast:

      0x40

      NoUuid:

      0x80

      9.2.3. Structures

      9.2.3.1. VOID *

      sizeof VOID* is 32 bits.

      9.2.3.2. char

      sizeof char is 8 bits.

      9.2.3.3. UTIME

      UTIME is 32 bits, indicating time in seconds since 01jan1970. documented in cifs6.txt (section 3.5 page, page 30).

      9.2.3.4. NTTIME

      NTTIME is 64 bits. documented in cifs6.txt (section 3.5 page, page 30).

      9.2.3.5. DOM_SID (domain SID structure)

      UINT32

      num of sub-authorities in domain SID

      UINT8

      SID revision number

      UINT8

      num of sub-authorities in domain SID

      UINT8[6]

      6 bytes for domain SID - Identifier Authority.

      UINT16[n_subauths]

      domain SID sub-authorities

      Note: the domain SID is documented elsewhere.

      9.2.3.6. STR (string)

      STR (string) is a char[] : a null-terminated string of ascii characters.

      9.2.3.7. UNIHDR (unicode string header)

      UINT16

      length of unicode string

      UINT16

      max length of unicode string

      UINT32

      4 - undocumented.

      9.2.3.8. UNIHDR2 (unicode string header plus buffer pointer)

      UNIHDR

      unicode string header

      VOID*

      undocumented buffer pointer

      9.2.3.9. UNISTR (unicode string)

      UINT16[]

      null-terminated string of unicode characters.

      9.2.3.10. NAME (length-indicated unicode string)

      UINT32

      length of unicode string

      UINT16[]

      null-terminated string of unicode characters.

      9.2.3.11. UNISTR2 (aligned unicode string)

      UINT8[]

      padding to get unicode string 4-byte aligned with the start of the SMB header.

      UINT32

      max length of unicode string

      UINT32

      0 - undocumented

      UINT32

      length of unicode string

      UINT16[]

      string of uncode characters

      9.2.3.12. OBJ_ATTR (object attributes)

      UINT32

      0x18 - length (in bytes) including the length field.

      VOID*

      0 - root directory (pointer)

      VOID*

      0 - object name (pointer)

      UINT32

      0 - attributes (undocumented)

      VOID*

      0 - security descriptior (pointer)

      UINT32

      0 - security quality of service

      9.2.3.13. POL_HND (LSA policy handle)

      char[20]

      policy handle

      9.2.3.14. DOM_SID2 (domain SID structure, SIDS stored in unicode)

      UINT32

      5 - SID type

      UINT32

      0 - undocumented

      UNIHDR2

      domain SID unicode string header

      UNISTR

      domain SID unicode string

      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.

      Note: the SID type indicates, for example, an alias; a well-known group etc. this is documented somewhere.

      9.2.3.15. DOM_RID (domain RID structure)

      UINT32

      5 - well-known SID. 1 - user SID (see ShowACLs)

      UINT32

      5 - undocumented

      UINT32

      domain RID

      UINT32

      0 - domain index out of above reference domains

      9.2.3.16. LOG_INFO (server, account, client structure)

      Note: logon server name starts with two '\' characters and is upper case.

      Note: account name is the logon client name from the LSA Request Challenge, with a $ on the end of it, in upper case.

      VOID*

      undocumented buffer pointer

      UNISTR2

      logon server unicode string

      UNISTR2

      account name unicode string

      UINT16

      sec_chan - security channel type

      UNISTR2

      logon client machine unicode string

      9.2.3.17. CLNT_SRV (server, client names structure)

      Note: logon server name starts with two '\' characters and is upper case.

      VOID*

      undocumented buffer pointer

      UNISTR2

      logon server unicode string

      VOID*

      undocumented buffer pointer

      UNISTR2

      logon client machine unicode string

      9.2.3.18. CREDS (credentials + time stamp)

      char[8]

      credentials

      UTIME

      time stamp

      9.2.3.19. CLNT_INFO2 (server, client structure, client credentials)

      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.

      CLNT_SRV

      client and server names

      UINT8[]

      ???? padding, for 4-byte alignment with SMB header.

      VOID*

      pointer to client credentials.

      CREDS

      client-calculated credentials + client time

      9.2.3.20. CLNT_INFO (server, account, client structure, client credentials)

      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.

      LOG_INFO

      logon account info

      CREDS

      client-calculated credentials + client time

      9.2.3.21. ID_INFO_1 (id info structure, auth level 1)

      VOID*

      ptr_id_info_1

      UNIHDR

      domain name unicode header

      UINT32

      param control

      UINT64

      logon ID

      UNIHDR

      user name unicode header

      UNIHDR

      workgroup name unicode header

      char[16]

      arc4 LM OWF Password

      char[16]

      arc4 NT OWF Password

      UNISTR2

      domain name unicode string

      UNISTR2

      user name unicode string

      UNISTR2

      workstation name unicode string

      9.2.3.22. SAM_INFO (sam logon/logoff id info structure)

      Note: presumably, the return credentials is supposedly for the server to verify that the credential chain hasn't been compromised.

      CLNT_INFO2

      client identification/authentication info

      VOID*

      pointer to return credentials.

      CRED

      return credentials - ignored.

      UINT16

      logon level

      UINT16

      switch value

              switch (switch_value)
+appears a third time after the last sub-structure.
+

    Enumerations

    MSRPC Header type

    command number in the msrpc packet header

    MSRPC_Request:

    0x00

    MSRPC_Response:

    0x02

    MSRPC_Bind:

    0x0B

    MSRPC_BindAck:

    0x0C

    MSRPC Packet info

    The meaning of these flags is undocumented

    FirstFrag:

    0x01

    LastFrag:

    0x02

    NotaFrag:

    0x04

    RecRespond:

    0x08

    NoMultiplex:

    0x10

    NotForIdemp:

    0x20

    NotforBcast:

    0x40

    NoUuid:

    0x80

    Structures

    VOID *

    sizeof VOID* is 32 bits.

    char

    sizeof char is 8 bits.

    UTIME

    UTIME is 32 bits, indicating time in seconds since 01jan1970. documented in cifs6.txt (section 3.5 page, page 30).

    NTTIME

    NTTIME is 64 bits. documented in cifs6.txt (section 3.5 page, page 30).

    DOM_SID (domain SID structure)

    UINT32

    num of sub-authorities in domain SID

    UINT8

    SID revision number

    UINT8

    num of sub-authorities in domain SID

    UINT8[6]

    6 bytes for domain SID - Identifier Authority.

    UINT16[n_subauths]

    domain SID sub-authorities

    Note: the domain SID is documented elsewhere. +

    STR (string)

    STR (string) is a char[] : a null-terminated string of ascii characters.

    UNIHDR (unicode string header)

    UINT16

    length of unicode string

    UINT16

    max length of unicode string

    UINT32

    4 - undocumented.

    UNIHDR2 (unicode string header plus buffer pointer)

    UNIHDR

    unicode string header

    VOID*

    undocumented buffer pointer

    UNISTR (unicode string)

    UINT16[]

    null-terminated string of unicode characters.

    NAME (length-indicated unicode string)

    UINT32

    length of unicode string

    UINT16[]

    null-terminated string of unicode characters.

    UNISTR2 (aligned unicode string)

    UINT8[]

    padding to get unicode string 4-byte aligned with the start of the SMB header.

    UINT32

    max length of unicode string

    UINT32

    0 - undocumented

    UINT32

    length of unicode string

    UINT16[]

    string of uncode characters

    OBJ_ATTR (object attributes)

    UINT32

    0x18 - length (in bytes) including the length field.

    VOID*

    0 - root directory (pointer)

    VOID*

    0 - object name (pointer)

    UINT32

    0 - attributes (undocumented)

    VOID*

    0 - security descriptior (pointer)

    UINT32

    0 - security quality of service

    POL_HND (LSA policy handle)

    char[20]

    policy handle

    DOM_SID2 (domain SID structure, SIDS stored in unicode)

    UINT32

    5 - SID type

    UINT32

    0 - undocumented

    UNIHDR2

    domain SID unicode string header

    UNISTR

    domain SID unicode string

    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.

    Note: the SID type indicates, for example, an alias; a well-known group etc. this is documented somewhere.

    DOM_RID (domain RID structure)

    UINT32

    5 - well-known SID. 1 - user SID (see ShowACLs)

    UINT32

    5 - undocumented

    UINT32

    domain RID

    UINT32

    0 - domain index out of above reference domains

    LOG_INFO (server, account, client structure)

    Note: logon server name starts with two '\' characters and is upper case.

    Note: account name is the logon client name from the LSA Request Challenge, with a $ on the end of it, in upper case.

    VOID*

    undocumented buffer pointer

    UNISTR2

    logon server unicode string

    UNISTR2

    account name unicode string

    UINT16

    sec_chan - security channel type

    UNISTR2

    logon client machine unicode string

    CLNT_SRV (server, client names structure)

    Note: logon server name starts with two '\' characters and is upper case.

    VOID*

    undocumented buffer pointer

    UNISTR2

    logon server unicode string

    VOID*

    undocumented buffer pointer

    UNISTR2

    logon client machine unicode string

    CREDS (credentials + time stamp)

    char[8]

    credentials

    UTIME

    time stamp

    CLNT_INFO2 (server, client structure, client credentials)

    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.

    CLNT_SRV

    client and server names

    UINT8[]

    ???? padding, for 4-byte alignment with SMB header.

    VOID*

    pointer to client credentials.

    CREDS

    client-calculated credentials + client time

    CLNT_INFO (server, account, client structure, client credentials)

    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.

    LOG_INFO

    logon account info

    CREDS

    client-calculated credentials + client time

    ID_INFO_1 (id info structure, auth level 1)

    VOID*

    ptr_id_info_1

    UNIHDR

    domain name unicode header

    UINT32

    param control

    UINT64

    logon ID

    UNIHDR

    user name unicode header

    UNIHDR

    workgroup name unicode header

    char[16]

    arc4 LM OWF Password

    char[16]

    arc4 NT OWF Password

    UNISTR2

    domain name unicode string

    UNISTR2

    user name unicode string

    UNISTR2

    workstation name unicode string

    SAM_INFO (sam logon/logoff id info structure)

    Note: presumably, the return credentials is supposedly for the server to verify that the credential chain hasn't been compromised.

    CLNT_INFO2

    client identification/authentication info

    VOID*

    pointer to return credentials.

    CRED

    return credentials - ignored.

    UINT16

    logon level

    UINT16

    switch value

    +        switch (switch_value)
         case 1:
         {
             ID_INFO_1     id_info_1;
-        }

    9.2.3.23. GID (group id info)

    UINT32

    group id

    UINT32

    user attributes (only used by NT 3.1 and 3.51)

    9.2.3.24. DOM_REF (domain reference info)

    VOID*

    undocumented buffer pointer.

    UINT32

    num referenced domains?

    VOID*

    undocumented domain name buffer pointer.

    UINT32

    32 - max number of entries

    UINT32

    4 - num referenced domains?

    UNIHDR2

    domain name unicode string header

    UNIHDR2[num_ref_doms-1]

    referenced domain unicode string headers

    UNISTR

    domain name unicode string

    DOM_SID[num_ref_doms]

    referenced domain SIDs

    9.2.3.25. DOM_INFO (domain info, levels 3 and 5 are the same))

    UINT8[]

    ??? padding to get 4-byte alignment with start of SMB header

    UINT16

    domain name string length * 2

    UINT16

    domain name string length * 2

    VOID*

    undocumented domain name string buffer pointer

    VOID*

    undocumented domain SID string buffer pointer

    UNISTR2

    domain name (unicode string)

    DOM_SID

    domain SID

    9.2.3.26. USER_INFO (user logon info)

    Note: it would be nice to know what the 16 byte user session key is for.

    NTTIME

    logon time

    NTTIME

    logoff time

    NTTIME

    kickoff time

    NTTIME

    password last set time

    NTTIME

    password can change time

    NTTIME

    password must change time

    UNIHDR

    username unicode string header

    UNIHDR

    user's full name unicode string header

    UNIHDR

    logon script unicode string header

    UNIHDR

    profile path unicode string header

    UNIHDR

    home directory unicode string header

    UNIHDR

    home directory drive unicode string header

    UINT16

    logon count

    UINT16

    bad password count

    UINT32

    User ID

    UINT32

    Group ID

    UINT32

    num groups

    VOID*

    undocumented buffer pointer to groups.

    UINT32

    user flags

    char[16]

    user session key

    UNIHDR

    logon server unicode string header

    UNIHDR

    logon domain unicode string header

    VOID*

    undocumented logon domain id pointer

    char[40]

    40 undocumented padding bytes. future expansion?

    UINT32

    0 - num_other_sids?

    VOID*

    NULL - undocumented pointer to other domain SIDs.

    UNISTR2

    username unicode string

    UNISTR2

    user's full name unicode string

    UNISTR2

    logon script unicode string

    UNISTR2

    profile path unicode string

    UNISTR2

    home directory unicode string

    UNISTR2

    home directory drive unicode string

    UINT32

    num groups

    GID[num_groups]

    group info

    UNISTR2

    logon server unicode string

    UNISTR2

    logon domain unicode string

    DOM_SID

    domain SID

    DOM_SID[num_sids]

    other domain SIDs?

    9.2.3.27. SH_INFO_1_PTR (pointers to level 1 share info strings)

    Note: see cifsrap2.txt section5, page 10.

    0 for shi1_type indicates a Disk.
    1 for shi1_type indicates a Print Queue.
    2 for shi1_type indicates a Device.
    3 for shi1_type indicates an IPC pipe.
    0x8000 0000 (top bit set in shi1_type) indicates a hidden share.

    VOID*

    shi1_netname - pointer to net name

    UINT32

    shi1_type - type of share. 0 - undocumented.

    VOID*

    shi1_remark - pointer to comment.

    9.2.3.28. SH_INFO_1_STR (level 1 share info strings)

    UNISTR2

    shi1_netname - unicode string of net name

    UNISTR2

    shi1_remark - unicode string of comment.

    9.2.3.29. SHARE_INFO_1_CTR

    share container with 0 entries:

    UINT32

    0 - EntriesRead

    UINT32

    0 - Buffer

    share container with > 0 entries:

    UINT32

    EntriesRead

    UINT32

    non-zero - Buffer

    UINT32

    EntriesRead

    SH_INFO_1_PTR[EntriesRead]

    share entry pointers

    SH_INFO_1_STR[EntriesRead]

    share entry strings

    UINT8[]

    padding to get unicode string 4-byte aligned with start of the SMB header.

    UINT32

    EntriesRead

    UINT32

    0 - padding

    9.2.3.30. SERVER_INFO_101

    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.

    SV_TYPE_WORKSTATION

    0x00000001 All workstations

    SV_TYPE_SERVER

    0x00000002 All servers

    SV_TYPE_SQLSERVER

    0x00000004 Any server running with SQL server

    SV_TYPE_DOMAIN_CTRL

    0x00000008 Primary domain controller

    SV_TYPE_DOMAIN_BAKCTRL

    0x00000010 Backup domain controller

    SV_TYPE_TIME_SOURCE

    0x00000020 Server running the timesource service

    SV_TYPE_AFP

    0x00000040 Apple File Protocol servers

    SV_TYPE_NOVELL

    0x00000080 Novell servers

    SV_TYPE_DOMAIN_MEMBER

    0x00000100 Domain Member

    SV_TYPE_PRINTQ_SERVER

    0x00000200 Server sharing print queue

    SV_TYPE_DIALIN_SERVER

    0x00000400 Server running dialin service.

    SV_TYPE_XENIX_SERVER

    0x00000800 Xenix server

    SV_TYPE_NT

    0x00001000 NT server

    SV_TYPE_WFW

    0x00002000 Server running Windows for

    SV_TYPE_SERVER_NT

    0x00008000 Windows NT non DC server

    SV_TYPE_POTENTIAL_BROWSER

    0x00010000 Server that can run the browser service

    SV_TYPE_BACKUP_BROWSER

    0x00020000 Backup browser server

    SV_TYPE_MASTER_BROWSER

    0x00040000 Master browser server

    SV_TYPE_DOMAIN_MASTER

    0x00080000 Domain Master Browser server

    SV_TYPE_LOCAL_LIST_ONLY

    0x40000000 Enumerate only entries marked "local"

    SV_TYPE_DOMAIN_ENUM

    0x80000000 Enumerate Domains. The pszServer and pszDomain parameters must be NULL.

    UINT32

    500 - platform_id

    VOID*

    pointer to name

    UINT32

    5 - major version

    UINT32

    4 - minor version

    UINT32

    type (SV_TYPE_... bit field)

    VOID*

    pointer to comment

    UNISTR2

    sv101_name - unicode string of server name

    UNISTR2

    sv_101_comment - unicode string of server comment.

    UINT8[]

    padding to get unicode string 4-byte aligned with start of the SMB header.

    9.3. MSRPC over Transact Named Pipe

    For details on the SMB Transact Named Pipe, see cifs6.txt

    9.3.1. MSRPC Pipes

    The MSRPC is conducted over an SMB Transact Pipe with a name of -\PIPE\. You must first obtain a 16 bit file handle, by -sending a SMBopenX with the pipe name \PIPE\srvsvc for + } +

    GID (group id info)

    UINT32

    group id

    UINT32

    user attributes (only used by NT 3.1 and 3.51)

    DOM_REF (domain reference info)

    VOID*

    undocumented buffer pointer.

    UINT32

    num referenced domains?

    VOID*

    undocumented domain name buffer pointer.

    UINT32

    32 - max number of entries

    UINT32

    4 - num referenced domains?

    UNIHDR2

    domain name unicode string header

    UNIHDR2[num_ref_doms-1]

    referenced domain unicode string headers

    UNISTR

    domain name unicode string

    DOM_SID[num_ref_doms]

    referenced domain SIDs

    DOM_INFO (domain info, levels 3 and 5 are the same))

    UINT8[]

    ??? padding to get 4-byte alignment with start of SMB header

    UINT16

    domain name string length * 2

    UINT16

    domain name string length * 2

    VOID*

    undocumented domain name string buffer pointer

    VOID*

    undocumented domain SID string buffer pointer

    UNISTR2

    domain name (unicode string)

    DOM_SID

    domain SID

    USER_INFO (user logon info)

    Note: it would be nice to know what the 16 byte user session key is for.

    NTTIME

    logon time

    NTTIME

    logoff time

    NTTIME

    kickoff time

    NTTIME

    password last set time

    NTTIME

    password can change time

    NTTIME

    password must change time

    UNIHDR

    username unicode string header

    UNIHDR

    user's full name unicode string header

    UNIHDR

    logon script unicode string header

    UNIHDR

    profile path unicode string header

    UNIHDR

    home directory unicode string header

    UNIHDR

    home directory drive unicode string header

    UINT16

    logon count

    UINT16

    bad password count

    UINT32

    User ID

    UINT32

    Group ID

    UINT32

    num groups

    VOID*

    undocumented buffer pointer to groups.

    UINT32

    user flags

    char[16]

    user session key

    UNIHDR

    logon server unicode string header

    UNIHDR

    logon domain unicode string header

    VOID*

    undocumented logon domain id pointer

    char[40]

    40 undocumented padding bytes. future expansion?

    UINT32

    0 - num_other_sids?

    VOID*

    NULL - undocumented pointer to other domain SIDs.

    UNISTR2

    username unicode string

    UNISTR2

    user's full name unicode string

    UNISTR2

    logon script unicode string

    UNISTR2

    profile path unicode string

    UNISTR2

    home directory unicode string

    UNISTR2

    home directory drive unicode string

    UINT32

    num groups

    GID[num_groups]

    group info

    UNISTR2

    logon server unicode string

    UNISTR2

    logon domain unicode string

    DOM_SID

    domain SID

    DOM_SID[num_sids]

    other domain SIDs?

    SH_INFO_1_PTR (pointers to level 1 share info strings)

    Note: see cifsrap2.txt section5, page 10.

    0 for shi1_type indicates a Disk.
    1 for shi1_type indicates a Print Queue.
    2 for shi1_type indicates a Device.
    3 for shi1_type indicates an IPC pipe.
    0x8000 0000 (top bit set in shi1_type) indicates a hidden share.
    VOID*

    shi1_netname - pointer to net name

    UINT32

    shi1_type - type of share. 0 - undocumented.

    VOID*

    shi1_remark - pointer to comment.

    SH_INFO_1_STR (level 1 share info strings)

    UNISTR2

    shi1_netname - unicode string of net name

    UNISTR2

    shi1_remark - unicode string of comment.

    SHARE_INFO_1_CTR

    share container with 0 entries:

    UINT32

    0 - EntriesRead

    UINT32

    0 - Buffer

    share container with > 0 entries:

    UINT32

    EntriesRead

    UINT32

    non-zero - Buffer

    UINT32

    EntriesRead

    SH_INFO_1_PTR[EntriesRead]

    share entry pointers

    SH_INFO_1_STR[EntriesRead]

    share entry strings

    UINT8[]

    padding to get unicode string 4-byte aligned with start of the SMB header.

    UINT32

    EntriesRead

    UINT32

    0 - padding

    SERVER_INFO_101

    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.

    SV_TYPE_WORKSTATION

    0x00000001 All workstations

    SV_TYPE_SERVER

    0x00000002 All servers

    SV_TYPE_SQLSERVER

    0x00000004 Any server running with SQL server

    SV_TYPE_DOMAIN_CTRL

    0x00000008 Primary domain controller

    SV_TYPE_DOMAIN_BAKCTRL

    0x00000010 Backup domain controller

    SV_TYPE_TIME_SOURCE

    0x00000020 Server running the timesource service

    SV_TYPE_AFP

    0x00000040 Apple File Protocol servers

    SV_TYPE_NOVELL

    0x00000080 Novell servers

    SV_TYPE_DOMAIN_MEMBER

    0x00000100 Domain Member

    SV_TYPE_PRINTQ_SERVER

    0x00000200 Server sharing print queue

    SV_TYPE_DIALIN_SERVER

    0x00000400 Server running dialin service.

    SV_TYPE_XENIX_SERVER

    0x00000800 Xenix server

    SV_TYPE_NT

    0x00001000 NT server

    SV_TYPE_WFW

    0x00002000 Server running Windows for

    SV_TYPE_SERVER_NT

    0x00008000 Windows NT non DC server

    SV_TYPE_POTENTIAL_BROWSER

    0x00010000 Server that can run the browser service

    SV_TYPE_BACKUP_BROWSER

    0x00020000 Backup browser server

    SV_TYPE_MASTER_BROWSER

    0x00040000 Master browser server

    SV_TYPE_DOMAIN_MASTER

    0x00080000 Domain Master Browser server

    SV_TYPE_LOCAL_LIST_ONLY

    0x40000000 Enumerate only entries marked "local"

    SV_TYPE_DOMAIN_ENUM

    0x80000000 Enumerate Domains. The pszServer and pszDomain parameters must be NULL.

    UINT32

    500 - platform_id

    VOID*

    pointer to name

    UINT32

    5 - major version

    UINT32

    4 - minor version

    UINT32

    type (SV_TYPE_... bit field)

    VOID*

    pointer to comment

    UNISTR2

    sv101_name - unicode string of server name

    UNISTR2

    sv_101_comment - unicode string of server comment.

    UINT8[]

    padding to get unicode string 4-byte aligned with start of the SMB header.

    MSRPC over Transact Named Pipe

    For details on the SMB Transact Named Pipe, see cifs6.txt

    MSRPC Pipes

    +The MSRPC is conducted over an SMB Transact Pipe with a name of +\PIPE\. You must first obtain a 16 bit file handle, by +sending a SMBopenX with the pipe name \PIPE\srvsvc for example. You can then perform an SMB Trans, -and must carry out an SMBclose on the file handle once you are finished.

    Trans Requests must be sent with two setup UINT16s, no UINT16 params (none +and must carry out an SMBclose on the file handle once you are finished. +

    +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.

    The Data section for an API Command of 0x0026 (RPC pipe) in the Trans +obtained above. +

    +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.

    MSRPC Responses are sent as response data inside standard SMB Trans -responses, with the MSRPC Header, MSRPC Data and MSRPC tail.

    It is suspected that the Trans Requests will need to be at least 2-byte +only value seen for these two bytes is 0x00 0x43. +

    +MSRPC Responses are sent as response data inside standard SMB Trans +responses, with the MSRPC Header, MSRPC Data and MSRPC tail. +

    +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.

    First, an SMBtconX connection is made to the IPC$ share. The connection +MSRPC data. +

    +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.

    To be resolved:

    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:

            initial SMBopenX request:         RPC API command 0x26 params:
-        "\\PIPE\\lsarpc"                  0x65 0x63; 0x72 0x70; 0x44 0x65;
-        "\\PIPE\\srvsvc"                  0x73 0x76; 0x4E 0x00; 0x5C 0x43;

    9.3.2. Header

    [section to be rewritten, following receipt of work by Duncan Stansfield]

    Interesting note: if you set packed data representation to 0x0100 0000 -then all 4-byte and 2-byte word ordering is turned around!

    The start of each of the NTLSA and NETLOGON named pipes begins with:

    offset: 00

    Variable type: UINT8

    Variable data: 5 - RPC major version

    offset: 01

    Variable type: UINT8

    Variable data: 0 - RPC minor version

    offset: 02

    Variable type: UINT8

    Variable data: 2 - RPC response packet

    offset: 03

    Variable type: UINT8

    Variable data: 3 - (FirstFrag bit-wise or with LastFrag)

    offset: 04

    Variable type: UINT32

    Variable data: 0x1000 0000 - packed data representation

    offset: 08

    Variable type: UINT16

    Variable data: fragment length - data size (bytes) inc header and tail.

    offset: 0A

    Variable type: UINT16

    Variable data: 0 - authentication length

    offset: 0C

    Variable type: UINT32

    Variable data: call identifier. matches 12th UINT32 of incoming RPC data.

    offset: 10

    Variable type: UINT32

    Variable data: allocation hint - data size (bytes) minus header and tail.

    offset: 14

    Variable type: UINT16

    Variable data: 0 - presentation context identifier

    offset: 16

    Variable type: UINT8

    Variable data: 0 - cancel count

    offset: 17

    Variable type: UINT8

    Variable data: in replies: 0 - reserved; in requests: opnum - see #defines.

    offset: 18

    Variable type: ......

    Variable data: start of data (goes on for allocation_hint bytes)

    9.3.2.1. RPC_Packet for request, response, bind and bind acknowledgement

    UINT8 versionmaj

    reply same as request (0x05)

    UINT8 versionmin

    reply same as request (0x00)

    UINT8 type

    one of the MSRPC_Type enums

    UINT8 flags

    reply same as request (0x00 for Bind, 0x03 for Request)

    UINT32 representation

    reply same as request (0x00000010)

    UINT16 fraglength

    the length of the data section of the SMB trans packet

    UINT16 authlength

    UINT32 callid

    call identifier. (e.g. 0x00149594)

    * stub USE TvPacket

    the remainder of the packet depending on the "type"

    9.3.2.2. Interface identification

    the interfaces are numbered. as yet I haven't seen more than one interface used on the same pipe name srvsvc

    abstract (0x4B324FC8, 0x01D31670, 0x475A7812, 0x88E16EBF, 0x00000003)
-transfer (0x8A885D04, 0x11C91CEB, 0x0008E89F, 0x6048102B, 0x00000002)

    9.3.2.3. RPC_Iface RW

    UINT8 byte[16]

    16 bytes of number

    UINT32 version

    the interface number

    9.3.2.4. RPC_ReqBind RW

    the remainder of the packet after the header if "type" was Bind in the response header, "type" should be BindAck

    UINT16 maxtsize

    maximum transmission fragment size (0x1630)

    UINT16 maxrsize

    max receive fragment size (0x1630)

    UINT32 assocgid

    associated group id (0x0)

    UINT32 numelements

    the number of elements (0x1)

    UINT16 contextid

    presentation context identifier (0x0)

    UINT8 numsyntaxes

    the number of syntaxes (has always been 1?)(0x1)

    UINT8[]

    4-byte alignment padding, against SMB header

    * abstractint USE RPC_Iface

    num and vers. of interface client is using

    * transferint USE RPC_Iface

    num and vers. of interface to use for replies

    9.3.2.5. RPC_Address RW

    UINT16 length

    length of the string including null terminator

    * port USE string

    the string above in single byte, null terminated form

    9.3.2.6. RPC_ResBind RW

    the response to place after the header in the reply packet

    UINT16 maxtsize

    same as request

    UINT16 maxrsize

    same as request

    UINT32 assocgid

    zero

    * secondaddr USE RPC_Address

    the address string, as described earlier

    UINT8[]

    4-byte alignment padding, against SMB header

    UINT8 numresults

    the number of results (0x01)

    UINT8[]

    4-byte alignment padding, against SMB header

    UINT16 result

    result (0x00 = accept)

    UINT16 reason

    reason (0x00 = no reason specified)

    * transfersyntax USE RPC_Iface

    the transfer syntax from the request

    9.3.2.7. RPC_ReqNorm RW

    the remainder of the packet after the header for every other other request

    UINT32 allochint

    the size of the stub data in bytes

    UINT16 prescontext

    presentation context identifier (0x0)

    UINT16 opnum

    operation number (0x15)

    * stub USE TvPacket

    a packet dependent on the pipe name (probably the interface) and the op number)

    9.3.2.8. RPC_ResNorm RW

    UINT32 allochint

    # size of the stub data in bytes

    UINT16 prescontext

    # presentation context identifier (same as request)

    UINT8 cancelcount

    # cancel count? (0x0)

    UINT8 reserved

    # 0 - one byte padding

    * stub USE TvPacket

    # the remainder of the reply

    9.3.3. Tail

    The end of each of the NTLSA and NETLOGON named pipes ends with:

    ......

    end of data

    UINT32

    return code

    9.3.4. RPC Bind / Bind Ack

    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.

    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.

    Note: The RPC_ResBind members maxtsize, maxrsize and assocgid are the same in the response as the same members in the RPC_ReqBind. The +is sent. +

    +To be resolved: +

    +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:

    +        initial SMBopenX request:         RPC API command 0x26 params:
+        "\\PIPE\\lsarpc"                  0x65 0x63; 0x72 0x70; 0x44 0x65;
+        "\\PIPE\\srvsvc"                  0x73 0x76; 0x4E 0x00; 0x5C 0x43;
+

    Header

    [section to be rewritten, following receipt of work by Duncan Stansfield]

    Interesting note: if you set packed data representation to 0x0100 0000 +then all 4-byte and 2-byte word ordering is turned around!

    The start of each of the NTLSA and NETLOGON named pipes begins with:

    offset: 00

    Variable type: UINT8

    Variable data: 5 - RPC major version

    offset: 01

    Variable type: UINT8

    Variable data: 0 - RPC minor version

    offset: 02

    Variable type: UINT8

    Variable data: 2 - RPC response packet

    offset: 03

    Variable type: UINT8

    Variable data: 3 - (FirstFrag bit-wise or with LastFrag)

    offset: 04

    Variable type: UINT32

    Variable data: 0x1000 0000 - packed data representation

    offset: 08

    Variable type: UINT16

    Variable data: fragment length - data size (bytes) inc header and tail.

    offset: 0A

    Variable type: UINT16

    Variable data: 0 - authentication length

    offset: 0C

    Variable type: UINT32

    Variable data: call identifier. matches 12th UINT32 of incoming RPC data.

    offset: 10

    Variable type: UINT32

    Variable data: allocation hint - data size (bytes) minus header and tail.

    offset: 14

    Variable type: UINT16

    Variable data: 0 - presentation context identifier

    offset: 16

    Variable type: UINT8

    Variable data: 0 - cancel count

    offset: 17

    Variable type: UINT8

    Variable data: in replies: 0 - reserved; in requests: opnum - see #defines.

    offset: 18

    Variable type: ......

    Variable data: start of data (goes on for allocation_hint bytes)

    RPC_Packet for request, response, bind and bind acknowledgement

    UINT8 versionmaj

    reply same as request (0x05)

    UINT8 versionmin

    reply same as request (0x00)

    UINT8 type

    one of the MSRPC_Type enums

    UINT8 flags

    reply same as request (0x00 for Bind, 0x03 for Request)

    UINT32 representation

    reply same as request (0x00000010)

    UINT16 fraglength

    the length of the data section of the SMB trans packet

    UINT16 authlength

    UINT32 callid

    call identifier. (e.g. 0x00149594)

    * stub USE TvPacket

    the remainder of the packet depending on the "type"

    Interface identification

    the interfaces are numbered. as yet I haven't seen more than one interface used on the same pipe name srvsvc

    +abstract (0x4B324FC8, 0x01D31670, 0x475A7812, 0x88E16EBF, 0x00000003)
+transfer (0x8A885D04, 0x11C91CEB, 0x0008E89F, 0x6048102B, 0x00000002)
+

    RPC_Iface RW

    UINT8 byte[16]

    16 bytes of number

    UINT32 version

    the interface number

    RPC_ReqBind RW

    the remainder of the packet after the header if "type" was Bind in the response header, "type" should be BindAck

    UINT16 maxtsize

    maximum transmission fragment size (0x1630)

    UINT16 maxrsize

    max receive fragment size (0x1630)

    UINT32 assocgid

    associated group id (0x0)

    UINT32 numelements

    the number of elements (0x1)

    UINT16 contextid

    presentation context identifier (0x0)

    UINT8 numsyntaxes

    the number of syntaxes (has always been 1?)(0x1)

    UINT8[]

    4-byte alignment padding, against SMB header

    * abstractint USE RPC_Iface

    num and vers. of interface client is using

    * transferint USE RPC_Iface

    num and vers. of interface to use for replies

    RPC_Address RW

    UINT16 length

    length of the string including null terminator

    * port USE string

    the string above in single byte, null terminated form

    RPC_ResBind RW

    the response to place after the header in the reply packet

    UINT16 maxtsize

    same as request

    UINT16 maxrsize

    same as request

    UINT32 assocgid

    zero

    * secondaddr USE RPC_Address

    the address string, as described earlier

    UINT8[]

    4-byte alignment padding, against SMB header

    UINT8 numresults

    the number of results (0x01)

    UINT8[]

    4-byte alignment padding, against SMB header

    UINT16 result

    result (0x00 = accept)

    UINT16 reason

    reason (0x00 = no reason specified)

    * transfersyntax USE RPC_Iface

    the transfer syntax from the request

    RPC_ReqNorm RW

    the remainder of the packet after the header for every other other request

    UINT32 allochint

    the size of the stub data in bytes

    UINT16 prescontext

    presentation context identifier (0x0)

    UINT16 opnum

    operation number (0x15)

    * stub USE TvPacket

    a packet dependent on the pipe name (probably the interface) and the op number)

    RPC_ResNorm RW

    UINT32 allochint

    # size of the stub data in bytes

    UINT16 prescontext

    # presentation context identifier (same as request)

    UINT8 cancelcount

    # cancel count? (0x0)

    UINT8 reserved

    # 0 - one byte padding

    * stub USE TvPacket

    # the remainder of the reply

    Tail

    The end of each of the NTLSA and NETLOGON named pipes ends with:

    ......

    end of data

    UINT32

    return code

    RPC Bind / Bind Ack

    +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. +

    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.

    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

    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:

    initial SMBopenX request:

    RPC_ResBind response:

    "\\PIPE\\srvsvc"

    "\\PIPE\\ntsvcs"

    "\\PIPE\\samr"

    "\\PIPE\\lsass"

    "\\PIPE\\lsarpc"

    "\\PIPE\\lsass"

    "\\PIPE\\wkssvc"

    "\\PIPE\\wksvcs"

    "\\PIPE\\NETLOGON"

    "\\PIPE\\NETLOGON"

    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.

    Request:

    RPC_Packet
    RPC_ReqBind

    Response:

    RPC_Packet
    RPC_ResBind

    9.3.5. NTLSA Transact Named Pipe

    The sequence of actions taken on this pipe are:

    Establish a connection to the IPC$ share (SMBtconX). use encrypted passwords.
    Open an RPC Pipe with the name "\\PIPE\\lsarpc". Store the file handle.
    Using the file handle, send a Set Named Pipe Handle state to 0x4300.
    Send an LSA Open Policy request. Store the Policy Handle.
    Using the Policy Handle, send LSA Query Info Policy requests, etc.
    Using the Policy Handle, send an LSA Close.
    Close the IPC$ share.

    Defines for this pipe, identifying the query are:

    LSA Open Policy:

    0x2c

    LSA Query Info Policy:

    0x07

    LSA Enumerate Trusted Domains:

    0x0d

    LSA Open Secret:

    0xff

    LSA Lookup SIDs:

    0xfe

    LSA Lookup Names:

    0xfd

    LSA Close:

    0x00

    9.3.6. LSA Open Policy

    Note: The policy handle can be anything you like.

    9.3.6.1. Request

    VOID*

    buffer pointer

    UNISTR2

    server name - unicode string starting with two '\'s

    OBJ_ATTR

    object attributes

    UINT32

    1 - desired access

    9.3.6.2. Response

    POL_HND

    LSA policy handle

    return

    0 - indicates success

    9.3.7. LSA Query Info Policy

    Note: The info class in response must be the same as that in the request.

    9.3.7.1. Request

    POL_HND

    LSA policy handle

    UINT16

    info class (also a policy handle?)

    9.3.7.2. Response

    VOID*

    undocumented buffer pointer

    UINT16

    info class (same as info class in request).

    switch (info class)
+	the
    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:
    initial SMBopenX request:
    RPC_ResBind response:
    "\\PIPE\\srvsvc"
    "\\PIPE\\ntsvcs"
    "\\PIPE\\samr"
    "\\PIPE\\lsass"
    "\\PIPE\\lsarpc"
    "\\PIPE\\lsass"
    "\\PIPE\\wkssvc"
    "\\PIPE\\wksvcs"
    "\\PIPE\\NETLOGON"
    "\\PIPE\\NETLOGON"
    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.
    Request:
    RPC_Packet
    RPC_ReqBind
    Response:
    RPC_Packet
    RPC_ResBind

    NTLSA Transact Named Pipe

    The sequence of actions taken on this pipe are:

    Establish a connection to the IPC$ share (SMBtconX). use encrypted passwords.
    Open an RPC Pipe with the name "\\PIPE\\lsarpc". Store the file handle.
    Using the file handle, send a Set Named Pipe Handle state to 0x4300.
    Send an LSA Open Policy request. Store the Policy Handle.
    Using the Policy Handle, send LSA Query Info Policy requests, etc.
    Using the Policy Handle, send an LSA Close.
    Close the IPC$ share.

    Defines for this pipe, identifying the query are:

    LSA Open Policy:

    0x2c

    LSA Query Info Policy:

    0x07

    LSA Enumerate Trusted Domains:

    0x0d

    LSA Open Secret:

    0xff

    LSA Lookup SIDs:

    0xfe

    LSA Lookup Names:

    0xfd

    LSA Close:

    0x00

    LSA Open Policy

    Note: The policy handle can be anything you like.

    Request

    VOID*

    buffer pointer

    UNISTR2

    server name - unicode string starting with two '\'s

    OBJ_ATTR

    object attributes

    UINT32

    1 - desired access

    Response

    POL_HND

    LSA policy handle

    return

    0 - indicates success

    LSA Query Info Policy

    Note: The info class in response must be the same as that in the request.

    Request

    POL_HND

    LSA policy handle

    UINT16

    info class (also a policy handle?)

    Response

    VOID*

    undocumented buffer pointer

    UINT16

    info class (same as info class in request).

    +switch (info class)
 case 3:
 case 5:
 {
 DOM_INFO domain info, levels 3 and 5 (are the same).
 }
 
-return    0 - indicates success

    9.3.8. LSA Enumerate Trusted Domains

    9.3.8.1. Request

    no extra data

    9.3.8.2. Response

    UINT32

    0 - enumeration context

    UINT32

    0 - entries read

    UINT32

    0 - trust information

    return

    0x8000 001a - "no trusted domains" success code

    9.3.9. LSA Open Secret

    9.3.9.1. Request

    no extra data

    9.3.9.2. Response

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    return 0x0C00 0034 - "no such secret" success code

    9.3.10. LSA Close

    9.3.10.1. Request

    POL_HND

    policy handle to be closed

    9.3.10.2. Response

    POL_HND

    0s - closed policy handle (all zeros)

    return 0 - indicates success

    9.3.11. LSA Lookup SIDS

    Note: num_entries in response must be same as num_entries in request.

    9.3.11.1. Request

    POL_HND

    LSA policy handle

    UINT32

    num_entries

    VOID*

    undocumented domain SID buffer pointer

    VOID*

    undocumented domain name buffer pointer

    VOID*[num_entries] undocumented domain SID pointers to be looked up.

    DOM_SID[num_entries] domain SIDs to be looked up.

    char[16]

    completely undocumented 16 bytes.

    9.3.11.2. Response

    DOM_REF

    domain reference response

    UINT32

    num_entries (listed above)

    VOID*

    undocumented buffer pointer

    UINT32

    num_entries (listed above)

    DOM_SID2[num_entries]

    domain SIDs (from Request, listed above).

    UINT32

    num_entries (listed above)

    return 0 - indicates success

    9.3.12. LSA Lookup Names

    Note: num_entries in response must be same as num_entries in request.

    9.3.12.1. Request

    POL_HND

    LSA policy handle

    UINT32

    num_entries

    UINT32

    num_entries

    VOID*

    undocumented domain SID buffer pointer

    VOID*

    undocumented domain name buffer pointer

    NAME[num_entries]

    names to be looked up.

    char[]

    undocumented bytes - falsely translated SID structure?

    9.3.12.2. Response

    DOM_REF

    domain reference response

    UINT32

    num_entries (listed above)

    VOID*

    undocumented buffer pointer

    UINT32

    num_entries (listed above)

    DOM_RID[num_entries]

    domain SIDs (from Request, listed above).

    UINT32

    num_entries (listed above)

    return 0 - indicates success

    9.4. NETLOGON rpc Transact Named Pipe

    The sequence of actions taken on this pipe are:

    tablish a connection to the IPC$ share (SMBtconX). use encrypted passwords.
    en an RPC Pipe with the name "\\PIPE\\NETLOGON". Store the file handle.
    ing the file handle, send a Set Named Pipe Handle state to 0x4300.
    eate Client Challenge. Send LSA Request Challenge. Store Server Challenge.
    lculate Session Key. Send an LSA Auth 2 Challenge. Store Auth2 Challenge.
    lc/Verify Client Creds. Send LSA Srv PW Set. Calc/Verify Server Creds.
    lc/Verify Client Creds. Send LSA SAM Logon . Calc/Verify Server Creds.
    lc/Verify Client Creds. Send LSA SAM Logoff. Calc/Verify Server Creds.
    ose the IPC$ share.

    Defines for this pipe, identifying the query are

    LSA Request Challenge:

    0x04

    LSA Server Password Set:

    0x06

    LSA SAM Logon:

    0x02

    LSA SAM Logoff:

    0x03

    LSA Auth 2:

    0x0f

    LSA Logon Control:

    0x0e

    9.4.1. LSA Request Challenge

    Note: logon server name starts with two '\' characters and is upper case.

    Note: logon client is the machine, not the user.

    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).

    9.4.1.1. Request

    VOID*

    undocumented buffer pointer

    UNISTR2

    logon server unicode string

    UNISTR2

    logon client unicode string

    char[8]

    client challenge

    9.4.1.2. Response

    char[8]

    server challenge

    return 0 - indicates success

    9.4.2. LSA Authenticate 2

    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).

    Note: neg_flags in the response is the same as that in the request.

    Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.

    9.4.2.1. Request

    LOG_INFO

    client identification info

    char[8]

    client-calculated credentials

    UINT8[]

    padding to 4-byte align with start of SMB header.

    UINT32

    neg_flags - negotiated flags (usual value is 0x0000 01ff)

    9.4.2.2. Response

    char[8]

    server credentials.

    UINT32

    neg_flags - same as neg_flags in request.

    return 0 - indicates success. failure value unknown.

    9.4.3. LSA Server Password Set

    Note: the new password is suspected to be a DES encryption using the old password to generate the key.

    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).

    Note: the server credentials are constructed from the client-calculated credentials and the client time + 1 second.

    Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.

    9.4.3.1. Request

    CLNT_INFO

    client identification/authentication info

    char[]

    new password - undocumented.

    9.4.3.2. Response

    CREDS

    server credentials. server time stamp appears to be ignored.

    return 0 - indicates success; 0xC000 006a indicates failure

    9.4.4. LSA SAM Logon

    Note: valid_user is True iff the username and password hash are valid for - the requested domain.

    9.4.4.1. Request

    SAM_INFO

    sam_id structure

    9.4.4.2. Response

    VOID*

    undocumented buffer pointer

    CREDS

    server credentials. server time stamp appears to be ignored.

    if (valid_user)
+return    0 - indicates success
+

    LSA Enumerate Trusted Domains

    Request

    no extra data

    Response

    UINT32

    0 - enumeration context

    UINT32

    0 - entries read

    UINT32

    0 - trust information

    return

    0x8000 001a - "no trusted domains" success code

    LSA Open Secret

    Request

    no extra data

    Response

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    UINT32

    0 - undocumented

    return 0x0C00 0034 - "no such secret" success code

    LSA Close

    Request

    POL_HND

    policy handle to be closed

    Response

    POL_HND

    0s - closed policy handle (all zeros)

    return 0 - indicates success

    LSA Lookup SIDS

    Note: num_entries in response must be same as num_entries in request.

    Request

    POL_HND

    LSA policy handle

    UINT32

    num_entries

    VOID*

    undocumented domain SID buffer pointer

    VOID*

    undocumented domain name buffer pointer

    VOID*[num_entries] undocumented domain SID pointers to be looked up. +

    DOM_SID[num_entries] domain SIDs to be looked up.

    char[16]

    completely undocumented 16 bytes.

    Response

    DOM_REF

    domain reference response

    UINT32

    num_entries (listed above)

    VOID*

    undocumented buffer pointer

    UINT32

    num_entries (listed above)

    DOM_SID2[num_entries]

    domain SIDs (from Request, listed above).

    UINT32

    num_entries (listed above)

    return 0 - indicates success

    LSA Lookup Names

    Note: num_entries in response must be same as num_entries in request.

    Request

    POL_HND

    LSA policy handle

    UINT32

    num_entries

    UINT32

    num_entries

    VOID*

    undocumented domain SID buffer pointer

    VOID*

    undocumented domain name buffer pointer

    NAME[num_entries]

    names to be looked up.

    char[]

    undocumented bytes - falsely translated SID structure?

    Response

    DOM_REF

    domain reference response

    UINT32

    num_entries (listed above)

    VOID*

    undocumented buffer pointer

    UINT32

    num_entries (listed above)

    DOM_RID[num_entries]

    domain SIDs (from Request, listed above).

    UINT32

    num_entries (listed above)

    return 0 - indicates success

    NETLOGON rpc Transact Named Pipe

    The sequence of actions taken on this pipe are:

    tablish a connection to the IPC$ share (SMBtconX). use encrypted passwords.
    en an RPC Pipe with the name "\\PIPE\\NETLOGON". Store the file handle.
    ing the file handle, send a Set Named Pipe Handle state to 0x4300.
    eate Client Challenge. Send LSA Request Challenge. Store Server Challenge.
    lculate Session Key. Send an LSA Auth 2 Challenge. Store Auth2 Challenge.
    lc/Verify Client Creds. Send LSA Srv PW Set. Calc/Verify Server Creds.
    lc/Verify Client Creds. Send LSA SAM Logon . Calc/Verify Server Creds.
    lc/Verify Client Creds. Send LSA SAM Logoff. Calc/Verify Server Creds.
    ose the IPC$ share.

    Defines for this pipe, identifying the query are

    LSA Request Challenge:

    0x04

    LSA Server Password Set:

    0x06

    LSA SAM Logon:

    0x02

    LSA SAM Logoff:

    0x03

    LSA Auth 2:

    0x0f

    LSA Logon Control:

    0x0e

    LSA Request Challenge

    Note: logon server name starts with two '\' characters and is upper case.

    Note: logon client is the machine, not the user.

    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).

    Request

    VOID*

    undocumented buffer pointer

    UNISTR2

    logon server unicode string

    UNISTR2

    logon client unicode string

    char[8]

    client challenge

    Response

    char[8]

    server challenge

    return 0 - indicates success

    LSA Authenticate 2

    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).

    Note: neg_flags in the response is the same as that in the request.

    Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.

    Request

    LOG_INFO

    client identification info

    char[8]

    client-calculated credentials

    UINT8[]

    padding to 4-byte align with start of SMB header.

    UINT32

    neg_flags - negotiated flags (usual value is 0x0000 01ff)

    Response

    char[8]

    server credentials.

    UINT32

    neg_flags - same as neg_flags in request.

    return 0 - indicates success. failure value unknown.

    LSA Server Password Set

    Note: the new password is suspected to be a DES encryption using the old password to generate the key.

    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).

    Note: the server credentials are constructed from the client-calculated credentials and the client time + 1 second.

    Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.

    Request

    CLNT_INFO

    client identification/authentication info

    char[]

    new password - undocumented.

    Response

    CREDS

    server credentials. server time stamp appears to be ignored.

    return 0 - indicates success; 0xC000 006a indicates failure

    LSA SAM Logon

    +Note: valid_user is True iff the username and password hash are valid for + the requested domain. +

    Request

    SAM_INFO

    sam_id structure

    Response

    VOID*

    undocumented buffer pointer

    CREDS

    server credentials. server time stamp appears to be ignored.

    +if (valid_user)
 {
 	UINT16      3 - switch value indicating USER_INFO structure.
     VOID*     non-zero - pointer to USER_INFO structure
@@ -6896,1325 +1315,117 @@ else
     UINT32    1 - Authoritative response; 0 - Non-Auth?
 
     return    0xC000 0064 - NT_STATUS_NO_SUCH_USER.
-}

    9.4.5. LSA SAM Logoff

    Note: presumably, the SAM_INFO structure is validated, and a (currently - undocumented) error code returned if the Logoff is invalid.

    9.4.5.1. Request

    SAM_INFO

    sam_id structure

    9.4.5.2. Response

    VOID*

    undocumented buffer pointer

    CREDS

    server credentials. server time stamp appears to be ignored.

    return 0 - indicates success. undocumented failure indication.

    9.5. \\MAILSLOT\NET\NTLOGON

    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.

    9.5.1. Query for PDC

    Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.

    9.5.1.1. Request

    UINT16

    0x0007 - Query for PDC

    STR

    machine name

    STR

    response mailslot

    UINT8[]

    padding to 2-byte align with start of mailslot.

    UNISTR

    machine name

    UINT32

    NTversion

    UINT16

    LMNTtoken

    UINT16

    LM20token

    9.5.1.2. Response

    UINT16

    0x000A - Respose to Query for PDC

    STR

    machine name (in uppercase)

    UINT8[]

    padding to 2-byte align with start of mailslot.

    UNISTR

    machine name

    UNISTR

    domain name

    UINT32

    NTversion (same as received in request)

    UINT16

    LMNTtoken (same as received in request)

    UINT16

    LM20token (same as received in request)

    9.5.2. SAM Logon

    Note: machine name in response is preceded by two '\' characters.

    Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.

    Note: user name in the response is presumably the same as that in the request.

    9.5.2.1. Request

    UINT16

    0x0012 - SAM Logon

    UINT16

    request count

    UNISTR

    machine name

    UNISTR

    user name

    STR

    response mailslot

    UINT32

    alloweable account

    UINT32

    domain SID size

    char[sid_size]

    domain SID, of sid_size bytes.

    UINT8[]

    ???? padding to 4? 2? -byte align with start of mailslot.

    UINT32

    NTversion

    UINT16

    LMNTtoken

    UINT16

    LM20token

    9.5.2.2. Response

    UINT16

    0x0013 - Response to SAM Logon

    UNISTR

    machine name

    UNISTR

    user name - workstation trust account

    UNISTR

    domain name

    UINT32

    NTversion

    UINT16

    LMNTtoken

    UINT16

    LM20token

    9.6. SRVSVC Transact Named Pipe

    Defines for this pipe, identifying the query are:

    Net Share Enum

    0x0f

    Net Server Get Info

    0x15

    9.6.1. Net Share Enum

    Note: share level and switch value in the response are presumably the same as those in the request.

    Note: cifsrap2.txt (section 5) may be of limited assistance here.

    9.6.1.1. Request

    VOID*

    pointer (to server name?)

    UNISTR2

    server name

    UINT8[]

    padding to get unicode string 4-byte aligned with the start of the SMB header.

    UINT32

    share level

    UINT32

    switch value

    VOID*

    pointer to SHARE_INFO_1_CTR

    SHARE_INFO_1_CTR

    share info with 0 entries

    UINT32

    preferred maximum length (0xffff ffff)

    9.6.1.2. Response

    UINT32

    share level

    UINT32

    switch value

    VOID*

    pointer to SHARE_INFO_1_CTR

    SHARE_INFO_1_CTR

    share info (only added if share info ptr is non-zero)

    return 0 - indicates success

    9.6.2. Net Server Get Info

    Note: level is the same value as in the request.

    9.6.2.1. Request

    UNISTR2

    server name

    UINT32

    switch level

    9.6.2.2. Response

    UINT32

    switch level

    VOID*

    pointer to SERVER_INFO_101

    SERVER_INFO_101

    server info (only added if server info ptr is non-zero)

    return 0 - indicates success

    9.7. Cryptographic side of NT Domain Authentication

    9.7.1. Definitions

    Add(A1,A2)

    Intel byte ordered addition of corresponding 4 byte words in arrays A1 and A2

    E(K,D)

    DES ECB encryption of 8 byte data D using 7 byte key K

    lmowf()

    Lan man hash

    ntowf()

    NT hash

    PW

    md4(machine_password) == md4(lsadump $machine.acc) == -pwdump(machine$) (initially) == md4(lmowf(unicode(machine)))

    ARC4(K,Lk,D,Ld)

    ARC4 encryption of data D of length Ld with key K of length Lk

    v[m..n(,l)]

    subset of v from bytes m to n, optionally padded with zeroes to length l

    Cred(K,D)

    E(K[7..7,7],E(K[0..6],D)) computes a credential

    Time()

    4 byte current time

    Cc,Cs

    8 byte client and server challenges Rc,Rs: 8 byte client and server credentials

    9.7.2. Protocol

    C->S ReqChal,Cc S->C Cs

    C & S compute session key Ks = E(PW[9..15],E(PW[0..6],Add(Cc,Cs)))

    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))

    On joining the domain the client will optionally attempt to change its +} +

    LSA SAM Logoff

    +Note: presumably, the SAM_INFO structure is validated, and a (currently + undocumented) error code returned if the Logoff is invalid. +

    Request

    SAM_INFO

    sam_id structure

    Response

    VOID*

    undocumented buffer pointer

    CREDS

    server credentials. server time stamp appears to be ignored.

    return 0 - indicates success. undocumented failure indication.

    \\MAILSLOT\NET\NTLOGON

    +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. +

    Query for PDC

    Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.

    Request

    UINT16

    0x0007 - Query for PDC

    STR

    machine name

    STR

    response mailslot

    UINT8[]

    padding to 2-byte align with start of mailslot.

    UNISTR

    machine name

    UINT32

    NTversion

    UINT16

    LMNTtoken

    UINT16

    LM20token

    Response

    UINT16

    0x000A - Respose to Query for PDC

    STR

    machine name (in uppercase)

    UINT8[]

    padding to 2-byte align with start of mailslot.

    UNISTR

    machine name

    UNISTR

    domain name

    UINT32

    NTversion (same as received in request)

    UINT16

    LMNTtoken (same as received in request)

    UINT16

    LM20token (same as received in request)

    SAM Logon

    Note: machine name in response is preceded by two '\' characters.

    Note: NTversion, LMNTtoken, LM20token in response are the same as those given in the request.

    Note: user name in the response is presumably the same as that in the request.

    Request

    UINT16

    0x0012 - SAM Logon

    UINT16

    request count

    UNISTR

    machine name

    UNISTR

    user name

    STR

    response mailslot

    UINT32

    alloweable account

    UINT32

    domain SID size

    char[sid_size]

    domain SID, of sid_size bytes.

    UINT8[]

    ???? padding to 4? 2? -byte align with start of mailslot.

    UINT32

    NTversion

    UINT16

    LMNTtoken

    UINT16

    LM20token

    Response

    UINT16

    0x0013 - Response to SAM Logon

    UNISTR

    machine name

    UNISTR

    user name - workstation trust account

    UNISTR

    domain name

    UINT32

    NTversion

    UINT16

    LMNTtoken

    UINT16

    LM20token

    SRVSVC Transact Named Pipe

    Defines for this pipe, identifying the query are:

    Net Share Enum

    0x0f

    Net Server Get Info

    0x15

    Net Share Enum

    Note: share level and switch value in the response are presumably the same as those in the request.

    Note: cifsrap2.txt (section 5) may be of limited assistance here.

    Request

    VOID*

    pointer (to server name?)

    UNISTR2

    server name

    UINT8[]

    padding to get unicode string 4-byte aligned with the start of the SMB header.

    UINT32

    share level

    UINT32

    switch value

    VOID*

    pointer to SHARE_INFO_1_CTR

    SHARE_INFO_1_CTR

    share info with 0 entries

    UINT32

    preferred maximum length (0xffff ffff)

    Response

    UINT32

    share level

    UINT32

    switch value

    VOID*

    pointer to SHARE_INFO_1_CTR

    SHARE_INFO_1_CTR

    share info (only added if share info ptr is non-zero)

    return 0 - indicates success

    Net Server Get Info

    Note: level is the same value as in the request.

    Request

    UNISTR2

    server name

    UINT32

    switch level

    Response

    UINT32

    switch level

    VOID*

    pointer to SERVER_INFO_101

    SERVER_INFO_101

    server info (only added if server info ptr is non-zero)

    return 0 - indicates success

    Cryptographic side of NT Domain Authentication

    Definitions

    Add(A1,A2)

    Intel byte ordered addition of corresponding 4 byte words in arrays A1 and A2

    E(K,D)

    DES ECB encryption of 8 byte data D using 7 byte key K

    lmowf()

    Lan man hash

    ntowf()

    NT hash

    PW

    md4(machine_password) == md4(lsadump $machine.acc) == +pwdump(machine$) (initially) == md4(lmowf(unicode(machine))) +

    ARC4(K,Lk,D,Ld)

    ARC4 encryption of data D of length Ld with key K of length Lk

    v[m..n(,l)]

    subset of v from bytes m to n, optionally padded with zeroes to length l

    Cred(K,D)

    E(K[7..7,7],E(K[0..6],D)) computes a credential

    Time()

    4 byte current time

    Cc,Cs

    8 byte client and server challenges Rc,Rs: 8 byte client and server credentials

    Protocol

    +C->S ReqChal,Cc
+S->C Cs
+
    +C & S compute session key Ks = E(PW[9..15],E(PW[0..6],Add(Cc,Cs)))
+
    +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))
+

    +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.

    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'

    User: U with password P wishes to login to the domain (incidental data -such as workstation and domain omitted)

    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()

    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)

    9.7.3. Comments

    On first joining the domain the session key could be computed by +on registry settings. This will also occur weekly afterwards. +

    +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'
+

    +User: U with password P wishes to login to the domain (incidental data +such as workstation and domain omitted) +

    +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()
+
    +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)
+

    Comments

    +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.

    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.

    The server time stamps appear to be ignored.

    The client sends a ReturnAuthenticator in the SamLogon request which I +course the new machine password is exposed at this time anyway. +

    +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. +

    +The server time stamps appear to be ignored. +

    +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.

    The password OWFs should NOT be sent over the network reversibly +returned by the server. +

    +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.

    9.8. SIDs and RIDs

    SIDs and RIDs are well documented elsewhere.

    A SID is an NT Security ID (see DOM_SID structure). They are of the form:

    revision-NN-SubAuth1-SubAuth2-SubAuth3...
    revision-0xNNNNNNNNNNNN-SubAuth1-SubAuth2-SubAuth3...

    currently, the SID revision is 1. -The Sub-Authorities are known as Relative IDs (RIDs).

    9.8.1. Well-known SIDs

    9.8.1.1. Universal well-known SIDs

    Null SID

    S-1-0-0

    World

    S-1-1-0

    Local

    S-1-2-0

    Creator Owner ID

    S-1-3-0

    Creator Group ID

    S-1-3-1

    Creator Owner Server ID

    S-1-3-2

    Creator Group Server ID

    S-1-3-3

    (Non-unique IDs)

    S-1-4

    9.8.1.2. NT well-known SIDs

    NT Authority

    S-1-5

    Dialup

    S-1-5-1

    Network

    S-1-5-2

    Batch

    S-1-5-3

    Interactive

    S-1-5-4

    Service

    S-1-5-6

    AnonymousLogon(aka null logon session)

    S-1-5-7

    Proxy

    S-1-5-8

    ServerLogon(aka domain controller account)

    S-1-5-8

    (Logon IDs)

    S-1-5-5-X-Y

    (NT non-unique IDs)

    S-1-5-0x15-...

    (Built-in domain)

    s-1-5-0x20

    9.8.2. Well-known RIDS

    A RID is a sub-authority value, as part of either a SID, or in the case +computing the same function using the owf values in the SAM. +

    SIDs and RIDs

    +SIDs and RIDs are well documented elsewhere. +

    +A SID is an NT Security ID (see DOM_SID structure). They are of the form: +

    revision-NN-SubAuth1-SubAuth2-SubAuth3...
    revision-0xNNNNNNNNNNNN-SubAuth1-SubAuth2-SubAuth3...

    +currently, the SID revision is 1. +The Sub-Authorities are known as Relative IDs (RIDs). +

    Well-known SIDs

    Universal well-known SIDs

    Null SID

    S-1-0-0

    World

    S-1-1-0

    Local

    S-1-2-0

    Creator Owner ID

    S-1-3-0

    Creator Group ID

    S-1-3-1

    Creator Owner Server ID

    S-1-3-2

    Creator Group Server ID

    S-1-3-3

    (Non-unique IDs)

    S-1-4

    NT well-known SIDs

    NT Authority

    S-1-5

    Dialup

    S-1-5-1

    Network

    S-1-5-2

    Batch

    S-1-5-3

    Interactive

    S-1-5-4

    Service

    S-1-5-6

    AnonymousLogon(aka null logon session)

    S-1-5-7

    Proxy

    S-1-5-8

    ServerLogon(aka domain controller account)

    S-1-5-8

    (Logon IDs)

    S-1-5-5-X-Y

    (NT non-unique IDs)

    S-1-5-0x15-...

    (Built-in domain)

    s-1-5-0x20

    Well-known RIDS

    +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.

    9.8.2.1. Well-known RID users

    Groupname: DOMAIN_USER_RID_ADMIN

    ????: 0x0000

    RID: 01F4

    Groupname: DOMAIN_USER_RID_GUEST

    ????: 0x0000

    RID: 01F5

    9.8.2.2. Well-known RID groups

    Groupname: DOMAIN_GROUP_RID_ADMINS

    ????: 0x0000

    RID: 0200

    Groupname: DOMAIN_GROUP_RID_USERS

    ????: 0x0000

    RID: 0201

    Groupname: DOMAIN_GROUP_RID_GUESTS

    ????: 0x0000

    RID: 0202

    9.8.2.3. Well-known RID aliases

    Groupname: DOMAIN_ALIAS_RID_ADMINS

    ????: 0x0000

    RID: 0220

    Groupname: DOMAIN_ALIAS_RID_USERS

    ????: 0x0000

    RID: 0221

    Groupname: DOMAIN_ALIAS_RID_GUESTS

    ????: 0x0000

    RID: 0222

    Groupname: DOMAIN_ALIAS_RID_POWER_USERS

    ????: 0x0000

    RID: 0223

    Groupname: DOMAIN_ALIAS_RID_ACCOUNT_OPS

    ????: 0x0000

    RID: 0224

    Groupname: DOMAIN_ALIAS_RID_SYSTEM_OPS

    ????: 0x0000

    RID: 0225

    Groupname: DOMAIN_ALIAS_RID_PRINT_OPS

    ????: 0x0000

    RID: 0226

    Groupname: DOMAIN_ALIAS_RID_BACKUP_OPS

    ????: 0x0000

    RID: 0227

    Groupname: DOMAIN_ALIAS_RID_REPLICATOR

    ????: 0x0000

    RID: 0228

    Chapter 10. Samba Printing Internals

    10.1. Abstract

    The purpose of this document is to provide some insight into +structure, in the LSA SAM Logon response. +

    Well-known RID users

    Groupname: DOMAIN_USER_RID_ADMIN

    ????: 0x0000

    RID: 01F4

    Groupname: DOMAIN_USER_RID_GUEST

    ????: 0x0000

    RID: 01F5

    Well-known RID groups

    Groupname: DOMAIN_GROUP_RID_ADMINS

    ????: 0x0000

    RID: 0200

    Groupname: DOMAIN_GROUP_RID_USERS

    ????: 0x0000

    RID: 0201

    Groupname: DOMAIN_GROUP_RID_GUESTS

    ????: 0x0000

    RID: 0202

    Well-known RID aliases

    Groupname: DOMAIN_ALIAS_RID_ADMINS

    ????: 0x0000

    RID: 0220

    Groupname: DOMAIN_ALIAS_RID_USERS

    ????: 0x0000

    RID: 0221

    Groupname: DOMAIN_ALIAS_RID_GUESTS

    ????: 0x0000

    RID: 0222

    Groupname: DOMAIN_ALIAS_RID_POWER_USERS

    ????: 0x0000

    RID: 0223

    Groupname: DOMAIN_ALIAS_RID_ACCOUNT_OPS

    ????: 0x0000

    RID: 0224

    Groupname: DOMAIN_ALIAS_RID_SYSTEM_OPS

    ????: 0x0000

    RID: 0225

    Groupname: DOMAIN_ALIAS_RID_PRINT_OPS

    ????: 0x0000

    RID: 0226

    Groupname: DOMAIN_ALIAS_RID_BACKUP_OPS

    ????: 0x0000

    RID: 0227

    Groupname: DOMAIN_ALIAS_RID_REPLICATOR

    ????: 0x0000

    RID: 0228

    Chapter 10. Samba Printing Internals

    Gerald Carter

    October 2002

    Table of Contents

    Abstract
    +Printing Interface to Various Back ends +
    +Print Queue TDB's +
    +ChangeID and Client Caching of Printer Information +
    +Windows NT/2K Printer Change Notify +

    Abstract

    +The purpose of this document is to provide some insight into Samba's printing functionality and also to describe the semantics -of certain features of Windows client printing.

    10.2. Printing Interface to Various Back ends

    Samba uses a table of function pointers to seven functions. The -function prototypes are defined in the printif structure declared -in printing.h.

    • retrieve the contents of a print queue

    • pause the print queue

    • resume a paused print queue

    • delete a job from the queue

    • pause a job in the print queue

    • result a paused print job in the queue

    • submit a job to the print queue

    Currently there are only two printing back end implementations -defined.

    • a generic set of functions for working with standard UNIX - printing subsystems

    • a set of CUPS specific functions (this is only enabled if - the CUPS libraries were located at compile time).

    10.3. Print Queue TDB's

    Samba provides periodic caching of the output from the "lpq command" +of certain features of Windows client printing. +

    +Printing Interface to Various Back ends +

    +Samba uses a table of function pointers to seven functions. The +function prototypes are defined in the printif structure declared +in printing.h. +

    • retrieve the contents of a print queue

    • pause the print queue

    • resume a paused print queue

    • delete a job from the queue

    • pause a job in the print queue

    • result a paused print job in the queue

    • submit a job to the print queue

    +Currently there are only two printing back end implementations +defined. +

    • a generic set of functions for working with standard UNIX + printing subsystems

    • a set of CUPS specific functions (this is only enabled if + the CUPS libraries were located at compile time).

    +Print Queue TDB's +

    +Samba provides periodic caching of the output from the "lpq command" for performance reasons. This cache time is configurable in seconds. Obviously the longer the cache time the less often smbd will be required to exec a copy of lpq. However, the accuracy of the print -queue contents displayed to clients will be diminished as well.

    The list of currently opened print queue TDB's can be found +queue contents displayed to clients will be diminished as well. +

    +The list of currently opened print queue TDB's can be found be examining the list of tdb_print_db structures ( see print_db_head in printing.c ). A queue TDB is opened using the wrapper function printing.c:get_print_db_byname(). The function ensures that smbd @@ -8222,17 +1433,15 @@ does not open more than MAX_PRINT_DBS_OPEN in an effort to prevent a large print server from exhausting all available file descriptors. If the number of open queue TDB's exceeds the MAX_PRINT_DBS_OPEN limit, smbd falls back to a most recently used algorithm for maintaining -a list of open TDB's.

    There are two ways in which a a print job can be entered into +a list of open TDB's. +

    +There are two ways in which a a print job can be entered into a print queue's TDB. The first is to submit the job from a Windows client which will insert the job information directly into the TDB. The second method is to have the print job picked up by executing the -"lpq command".

    /* included from printing.h */
+"lpq command".
+
    +/* included from printing.h */
 struct printjob {
 	pid_t pid; /* which process launched the job */
 	int sysjob; /* the system (lp) job number */
@@ -8248,63 +1457,28 @@ struct printjob {
 	fstring user; /* the user who started the job */
 	fstring queuename; /* service number of printer for this job */
 	NT_DEVICEMODE *nt_devmode;
-};
    The current manifestation of the printjob structure contains a field
-for the UNIX job id returned from the "lpq command" and a Windows job
+};
+

    +The current manifestation of the printjob structure contains a field +for the UNIX job id returned from the "lpq command" and a Windows job ID (32-bit bounded by PRINT_MAX_JOBID). When a print job is returned -by the "lpq command" that does not match an existing job in the queue's +by the "lpq command" that does not match an existing job in the queue's TDB, a 32-bit job ID above the <*vance doesn't know what word is missing here*> is generating by adding UNIX_JOB_START to -the id reported by lpq.

    In order to match a 32-bit Windows jobid onto a 16-bit lanman print job +the id reported by lpq. +

    +In order to match a 32-bit Windows jobid onto a 16-bit lanman print job id, smbd uses an in memory TDB to match the former to a number appropriate -for old lanman clients.

    When updating a print queue, smbd will perform the following -steps ( refer to print.c:print_queue_update() ):

    1. Check to see if another smbd is currently in +for old lanman clients. +

      +When updating a print queue, smbd will perform the following +steps ( refer to print.c:print_queue_update() ): +

      1. Check to see if another smbd is currently in the process of updating the queue contents by checking the pid - stored in LOCK/printer_name. - If so, then do not update the TDB.

      2. Lock the mutex entry in the TDB and store our own pid. - Check that this succeeded, else fail.

      3. Store the updated time stamp for the new cache - listing

      4. Retrieve the queue listing via "lpq command"

      5. 	foreach job in the queue
+	stored in LOCK/printer_name.  
+	If so, then do not update the TDB.

      6. Lock the mutex entry in the TDB and store our own pid. + Check that this succeeded, else fail.

      7. Store the updated time stamp for the new cache + listing

      8. Retrieve the queue listing via "lpq command"

      9. +	foreach job in the queue
      	{
 		if the job is a UNIX job, create a new entry;
 		if the job has a Windows based jobid, then
@@ -8315,119 +1489,51 @@ CLASS="PROGRAMLISTING"
 			else
 				update the job status only
 		}
-	}

      10. Delete any jobs in the TDB that are not - in the in the lpq listing

      11. Store the print queue status in the TDB

      12. update the cache time stamp again

      Note that it is the contents of this TDB that is returned to Windows -clients and not the actual listing from the "lpq command".

      The NT_DEVICEMODE stored as part of the printjob structure is used to + }

    2. Delete any jobs in the TDB that are not + in the in the lpq listing

    3. Store the print queue status in the TDB

    4. update the cache time stamp again

    +Note that it is the contents of this TDB that is returned to Windows +clients and not the actual listing from the "lpq command". +

    +The NT_DEVICEMODE stored as part of the printjob structure is used to store a pointer to a non-default DeviceMode associated with the print job. The pointer will be non-null when the client included a Device Mode in the OpenPrinterEx() call and subsequently submitted a job for printing on that same handle. If the client did not include a Device Mode in the OpenPrinterEx() request, the nt_devmode field is NULL -and the job has the printer's device mode associated with it by default.

    Only non-default Device Mode are stored with print jobs in the print +and the job has the printer's device mode associated with it by default. +

    +Only non-default Device Mode are stored with print jobs in the print queue TDB. Otherwise, the Device Mode is obtained from the printer -object when the client issues a GetJob(level == 2) request.

    10.4. ChangeID & Client Caching of Printer Information

    [To be filled in later]

    10.5. Windows NT/2K Printer Change Notify

    When working with Windows NT+ clients, it is possible for a +object when the client issues a GetJob(level == 2) request. +

    +ChangeID and Client Caching of Printer Information +

    +[To be filled in later] +

    +Windows NT/2K Printer Change Notify +

    +When working with Windows NT+ clients, it is possible for a print server to use RPC to send asynchronous change notification events to clients for certain printer and print job attributes. This can be useful when the client needs to know that a new job has been added to the queue for a given printer or that the driver for a printer has been changed. Note that this is done entirely orthogonal to cache updates based on a new ChangeID for -a printer object.

    The basic set of RPC's used to implement change notification are

    One additional RPC is available to a server, but is never used by the -Windows spooler service:

    The opnum for all of these RPC's are defined in include/rpc_spoolss.h

    Windows NT print servers use a bizarre method of sending print +a printer object. +

    +The basic set of RPC's used to implement change notification are +

    • RemoteFindFirstPrinterChangeNotifyEx ( RFFPCN )

    • RemoteFindNextPrinterChangeNotifyEx ( RFNPCN )

    • FindClosePrinterChangeNotify( FCPCN )

    • ReplyOpenPrinter

    • ReplyClosePrinter

    • RouteRefreshPrinterChangeNotify ( RRPCN )

    +One additional RPC is available to a server, but is never used by the +Windows spooler service: +

    • RouteReplyPrinter()

    +The opnum for all of these RPC's are defined in include/rpc_spoolss.h +

    +Windows NT print servers use a bizarre method of sending print notification event to clients. The process of registering a new change notification handle is as follows. The 'C' is for client and the -'S' is for server. All error conditions have been eliminated.

    C:	Obtain handle to printer or to the printer
+'S' is for server.  All error conditions have been eliminated.
+
    +C:	Obtain handle to printer or to the printer
 	server via the standard OpenPrinterEx() call.
 S:	Respond with a valid handle to object
 
@@ -8457,453 +1563,229 @@ C:	If the change notification handle is ever released by the
 	or a piece of data was wrong.
 S:	The server closes the internal change notification handle
 	(POLICY_HND) and does not send any further change notification
-	events to the client for that printer or job.
    The current list of notification events supported by Samba can be
-found by examining the internal tables in srv_spoolss_nt.c
    • printer_notify_table[]
    • job_notify_table[]
    When an event occurs that could be monitored, smbd sends a message
+	events to the client for that printer or job.
+

    +The current list of notification events supported by Samba can be +found by examining the internal tables in srv_spoolss_nt.c +

    • printer_notify_table[]

    • job_notify_table[]

    +When an event occurs that could be monitored, smbd sends a message to itself about the change. The list of events to be transmitted are queued by the smbd process sending the message to prevent an overload of TDB usage and the internal message is sent during smbd's idle loop (refer to printing/notify.c and the functions -send_spoolss_notify2_msg() and print_notify_send_messages() ).

    The decision of whether or not the change is to be sent to connected +send_spoolss_notify2_msg() and print_notify_send_messages() ). +

    +The decision of whether or not the change is to be sent to connected clients is made by the routine which actually sends the notification. -( refer to srv_spoolss_nt.c:recieve_notify2_message() ).

    Because it possible to receive a listing of multiple changes for +( refer to srv_spoolss_nt.c:recieve_notify2_message() ). +

    +Because it possible to receive a listing of multiple changes for multiple printers, the notification events must be split into categories by the printer name. This makes it possible to group multiple change events to be sent in a single RPC according to the -printer handle obtained via a ReplyOpenPrinter().

    The actual change notification is performed using the RRPCN request -RPC. This packet contains

    A SPOOL_NOTIFY_INFO contains:

    The SPOOL_NOTIFY_INFO_DATA entries contain:

    Chapter 11. Samba WINS Internals

    11.1. WINS Failover

    The current Samba codebase possesses the capability to use groups of WINS +data values.

    Chapter 11. Samba WINS Internals

    Gerald Carter

    October 2002

    Table of Contents

    WINS Failover

    WINS Failover

    +The current Samba codebase possesses the capability to use groups of WINS servers that share a common namespace for NetBIOS name registration and -resolution. The formal parameter syntax is

    	WINS_SERVER_PARAM 	= SERVER [ SEPARATOR SERVER_LIST ]
+resolution.  The formal parameter syntax is
+
    +	WINS_SERVER_PARAM 	= SERVER [ SEPARATOR SERVER_LIST ]
 	WINS_SERVER_PARAM 	= "wins server"
 	SERVER 			= ADDR[:TAG]
 	ADDR 			= ip_addr | fqdn
 	TAG 			= string
 	SEPARATOR		= comma | \s+
-	SERVER_LIST		= SERVER [ SEPARATOR SERVER_LIST ]
    A simple example of a valid wins server setting is
    [global]
-	wins server = 192.168.1.2 192.168.1.3
    In the event that no TAG is defined in for a SERVER in the list, smbd assigns a default
+	SERVER_LIST		= SERVER [ SEPARATOR SERVER_LIST ]
+

    +A simple example of a valid wins server setting is +

    +[global]
+	wins server = 192.168.1.2 192.168.1.3
+

    +In the event that no TAG is defined in for a SERVER in the list, smbd assigns a default TAG of "*". A TAG is used to group servers of a shared NetBIOS namespace together. Upon startup, nmbd will attempt to register the netbios name value with one server in each -tagged group.

    An example using tags to group WINS servers together is show here. Note that the use of -interface names in the tags is only by convention and is not a technical requirement.

    [global]
-	wins server = 192.168.1.2:eth0 192.168.1.3:eth0 192.168.2.2:eth1

    Using this configuration, nmbd would attempt to register the server's NetBIOS name +tagged group. +

    +An example using tags to group WINS servers together is show here. Note that the use of +interface names in the tags is only by convention and is not a technical requirement. +

    +[global]
+	wins server = 192.168.1.2:eth0 192.168.1.3:eth0 192.168.2.2:eth1
+

    +Using this configuration, nmbd would attempt to register the server's NetBIOS name with one WINS server in each group. Because the "eth0" group has two servers, the second server would only be used when a registration (or resolution) request to -the first server in that group timed out.

    NetBIOS name resolution follows a similar pattern as name registration. When resolving +the first server in that group timed out. +

    +NetBIOS name resolution follows a similar pattern as name registration. When resolving a NetBIOS name via WINS, smbd and other Samba programs will attempt to query a single WINS server in a tagged group until either a positive response is obtained at least once or until a server from every tagged group has responded negatively to the name query request. If a timeout occurs when querying a specific WINS server, that server is marked as down to prevent further timeouts and the next server in the WINS group is contacted. Once marked as dead, Samba will not attempt to contact that server for name registration/resolution queries -for a period of 10 minutes.

    Chapter 12. The Upcoming SAM System

    12.1. Security in the 'new SAM'

    One of the biggest problems with passdb is it's implementation of +for a period of 10 minutes. +

    Chapter 12. The Upcoming SAM System

    Andrew Bartlett

    1 October 2002

    Table of Contents

    Security in the 'new SAM'
    Standalone from UNIX
    Handles and Races in the new SAM
    Layers
    Application
    SAM Interface
    SAM Modules
    SAM Modules
    Special Module: sam_passdb
    sam_ads
    Memory Management
    Testing

    Security in the 'new SAM'

    One of the biggest problems with passdb is it's implementation of 'security'. Access control is on a 'are you root at the moment' basis, and it has no concept of NT ACLs. Things like ldapsam had to add -'magic' 'are you root' checks.

    We took this very seriously when we started work, and the new structure +'magic' 'are you root' checks.

    We took this very seriously when we started work, and the new structure is designed with this in mind, from the ground up. Each call to the SAM has a NT_TOKEN and (if relevant) an 'access desired'. This is either provided as a parameter, or implicitly supplied by the object being -accessed.

    For example, when you call 

    <
+accessed.
    
+For example, when you call 
+
     NTSTATUS sam_get_account_by_name(const SAM_CONTEXT *context, const
 NT_USER_TOKEN *access_token, uint32 access_desired, const char *domain,
-const char *name, SAM_ACCOUNT_HANDLE **account)
    The context can be NULL (and is used to allow import/export by setting
-up 2 contexts, and allowing calls on both simultaneously)
    The access token *must* be specified.  Normally the user's token out of
-current_user, this can also be a global 'system' context.
    The access desired is as per the ACL, for passing to the seaccess stuff.
    The domain/username are standard.  Even if we only have one domain,
+const char *name, SAM_ACCOUNT_HANDLE **account)
+

    +The context can be NULL (and is used to allow import/export by setting +up 2 contexts, and allowing calls on both simultaneously) +

    +The access token *must* be specified. Normally the user's token out of +current_user, this can also be a global 'system' context. +

    +The access desired is as per the ACL, for passing to the seaccess stuff. +

    +The domain/username are standard. Even if we only have one domain, keeping this ensures that we don't get 'unqualified' usernames (same -problem as we had with unqualified SIDs).

    We return a 'handle'. This is opaque to the rest of Samba, but is -operated on by get/set routines, all of which return NTSTATUS.

    The access checking is done by the SAM module. The reason it is not +problem as we had with unqualified SIDs). +

    +We return a 'handle'. This is opaque to the rest of Samba, but is +operated on by get/set routines, all of which return NTSTATUS. +

    +The access checking is done by the SAM module. The reason it is not done 'above' the interface is to ensure a 'choke point'. I put a lot of effort into the auth subsystem to ensure we never 'accidentally' forgot to check for null passwords, missed a restriction etc. I intend the SAM -to be written with the same caution.

    The reason the access checking is not handled by the interface itself is +to be written with the same caution. +

    +The reason the access checking is not handled by the interface itself is due to the different implementations it make take on. For example, on ADS, you cannot set a password over a non-SSL connection. Other backends may have similar requirements - we need to leave this policy up to the modules. They will naturally have access to 'helper' procedures -and good examples to avoid mishaps.

    (Furthermore, some backends my actually chose to push the whole ACL +and good examples to avoid mishaps. +

    +(Furthermore, some backends my actually chose to push the whole ACL issue to the remote server, and - assuming ldap for this example - bind -as the user directly)

    Each returned handle has an internal 'access permitted', which allows +as the user directly) +

    +Each returned handle has an internal 'access permitted', which allows the 'get' and 'set' routines to return 'ACCESS_DENIED' for things that were not able to be retrieved from the backend. This removes the need to specify the NT_TOKEN on every operation, and allows for 'object not -present' to be easily distinguished from 'access denied'.

    When you 'set' an object (calling sam_update_account) the internal +present' to be easily distinguished from 'access denied'. +

    +When you 'set' an object (calling sam_update_account) the internal details are again used. Each change that has been made to the object has been flagged, so as to avoid race conditions (on unmodified components) and to avoid violating any extra ACL requirements on the -actual data store (like the LDAP server).

    Finally, we have generic get_sec_desc() and set_sec_desc() routines to -allow external ACL manipulation. These do lookups based on SID.

    12.2. Standalone from UNIX

    One of the primary tenants of the 'new SAM' is that it would not attempt +actual data store (like the LDAP server). +

    +Finally, we have generic get_sec_desc() and set_sec_desc() routines to +allow external ACL manipulation. These do lookups based on SID. +

    Standalone from UNIX

    +One of the primary tenants of the 'new SAM' is that it would not attempt to deal with 'what unix id for that'. This would be left to the 'SMS' (Sid Mapping System') or SID farm, and probably administered via winbind. We have had constructive discussion on how 'basic' unix accounts like 'root' would be handled, and we think this can work. -Accounts not preexisting in unix would be served up via winbind.

    This is an *optional* part, and my preferred end-game. We have a fare -way to go before things like winbind up to it however.

    12.3. Handles and Races in the new SAM

    One of the things that the 'new SAM' work has tried to face is both +Accounts not preexisting in unix would be served up via winbind. +

    +This is an *optional* part, and my preferred end-game. We have a fare +way to go before things like winbind up to it however. +

    Handles and Races in the new SAM

    +One of the things that the 'new SAM' work has tried to face is both compatibility with existing code, and a closer alignment to the SAMR interface. I consider SAMR to be a 'primary customer' to the this work, because if we get alignment with that wrong, things get more, rather than less complex. Also, most other parts of Samba are much more -flexible with what they can allow.

    In any case, that was a decision taken as to how the general design -would progress. BTW, my understanding of SAMR may be completely flawed.

    One of the most race-prone areas of the new code is the conflicting -update problem. We have taken two approaches:

    • 'Not conflicting' conflicts. Due to the way usrmgr operates, it will +flexible with what they can allow. +

      +In any case, that was a decision taken as to how the general design +would progress. BTW, my understanding of SAMR may be completely flawed. +

      +One of the most race-prone areas of the new code is the conflicting +update problem. We have taken two approaches: +

      • 'Not conflicting' conflicts. Due to the way usrmgr operates, it will open a user, display all the properties and *save* them all, even if you -don't change any.

        For this, see what I've done in rpc_server/srv_samr_util.c. I intend +don't change any. +

        +For this, see what I've done in rpc_server/srv_samr_util.c. I intend to take this one step further, and operate on the 'handle' that the values were read from. This should mean that we only update things that -have *really* changed.

      • 'conflicting' updates: Currently we don't deal with this (in passdb +have *really* changed. +

      • +'conflicting' updates: Currently we don't deal with this (in passdb or the new sam stuff), but the design is sufficiently flexible to 'deny' -a second update. I don't foresee locking records however.

      12.4. Layers

      12.4.1. Application

      This is where smbd, samtest and whatever end-user replacement we have +a second update. I don't foresee locking records however. +

    Layers

    Application

    +This is where smbd, samtest and whatever end-user replacement we have for pdbedit sits. They use only the SAM interface, and do not get -'special knowledge' of what is below them.

    12.4.2. SAM Interface

    This level 'owns' the various handle structures, the get/set routines on +'special knowledge' of what is below them. +

    SAM Interface

    +This level 'owns' the various handle structures, the get/set routines on those structures and provides the public interface. The application layer may initialize a 'context' to be passed to all interface routines, else a default, self-initialising context will be supplied. This layser finds the appropriate backend module for the task, and tries very hard not to need to much 'knowledge'. It should just provide the required -abstraction to the modules below, and arrange for their initial loading.

    We could possibly add ACL checking at this layer, to avoid discrepancies -in implementation modules.

    12.4.3. SAM Modules

    These do not communicate with the application directly, only by setting +abstraction to the modules below, and arrange for their initial loading. +

    +We could possibly add ACL checking at this layer, to avoid discrepancies +in implementation modules. +

    SAM Modules

    +These do not communicate with the application directly, only by setting values in the handles, and receiving requests from the interface. These modules are responsible for translating values from the handle's .private into (say) an LDAP modification list. The module is expected to 'know' things like it's own domain SID, domain name, and any other state attached to the SAM. Simpler modules may call back to some helper -routine.

    12.5. SAM Modules

    12.5.1. Special Module: sam_passdb

    In order for there to be a smooth transition, kai is writing a module +routine. +

    SAM Modules

    Special Module: sam_passdb

    +In order for there to be a smooth transition, kai is writing a module that reads existing passdb backends, and translates them into SAM replies. (Also pulling data from the account policy DB etc). We also intend to write a module that does the reverse - gives the SAM a passdb -interface.

    12.5.2. sam_ads

    This is the first of the SAM modules to be committed to the tree - +interface. +

    sam_ads

    +This is the first of the SAM modules to be committed to the tree - mainly because I needed to coordinate work with metze (who authored most of it). This module aims to use Samba's libads code to provide an Active Directory LDAP client, suitable for use on a mixed-mode DC. While it is currently being tested against Win2k servers (with a password in the smb.conf file) it is expected to eventually use a (possibly modified) OpenLDAP server. We hope that this will assist in -the construction of an Samba AD DC.

    We also intend to construct a Samba 2.2/3.0 compatible ldap module, -again using libads code.

    12.6. Memory Management

    +the construction of an Samba AD DC. +

    +We also intend to construct a Samba 2.2/3.0 compatible ldap module, +again using libads code. +

    Memory Management

    The 'new SAM' development effort also concerned itself with getting a sane implementation of memory management. It was decided that we would be (as much as possible) talloc based, using an 'internal talloc @@ -8911,132 +1793,63 @@ context' on many objects. That is, the creation of an object would initiate it's own internal talloc context, and this would be used for all operations on that object. Much of this is already implemented in passdb. Also, like passdb, it will be possible to specify that some -object actually be created on a specified context.

    Memory management is important here because the APIs in the 'new SAM' do +object actually be created on a specified context. +

    +Memory management is important here because the APIs in the 'new SAM' do not use 'pdb_init()' or an equivalent. They always allocate new objects. Enumeration's are slightly different, and occur on a supplied context that 'owns' the entire list, rather than per-element. (the enumeration functions return an array of all elements - not full handles just basic (and public) info) Likewise for things that fill in a char -**.

    For example:

    NTSTATUS sam_lookup_sid(const SAM_CONTEXT *context, const NT_USER_TOKEN
+**.
+
    For example:
    +NTSTATUS sam_lookup_sid(const SAM_CONTEXT *context, const NT_USER_TOKEN
 *access_token, TALLOC_CTX *mem_ctx, const DOM_SID *sid, char **name,
-uint32 *type)
    Takes a context to allocate the 'name' on, while:
    NTSTATUS sam_get_account_by_sid(const SAM_CONTEXT *context, const
+uint32 *type)
+
    Takes a context to allocate the 'name' on, while:
    +NTSTATUS sam_get_account_by_sid(const SAM_CONTEXT *context, const
 NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID
-*accountsid, SAM_ACCOUNT_HANDLE **account)
    Allocates a handle and stores the allocation context on that handle.
    I think that the following:
    NTSTATUS sam_enum_accounts(const SAM_CONTEXT *context, const
+*accountsid, SAM_ACCOUNT_HANDLE **account)
+
    Allocates a handle and stores the allocation context on that handle.
    I think that the following:
    +NTSTATUS sam_enum_accounts(const SAM_CONTEXT *context, const
 NT_USER_TOKEN *access_token, const DOM_SID *domainsid, uint16 acct_ctrl,
-int32 *account_count, SAM_ACCOUNT_ENUM **accounts)

    12.7. Testing

    Testing is vital in any piece of software, and Samba is certainly no +int32 *account_count, SAM_ACCOUNT_ENUM **accounts) +

    Testing

    +Testing is vital in any piece of software, and Samba is certainly no exception. In designing this new subsystem, we have taken care to ensure -it is easily tested, independent of outside protocols.

    To this end, Jelmer has constructed 'samtest'.

    This utility (see torture/samtest.c) is structured like rpcclient, but +it is easily tested, independent of outside protocols. +

    +To this end, Jelmer has constructed 'samtest'. +

    +This utility (see torture/samtest.c) is structured like rpcclient, but instead operates on the SAM subsystem. It creates a 'custom' SAM context, that may be distinct from the default values used by the rest -of the system, and can load a separate configuration file.

    A small number of commands are currently implemented, but these have +of the system, and can load a separate configuration file. +

    +A small number of commands are currently implemented, but these have already proved vital in testing. I expect SAM module authors will find -it particularly valuable.

    Example useage:

    $ bin/samtest

    > context ads:ldap://192.168.1.96
    +it particularly valuable. +

    Example useage:

    $ bin/samtest

    +> context ads:ldap://192.168.1.96
+

    (this loads a new context, using the new ADS module. The parameter is -the 'location' of the ldap server)

    > lookup_name DOMAIN abartlet
    -(returns a sid).

    Because the 'new SAM' is NT ACL based, there will be a command to -specify an arbitrary NT ACL, but for now it uses 'system' by default.

    Chapter 13. LanMan and NT Password Encryption

    13.1. Introduction

    With the development of LanManager and Windows NT +the 'location' of the ldap server) +

    +> lookup_name DOMAIN abartlet
+

    +(returns a sid). +

    +Because the 'new SAM' is NT ACL based, there will be a command to +specify an arbitrary NT ACL, but for now it uses 'system' by default. +

    Chapter 13. LanMan and NT Password Encryption

    Jeremy Allison

    Samba Team


    +
    +

    19 Apr 1999

    Table of Contents

    Introduction
    How does it work?
    The smbpasswd file

    Introduction

    With the development of LanManager and Windows NT compatible password encryption for Samba, it is now able to validate user connections in exactly the same way as - a LanManager or Windows NT server.

    This document describes how the SMB password encryption + a LanManager or Windows NT server.

    This document describes how the SMB password encryption algorithm works and what issues there are in choosing whether you want to use it. You should read it carefully, especially - the part about security and the "PROS and CONS" section.

    13.2. How does it work?

    LanManager encryption is somewhat similar to UNIX + the part about security and the "PROS and CONS" section.

    How does it work?

    LanManager encryption is somewhat similar to UNIX password encryption. The server uses a file containing a hashed value of a user's password. This is created by taking the user's plaintext password, capitalising it, and either @@ -9044,265 +1857,791 @@ NAME="AEN3151" This 14 byte value is used as two 56 bit DES keys to encrypt a 'magic' eight byte value, forming a 16 byte value which is stored by the server and client. Let this value be known as - the "hashed password".

    Windows NT encryption is a higher quality mechanism, + the "hashed password".

    Windows NT encryption is a higher quality mechanism, consisting of doing an MD4 hash on a Unicode version of the user's password. This also produces a 16 byte hash value that is - non-reversible.

    When a client (LanManager, Windows for WorkGroups, Windows + non-reversible.

    When a client (LanManager, Windows for WorkGroups, Windows 95 or Windows NT) wishes to mount a Samba drive (or use a Samba resource), it first requests a connection and negotiates the protocol that the client and server will use. In the reply to this request the Samba server generates and appends an 8 byte, random value - this is stored in the Samba server after the reply is sent - and is known as the "challenge". The challenge is different for - every client connection.

    The client then uses the hashed password (16 byte values + and is known as the "challenge". The challenge is different for + every client connection.

    The client then uses the hashed password (16 byte values described above), appended with 5 null bytes, as three 56 bit DES keys, each of which is used to encrypt the challenge 8 byte - value, forming a 24 byte value known as the "response".

    In the SMB call SMBsessionsetupX (when user level security + value, forming a 24 byte value known as the "response".

    In the SMB call SMBsessionsetupX (when user level security is selected) or the call SMBtconX (when share level security is selected), the 24 byte response is returned by the client to the Samba server. For Windows NT protocol levels the above calculation is done on both hashes of the user's password and both responses are - returned in the SMB call, giving two 24 byte values.

    The Samba server then reproduces the above calculation, using + returned in the SMB call, giving two 24 byte values.

    The Samba server then reproduces the above calculation, using its own stored value of the 16 byte hashed password (read from the - smbpasswd file - described later) and the challenge + smbpasswd file - described later) and the challenge value that it kept from the negotiate protocol reply. It then checks to see if the 24 byte value it calculates matches the 24 byte value - returned to it from the client.

    If these values match exactly, then the client knew the + returned to it from the client.

    If these values match exactly, then the client knew the correct password (or the 16 byte hashed value - see security note below) and is thus allowed access. If not, then the client did not - know the correct password and is denied access.

    Note that the Samba server never knows or stores the cleartext + know the correct password and is denied access.

    Note that the Samba server never knows or stores the cleartext of the user's password - just the 16 byte hashed values derived from it. Also note that the cleartext password or 16 byte hashed values - are never transmitted over the network - thus increasing security.

    13.3. The smbpasswd file

    In order for Samba to participate in the above protocol + are never transmitted over the network - thus increasing security.

    The smbpasswd file

    In order for Samba to participate in the above protocol it must be able to look up the 16 byte hashed values given a user name. Unfortunately, as the UNIX password value is also a one way hash function (ie. it is impossible to retrieve the cleartext of the user's password given the UNIX hash of it), a separate password file containing this 16 byte value must be kept. To minimise problems with - these two password files, getting out of sync, the UNIX /etc/passwd and the smbpasswd file, - a utility, mksmbpasswd.sh, is provided to generate - a smbpasswd file from a UNIX /etc/passwd file. -

    To generate the smbpasswd file from your /etc/passwd - file use the following command :

    $ cat /etc/passwd | mksmbpasswd.sh - > /usr/local/samba/private/smbpasswd

    If you are running on a system that uses NIS, use

    $ ypcat passwd | mksmbpasswd.sh - > /usr/local/samba/private/smbpasswd

    The mksmbpasswd.sh program is found in + these two password files, getting out of sync, the UNIX + /etc/passwd and the smbpasswd file, + a utility, mksmbpasswd.sh, is provided to generate + a smbpasswd file from a UNIX /etc/passwd file. +

    To generate the smbpasswd file from your /etc/passwd + file use the following command:

    $ cat /etc/passwd | mksmbpasswd.sh + > /usr/local/samba/private/smbpasswd

    If you are running on a system that uses NIS, use

    $ ypcat passwd | mksmbpasswd.sh + > /usr/local/samba/private/smbpasswd

    The mksmbpasswd.sh program is found in the Samba source directory. By default, the smbpasswd file is - stored in :

    /usr/local/samba/private/smbpasswd

    The owner of the /usr/local/samba/private/ + stored in :

    /usr/local/samba/private/smbpasswd

    The owner of the /usr/local/samba/private/ directory should be set to root, and the permissions on it should - be set to 0500 (chmod 500 /usr/local/samba/private). -

    Likewise, the smbpasswd file inside the private directory should + be set to 0500 (chmod 500 /usr/local/samba/private). +

    Likewise, the smbpasswd file inside the private directory should be owned by root and the permissions on is should be set to 0600 - (chmod 600 smbpasswd).

    The format of the smbpasswd file is (The line has been + (chmod 600 smbpasswd).

    The format of the smbpasswd file is (The line has been wrapped here. It should appear as one entry per line in - your smbpasswd file.)

    username:uid:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
+	your smbpasswd file.)
    +username:uid:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
 	[Account type]:LCT-<last-change-time>:Long name
-	
    Although only the username, 
-	uid, 	XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX,
-	[Account type] and 	last-change-time sections are significant 
-	and are looked at in the Samba code.
    It is VITALLY important that there by 32 
+

    Although only the username, + uid, + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX, + [Account type] and + last-change-time sections are significant + and are looked at in the Samba code.

    It is VITALLY important that there by 32 'X' characters between the two ':' characters in the XXX sections - the smbpasswd and Samba code will fail to validate any entries that do not have 32 characters between ':' characters. The first XXX section is for the Lanman password hash, the second is for the - Windows NT version.

    When the password file is created all users have password entries + Windows NT version.

    When the password file is created all users have password entries consisting of 32 'X' characters. By default this disallows any access as this user. When a user has a password set, the 'X' characters change to 32 ascii hexadecimal digits (0-9, A-F). These are an ascii - representation of the 16 byte hashed value of a user's password.

    To set a user to have no password (not recommended), edit the file + representation of the 16 byte hashed value of a user's password.

    To set a user to have no password (not recommended), edit the file using vi, and replace the first 11 characters with the ascii text - "NO PASSWORD" (minus the quotes).

    For example, to clear the password for user bob, his smbpasswd file - entry would look like :

    	bob:100:NO PASSWORDXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:[U          ]:LCT-00000000:Bob's full name:/bobhome:/bobshell
-

    If you are allowing users to use the smbpasswd command to set + "NO PASSWORD" (minus the quotes).

    For example, to clear the password for user bob, his smbpasswd file + entry would look like :

    +bob:100:NO PASSWORDXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
+	[U          ]:LCT-00000000:Bob's full name:/bobhome:/bobshell
+

    If you are allowing users to use the smbpasswd command to set their own passwords, you may want to give users NO PASSWORD initially so they do not have to enter a previous password when changing to their new password (not recommended). In order for you to allow this the - smbpasswd program must be able to connect to the - smbd daemon as that user with no password. Enable this - by adding the line :

    null passwords = yes

    to the [global] section of the smb.conf file (this is why + smbpasswd program must be able to connect to the + smbd daemon as that user with no password. Enable this + by adding the line :

    null passwords = yes

    to the [global] section of the smb.conf file (this is why the above scenario is not recommended). Preferably, allocate your users a default password to begin with, so you do not have - to enable this on your server.

    Note : This file should be protected very + to enable this on your server.

    Note : This file should be protected very carefully. Anyone with access to this file can (with enough knowledge of the protocols) gain access to your SMB server. The file is thus more - sensitive than a normal unix /etc/passwd file.

    \ No newline at end of file + sensitive than a normal unix /etc/passwd file.

    Chapter 14. Modules

    Jelmer Vernooij

    Samba Team

    19 March 2003

    Table of Contents

    Advantages
    Loading modules
    Static modules
    Shared modules
    Writing modules
    Static/Shared selection in configure.in

    Advantages

    +The new modules system has the following advantages: +

    Transparent loading of static and shared modules (no need +for a subsystem to know about modules)
    Simple selection between shared and static modules at configure time
    "preload modules" option for increasing performance for stable modules
    No nasty #define stuff anymore
    All backends are available as plugin now (including pdb_ldap and pdb_tdb)

    Loading modules

    +Some subsystems in samba use different backends. These backends can be +either statically linked in to samba or available as a plugin. A subsystem +should have a function that allows a module to register itself. For example, +the passdb subsystem has: +

    +NTSTATUS smb_register_passdb(int version, const char *name, pdb_init_function init);
+

    +This function will be called by the initialisation function of the module to +register itself. +

    Static modules

    +The modules system compiles a list of initialisation functions for the +static modules of each subsystem. This is a define. For example, +it is here currently (from include/config.h): +

    +/* Static init functions */
+#define static_init_pdb { pdb_mysql_init(); pdb_ldap_init(); pdb_smbpasswd_init(); pdb_tdbsam_init(); pdb_guest_init();}
+

    +These functions should be called before the subsystem is used. That +should be done when the subsystem is initialised or first used. +

    Shared modules

    +If a subsystem needs a certain backend, it should check if it has +already been registered. If the backend hasn't been registered already, +the subsystem should call smb_probe_module(char *subsystem, char *backend). +This function tries to load the correct module from a certain path +($LIBDIR/subsystem/backend.so). If the first character in 'backend' +is a slash, smb_probe_module() tries to load the module from the +absolute path specified in 'backend'. +

    After smb_probe_module() has been executed, the subsystem +should check again if the module has been registered. +

    Writing modules

    +Each module has an initialisation function. For modules that are +included with samba this name is 'subsystem_backend_init'. For external modules (that will never be built-in, but only available as a module) this name is always 'init_module'. (In the case of modules included with samba, the configure system will add a #define subsystem_backend_init() init_module()). +The prototype for these functions is: +

    +NTSTATUS init_module(void);
+

    This function should call one or more +registration functions. The function should return NT_STATUS_OK on success and +NT_STATUS_UNSUCCESSFUL or a more useful nt error code on failure.

    For example, pdb_ldap_init() contains: 

    +NTSTATUS pdb_ldap_init(void)
+{
+smb_register_passdb(PASSDB_INTERFACE_VERSION, "ldapsam", pdb_init_ldapsam);
+smb_register_passdb(PASSDB_INTERFACE_VERSION, "ldapsam_nua", pdb_init_ldapsam_nua);
+	return NT_STATUS_OK;
+}
+

    Static/Shared selection in configure.in

    +Some macros in configure.in generate the various defines and substs that +are necessary for the system to work correct. All modules that should +be built by default have to be added to the variable 'default_modules'. +For example, if ldap is found, pdb_ldap is added to this variable. +

    +On the bottom of configure.in, SMB_MODULE() should be called +for each module and SMB_SUBSYSTEM() for each subsystem. +

    Syntax:

    +SMB_MODULE(subsystem_backend, object files, plugin name, subsystem name, static_action, shared_action)
+SMB_SUBSYSTEM(subsystem)
+

    Also, make sure to add the correct directives to +Makefile.in. @SUBSYSTEM_STATIC@ +will be replaced with a list of objects files of the modules that need to +be linked in statically. @SUBSYSTEM_MODULES@ will +be replaced with the names of the plugins to build. +

    You must make sure all .c files that contain defines that can +be changed by ./configure are rebuilded in the 'modules_clean' make target. +Practically, this means all c files that contain static_init_subsystem; calls need to be rebuilded. +

    Chapter 15. RPC Pluggable Modules

    Anthony Liguori

    IBM

    Jelmer Vernooij

    Samba Team

    January 2003

    Table of Contents

    About
    General Overview

    About

    +This document describes how to make use the new RPC Pluggable Modules features +of Samba 3.0. This architecture was added to increase the maintainability of +Samba allowing RPC Pipes to be worked on separately from the main CVS branch. +The RPM architecture will also allow third-party vendors to add functionality +to Samba through plug-ins. +

    General Overview

    +When an RPC call is sent to smbd, smbd tries to load a shared library by the +name librpc_<pipename>.so to handle the call if +it doesn't know how to handle the call internally. For instance, LSA calls +are handled by librpc_lsass.so.. +These shared libraries should be located in the <sambaroot>/lib/rpc. smbd then attempts to call the init_module function within +the shared library. Check the chapter on modules for more information. +

    +In the init_module function, the library should call +rpc_pipe_register_commands(). This function takes the following arguments: +

    +NTSTATUS rpc_pipe_register_commands(int version, const char *clnt, const char *srv,
+                               const struct api_struct *cmds, int size);
+
    version

    Version number of the RPC interface. Use the define SMB_RPC_INTERFACE_VERSION for this +argument.

    clnt

    the Client name of the named pipe

    srv

    the Server name of the named pipe

    cmds

    a list of api_structs that map RPC ordinal numbers to function calls

    size

    the number of api_structs contained in cmds

    +See rpc_server/srv_reg.c and rpc_server/srv_reg_nt.c for a small example of +how to use this library. +

    Chapter 16. VFS Modules

    Alexander Bokovoy

    Stefan Metzmacher

    27 May 2003

    Table of Contents

    The Samba (Posix) VFS layer
    The general interface
    Possible VFS operation layers
    The Interaction between the Samba VFS subsystem and the modules
    Initialization and registration
    How the Modules handle per connection data
    Upgrading to the New VFS Interface
    Upgrading from 2.2.* and 3.0aplha modules
    Some Notes
    Implement TRANSPARENT functions
    Implement OPAQUE functions

    The Samba (Posix) VFS layer

    The general interface

    +Each VFS operation has a vfs_op_type, a function pointer and a handle pointer in the +struct vfs_ops and tree macros to make it easier to call the operations. +(Take a look at include/vfs.h and include/vfs_macros.h.) +

    +typedef enum _vfs_op_type {
+	SMB_VFS_OP_NOOP = -1,
+
+	...
+
+	/* File operations */
+
+	SMB_VFS_OP_OPEN,
+	SMB_VFS_OP_CLOSE,
+	SMB_VFS_OP_READ,
+	SMB_VFS_OP_WRITE,
+	SMB_VFS_OP_LSEEK,
+	SMB_VFS_OP_SENDFILE,
+
+	...
+
+	SMB_VFS_OP_LAST
+} vfs_op_type;
+

    This struct contains the function and handle pointers for all operations.

    +struct vfs_ops {
+	struct vfs_fn_pointers {
+		...
+		
+		/* File operations */
+		
+		int (*open)(struct vfs_handle_struct *handle,
+			struct connection_struct *conn,
+			const char *fname, int flags, mode_t mode);
+		int (*close)(struct vfs_handle_struct *handle,
+			struct files_struct *fsp, int fd);
+		ssize_t (*read)(struct vfs_handle_struct *handle, 
+			struct files_struct *fsp, int fd, void *data, size_t n);
+		ssize_t (*write)(struct vfs_handle_struct *handle, 
+			struct files_struct *fsp, int fd, 
+			const void *data, size_t n);
+		SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, 
+			struct files_struct *fsp, int fd, 
+			SMB_OFF_T offset, int whence);
+		ssize_t (*sendfile)(struct vfs_handle_struct *handle, 
+			int tofd, files_struct *fsp, int fromfd, 
+			const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
+
+		...
+	} ops;
+	
+	struct vfs_handles_pointers {
+		...
+		
+		/* File operations */
+		
+		struct vfs_handle_struct *open;
+		struct vfs_handle_struct *close;
+		struct vfs_handle_struct *read;
+		struct vfs_handle_struct *write;
+		struct vfs_handle_struct *lseek;
+		struct vfs_handle_struct *sendfile;
+		
+		...
+	} handles;
+};
+

    +This macros SHOULD be used to call any vfs operation. +DO NOT ACCESS conn->vfs.ops.* directly !!! +

    +...
+	
+/* File operations */
+#define SMB_VFS_OPEN(conn, fname, flags, mode) \
+	((conn)->vfs.ops.open((conn)->vfs.handles.open,\
+	 (conn), (fname), (flags), (mode)))
+#define SMB_VFS_CLOSE(fsp, fd) \
+	((fsp)->conn->vfs.ops.close(\
+	(fsp)->conn->vfs.handles.close, (fsp), (fd)))
+#define SMB_VFS_READ(fsp, fd, data, n) \
+	((fsp)->conn->vfs.ops.read(\
+	(fsp)->conn->vfs.handles.read,\
+	 (fsp), (fd), (data), (n)))
+#define SMB_VFS_WRITE(fsp, fd, data, n) \
+	((fsp)->conn->vfs.ops.write(\
+	(fsp)->conn->vfs.handles.write,\
+	 (fsp), (fd), (data), (n)))
+#define SMB_VFS_LSEEK(fsp, fd, offset, whence) \
+	((fsp)->conn->vfs.ops.lseek(\
+	(fsp)->conn->vfs.handles.lseek,\
+	 (fsp), (fd), (offset), (whence)))
+#define SMB_VFS_SENDFILE(tofd, fsp, fromfd, header, offset, count) \
+	((fsp)->conn->vfs.ops.sendfile(\
+	(fsp)->conn->vfs.handles.sendfile,\
+	 (tofd), (fsp), (fromfd), (header), (offset), (count)))
+
+...
+

    Possible VFS operation layers

    +These values are used by the VFS subsystem when building the conn->vfs +and conn->vfs_opaque structs for a connection with multiple VFS modules. +Internally, Samba differentiates only opaque and transparent layers at this process. +Other types are used for providing better diagnosing facilities. +

    +Most modules will provide transparent layers. Opaque layer is for modules +which implement actual file system calls (like DB-based VFS). For example, +default POSIX VFS which is built in into Samba is an opaque VFS module. +

    +Other layer types (logger, splitter, scanner) were designed to provide different +degree of transparency and for diagnosing VFS module behaviour. +

    +Each module can implement several layers at the same time provided that only +one layer is used per each operation. +

    +typedef enum _vfs_op_layer {
+	SMB_VFS_LAYER_NOOP = -1,	/* - For using in VFS module to indicate end of array */
+					/*   of operations description */
+	SMB_VFS_LAYER_OPAQUE = 0,	/* - Final level, does not call anything beyond itself */
+	SMB_VFS_LAYER_TRANSPARENT,	/* - Normal operation, calls underlying layer after */
+					/*   possibly changing passed data */
+	SMB_VFS_LAYER_LOGGER,		/* - Logs data, calls underlying layer, logging may not */
+					/*   use Samba VFS */
+	SMB_VFS_LAYER_SPLITTER,		/* - Splits operation, calls underlying layer _and_ own facility, */
+					/*   then combines result */
+	SMB_VFS_LAYER_SCANNER		/* - Checks data and possibly initiates additional */
+					/*   file activity like logging to files _inside_ samba VFS */
+} vfs_op_layer;
+

    The Interaction between the Samba VFS subsystem and the modules

    Initialization and registration

    +As each Samba module a VFS module should have a +

    NTSTATUS vfs_example_init(void);

    function if it's staticly linked to samba or +

    NTSTATUS init_module(void);

    function if it's a shared module. +

    +This should be the only non static function inside the module. +Global variables should also be static! +

    +The module should register its functions via the +

    +NTSTATUS smb_register_vfs(int version, const char *name, vfs_op_tuple *vfs_op_tuples);
+

    function. +

    version

    should be filled with SMB_VFS_INTERFACE_VERSION

    name

    this is the name witch can be listed in the +vfs objects parameter to use this module.

    vfs_op_tuples

    +this is an array of vfs_op_tuple's. +(vfs_op_tuples is descripted in details below.) +

    +For each operation the module wants to provide it has a entry in the +vfs_op_tuple array. +

    +typedef struct _vfs_op_tuple {
+	void* op;
+	vfs_op_type type;
+	vfs_op_layer layer;
+} vfs_op_tuple;
+
    op

    the function pointer to the specified function.

    type

    the vfs_op_type of the function to specified witch operation the function provides.

    layer

    the vfs_op_layer in whitch the function operates.

    A simple example:

    +static vfs_op_tuple example_op_tuples[] = {	
+	{SMB_VFS_OP(example_connect),	SMB_VFS_OP_CONNECT,	SMB_VFS_LAYER_TRANSPARENT},
+	{SMB_VFS_OP(example_disconnect),	SMB_VFS_OP_DISCONNECT,	SMB_VFS_LAYER_TRANSPARENT},
+
+	{SMB_VFS_OP(example_rename),	SMB_VFS_OP_RENAME,	SMB_VFS_LAYER_OPAQUE},
+
+	/* This indicates the end of the array */
+	{SMB_VFS_OP(NULL),				SMB_VFS_OP_NOOP,	SMB_VFS_LAYER_NOOP}
+};
+
+NTSTATUS init_module(void)
+{
+	return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "example", example_op_tuples);
+}
+

    How the Modules handle per connection data

    Each VFS function has as first parameter a pointer to the modules vfs_handle_struct. +

    +typedef struct vfs_handle_struct {
+	struct vfs_handle_struct  *next, *prev;
+	const char *param;
+	struct vfs_ops vfs_next;
+	struct connection_struct *conn;
+	void *data;
+	void (*free_data)(void **data);
+} vfs_handle_struct;
+
    param

    this is the module parameter specified in the vfs objects parameter.

    e.g. for 'vfs objects = example:test' param would be "test".

    vfs_next

    This vfs_ops struct contains the information for calling the next module operations. +Use the vfs_next_* macros to call a next module operations and +don't access handle->vfs_next.ops.* directly!

    conn

    This is a pointer back to the connection_struct to witch the handle belongs.

    data

    This is a pointer for holding module private data. +You can alloc data with connection life time on the handle->conn->mem_ctx TALLOC_CTX. +But you can also manage the memory allocation yourself.

    free_data

    This is a function pointer to a function that free's the module private data. +If you talloc your private data on the TALLOC_CTX handle->conn->mem_ctx, +you can set this function pointer to NULL.

    Some useful MACROS for handle private data. +

    +#define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
+	if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
+		DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
+		ret; \
+	} \
+}
+
+#define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
+	if (!(handle)) { \
+		DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
+		ret; \
+	} else { \
+		if ((handle)->free_data) { \
+			(handle)->free_data(&(handle)->data); \
+		} \
+		(handle)->data = (void *)datap; \
+		(handle)->free_data = free_fn; \
+	} \
+}
+
+#define SMB_VFS_HANDLE_FREE_DATA(handle) { \
+	if ((handle) && (handle)->free_data) { \
+		(handle)->free_data(&(handle)->data); \
+	} \
+}
+

    How SMB_VFS_LAYER_TRANSPARENT functions can call the SMB_VFS_LAYER_OPAQUE functions.

    The easiest way to do this is to use the SMB_VFS_OPAQUE_* macros. +

    +...
+/* File operations */
+#define SMB_VFS_OPAQUE_OPEN(conn, fname, flags, mode) \
+	((conn)->vfs_opaque.ops.open(\
+	(conn)->vfs_opaque.handles.open,\
+	 (conn), (fname), (flags), (mode)))
+#define SMB_VFS_OPAQUE_CLOSE(fsp, fd) \
+	((fsp)->conn->vfs_opaque.ops.close(\
+	(fsp)->conn->vfs_opaque.handles.close,\
+	 (fsp), (fd)))
+#define SMB_VFS_OPAQUE_READ(fsp, fd, data, n) \
+	((fsp)->conn->vfs_opaque.ops.read(\
+	(fsp)->conn->vfs_opaque.handles.read,\
+	 (fsp), (fd), (data), (n)))
+#define SMB_VFS_OPAQUE_WRITE(fsp, fd, data, n) \
+	((fsp)->conn->vfs_opaque.ops.write(\
+	(fsp)->conn->vfs_opaque.handles.write,\
+	 (fsp), (fd), (data), (n)))
+#define SMB_VFS_OPAQUE_LSEEK(fsp, fd, offset, whence) \
+	((fsp)->conn->vfs_opaque.ops.lseek(\
+	(fsp)->conn->vfs_opaque.handles.lseek,\
+	 (fsp), (fd), (offset), (whence)))
+#define SMB_VFS_OPAQUE_SENDFILE(tofd, fsp, fromfd, header, offset, count) \
+	((fsp)->conn->vfs_opaque.ops.sendfile(\
+	(fsp)->conn->vfs_opaque.handles.sendfile,\
+	 (tofd), (fsp), (fromfd), (header), (offset), (count)))
+...
+

    How SMB_VFS_LAYER_TRANSPARENT functions can call the next modules functions.

    The easiest way to do this is to use the SMB_VFS_NEXT_* macros. +

    +...
+/* File operations */
+#define SMB_VFS_NEXT_OPEN(handle, conn, fname, flags, mode) \
+	((handle)->vfs_next.ops.open(\
+	(handle)->vfs_next.handles.open,\
+	 (conn), (fname), (flags), (mode)))
+#define SMB_VFS_NEXT_CLOSE(handle, fsp, fd) \
+	((handle)->vfs_next.ops.close(\
+	(handle)->vfs_next.handles.close,\
+	 (fsp), (fd)))
+#define SMB_VFS_NEXT_READ(handle, fsp, fd, data, n) \
+	((handle)->vfs_next.ops.read(\
+	(handle)->vfs_next.handles.read,\
+	 (fsp), (fd), (data), (n)))
+#define SMB_VFS_NEXT_WRITE(handle, fsp, fd, data, n) \
+	((handle)->vfs_next.ops.write(\
+	(handle)->vfs_next.handles.write,\
+	 (fsp), (fd), (data), (n)))
+#define SMB_VFS_NEXT_LSEEK(handle, fsp, fd, offset, whence) \
+	((handle)->vfs_next.ops.lseek(\
+	(handle)->vfs_next.handles.lseek,\
+	 (fsp), (fd), (offset), (whence)))
+#define SMB_VFS_NEXT_SENDFILE(handle, tofd, fsp, fromfd, header, offset, count) \
+	((handle)->vfs_next.ops.sendfile(\
+	(handle)->vfs_next.handles.sendfile,\
+	 (tofd), (fsp), (fromfd), (header), (offset), (count)))
+...
+

    Upgrading to the New VFS Interface

    Upgrading from 2.2.* and 3.0aplha modules

    1. +Add "vfs_handle_struct *handle, " as first parameter to all vfs operation functions. +e.g. example_connect(connection_struct *conn, const char *service, const char *user); +-> example_connect(vfs_handle_struct *handle, connection_struct *conn, const char *service, const char *user); +

    2. +Replace "default_vfs_ops." with "smb_vfs_next_". +e.g. default_vfs_ops.connect(conn, service, user); +-> smb_vfs_next_connect(conn, service, user); +

    3. +Uppercase all "vfs_next_*" functions. +e.g. smb_vfs_next_connect(conn, service, user); +-> SMB_VFS_NEXT_CONNECT(conn, service, user); +

    4. +Add "handle, " as first parameter to all VFS_NEXT_*() calls. +e.g. SMB_VFS_NEXT_CONNECT(conn, service, user); +-> SMB_VFS_NEXT_CONNECT(handle, conn, service, user); +

    5. +(Only for 2.2.* modules) +Convert the old struct vfs_ops example_ops to +a vfs_op_tuple example_op_tuples[] array. +e.g. +

      +struct vfs_ops example_ops = {
+	/* Disk operations */
+	example_connect,		/* connect */
+	example_disconnect,		/* disconnect */
+	NULL,				/* disk free *
+	/* Directory operations */
+	NULL,				/* opendir */
+	NULL,				/* readdir */
+	NULL,				/* mkdir */
+	NULL,				/* rmdir */
+	NULL,				/* closedir */
+	/* File operations */
+	NULL,				/* open */
+	NULL,				/* close */
+	NULL,				/* read  */
+	NULL,				/* write */
+	NULL,				/* lseek */
+	NULL,				/* sendfile */
+	NULL,				/* rename */
+	NULL,				/* fsync */
+	example_stat,			/* stat  */
+	example_fstat,			/* fstat */
+	example_lstat,			/* lstat */
+	NULL,				/* unlink */
+	NULL,				/* chmod */
+	NULL,				/* fchmod */
+	NULL,				/* chown */
+	NULL,				/* fchown */
+	NULL,				/* chdir */
+	NULL,				/* getwd */
+	NULL,				/* utime */
+	NULL,				/* ftruncate */
+	NULL,				/* lock */
+	NULL,				/* symlink */
+	NULL,				/* readlink */
+	NULL,				/* link */
+	NULL,				/* mknod */
+	NULL,				/* realpath */
+	NULL,				/* fget_nt_acl */
+	NULL,				/* get_nt_acl */
+	NULL,				/* fset_nt_acl */
+	NULL,				/* set_nt_acl */
+
+	NULL,				/* chmod_acl */
+	NULL,				/* fchmod_acl */
+
+	NULL,				/* sys_acl_get_entry */
+	NULL,				/* sys_acl_get_tag_type */
+	NULL,				/* sys_acl_get_permset */
+	NULL,				/* sys_acl_get_qualifier */
+	NULL,				/* sys_acl_get_file */
+	NULL,				/* sys_acl_get_fd */
+	NULL,				/* sys_acl_clear_perms */
+	NULL,				/* sys_acl_add_perm */
+	NULL,				/* sys_acl_to_text */
+	NULL,				/* sys_acl_init */
+	NULL,				/* sys_acl_create_entry */
+	NULL,				/* sys_acl_set_tag_type */
+	NULL,				/* sys_acl_set_qualifier */
+	NULL,				/* sys_acl_set_permset */
+	NULL,				/* sys_acl_valid */
+	NULL,				/* sys_acl_set_file */
+	NULL,				/* sys_acl_set_fd */
+	NULL,				/* sys_acl_delete_def_file */
+	NULL,				/* sys_acl_get_perm */
+	NULL,				/* sys_acl_free_text */
+	NULL,				/* sys_acl_free_acl */
+	NULL				/* sys_acl_free_qualifier */
+};
+

      +-> +

       
+static vfs_op_tuple example_op_tuples[] = {
+	{SMB_VFS_OP(example_connect),	SMB_VFS_OP_CONNECT,	SMB_VFS_LAYER_TRANSPARENT},
+	{SMB_VFS_OP(example_disconnect),	SMB_VFS_OP_DISCONNECT,	SMB_VFS_LAYER_TRANSPARENT},
+	
+	{SMB_VFS_OP(example_fstat), 	SMB_VFS_OP_FSTAT,	SMB_VFS_LAYER_TRANSPARENT},
+	{SMB_VFS_OP(example_stat),		SMB_VFS_OP_STAT,	SMB_VFS_LAYER_TRANSPARENT},
+	{SMB_VFS_OP(example_lstat), 	SMB_VFS_OP_LSTAT,	SMB_VFS_LAYER_TRANSPARENT},
+
+	{SMB_VFS_OP(NULL),				SMB_VFS_OP_NOOP,	SMB_VFS_LAYER_NOOP}
+};
+

      +

    6. +Move the example_op_tuples[] array to the end of the file. +

    7. +Add the init_module() function at the end of the file. +e.g. +

      +NTSTATUS init_module(void)
+{
+	return smb_register_vfs(SMB_VFS_INTERFACE_VERSION,"example",example_op_tuples);
+}
+

      +

    8. +Check if your vfs_init() function does more then just prepare the vfs_ops structs or +remember the struct smb_vfs_handle_struct. +

      If NOT you can remove the vfs_init() function.
      If YES decide if you want to move the code to the example_connect() operation or to the init_module(). And then remove vfs_init(). + e.g. a debug class registration should go into init_module() and the allocation of private data should go to example_connect().

      +

    9. +(Only for 3.0alpha* modules) +Check if your vfs_done() function contains needed code. +

      If NOT you can remove the vfs_done() function.
      If YES decide if you can move the code to the example_disconnect() operation. Otherwise register a SMB_EXIT_EVENT with smb_register_exit_event(); (Described in the modules section) And then remove vfs_done(). e.g. the freeing of private data should go to example_disconnect(). +

      +

    10. +Check if you have any global variables left. +Decide if it wouldn't be better to have this data on a connection basis. +

      If NOT leave them as they are. (e.g. this could be the variable for the private debug class.)
      If YES pack all this data into a struct. You can use handle->data to point to such a struct on a per connection basis.

      + + e.g. if you have such a struct: +

          
+struct example_privates {
+	char *some_string;
+	int db_connection;
+};
+

      +first way of doing it: +

      +static int example_connect(vfs_handle_struct *handle,
+	connection_struct *conn, const char *service, 
+	const char* user)
+{
+	struct example_privates *data = NULL;
+
+	/* alloc our private data */
+	data = (struct example_privates *)talloc_zero(conn->mem_ctx, sizeof(struct example_privates));
+	if (!data) {
+		DEBUG(0,("talloc_zero() failed\n"));
+		return -1;
+	}
+
+	/* init out private data */
+	data->some_string = talloc_strdup(conn->mem_ctx,"test");
+	if (!data->some_string) {
+		DEBUG(0,("talloc_strdup() failed\n"));
+		return -1;
+	}
+
+	data->db_connection = open_db_conn();
+
+	/* and now store the private data pointer in handle->data
+	 * we don't need to specify a free_function here because
+	 * we use the connection TALLOC context.
+	 * (return -1 if something failed.)
+	 */
+	VFS_HANDLE_SET_DATA(handle, data, NULL, struct example_privates, return -1);
+
+	return SMB_VFS_NEXT_CONNECT(handle,conn,service,user);
+}
+
+static int example_close(vfs_handle_struct *handle, files_struct *fsp, int fd)
+{
+	struct example_privates *data = NULL;
+	
+	/* get the pointer to our private data
+	 * return -1 if something failed
+	 */
+	SMB_VFS_HANDLE_GET_DATA(handle, data, struct example_privates, return -1);
+	
+	/* do something here...*/
+	DEBUG(0,("some_string: %s\n",data->some_string));
+	
+	return SMB_VFS_NEXT_CLOSE(handle, fsp, fd);
+}
+

      +second way of doing it: +

      +static void free_example_privates(void **datap)
+{
+	struct example_privates *data = (struct example_privates *)*datap;
+	
+	SAFE_FREE(data->some_string);
+	SAFE_FREE(data);
+	
+	datap = NULL;
+	
+	return;
+}
+
+static int example_connect(vfs_handle_struct *handle, 
+	connection_struct *conn, const char *service, 
+	const char* user)
+{
+	struct example_privates *data = NULL;
+
+	/* alloc our private data */
+	data = (struct example_privates *)malloc(sizeof(struct example_privates));
+	if (!data) {
+		DEBUG(0,("malloc() failed\n"));
+		return -1;
+	}
+
+	/* init out private data */
+	data->some_string = strdup(conn->mem_ctx,"test");
+	if (!data->some_string) {
+		DEBUG(0,("strdup() failed\n"));
+		return -1;
+	}
+
+	data->db_connection = open_db_conn();
+
+	/* and now store the private data pointer in handle->data
+	 * we need to specify a free_function because we used malloc() and strdup().
+	 * (return -1 if something failed.)
+	 */
+	SMB_VFS_HANDLE_SET_DATA(handle, data, NULL, struct example_privates, return -1);
+
+	return SMB_VFS_NEXT_CONNECT(handle,conn,service,user);
+}
+
+static int example_close(vfs_handle_struct *handle, files_struct *fsp, int fd)
+{
+	struct example_privates *data = NULL;
+	
+	/* get the pointer to our private data
+	 * return -1 if something failed
+	 */
+	SMB_VFS_HANDLE_GET_DATA(handle, data, struct example_privates, return -1);
+	
+	/* do something here...*/
+	DEBUG(0,("some_string: %s\n",data->some_string));
+	
+	return VFS_NEXT_CLOSE(handle, fsp, fd);
+}
+

      +

    11. +To make it easy to build 3rd party modules it would be usefull to provide +configure.in, (configure), install.sh and Makefile.in with the module. +(Take a look at the example in examples/VFS.) +

      +The configure script accepts --with-samba-source to specify +the path to the samba source tree. +It also accept --enable-developer which lets the compiler +give you more warnings. +

      +The idea is that you can extend this +configure.in and Makefile.in scripts +for your module. +

    12. +Compiling & Testing... +

      ./configure --enable-developer ...
      make
      Try to fix all compiler warnings
      make
      Testing, Testing, Testing ...

      +

    Some Notes

    Implement TRANSPARENT functions

    +Avoid writing functions like this: + +

    +static int example_close(vfs_handle_struct *handle, files_struct *fsp, int fd)
+{
+	return SMB_VFS_NEXT_CLOSE(handle, fsp, fd);
+}
+

    + +Overload only the functions you really need to! +

    Implement OPAQUE functions

    +If you want to just implement a better version of a +default samba opaque function +(e.g. like a disk_free() function for a special filesystem) +it's ok to just overload that specific function. +

    +If you want to implement a database filesystem or +something different from a posix filesystem. +Make sure that you overload every vfs operation!!! +

    +Functions your FS does not support should be overloaded by something like this: +e.g. for a readonly filesystem. +

    +static int example_rename(vfs_handle_struct *handle, connection_struct *conn,
+			char *oldname, char *newname)
+{
+	DEBUG(10,("function rename() not allowed on vfs 'example'\n"));
+	errno = ENOSYS;
+	return -1;
+}
+

    Chapter 17. Notes to packagers

    Jelmer Vernooij

    Table of Contents

    Versioning
    Modules

    Versioning

    Please, please update the version number in +source/include/version.h to include the versioning of your package. This makes it easier to distinguish standard samba builds +from custom-build samba builds (distributions often patch packages). For +example, a good version would be: 

    +Version 2.999+3.0.alpha21-5 for Debian
+

    Modules

    Samba now has support for building parts of samba as plugins. This +makes it possible to, for example, put ldap or mysql support in a seperate +package, thus making it possible to have a normal samba package not +depending on ldap or mysql. To build as much parts of samba +as a plugin, run: 

    +./configure --with-shared-modules=rpc,vfs,auth,pdb,charset
+

    Chapter 18. Contributing code

    Jelmer R. Vernooij

    The Samba Team

    Here are a few tips and notes that might be useful if you are + interested in modifying samba source code and getting it into + samba's main branch.

    Retrieving the source

    In order to contribute code to samba, make sure you have the + latest source. Retrieving the samba source code from CVS is + documented in the appendix of the Samba HOWTO Collection. +

    Discuss large modifications with team members

    Please discuss large modifications you are going to make + with members of the samba team. Some parts of the samba code + have one or more 'owners' - samba developers who wrote most + of the code and maintain it. +

    This way you can avoid spending your time and effort on + something that is not going to make it into the main samba branch + because someone else was working on the same thing or because your + implementation is not the correct one. +

    Patch format

    Patches to the samba tree should be in unified diff format, + e.g. files generated by diff -u. +

    If you are modifying a copy of samba you retrieved from CVS, + you can easily generate a diff file of these changes by running + cvs diff -u.

    Points of attention when modifying samba source code

    +

    Don't simply copy code from other places and modify it until it + works. Code needs to be clean and logical. Duplicate + code is to be avoided.
    Test your patch. It might take a while before one of us looks + at your patch so it will take longer before your patch when your patch + needs to go thru the review cycle again.
    Don't put seperate patches in one large diff file. This makes + it harder to read, understand and test the patch. You might + also risk not getting a good patch committed because you mixed it + with one that had issues.
    Make sure your patch complies to the samba coding style as + suggested in the coding-suggestions chapter.

    +

    Sending in bugfixes

    Bugfixes to bugs in samba should be submitted to samba's + bugzilla system, + along with a description of the bug. +

    Sending in feature patches

    Send feature patches along with a description of what the + patch is supposed to do to the + Samba-technical mailinglist and possibly to a samba team member who is (one of the) 'owners' + of the code you made modifications to. We are all busy people + so everybody tends to 'let one of the others handle it'. If nobody + responded to your patch for a week, try to send it again until you + get a response from one of us. +

    Feedback on your patch

    One of the team members will look at your patch and either + commit your patch or give comments why he won't apply it. In the + latter case you can fix your patch and re-send it until + your patch is approved.

    diff --git a/docs/htmldocs/bugreport.html b/docs/htmldocs/bugreport.html index fcc4b7e91a..01b88729ed 100644 --- a/docs/htmldocs/bugreport.html +++ b/docs/htmldocs/bugreport.html @@ -1,352 +1,119 @@ - -Reporting Bugs
    SAMBA Project Documentation
    PrevNext

    Chapter 25. Reporting Bugs

    25.1. Introduction

    The email address for bug reports for stable releases is samba@samba.org. -Bug reports for alpha releases should go to samba-technical@samba.org.

    Please take the time to read this file before you submit a bug +Chapter 35. Reporting Bugs

    Chapter 35. Reporting Bugs
    Prev Part V. Troubleshooting Next

    Chapter 35. Reporting Bugs

    Jelmer R. Vernooij

    The Samba Team

    Someone; Tridge or Karl Auer perhaps?

    27 June 1997

    Table of Contents

    Introduction
    General info
    Debug levels
    Internal errors
    Attaching to a running process
    Patches

    Introduction

    Please report bugs using + bugzilla.

    +Please take the time to read this file before you submit a bug report. Also, please see if it has changed between releases, as we -may be changing the bug reporting mechanism at some time.

    Please also do as much as you can yourself to help track down the +may be changing the bug reporting mechanism at some time. +

    +Please also do as much as you can yourself to help track down the bug. Samba is maintained by a dedicated group of people who volunteer their time, skills and efforts. We receive far more mail about it than we can possibly answer, so you have a much higher chance of an answer -and a fix if you send us a "developer friendly" bug report that lets -us fix it fast.

    Do not assume that if you post the bug to the comp.protocols.smb +and a fix if you send us a "developer friendly" bug report that lets +us fix it fast. +

    +Do not assume that if you post the bug to the comp.protocols.smb newsgroup or the mailing list that we will read it. If you suspect that your problem is not a bug but a configuration problem then it is better to send it to the Samba mailing list, as there are (at last count) 5000 other users on -that list that may be able to help you.

    You may also like to look though the recent mailing list archives, +that list that may be able to help you. +

    +You may also like to look though the recent mailing list archives, which are conveniently accessible on the Samba web pages -at http://samba.org/samba/.

    25.2. General info

    Before submitting a bug report check your config for silly +at http://samba.org/samba/. +

    General info

    +Before submitting a bug report check your config for silly errors. Look in your log files for obvious messages that tell you that you've misconfigured something and run testparm to test your config -file for correct syntax.

    Have you run through the diagnosis? -This is very important.

    If you include part of a log file with your bug report then be sure to +file for correct syntax. +

    +Have you run through the diagnosis? +This is very important. +

    +If you include part of a log file with your bug report then be sure to annotate it with exactly what you were doing on the client at the -time, and exactly what the results were.

    25.3. Debug levels

    If the bug has anything to do with Samba behaving incorrectly as a +time, and exactly what the results were. +

    Debug levels

    +If the bug has anything to do with Samba behaving incorrectly as a server (like refusing to open a file) then the log files will probably be very useful. Depending on the problem a log level of between 3 and 10 showing the problem may be appropriate. A higher level givesmore -detail, but may use too much disk space.

    To set the debug level use log level = in your -smb.conf. You may also find it useful to set the log +detail, but may use too much disk space. +

    +To set the debug level use the log level in your +smb.conf. You may also find it useful to set the log level higher for just one machine and keep separate logs for each machine. -To do this use:

    log level = 10
+To do this use:
+
    +log level = 10
 log file = /usr/local/samba/lib/log.%m
-include = /usr/local/samba/lib/smb.conf.%m
    then create a file 
-/usr/local/samba/lib/smb.conf.machine where
-"machine" is the name of the client you wish to debug. In that file
-put any smb.conf commands you want, for example 
-log level= may be useful. This also allows you to 
+include = /usr/local/samba/lib/smb.conf.%m
+

    +then create a file +/usr/local/samba/lib/smb.conf.machine where +machine is the name of the client you wish to debug. In that file +put any smb.conf commands you want, for example +log level may be useful. This also allows you to experiment with different security systems, protocol levels etc on just -one machine.

    The smb.conf entry log level = -is synonymous with the entry debuglevel = that has been -used in older versions of Samba and is being retained for backwards -compatibility of smb.conf files.

    As the log level = value is increased you will record +one machine. +

    +The smb.conf entry log level +is synonymous with the parameter debuglevel that has +been used in older versions of Samba and is being retained for backwards +compatibility of smb.conf files. +

    +As the log level value is increased you will record a significantly increasing level of debugging information. For most -debugging operations you may not need a setting higher than 3. Nearly -all bugs can be tracked at a setting of 10, but be prepared for a VERY -large volume of log data.

    25.4. Internal errors

    If you get a "INTERNAL ERROR" message in your log files it means that -Samba got an unexpected signal while running. It is probably a +debugging operations you may not need a setting higher than +3. Nearly +all bugs can be tracked at a setting of 10, but be +prepared for a VERY large volume of log data. +

    Internal errors

    +If you get a INTERNAL ERROR message in your log files +it means that Samba got an unexpected signal while running. It is probably a segmentation fault and almost certainly means a bug in Samba (unless -you have faulty hardware or system software)

    If the message came from smbd then it will probably be accompanied by +you have faulty hardware or system software). +

    +If the message came from smbd then it will probably be accompanied by a message which details the last SMB message received by smbd. This info is often very useful in tracking down the problem so please -include it in your bug report.

    You should also detail how to reproduce the problem, if -possible. Please make this reasonably detailed.

    You may also find that a core file appeared in a "corefiles" +include it in your bug report. +

    +You should also detail how to reproduce the problem, if +possible. Please make this reasonably detailed. +

    +You may also find that a core file appeared in a corefiles subdirectory of the directory where you keep your samba log files. This file is the most useful tool for tracking down the bug. To -use it you do this:

    gdb smbd core

    adding appropriate paths to smbd and core so gdb can find them. If you -don't have gdb then try "dbx". Then within the debugger use the -command "where" to give a stack trace of where the problem -occurred. Include this in your mail.

    If you known any assembly language then do a "disass" of the routine +use it you do this: +

    +	$ gdb smbd core
+

    +adding appropriate paths to smbd and core so gdb can find them. If you +don't have gdb then try dbx. Then within the debugger +use the command where to give a stack trace of where the +problem occurred. Include this in your report. +

    +If you know any assembly language then do a +disass of the routine where the problem occurred (if its in a library routine then disassemble the routine that called it) and try to work out exactly where the problem is by looking at the surrounding code. Even if you don't know assembly then incuding this info in the bug report can be -useful.

    25.5. Attaching to a running process

    Unfortunately some unixes (in particular some recent linux kernels) +useful. +

    Attaching to a running process

    +Unfortunately some unixes (in particular some recent linux kernels) refuse to dump a core file if the task has changed uid (which smbd does often). To debug with this sort of system you could try to attach -to the running process using "gdb smbd PID" where you get PID from -smbstatus. Then use "c" to continue and try to cause the core dump +to the running process using +gdb smbd PID where you get +PID from smbstatus. +Then use c to continue and try to cause the core dump using the client. The debugger should catch the fault and tell you -where it occurred.

    25.6. Patches

    The best sort of bug report is one that includes a fix! If you send us -patches please use diff -u format if your version of -diff supports it, otherwise use diff -c4. Make sure -your do the diff against a clean version of the source and let me know -exactly what version you used.

    PrevHomeNext
    Samba and other CIFS clientsUpDiagnosing your samba server
    \ No newline at end of file +where it occurred. +

    Patches

    +The best sort of bug report is one that includes a fix! If you send us +patches please use diff -u format if your version of +diff supports it, otherwise use diff -c4. Make sure +you do the diff against a clean version of the source and let me know +exactly what version you used. +

    Prev Up Next
    Chapter 34. Analysing and solving samba problems Home Part VI. Appendixes
    diff --git a/docs/htmldocs/diagnosis.html b/docs/htmldocs/diagnosis.html index a7b2e59436..af242b6006 100644 --- a/docs/htmldocs/diagnosis.html +++ b/docs/htmldocs/diagnosis.html @@ -1,627 +1,302 @@ - -Diagnosing your samba server
    SAMBA Project Documentation
    Prev 

    Chapter 26. Diagnosing your samba server

    26.1. Introduction

    This file contains a list of tests you can perform to validate your +Chapter 33. The samba checklist

    Chapter 33. The samba checklist
    Prev Part V. Troubleshooting Next

    Chapter 33. The samba checklist

    Andrew Tridgell

    Samba Team

    Jelmer R. Vernooij

    The Samba Team

    Wed Jan 15

    Table of Contents

    Introduction
    Assumptions
    The tests
    Still having troubles?

    Introduction

    +This file contains a list of tests you can perform to validate your Samba server. It also tells you what the likely cause of the problem is if it fails any one of these steps. If it passes all these tests -then it is probably working fine.

    You should do ALL the tests, in the order shown. We have tried to +then it is probably working fine. +

    +You should do ALL the tests, in the order shown. We have tried to carefully choose them so later tests only use capabilities verified in -the earlier tests.

    If you send one of the samba mailing lists an email saying "it doesn't work" +the earlier tests. However, do not stop at the first error as there +have been some instances when continuing with the tests has helped +to solve a problem. +

    +If you send one of the samba mailing lists an email saying "it doesn't work" and you have not followed this test procedure then you should not be surprised -your email is ignored.

    26.2. Assumptions

    In all of the tests it is assumed you have a Samba server called -BIGSERVER and a PC called ACLIENT both in workgroup TESTGROUP.

    The procedure is similar for other types of clients.

    It is also assumed you know the name of an available share in your -smb.conf. I will assume this share is called "tmp". You can add a -"tmp" share like by adding the following to smb.conf:

    
[tmp]
+if your email is ignored.
+

    Assumptions

    +In all of the tests it is assumed you have a Samba server called +BIGSERVER and a PC called ACLIENT both in workgroup TESTGROUP. +

    +The procedure is similar for other types of clients. +

    +It is also assumed you know the name of an available share in your +smb.conf. I will assume this share is called tmp. +You can add a tmp share like this by adding the +following to smb.conf: +

    +
+[tmp]
  comment = temporary files 
  path = /tmp
- read only = yes

    THESE TESTS ASSUME VERSION 3.0.0 OR LATER OF THE SAMBA SUITE. SOME -COMMANDS SHOWN DID NOT EXIST IN EARLIER VERSIONS

    Please pay attention to the error messages you receive. If any error message -reports that your server is being unfriendly you should first check that you -IP name resolution is correctly set up. eg: Make sure your /etc/resolv.conf -file points to name servers that really do exist.

    Also, if you do not have DNS server access for name resolution please check -that the settings for your smb.conf file results in "dns proxy = no". The -best way to check this is with "testparm smb.conf"

    26.3. Tests

    26.3.2. Test 2

    Run the command "ping BIGSERVER" from the PC and "ping ACLIENT" from + read only = yes + +

    +

    Note

    +These tests assume version 3.0 or later of the samba suite. +Some commands shown did not exist in earlier versions. +

    +Please pay attention to the error messages you receive. If any error message +reports that your server is being unfriendly you should first check that your +IP name resolution is correctly set up. eg: Make sure your /etc/resolv.conf +file points to name servers that really do exist. +

    +Also, if you do not have DNS server access for name resolution please check +that the settings for your smb.conf file results in dns proxy = no. The +best way to check this is with testparm smb.conf. +

    +It is helpful to monitor the log files during testing by using the +tail -F log_file_name in a separate +terminal console (use ctrl-alt-F1 through F6 or multiple terminals in X). +Relevant log files can be found (for default installations) in +/usr/local/samba/var. Also, connection logs from +machines can be found here or possibly in /var/log/samba +depending on how or if you specified logging in your smb.conf file. +

    +If you make changes to your smb.conf file while going through these test, +don't forget to restart smbd and nmbd. +

    The tests

    Procedure 33.1. Diagnosing your samba server

    1. +In the directory in which you store your smb.conf file, run the command +testparm smb.conf. If it reports any errors then your smb.conf +configuration file is faulty. +

      Note

      +Your smb.conf file may be located in: /etc/samba +Or in: /usr/local/samba/lib +

    2. +Run the command ping BIGSERVER from the PC and +ping ACLIENT from the unix box. If you don't get a valid response then your TCP/IP -software is not correctly installed.

      Note that you will need to start a "dos prompt" window on the PC to -run ping.

      If you get a message saying "host not found" or similar then your DNS -software or /etc/hosts file is not correctly setup. It is possible to +software is not correctly installed. +

      +Note that you will need to start a "dos prompt" window on the PC to +run ping. +

      +If you get a message saying host not found or similar then your DNS +software or /etc/hosts file is not correctly setup. +It is possible to run samba without DNS entries for the server and client, but I assume -you do have correct entries for the remainder of these tests.

      Another reason why ping might fail is if your host is running firewall +you do have correct entries for the remainder of these tests. +

      +Another reason why ping might fail is if your host is running firewall software. You will need to relax the rules to let in the workstation in question, perhaps by allowing access from another subnet (on Linux -this is done via the ipfwadm program.)

    26.3.3. Test 3

    Run the command "smbclient -L BIGSERVER" on the unix box. You -should get a list of available shares back.

    If you get a error message containing the string "Bad password" then -you probably have either an incorrect "hosts allow", "hosts deny" or -"valid users" line in your smb.conf, or your guest account is not -valid. Check what your guest account is using "testparm" and -temporarily remove any "hosts allow", "hosts deny", "valid users" or -"invalid users" lines.

    If you get a "connection refused" response then the smbd server may +this is done via the ipfwadm program.) +

    Note

    +Modern Linux distributions install ipchains/iptables by default. +This is a common problem that is often overlooked. +

  • +Run the command smbclient -L BIGSERVER on the unix box. You +should get a list of available shares back. +

    +If you get a error message containing the string "Bad password" then +you probably have either an incorrect hosts allow, +hosts deny or valid users line in your +smb.conf, or your guest account is not +valid. Check what your guest account is using testparm and +temporarily remove any hosts allow, hosts deny, valid users or invalid users lines. +

    +If you get a connection refused response then the smbd server may not be running. If you installed it in inetd.conf then you probably edited that file incorrectly. If you installed it as a daemon then check that it is running, and check that the netbios-ssn port is in a LISTEN -state using "netstat -a".

    If you get a "session request failed" then the server refused the -connection. If it says "Your server software is being unfriendly" then -its probably because you have invalid command line parameters to smbd, -or a similar fatal problem with the initial startup of smbd. Also -check your config file (smb.conf) for syntax errors with "testparm" +state using netstat -a. +

    Note

    +Some Unix / Linux systems use xinetd in place of +inetd. Check your system documentation for the location +of the control file/s for your particular system implementation of +this network super daemon. +

    +If you get a session request failed then the server refused the +connection. If it says "Your server software is being unfriendly" then +its probably because you have invalid command line parameters to smbd, +or a similar fatal problem with the initial startup of smbd. Also +check your config file (smb.conf) for syntax errors with testparm and that the various directories where samba keeps its log and lock -files exist.

    There are a number of reasons for which smbd may refuse or decline +files exist. +

    +There are a number of reasons for which smbd may refuse or decline a session request. The most common of these involve one or more of -the following smb.conf file entries:

    	hosts deny = ALL
+the following smb.conf file entries:
+
    +	hosts deny = ALL
 	hosts allow = xxx.xxx.xxx.xxx/yy
-	bind interfaces only = Yes
    In the above, no allowance has been made for any session requests that
+	bind interfaces only = Yes
+

    +In the above, no allowance has been made for any session requests that will automatically translate to the loopback adaptor address 127.0.0.1. -To solve this problem change these lines to:

    	hosts deny = ALL
-	hosts allow = xxx.xxx.xxx.xxx/yy 127.

    Do NOT use the "bind interfaces only" parameter where you may wish to -use the samba password change facility, or where smbclient may need to -access local service for name resolution or for local resource -connections. (Note: the "bind interfaces only" parameter deficiency +To solve this problem change these lines to: +

    +	hosts deny = ALL
+	hosts allow = xxx.xxx.xxx.xxx/yy 127.
+

    +Do not use the bind interfaces only parameter where you +may wish to +use the samba password change facility, or where smbclient may need to +access a local service for name resolution or for local resource +connections. (Note: the bind interfaces only parameter deficiency where it will not allow connections to the loopback address will be -fixed soon).

    Another common cause of these two errors is having something already running -on port 139, such as Samba (ie: smbd is running from inetd already) or -something like Digital's Pathworks. Check your inetd.conf file before trying -to start smbd as a daemon, it can avoid a lot of frustration!

    And yet another possible cause for failure of TEST 3 is when the subnet mask +fixed soon). +

    +Another common cause of these two errors is having something already running +on port 139, such as Samba +(ie: smbd is running from inetd already) or +something like Digital's Pathworks. Check your inetd.conf file before trying +to start smbd as a daemon, it can avoid a lot of frustration! +

    +And yet another possible cause for failure of this test is when the subnet mask and / or broadcast address settings are incorrect. Please check that the network interface IP Address / Broadcast Address / Subnet Mask settings are -correct and that Samba has correctly noted these in the log.nmb file.

    • 26.3.4. Test 4

    Run the command "nmblookup -B BIGSERVER __SAMBA__". You should get the -IP address of your Samba server back.

    If you don't then nmbd is incorrectly installed. Check your inetd.conf +correct and that Samba has correctly noted these in the log.nmb file. +

  • +Run the command nmblookup -B BIGSERVER __SAMBA__. You should get the +IP address of your Samba server back. +

    +If you don't then nmbd is incorrectly installed. Check your inetd.conf if you run it from there, or that the daemon is running and listening -to udp port 137.

    One common problem is that many inetd implementations can't take many +to udp port 137. +

    +One common problem is that many inetd implementations can't take many parameters on the command line. If this is the case then create a one-line script that contains the right parameters and run that from -inetd.

    • 26.3.6. Test 6

    Run the command nmblookup -d 2 '*'

    This time we are trying the same as the previous test but are trying +got the name of the PC wrong. +

    +If ACLIENT doesn't resolve via DNS then use the IP address of the +client in the above test. +

  • +Run the command nmblookup -d 2 '*' +

    +This time we are trying the same as the previous test but are trying it via a broadcast to the default broadcast address. A number of Netbios/TCPIP hosts on the network should respond, although Samba may not catch all of the responses in the short time it listens. You -should see "got a positive name query response" messages from several -hosts.

    If this doesn't give a similar result to the previous test then +should see got a positive name query response +messages from several hosts. +

    +If this doesn't give a similar result to the previous test then nmblookup isn't correctly getting your broadcast address through its -automatic mechanism. In this case you should experiment use the -"interfaces" option in smb.conf to manually configure your IP -address, broadcast and netmask.

    If your PC and server aren't on the same subnet then you will need to -use the -B option to set the broadcast address to the that of the PCs -subnet.

    This test will probably fail if your subnet mask and broadcast address are -not correct. (Refer to TEST 3 notes above).

    • 26.3.7. Test 7

    Run the command smbclient //BIGSERVER/TMP. You should +automatic mechanism. In this case you should experiment with the +interfaces option in smb.conf to manually configure your IP +address, broadcast and netmask. +

    +If your PC and server aren't on the same subnet then you will need to +use the -B option to set the broadcast address to that of the PCs +subnet. +

    +This test will probably fail if your subnet mask and broadcast address are +not correct. (Refer to TEST 3 notes above). +

  • +Run the command smbclient //BIGSERVER/TMP. You should then be prompted for a password. You should use the password of the account you are logged into the unix box with. If you want to test with -another account then add the -U >accountname< option to the end of +another account then add the -U accountname option to the end of the command line. eg: -smbclient //bigserver/tmp -Ujohndoe

    Note: It is possible to specify the password along with the username +smbclient //bigserver/tmp -Ujohndoe +

    Note

    +It is possible to specify the password along with the username as follows: -smbclient //bigserver/tmp -Ujohndoe%secret

    Once you enter the password you should get the "smb>" prompt. If you -don't then look at the error message. If it says "invalid network -name" then the service "tmp" is not correctly setup in your smb.conf.

    If it says "bad password" then the likely causes are:

    1. you have shadow passords (or some other password system) but didn't - compile in support for them in smbd -

    2. your "valid users" configuration is incorrect -

    3. you have a mixed case password and you haven't enabled the "password - level" option at a high enough level -

    4. the "path =" line in smb.conf is incorrect. Check it with testparm -

    5. you enabled password encryption but didn't create the SMB encrypted - password file -

    Once connected you should be able to use the commands -dir get put etc. -Type help >command< for instructions. You should +smbclient //bigserver/tmp -Ujohndoe%secret +

    +Once you enter the password you should get the smb> prompt. If you +don't then look at the error message. If it says invalid network +name then the service "tmp" is not correctly setup in your smb.conf. +

    +If it says bad password then the likely causes are: +

    1. + you have shadow passords (or some other password system) but didn't + compile in support for them in smbd +

    2. + your valid users configuration is incorrect +

    3. + you have a mixed case password and you haven't enabled the password + level option at a high enough level +

    4. + the path = line in smb.conf is incorrect. Check it with testparm +

    5. + you enabled password encryption but didn't map unix to samba users +

    +Once connected you should be able to use the commands +dir get put etc. +Type help command for instructions. You should especially check that the amount of free disk space shown is correct -when you type dir.

    • 26.3.8. Test 8

    On the PC type the command net view \\BIGSERVER. You will -need to do this from within a "dos prompt" window. You should get back a -list of available shares on the server.

    If you get a "network name not found" or similar error then netbios +when you type dir. +

  • +On the PC, type the command net view \\BIGSERVER. You will +need to do this from within a "dos prompt" window. You should get back a +list of available shares on the server. +

    +If you get a network name not found or similar error then netbios name resolution is not working. This is usually caused by a problem in nmbd. To overcome it you could do one of the following (you only need -to choose one of them):

    1. fixup the nmbd installation

    2. add the IP address of BIGSERVER to the "wins server" box in the - advanced tcp/ip setup on the PC.

    3. enable windows name resolution via DNS in the advanced section of - the tcp/ip setup

    4. add BIGSERVER to your lmhosts file on the PC.

    If you get a "invalid network name" or "bad password error" then the -same fixes apply as they did for the "smbclient -L" test above. In -particular, make sure your "hosts allow" line is correct (see the man -pages)

    Also, do not overlook that fact that when the workstation requests the +to choose one of them): +

    1. + fixup the nmbd installation +

    2. + add the IP address of BIGSERVER to the wins server box in the + advanced tcp/ip setup on the PC. +

    3. + enable windows name resolution via DNS in the advanced section of + the tcp/ip setup +

    4. + add BIGSERVER to your lmhosts file on the PC. +

    +If you get a invalid network name or bad password error then the +same fixes apply as they did for the smbclient -L test above. In +particular, make sure your hosts allow line is correct (see the man +pages) +

    +Also, do not overlook that fact that when the workstation requests the connection to the samba server it will attempt to connect using the name with which you logged onto your Windows machine. You need to make sure that an account exists on your Samba server with that exact same -name and password.

    If you get "specified computer is not receiving requests" or similar +name and password. +

    +If you get specified computer is not receiving requests or similar it probably means that the host is not contactable via tcp services. Check to see if the host is running tcp wrappers, and if so add an entry in -the hosts.allow file for your client (or subnet, etc.)

    • 26.3.9. Test 9

    Run the command net use x: \\BIGSERVER\TMP. You should -be prompted for a password then you should get a "command completed -successfully" message. If not then your PC software is incorrectly -installed or your smb.conf is incorrect. make sure your "hosts allow" -and other config lines in smb.conf are correct.

    It's also possible that the server can't work out what user name to -connect you as. To see if this is the problem add the line "user = -USERNAME" to the [tmp] section of smb.conf where "USERNAME" is the +the hosts.allow file for your client (or subnet, etc.) +

  • +Run the command net use x: \\BIGSERVER\TMP. You should +be prompted for a password then you should get a command completed +successfully message. If not then your PC software is incorrectly +installed or your smb.conf is incorrect. make sure your hosts allow +and other config lines in smb.conf are correct. +

    +It's also possible that the server can't work out what user name to +connect you as. To see if this is the problem add the line user = +username to the [tmp] section of +smb.conf where username is the username corresponding to the password you typed. If you find this -fixes things you may need the username mapping option.

    It might also be the case that your client only sends encrypted passwords -and you have encrypt passwords = no in smb.conf. -Turn it back on to fix.

    • 26.3.10. Test 10

    Run the command nmblookup -M TESTGROUP where -TESTGROUP is the name of the workgroup that your Samba server and +fixes things you may need the username mapping option. +

    +It might also be the case that your client only sends encrypted passwords +and you have encrypt passwords = no in smb.conf +Turn it back on to fix. +

  • +Run the command nmblookup -M testgroup where +testgroup is the name of the workgroup that your Samba server and Windows PCs belong to. You should get back the IP address of the -master browser for that workgroup.

    If you don't then the election process has failed. Wait a minute to +master browser for that workgroup. +

    +If you don't then the election process has failed. Wait a minute to see if it is just being slow then try again. If it still fails after -that then look at the browsing options you have set in smb.conf. Make -sure you have preferred master = yes to ensure that -an election is held at startup.

    • 26.3.11. Test 11

    From file manager try to browse the server. Your samba server should +that then look at the browsing options you have set in smb.conf. Make +sure you have preferred master = yes to ensure that +an election is held at startup. +

  • +>From file manager try to browse the server. Your samba server should appear in the browse list of your local workgroup (or the one you specified in smb.conf). You should be able to double click on the name -of the server and get a list of shares. If you get a "invalid -password" error when you do then you are probably running WinNT and it +of the server and get a list of shares. If you get a "invalid +password" error when you do then you are probably running WinNT and it is refusing to browse a server that has no encrypted password capability and is in user level security mode. In this case either set -security = server AND -password server = Windows_NT_Machine in your -smb.conf file, or enable encrypted passwords AFTER compiling in support -for encrypted passwords (refer to the Makefile).

    • 26.4. Still having troubles?

    Try the mailing list or newsgroup, or use the ethereal utility to -sniff the problem. The official samba mailing list can be reached at -samba@samba.org. To find -out more about samba and how to subscribe to the mailing list check -out the samba web page at -http://samba.org/samba

    Also look at the other docs in the Samba package!

    PrevHome 
    Reporting BugsUp 
    \ No newline at end of file +security = server AND +password server = Windows_NT_Machine in your +smb.conf file, or make sure encrypted passwords is +set to "yes". +

    Still having troubles?

    Read the chapter on +Analysing and Solving Problems. +

    Prev Up Next
    Part V. Troubleshooting Home Chapter 34. Analysing and solving samba problems
    diff --git a/docs/htmldocs/findsmb.1.html b/docs/htmldocs/findsmb.1.html index af7100ed6f..a6013a13ec 100644 --- a/docs/htmldocs/findsmb.1.html +++ b/docs/htmldocs/findsmb.1.html @@ -1,214 +1,41 @@ - -findsmb

    findsmb

    Name

    findsmb -- list info about machines that respond to SMB - name queries on a subnet

    Synopsis

    findsmb [subnet broadcast address]

    DESCRIPTION

    This perl script is part of the Samba suite.

    findsmb is a perl script that +findsmb

    Name

    findsmb — list info about machines that respond to SMB + name queries on a subnet

    Synopsis

    findsmb [subnet broadcast address]

    DESCRIPTION

    This perl script is part of the Samba(7) + suite.

    findsmb is a perl script that prints out several pieces of information about machines on a subnet that respond to SMB name query requests. - It uses nmblookup(1) and smbclient(1) to obtain this information. -

    OPTIONS

    -r

    Controls whether findsmb takes + It uses nmblookup(1) + and smbclient(1) + to obtain this information. +

    OPTIONS

    -r

    Controls whether findsmb takes bugs in Windows95 into account when trying to find a Netbios name registered of the remote machine. This option is disabled by default because it is specific to Windows 95 and Windows 95 machines only. - If set, nmblookup - will be called with -B option.

    subnet broadcast address

    Without this option, findsmb - will probe the subnet of the machine where - findsmb is run. This value is passed - to nmblookup as part of the - -B option.

    EXAMPLES

    The output of findsmb lists the following + If set, nmblookup(1) + will be called with -B option.

    subnet broadcast address

    Without this option, findsmb + will probe the subnet of the machine where + findsmb(1) + is run. This value is passed to + nmblookup(1) + as part of the -B option.

    EXAMPLES

    The output of findsmb lists the following information for all machines that respond to the initial - nmblookup for any name: IP address, NetBIOS name, - Workgroup name, operating system, and SMB server version.

    There will be a '+' in front of the workgroup name for + nmblookup for any name: IP address, NetBIOS name, + Workgroup name, operating system, and SMB server version.

    There will be a '+' in front of the workgroup name for machines that are local master browsers for that workgroup. There will be an '*' in front of the workgroup name for machines that are the domain master browser for that workgroup. Machines that are running Windows, Windows 95 or Windows 98 will not show any information about the operating system or server - version.

    The command with -r option - must be run on a system without nmbd running. - If nmbd is running on the system, you will + version.

    The command with -r option + must be run on a system without nmbd(8) running. + + If nmbd is running on the system, you will only get the IP address and the DNS name of the machine. To get proper responses from Windows 95 and Windows 98 machines, - the command must be run as root and with -r - option on a machine without nmbd running.

    For example, running findsmb without - -r option set would yield output similar - to the following

    IP ADDR         NETBIOS NAME   WORKGROUP/OS/VERSION 
+	the command must be run as root and with -r
+	option on a machine without nmbd running.
    For example, running findsmb 
+	without -r option set would yield output similar
+	to the following
    +IP ADDR         NETBIOS NAME   WORKGROUP/OS/VERSION 
 --------------------------------------------------------------------- 
 192.168.35.10   MINESET-TEST1  [DMVENGR]
 192.168.35.55   LINUXBOX      *[MYGROUP] [Unix] [Samba 2.0.6]
@@ -220,81 +47,15 @@ CLASS="COMPUTEROUTPUT"
 192.168.35.88   SCNT2         +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0]
 192.168.35.93   FROGSTAR-PC    [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager]
 192.168.35.97   HERBNT1       *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0]
-

    VERSION

    This man page is correct for version 3.0 of - the Samba suite.

    SEE ALSO

    nmbd(8), - smbclient(1) - , and nmblookup(1) -

    AUTHOR

    The original Samba software and related utilities +

    VERSION

    This man page is correct for version 3.0 of + the Samba suite.

    SEE ALSO

    nmbd(8), + smbclient(1), and nmblookup(1) +

    AUTHOR

    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.

    The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

    The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

    \ No newline at end of file + excellent piece of Open Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) + and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.

    diff --git a/docs/htmldocs/groupmapping.html b/docs/htmldocs/groupmapping.html index 84cf521fc9..8508edf2a5 100644 --- a/docs/htmldocs/groupmapping.html +++ b/docs/htmldocs/groupmapping.html @@ -1,235 +1,177 @@ - -Group mapping HOWTO
    SAMBA Project Documentation
    PrevNext

    Chapter 21. Group mapping HOWTO

    -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 -smbgroupedit.

    The first immediate reason to use the group mapping on a PDC, is that -the domain admin group of smb.conf 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.

    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'.

    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.

    You are now wondering how to make some of your samba PDC users members of the -'Domain Administrators' ? That's really easy.

    1. create a unix group (usually in /etc/group), let's call it domadm

    2. add to this group the users that must be Administrators. For example if you want joe,john and mary, your entry in /etc/group will look like:

      domadm:x:502:joe,john,mary

    3. Map this domadm group to the domain admins group by running the command:

      smbgroupedit -c "Domain Admins" -u domadm

    You're set, joe, john and mary are domain administrators !

    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:

    smbgroupedit -a unixgroup -td

    You can list the various groups in the mapping database like this

    smbgroupedit -v

    PrevHomeNext
    HOWTO Access Samba source code via CVSUpSamba performance issues
    \ No newline at end of file +Chapter 12. Mapping MS Windows and Unix Groups
    Chapter 12. Mapping MS Windows and Unix Groups
    Prev Part III. Advanced Configuration Next

    Chapter 12. Mapping MS Windows and Unix Groups

    Jean François Micouleau

    Gerald (Jerry) Carter

    Samba Team

    John H. Terpstra

    Samba Team

    Table of Contents

    Features and Benefits
    Discussion
    Example Configuration
    Configuration Scripts
    Sample smb.conf add group script
    Script to configure Group Mapping
    Common Errors
    Adding Groups Fails
    Adding MS Windows Groups to MS Windows Groups Fails

    + Starting with Samba-3, new group mapping functionality is available to create associations + between Windows group SIDs and UNIX groups. The groupmap subcommand + included with the net tool can be used to manage these associations. +

    Warning

    + The first immediate reason to use the group mapping on a Samba PDC, is that + the domain admin group has been removed and should no longer + be specified in smb.conf. This parameter was used to give the listed users membership + in the Domain Admins Windows group which gave local admin rights on their workstations + (in default configurations). +

    Features and Benefits

    + Samba allows the administrator to create MS Windows NT4 / 200x group accounts and to + arbitrarily associate them with Unix/Linux group accounts. +

    + Group accounts can be managed using the MS Windows NT4 or MS Windows 200x MMC tools + so long as appropriate interface scripts have been provided to smb.conf +

    + Administrators should be aware that where smb.conf group interface scripts make + direct calls to the Unix/Linux system tools (eg: the shadow utilities, groupadd, + groupdel, groupmod) then the resulting Unix/Linux group names will be subject + to any limits imposed by these tools. If the tool does NOT allow upper case characters + or space characters, then the creation of an MS Windows NT4 / 200x style group of + Engineering Managers will attempt to create an identically named + Unix/Linux group, an attempt that will of course fail! +

    + There are several possible work-arounds for the operating system tools limitation. One + method is to use a script that generates a name for the Unix/Linux system group that + fits the operating system limits, and that then just passes the Unix/Linux group id (GID) + back to the calling samba interface. This will provide a dynamic work-around solution. +

    + Another work-around is to manually create a Unix/Linux group, then manually create the + MS Windows NT4 / 200x group on the Samba server and then use the net groupmap + tool to connect the two to each other. +

    Discussion

    + When installing MS Windows NT4 / 200x on a computer, the installation + program creates default users and groups. Notably the Administrators group, + and gives to that group privileges necessary privilidges to perform essential system tasks. + eg: 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 inherits + 'Administrators' group privileges. If a 'joe' user is created to be a member of the + 'Administrator' group, 'joe' has exactly the same rights as 'Administrator'. +

    + When an MS Windows NT4 / W200x is made a domain member, the "Domain Adminis" group of the + PDC is added to the local 'Administrators' group of the workstation. Every member of the + 'Domain Administrators' group inherits the rights of the local 'Administrators' group when + logging on the workstation. +

    + The following steps describe how to make samba PDC users members of the 'Domain Admins' group? +

    1. + create a unix group (usually in /etc/group), let's call it domadm +

    2. add to this group the users that must be Administrators. For example + if you want joe,john and mary, your entry in /etc/group will + look like: + 

      +		domadm:x:502:joe,john,mary
+

      +

    3. + Map this domadm group to the "Domain Admins" group by running the command: +

      + 

      +		root# net groupmap add ntgroup="Domain Admins" unixgroup=domadm
+

      +

      + The quotes around "Domain Admins" are necessary due to the space in the group name. + Also make sure to leave no whitespace surrounding the equal character (=). +

    + Now joe, john and mary are domain administrators! +

    + It is possible to map any arbitrary UNIX group to any Windows NT4 / 200x group as well as + making any UNIX group a Windows domain group. For example, if you wanted to include a + UNIX group (e.g. acct) in a ACL on a local file or printer on a domain member machine, + you would flag that group as a domain group by running the following on the Samba PDC: +

    + 

    +	root# net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct
+

    +

    + Be aware that the RID parmeter is a unsigned 32 bit integer that should + normally start at 1000. However, this rid must not overlap with any RID assigned + to a user. Verifying this is done differently depending on on the passdb backend + you are using. Future versions of the tools may perform the verification automatically, + but for now the burden is on you. +

    Example Configuration

    + You can list the various groups in the mapping database by executing + net groupmap list. Here is an example: +

    + 

    +		root#  net groupmap list
+		System Administrators (S-1-5-21-2547222302-1596225915-2414751004-1002) -> sysadmin
+		Domain Admins (S-1-5-21-2547222302-1596225915-2414751004-512) -> domadmin
+		Domain Users (S-1-5-21-2547222302-1596225915-2414751004-513) -> domuser
+		Domain Guests (S-1-5-21-2547222302-1596225915-2414751004-514) -> domguest
+

    +

    + For complete details on net groupmap, refer to the net(8) man page. +

    Configuration Scripts

    + Everyone needs tools. Some of us like to create our own, others prefer to use canned tools + (ie: prepared by someone else for general use). +

    Sample smb.conf add group script

    + A script to great complying group names for use by the samba group interfaces: +

    +

    Example 12.1. smbgrpadd.sh

    +
+#!/bin/bash
+
+# Add the group using normal system groupadd tool.
+groupadd smbtmpgrp00
+
+thegid=`cat /etc/group | grep smbtmpgrp00 | cut -d ":" -f3`
+
+# Now change the name to what we want for the MS Windows networking end
+cat /etc/group | sed s/smbtmpgrp00/$1/g > /etc/group
+
+# Now return the GID as would normally happen.
+echo $thegid
+exit 0
+

    +

    + The smb.conf entry for the above script would look like: + 

    +		add group script = /path_to_tool/smbgrpadd.sh %g
+

    +

    Script to configure Group Mapping

    + In our example we have created a Unix/Linux group called ntadmin. + Our script will create the additional groups Engineers, Marketoids, Gnomes: +

    +

    +#!/bin/bash
+
+net groupmap modify ntgroup="Domain Admins" unixgroup=ntadmin
+net groupmap modify ntgroup="Domain Users" unixgroup=users
+net groupmap modify ntgroup="Domain Guests" unixgroup=nobody
+net groupmap modify ntgroup="Administrators" unixgroup=root
+net groupmap modify ntgroup="Users" unixgroup=users
+net groupmap modify ntgroup="Guests" unixgroup=nobody
+net groupmap modify ntgroup="System Operators" unixgroup=sys
+net groupmap modify ntgroup="Account Operators" unixgroup=root
+net groupmap modify ntgroup="Backup Operators" unixgroup=bin
+net groupmap modify ntgroup="Print Operators" unixgroup=lp
+net groupmap modify ntgroup="Replicators" unixgroup=daemon
+net groupmap modify ntgroup="Power Users" unixgroup=sys
+
+#groupadd Engineers
+#groupadd Marketoids
+#groupadd Gnomes
+
+#net groupmap add ntgroup="Engineers"  unixgroup=Engineers    type=d
+#net groupmap add ntgroup="Marketoids" unixgroup=Marketoids   type=d
+#net groupmap add ntgroup="Gnomes"     unixgroup=Gnomes       type=d
+

    +

    + Of course it is expected that the admininstrator will modify this to suit local needs. + For information regarding the use of the net groupmap tool please + refer to the man page. +

    Common Errors

    +At this time there are many little surprises for the unwary administrator. In a real sense +it is imperative that every step of automated control scripts must be carefully tested +manually before putting them into active service. +

    Adding Groups Fails

    + This is a common problem when the groupadd is called directly + by the samba interface script for the add group script in + the smb.conf file. +

    + The most common cause of failure is an attempt to add an MS Windows group acocunt + that has either an upper case character and/or a space character in it. +

    + There are three possible work-arounds. Firstly, use only group names that comply + with the limitations of the Unix/Linux groupadd system tool. + The second involves use of the script mentioned earlier in this chapter, and the + third option is to manually create a Unix/Linux group account that can substitute + for the MS Windows group name, then use the procedure listed above to map that group + to the MS Windows group. +

    Adding MS Windows Groups to MS Windows Groups Fails

    + Samba-3 does NOT support nested groups from the MS Windows control environment. +

    Prev Up Next
    Chapter 11. Account Information Databases Home Chapter 13. File, Directory and Share Access Controls
    diff --git a/docs/htmldocs/install.html b/docs/htmldocs/install.html index 0ba79dbe26..973b6083a8 100644 --- a/docs/htmldocs/install.html +++ b/docs/htmldocs/install.html @@ -1,896 +1,155 @@ - -How to Install and Test SAMBA
    SAMBA Project Documentation
    PrevNext

    Chapter 1. How to Install and Test SAMBA

    1.1. Read the man pages

    The man pages distributed with SAMBA contain - lots of useful info that will help to get you started. - If you don't know how to read man pages then try - something like:

    $ man smbd.8 - or - $ nroff -man smbd.8 | more - on older unixes.

    Other sources of information are pointed to - by the Samba web site, http://www.samba.org

    1.2. Building the Binaries

    To do this, first run the program ./configure - in the source directory. This should automatically - configure Samba for your operating system. If you have unusual - needs then you may wish to run

    root# ./configure --help -

    first to see what special options you can enable. - Then executing

    root# make

    will create the binaries. Once it's successfully - compiled you can use

    root# make install

    to install the binaries and manual pages. You can - separately install the binaries and/or man pages using

    root# make installbin -

    and

    root# make installman -

    Note that if you are upgrading for a previous version - of Samba you might like to know that the old versions of - the binaries will be renamed with a ".old" extension. You - can go back to the previous version with

    root# make revert -

    if you find this version a disaster!

    1.3. The all important step

    At this stage you must fetch yourself a - coffee or other drink you find stimulating. Getting the rest - of the install right can sometimes be tricky, so you will - probably need it.

    If you have installed samba before then you can skip - this step.

    1.4. Create the smb configuration file.

    There are sample configuration files in the examples - subdirectory in the distribution. I suggest you read them - carefully so you can see how the options go together in - practice. See the man page for all the options.

    The simplest useful configuration file would be - something like this:

    	[global]
-	   workgroup = MYGROUP
+Chapter 2. How to Install and Test SAMBA
    Chapter 2. How to Install and Test SAMBA
    Prev Part I. General Installation Next
    Chapter 2. How to Install and Test SAMBA
    Andrew Tridgell
    Samba Team
    Jelmer R. Vernooij
    The Samba Team
    John H. Terpstra
    Samba Team
    Karl Auer
    Table of Contents
    Obtaining and installing samba
    Configuring samba (smb.conf)
    Example Configuration
    SWAT
    Try listing the shares available on your 
+	server
    Try connecting with the unix client
    Try connecting from a DOS, WfWg, Win9x, WinNT, 
+	Win2k, OS/2, etc... client
    What If Things Don't Work?
    Common Errors
    Why are so many smbd processes eating memory?
    I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs
    Obtaining and installing samba
    
+	Binary packages of samba are included in almost any Linux or
+	Unix distribution. There are also some packages available at 
+	the samba homepage.
+	
    If you need to compile samba from source, check the 
+	appropriate appendix chapter.
    If you have already installed samba, or if your operating system
+	was pre-installed with samba, then you may not need to bother with this
+	chapter. On the other hand, you may want to read this chapter anyhow
+	for information about updating samba.
    Configuring samba (smb.conf)
    
+	Samba's configuration is stored in the smb.conf file, 
+	that usually resides in /etc/samba/smb.conf 
+	or /usr/local/samba/lib/smb.conf. You can either 
+	edit this file yourself or do it using one of the many graphical 
+	tools that are available, such as the web-based interface swat, that 
+	is included with samba.
+	
    Example Configuration
    
+	There are sample configuration files in the examples subdirectory in the
+	distribution. I suggest you read them carefully so you can see how the options
+	go together in practice. See the man page for all the options.
+	
    
+	The simplest useful configuration file would be something like this:
+	
    
+	
    +	[global]
+		workgroup = MYGROUP
 
-	   [homes]
-	      guest ok = no
-	      read only = no
-	
    which would allow connections by anyone with an 
-	account on the server, using either their login name or 
-	"homes" as the service name. (Note that I also set the 
-	workgroup that Samba is part of. See BROWSING.txt for details)
    Note that make install will not install 
-	a smb.conf file. You need to create it 
-	yourself. 
    Make sure you put the smb.conf file in the same place 
-	you specified in theMakefile (the default is to 
-	look for it in /usr/local/samba/lib/).
    For more information about security settings for the 
-	[homes] share please refer to the document UNIX_SECURITY.txt.
    1.6. Starting the smbd and nmbd
    You must choose to start smbd and nmbd either
-	as daemons or from inetd. Don't try
-	to do both!  Either you can put them in 	inetd.conf and have them started on demand
-	by inetd, or you can start them as
-	daemons either from the command line or in 	/etc/rc.local. See the man pages for details
-	on the command line options. Take particular care to read
-	the bit about what user you need to be in order to start
-	Samba.  In many cases you must be root.
    The main advantage of starting smbd
-	and nmbd using the recommended daemon method
-	is that they will respond slightly more quickly to an initial connection
-	request.
    1.6.1. Starting from inetd.conf
    NOTE; The following will be different if 
-		you use NIS or NIS+ to distributed services maps.
    Look at your /etc/services. 
-		What is defined at port 139/tcp. If nothing is defined 
-		then add a line like this:
    netbios-ssn     139/tcp
    similarly for 137/udp you should have an entry like:
    netbios-ns	137/udp
    Next edit your /etc/inetd.conf 
-		and add two lines something like this:
    		netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd 
-		netbios-ns dgram udp wait root /usr/local/samba/bin/nmbd nmbd 
-		
    The exact syntax of /etc/inetd.conf 
-		varies between unixes. Look at the other entries in inetd.conf 
-		for a guide.
    NOTE: Some unixes already have entries like netbios_ns 
-		(note the underscore) in /etc/services. 
-		You must either edit /etc/services or
-		/etc/inetd.conf to make them consistent.
    NOTE: On many systems you may need to use the 
-		"interfaces" option in smb.conf to specify the IP address 
-		and netmask of your interfaces. Run ifconfig 
-		as root if you don't know what the broadcast is for your
-		net. nmbd tries to determine it at run 
-		time, but fails on some unixes. See the section on "testing nmbd" 
-		for a method of finding if you need to do this.
    !!!WARNING!!! Many unixes only accept around 5 
-		parameters on the command line in inetd.conf. 
-		This means you shouldn't use spaces between the options and 
-		arguments, or you should use a script, and start the script 
-		from inetd.
    Restart inetd, perhaps just send 
-		it a HUP. If you have installed an earlier version of 		nmbd then you may need to kill nmbd as well.

    +

    + This will allow connections by anyone with an account on the server, using either + their login name or "homes" as the service name. + (Note that the workgroup that Samba must also be set.) +

    + Make sure you put the smb.conf file in the same place + you specified in theMakefile (the default is to + look for it in /usr/local/samba/lib/). +

    + For more information about security settings for the + [homes] share please refer to the chapter + Securing Samba. +

    Test your config file with testparm

    + It's important that you test the validity of your smb.conf + file using the testparm program. If testparm runs OK + then it will list the loaded services. If not it will give an error message. +

    + Make sure it runs OK and that the services look reasonable before proceeding. +

    + Always run testparm again when you change smb.conf! +

    SWAT

    + SWAT is a web-based interface that helps you configure samba. + SWAT might not be available in the samba package on your platform, + but in a separate package. Please read the swat manpage + on compiling, installing and configuring swat from source. +

    + To launch SWAT just run your favorite web browser and + point it at http://localhost:901/. Replace + localhost + with the name of the computer you are running samba on if you + are running samba on a different computer than your browser. +

    + Note that you can attach to SWAT from any IP connected + machine but connecting from a remote machine leaves your + connection open to password sniffing as passwords will be sent + in the clear over the wire. +

    Try listing the shares available on your + server

    $ smbclient -L + yourhostname

    You should get back a list of shares available on your server. If you don't then something is incorrectly setup. Note that this method can also be used to see what shares - are available on other LanManager clients (such as WfWg).

    If you choose user level security then you may find + are available on other LanManager clients (such as WfWg).

    If you choose user level security then you may find that Samba requests a password before it will list the shares. - See the smbclient man page for details. (you + See the smbclient man page for details. (you can force it to list the shares without a password by adding the option -U% to the command line. This will not work - with non-Samba servers)

    1.8. Try connecting with the unix client

    $ smbclient //yourhostname/aservice

    Typically the yourhostname - would be the name of the host where you installed smbd. The aservice is - any service you have defined in the smb.conf - file. Try your user name if you just have a [homes] section - in smb.conf.

    For example if your unix host is bambi and your login - name is fred you would type:

    $ smbclient //bambi/fred -

    1.9. Try connecting from a DOS, WfWg, Win9x, WinNT, - Win2k, OS/2, etc... client

    Try mounting disks. eg:

    C:\WINDOWS\> net use d: \\servername\service -

    Try printing. eg:

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

    C:\WINDOWS\> print filename -

    Celebrate, or send me a bug report!

    1.10. What If Things Don't Work?

    If nothing works and you start to think "who wrote - this pile of trash" then I suggest you do step 2 again (and - again) till you calm down.

    Then you might read the file DIAGNOSIS.txt and the - FAQ. If you are still stuck then try the mailing list or - newsgroup (look in the README for details). Samba has been - successfully installed at thousands of sites worldwide, so maybe - someone else has hit your problem and has overcome it. You could - also use the WWW site to scan back issues of the samba-digest.

    When you fix the problem PLEASE send me some updates to the - documentation (or source code) so that the next person will find it - easier.

    1.10.1. Diagnosing Problems

    If you have installation problems then go to the - Diagnosis chapter to try to find the - problem.

    1.10.2. Scope IDs

    By default Samba uses a blank scope ID. This means - all your windows boxes must also have a blank scope ID. - If you really want to use a non-blank scope ID then you will - need to use the 'netbios scope' smb.conf option. - All your PCs will need to have the same setting for - this to work. I do not recommend scope IDs.

    1.10.3. Choosing the Protocol Level

    The SMB protocol has many dialects. Currently - Samba supports 5, called CORE, COREPLUS, LANMAN1, - LANMAN2 and NT1.

    You can choose what maximum protocol to support - in the smb.conf file. The default is - NT1 and that is the best for the vast majority of sites.

    In older versions of Samba you may have found it - necessary to use COREPLUS. The limitations that led to - this have mostly been fixed. It is now less likely that you - will want to use less than LANMAN1. The only remaining advantage - of COREPLUS is that for some obscure reason WfWg preserves - the case of passwords in this protocol, whereas under LANMAN1, - LANMAN2 or NT1 it uppercases all passwords before sending them, - forcing you to use the "password level=" option in some cases.

    The main advantage of LANMAN2 and NT1 is support for - long filenames with some clients (eg: smbclient, Windows NT - or Win95).

    See the smb.conf(5) manual page for more details.

    Note: To support print queue reporting you may find - that you have to use TCP/IP as the default protocol under - WfWg. For some reason if you leave Netbeui as the default - it may break the print queue reporting on some systems. - It is presumably a WfWg bug.

    1.10.4. Printing from UNIX to a Client PC

    To use a printer that is available via a smb-based - server from a unix host with LPR you will need to compile the - smbclient program. You then need to install the script - "smbprint". Read the instruction in smbprint for more details. -

    There is also a SYSV style script that does much - the same thing called smbprint.sysv. It contains instructions.

    See the CUPS manual for information about setting up - printing from a unix host with CUPS to a smb-based server.

    1.10.5. Locking

    One area which sometimes causes trouble is locking.

    There are two types of locking which need to be - performed by a SMB server. The first is "record locking" - which allows a client to lock a range of bytes in a open file. - The second is the "deny modes" that are specified when a file - is open.

    Record locking semantics under Unix is very - different from record locking under Windows. Versions - of Samba before 2.2 have tried to use the native - fcntl() unix system call to implement proper record - locking between different Samba clients. This can not - be fully correct due to several reasons. The simplest - is the fact that a Windows client is allowed to lock a - byte range up to 2^32 or 2^64, depending on the client - OS. The unix locking only supports byte ranges up to - 2^31. So it is not possible to correctly satisfy a - lock request above 2^31. There are many more - differences, too many to be listed here.

    Samba 2.2 and above implements record locking - completely independent of the underlying unix - system. If a byte range lock that the client requests - happens to fall into the range 0-2^31, Samba hands - this request down to the Unix system. All other locks - can not be seen by unix anyway.

    Strictly a SMB server should check for locks before - every read and write call on a file. Unfortunately with the - way fcntl() works this can be slow and may overstress the - rpc.lockd. It is also almost always unnecessary as clients - are supposed to independently make locking calls before reads - and writes anyway if locking is important to them. By default - Samba only makes locking calls when explicitly asked - to by a client, but if you set "strict locking = yes" then it will - make lock checking calls on every read and write.

    You can also disable by range locking completely - using "locking = no". This is useful for those shares that - don't support locking or don't need it (such as cdroms). In - this case Samba fakes the return codes of locking calls to - tell clients that everything is OK.

    The second class of locking is the "deny modes". These - are set by an application when it opens a file to determine - what types of access should be allowed simultaneously with - its open. A client may ask for DENY_NONE, DENY_READ, DENY_WRITE - or DENY_ALL. There are also special compatibility modes called - DENY_FCB and DENY_DOS.

    1.10.6. Mapping Usernames

    If you have different usernames on the PCs and - the unix server then take a look at the "username map" option. - See the smb.conf man page for details.

    PrevHomeNext
    General installationUpImproved browsing in samba
    \ No newline at end of file + with non-Samba servers)

    Try connecting with the unix client

    $ smbclient + //yourhostname/aservice

    Typically the yourhostname + would be the name of the host where you installed smbd. + The aservice is + any service you have defined in the smb.conf + file. Try your user name if you just have a [homes] + section + in smb.conf.

    For example if your unix host is bambi + and your login name is fred you would type:

    $ smbclient //bambi/fred +

    Try connecting from a DOS, WfWg, Win9x, WinNT, + Win2k, OS/2, etc... client

    Try mounting disks. eg:

    C:\WINDOWS\> net use d: \\servername\service +

    Try printing. eg:

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

    C:\WINDOWS\> print filename +

    What If Things Don't Work?

    Then you might read the file chapter + Diagnosis and the + FAQ. If you are still stuck then try to follow + the Analysing and Solving Problems chapter + Samba has been successfully installed at thousands of sites worldwide, + so maybe someone else has hit your problem and has overcome it.

    Common Errors

    +The following questions and issues get raised on the samba mailing list over and over again. +

    Why are so many smbd processes eating memory?

    +“ +Site that is running Samba on an AIX box. They are sharing out about 2 terabytes using samba. +Samba was installed using smitty and the binaries. We seem to be experiencing a memory problem +with this box. When I do a svmon -Pu the monitoring program shows that smbd has several +processes of smbd running: +” +

    + “ +Is samba suppose to start this many different smbd processes? Or does it run as one smbd process? Also +is it normal for it to be taking up this much memory? +” +

    +

    +Inuse * 4096 = amount of memory being used by this process
+
+     Pid Command        Inuse      Pin     Pgsp  Virtual   64-bit    Mthrd
+   20950 smbd           33098     1906      181     5017        N        N
+   22262 smbd            9104     1906      5410
+   21060 smbd            9048     1906      181     5479        N        N
+   25972 smbd            8678     1906      181     5109        N        N
+   24524 smbd            8674     1906      181     5105        N        N
+   19262 smbd            8582     1906      181     5013        N        N
+   20722 smbd            8572     1906      181     5003        N        N
+   21454 smbd            8572     1906      181     5003        N        N
+   28946 smbd            8567     1906      181     4996        N        N
+   24076 smbd            8566     1906      181     4996        N        N
+   20138 smbd            8566     1906      181     4996        N        N
+   17608 smbd            8565     1906      181     4996        N        N
+   21820 smbd            8565     1906      181     4996        N        N
+   26940 smbd            8565     1906      181     4996        N        N
+   19884 smbd            8565     1906      181     4996        N        N
+    9912 smbd            8565     1906      181     4996        N        N
+   25800 smbd            8564     1906      181     4995        N        N
+   20452 smbd            8564     1906      181     4995        N        N
+   18592 smbd            8562     1906      181     4993        N        N
+   28216 smbd            8521     1906      181     4954        N        N
+   19110 smbd            8404     1906      181     4862        N        N
+
+   Total memory used:  841,592,832 bytes
+

    +

    +Samba consists on three core programs: +nmbd, smbd, winbindd. nmbd is the name server message daemon, +smbd is the server message daemon, winbindd is the daemon that +handles communication with Domain Controllers. +

    +If your system is NOT running as a WINS server, then there will be one (1) single instance of + nmbd running on your system. If it is running as a WINS server then there will be +two (2) instances - one to handle the WINS requests. +

    +smbd handles ALL connection requests and then spawns a new process for each client +connection made. That is why you are seeing so many of them, one (1) per client connection. +

    +winbindd will run as one or two daemons, depending on whether or not it is being +run in "split mode" (in which case there will be two instances). +

    I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs

    Your loopback device isn't working correctly. Make sure it's running.

    Prev Up Next
    Chapter 1. Introduction to Samba Home Chapter 3. FastStart for the Impatient
    diff --git a/docs/htmldocs/integrate-ms-networks.html b/docs/htmldocs/integrate-ms-networks.html index ad6aa9e225..f3038ce5a4 100644 --- a/docs/htmldocs/integrate-ms-networks.html +++ b/docs/htmldocs/integrate-ms-networks.html @@ -1,221 +1,62 @@ - -Integrating MS Windows networks with Samba
    SAMBA Project Documentation
    PrevNext

    Chapter 10. Integrating MS Windows networks with Samba

    10.1. Agenda

    To identify the key functional mechanisms of MS Windows networking -to enable the deployment of Samba as a means of extending and/or -replacing MS Windows NT/2000 technology.

    We will examine:

    1. Name resolution in a pure Unix/Linux TCP/IP - environment -

    2. Name resolution as used within MS Windows - networking -

    3. How browsing functions and how to deploy stable - and dependable browsing using Samba -

    4. MS Windows security options and how to - configure Samba for seemless integration -

    5. Configuration of Samba as:

      1. A stand-alone server

      2. An MS Windows NT 3.x/4.0 security domain member -

      3. An alternative to an MS Windows NT 3.x/4.0 Domain Controller -

    10.2. Name Resolution in a pure Unix/Linux world

    The key configuration files covered in this section are:

    10.2.1. /etc/hosts

    Contains a static list of IP Addresses and names. -eg:

    	127.0.0.1	localhost localhost.localdomain
-	192.168.1.1	bigbox.caldera.com	bigbox	alias4box

    The purpose of /etc/hosts is to provide a +Chapter 26. Integrating MS Windows networks with Samba

    Chapter 26. Integrating MS Windows networks with Samba
    Prev Part III. Advanced Configuration Next

    Chapter 26. Integrating MS Windows networks with Samba

    John H. Terpstra

    Samba Team

    (Jan 01 2001)

    Table of Contents

    Features and Benefits
    Background Information
    Name Resolution in a pure Unix/Linux world
    /etc/hosts
    /etc/resolv.conf
    /etc/host.conf
    /etc/nsswitch.conf
    Name resolution as used within MS Windows networking
    The NetBIOS Name Cache
    The LMHOSTS file
    HOSTS file
    DNS Lookup
    WINS Lookup
    Common Errors
    My Boomerang Won't Come Back
    Very Slow Network Connections
    Samba server name change problem

    +This section deals with NetBIOS over TCP/IP name to IP address resolution. If +your MS Windows clients are NOT configured to use NetBIOS over TCP/IP then this +section does not apply to your installation. If your installation involves use of +NetBIOS over TCP/IP then this section may help you to resolve networking problems. +

    Note

    + NetBIOS over TCP/IP has nothing to do with NetBEUI. NetBEUI is NetBIOS + over Logical Link Control (LLC). On modern networks it is highly advised + to NOT run NetBEUI at all. Note also that there is NO such thing as + NetBEUI over TCP/IP - the existence of such a protocol is a complete + and utter mis-apprehension. +

    Features and Benefits

    +Many MS Windows network administrators have never been exposed to basic TCP/IP +networking as it is implemented in a Unix/Linux operating system. Likewise, many Unix and +Linux adminsitrators have not been exposed to the intricacies of MS Windows TCP/IP based +networking (and may have no desire to be either). +

    +This chapter gives a short introduction to the basics of how a name can be resolved to +it's IP address for each operating system environment. +

    Background Information

    +Since the introduction of MS Windows 2000 it is possible to run MS Windows networking +without the use of NetBIOS over TCP/IP. NetBIOS over TCP/IP uses UDP port 137 for NetBIOS +name resolution and uses TCP port 139 for NetBIOS session services. When NetBIOS over +TCP/IP is disabled on MS Windows 2000 and later clients then only TCP port 445 will be +used and UDP port 137 and TCP port 139 will not. +

    Note

    +When using Windows 2000 or later clients, if NetBIOS over TCP/IP is NOT disabled, then +the client will use UDP port 137 (NetBIOS Name Service, also known as the Windows Internet +Name Service or WINS), TCP port 139 AND TCP port 445 (for actual file and print traffic). +

    +When NetBIOS over TCP/IP is disabled the use of DNS is essential. Most installations that +disable NetBIOS over TCP/IP today use MS Active Directory Service (ADS). ADS requires +Dynamic DNS with Service Resource Records (SRV RR) and with Incremental Zone Transfers (IXFR). +Use of DHCP with ADS is recommended as a further means of maintaining central control +over client workstation network configuration. +

    Name Resolution in a pure Unix/Linux world

    +The key configuration files covered in this section are: +

    • /etc/hosts

    • /etc/resolv.conf

    • /etc/host.conf

    • /etc/nsswitch.conf

    /etc/hosts

    +Contains a static list of IP Addresses and names. +eg: +

    +	127.0.0.1	localhost localhost.localdomain
+	192.168.1.1	bigbox.caldera.com	bigbox	alias4box
+

    +The purpose of /etc/hosts is to provide a name resolution mechanism so that uses do not need to remember -IP addresses.

    Network packets that are sent over the physical network transport +IP addresses. +

    +Network packets that are sent over the physical network transport layer communicate not via IP addresses but rather using the Media Access Control address, or MAC address. IP Addresses are currently 32 bits in length and are typically presented as four (4) decimal -numbers that are separated by a dot (or period). eg: 168.192.1.1

    MAC Addresses use 48 bits (or 6 bytes) and are typically represented +numbers that are separated by a dot (or period). eg: 168.192.1.1. +

    +MAC Addresses use 48 bits (or 6 bytes) and are typically represented as two digit hexadecimal numbers separated by colons. eg: -40:8e:0a:12:34:56

    Every network interfrace must have an MAC address. Associated with +40:8e:0a:12:34:56 +

    +Every network interface must have an MAC address. Associated with a MAC address there may be one or more IP addresses. There is NO relationship between an IP address and a MAC address, all such assignments are arbitary or discretionary in nature. At the most basic level all @@ -224,18 +65,15 @@ addresses must be globally unique, and generally remains fixed for any particular interface, the assignment of an IP address makes sense from a network management perspective. More than one IP address can be assigned per MAC address. One address must be the primary IP address, -this is the address that will be returned in the ARP reply.

    When a user or a process wants to communicate with another machine -the protocol implementation ensures that the "machine name" or "host -name" is resolved to an IP address in a manner that is controlled +this is the address that will be returned in the ARP reply. +

    +When a user or a process wants to communicate with another machine +the protocol implementation ensures that the "machine name" or "host +name" is resolved to an IP address in a manner that is controlled by the TCP/IP configuration control files. The file -/etc/hosts is one such file.

    When the IP address of the destination interface has been +/etc/hosts is one such file. +

    +When the IP address of the destination interface has been determined a protocol called ARP/RARP is used to identify the MAC address of the target interface. ARP stands for Address Resolution Protocol, and is a broadcast oriented method that @@ -245,98 +83,41 @@ address. Network interfaces are programmed to respond to two MAC addresses only; their own unique address and the address ff:ff:ff:ff:ff:ff. The reply packet from an ARP request will contain the MAC address and the primary IP address for each -interface.

    The /etc/hosts file is foundational to all +interface. +

    +The /etc/hosts file is foundational to all Unix/Linux TCP/IP installations and as a minumum will contain the localhost and local network interface IP addresses and the primary names by which they are known within the local machine. This file helps to prime the pump so that a basic level of name resolution can exist before any other method of name resolution -becomes available.

    /etc/resolv.conf

    +This file tells the name resolution libraries: +

    • The name of the domain to which the machine belongs -

    • The name(s) of any domains that should be +

    • The name(s) of any domains that should be automatically searched when trying to resolve unqualified host names to their IP address -

    • The name or IP address of available Domain +

    • The name or IP address of available Domain Name Servers that may be asked to perform name to address translation lookups -

    /etc/host.conf

    +/etc/host.conf is the primary means by which the setting in /etc/resolv.conf may be affected. It is a critical configuration file. This file controls the order by -which name resolution may procede. The typical structure is:

    	order hosts,bind
-	multi on

    then both addresses should be returned. Please refer to the -man page for host.conf for further details.

    /etc/nsswitch.conf

    +This file controls the actual name resolution targets. The +file typically has resolver object specifications as follows: +

    +	# /etc/nsswitch.conf
 	#
 	# Name Service Switch configuration file.
 	#
@@ -355,99 +136,75 @@ CLASS="PROGRAMLISTING"
 	ethers:		nis files
 	protocols:	nis files
 	rpc:		nis files
-	services:	nis files

    Of course, each of these mechanisms requires that the appropriate -facilities and/or services are correctly configured.

    It should be noted that unless a network request/message must be + services: nis files +

    +Of course, each of these mechanisms requires that the appropriate +facilities and/or services are correctly configured. +

    +It should be noted that unless a network request/message must be sent, TCP/IP networks are silent. All TCP/IP communications assumes a -principal of speaking only when necessary.

    Starting with version 2.2.0 samba has Linux support for extensions to +principal of speaking only when necessary. +

    +Starting with version 2.2.0 samba has Linux support for extensions to the name service switch infrastructure so that linux clients will be able to obtain resolution of MS Windows NetBIOS names to IP Addresses. To gain this functionality Samba needs to be compiled -with appropriate arguments to the make command (ie: make -nsswitch/libnss_wins.so). The resulting library should -then be installed in the /lib directory and -the "wins" parameter needs to be added to the "hosts:" line in -the /etc/nsswitch.conf file. At this point it +with appropriate arguments to the make command (ie: make +nsswitch/libnss_wins.so). The resulting library should +then be installed in the /lib directory and +the "wins" parameter needs to be added to the "hosts:" line in +the /etc/nsswitch.conf file. At this point it will be possible to ping any MS Windows machine by it's NetBIOS machine name, so long as that machine is within the workgroup to -which both the samba machine and the MS Windows machine belong.

    Name resolution as used within MS Windows networking

    +MS Windows networking is predicated about the name each machine is given. This name is known variously (and inconsistently) as -the "computer name", "machine name", "networking name", "netbios name", -"SMB name". All terms mean the same thing with the exception of -"netbios name" which can apply also to the name of the workgroup or the -domain name. The terms "workgroup" and "domain" are really just a +the "computer name", "machine name", "networking name", "netbios name", +"SMB name". All terms mean the same thing with the exception of +"netbios name" which can apply also to the name of the workgroup or the +domain name. The terms "workgroup" and "domain" are really just a simply name with which the machine is associated. All NetBIOS names are exactly 16 characters in length. The 16th character is reserved. It is used to store a one byte value that indicates service level information for the NetBIOS name that is registered. A NetBIOS machine name is therefore registered for each service type that is provided by -the client/server.

    The following are typical NetBIOS name/service type registrations:

    	Unique NetBIOS Names:
-		MACHINENAME<00>	= Server Service is running on MACHINENAME
-		MACHINENAME<03> = Generic Machine Name (NetBIOS name)
-		MACHINENAME<20> = LanMan Server service is running on MACHINENAME
-		WORKGROUP<1b> = Domain Master Browser
+the client/server.
+
    
+The following are typical NetBIOS name/service type registrations:
+
    +	Unique NetBIOS Names:
+		MACHINENAME<00>	= Server Service is running on MACHINENAME
+		MACHINENAME<03> = Generic Machine Name (NetBIOS name)
+		MACHINENAME<20> = LanMan Server service is running on MACHINENAME
+		WORKGROUP<1b> = Domain Master Browser
 
 	Group Names:
-		WORKGROUP<03> = Generic Name registered by all members of WORKGROUP
-		WORKGROUP<1c> = Domain Controllers / Netlogon Servers
-		WORKGROUP<1d> = Local Master Browsers
-		WORKGROUP<1e> = Internet Name Resolvers
    It should be noted that all NetBIOS machines register their own 
+		WORKGROUP<03> = Generic Name registered by all members of WORKGROUP
+		WORKGROUP<1c> = Domain Controllers / Netlogon Servers
+		WORKGROUP<1d> = Local Master Browsers
+		WORKGROUP<1e> = Internet Name Resolvers
+

    +It should be noted that all NetBIOS machines register their own names as per the above. This is in vast contrast to TCP/IP installations where traditionally the system administrator will determine in the /etc/hosts or in the DNS database what names -are associated with each IP address.

    One further point of clarification should be noted, the /etc/hosts +are associated with each IP address. +

    +One further point of clarification should be noted, the /etc/hosts file and the DNS records do not provide the NetBIOS name type information that MS Windows clients depend on to locate the type of service that may be needed. An example of this is what happens when an MS Windows client -wants to locate a domain logon server. It find this service and the IP +wants to locate a domain logon server. It finds this service and the IP address of a server that provides it by performing a lookup (via a NetBIOS broadcast) for enumeration of all machines that have -registered the name type *<1c>. A logon request is then sent to each +registered the name type *<1c>. A logon request is then sent to each IP address that is returned in the enumerated list of IP addresses. Which -ever machine first replies then ends up providing the logon services.

    The name "workgroup" or "domain" really can be confusing since these +ever machine first replies then ends up providing the logon services. +

    +The name "workgroup" or "domain" really can be confusing since these have the added significance of indicating what is the security -architecture of the MS Windows network. The term "workgroup" indicates +architecture of the MS Windows network. The term "workgroup" indicates that the primary nature of the network environment is that of a peer-to-peer design. In a WORKGROUP all machines are responsible for their own security, and generally such security is limited to use of @@ -455,9 +212,9 @@ just a password (known as SHARE MODE security). In most situations with peer-to-peer networking the users who control their own machines will simply opt to have no security at all. It is possible to have USER MODE security in a WORKGROUP environment, thus requiring use -of a user name and a matching password.

    MS Windows networking is thus predetermined to use machine names +of a user name and a matching password. +

    +MS Windows networking is thus predetermined to use machine names for all local and remote machine message passing. The protocol used is called Server Message Block (SMB) and this is implemented using the NetBIOS protocol (Network Basic Input Output System). NetBIOS can @@ -466,60 +223,39 @@ the resulting protocol is called NetBEUI (Network Basic Extended User Interface). NetBIOS can also be run over IPX (Internetworking Packet Exchange) protocol as used by Novell NetWare, and it can be run over TCP/IP protocols - in which case the resulting protocol is called -NBT or NetBT, the NetBIOS over TCP/IP.

    MS Windows machines use a complex array of name resolution mechanisms. +NBT or NetBT, the NetBIOS over TCP/IP. +

    +MS Windows machines use a complex array of name resolution mechanisms. Since we are primarily concerned with TCP/IP this demonstration is -limited to this area.

    10.3.1. The NetBIOS Name Cache

    All MS Windows machines employ an in memory buffer in which is +limited to this area. +

    The NetBIOS Name Cache

    +All MS Windows machines employ an in memory buffer in which is stored the NetBIOS names and IP addresses for all external machines that that machine has communicated with over the past 10-15 minutes. It is more efficient to obtain an IP address for a machine from the local cache than it is to go through all the -configured name resolution mechanisms.

    If a machine whose name is in the local name cache has been shut +configured name resolution mechanisms. +

    +If a machine whose name is in the local name cache has been shut down before the name had been expired and flushed from the cache, then an attempt to exchange a message with that machine will be subject to time-out delays. i.e.: Its name is in the cache, so a name resolution lookup will succeed, but the machine can not respond. This can be -frustrating for users - but it is a characteristic of the protocol.

    The MS Windows utility that allows examination of the NetBIOS -name cache is called "nbtstat". The Samba equivalent of this -is called "nmblookup".

    The LMHOSTS file

    +This file is usually located in MS Windows NT 4.0 or +2000 in C:\WINNT\SYSTEM32\DRIVERS\ETC and contains the IP Address and the machine name in matched pairs. The -LMHOSTS file performs NetBIOS name -to IP address mapping oriented.

    It typically looks like:

    	# Copyright (c) 1998 Microsoft Corp.
+LMHOSTS file performs NetBIOS name 
+to IP address mapping.
+
    
+It typically looks like:
+
    +	# Copyright (c) 1998 Microsoft Corp.
 	#
 	# This is a sample LMHOSTS file used by the Microsoft Wins Client (NetBIOS
 	# over TCP/IP) stack for Windows98
@@ -528,7 +264,7 @@ CLASS="PROGRAMLISTING"
 	# (NetBIOS) names.  Each entry should be kept on an individual line.
 	# The IP address should be placed in the first column followed by the
 	# corresponding computername. The address and the comptername
-	# should be separated by at least one space or tab. The "#" character
+	# should be separated by at least one space or tab. The "#" character
 	# is generally used to denote the start of a comment (see the exceptions
 	# below).
 	#
@@ -542,28 +278,28 @@ CLASS="PROGRAMLISTING"
 	#      #END_ALTERNATE
 	#      \0xnn (non-printing character support)
 	#
-	# Following any entry in the file with the characters "#PRE" will cause
+	# Following any entry in the file with the characters "#PRE" will cause
 	# the entry to be preloaded into the name cache. By default, entries are
 	# not preloaded, but are parsed only after dynamic name resolution fails.
 	#
-	# Following an entry with the "#DOM:<domain>" tag will associate the
+	# Following an entry with the "#DOM:<domain>" tag will associate the
 	# entry with the domain specified by <domain>. This affects how the
 	# browser and logon services behave in TCP/IP environments. To preload
 	# the host name associated with #DOM entry, it is necessary to also add a
 	# #PRE to the line. The <domain> is always preloaded although it will not
 	# be shown when the name cache is viewed.
 	#
-	# Specifying "#INCLUDE <filename>" will force the RFC NetBIOS (NBT)
+	# Specifying "#INCLUDE <filename>" will force the RFC NetBIOS (NBT)
 	# software to seek the specified <filename> and parse it as if it were
 	# local. <filename> is generally a UNC-based name, allowing a
 	# centralized lmhosts file to be maintained on a server.
 	# It is ALWAYS necessary to provide a mapping for the IP address of the
 	# server prior to the #INCLUDE. This mapping must use the #PRE directive.
-	# In addtion the share "public" in the example below must be in the
-	# LanManServer list of "NullSessionShares" in order for client machines to
+	# In addtion the share "public" in the example below must be in the
+	# LanManServer list of "NullSessionShares" in order for client machines to
 	# be able to read the lmhosts file successfully. This key is under
 	# \machine\system\currentcontrolset\services\lanmanserver\parameters\nullsessionshares
-	# in the registry. Simply add "public" to the list found there.
+	# in the registry. Simply add "public" to the list found there.
 	#
 	# The #BEGIN_ and #END_ALTERNATE keywords allow multiple #INCLUDE
 	# statements to be grouped together. Any single successful include
@@ -576,7 +312,7 @@ CLASS="PROGRAMLISTING"
 	# The following example illustrates all of these extensions:
 	#
 	# 102.54.94.97     rhino         #PRE #DOM:networking  #net group's DC
-	# 102.54.94.102    "appname  \0x14"                    #special app server
+	# 102.54.94.102    "appname  \0x14"                    #special app server
 	# 102.54.94.123    popular            #PRE             #source server
 	# 102.54.94.117    localsrv           #PRE             #needed for the include
 	#
@@ -585,564 +321,107 @@ CLASS="PROGRAMLISTING"
 	# #INCLUDE \\rhino\public\lmhosts
 	# #END_ALTERNATE
 	#
-	# In the above example, the "appname" server contains a special
-	# character in its name, the "popular" and "localsrv" server names are
-	# preloaded, and the "rhino" server name is specified so it can be used
-	# to later #INCLUDE a centrally maintained lmhosts file if the "localsrv"
+	# In the above example, the "appname" server contains a special
+	# character in its name, the "popular" and "localsrv" server names are
+	# preloaded, and the "rhino" server name is specified so it can be used
+	# to later #INCLUDE a centrally maintained lmhosts file if the "localsrv"
 	# system is unavailable.
 	#
 	# Note that the whole file is parsed including comments on each lookup,
 	# so keeping the number of comments to a minimum will improve performance.
 	# Therefore it is not advisable to simply add lmhosts file entries onto the
-	# end of this file.

    HOSTS file

    +This file is usually located in MS Windows NT 4.0 or 2000 in +C:\WINNT\SYSTEM32\DRIVERS\ETC and contains the IP Address and the IP hostname in matched pairs. It can be used by the name resolution infrastructure in MS Windows, depending on how the TCP/IP environment is configured. This file is in -every way the equivalent of the Unix/Linux /etc/hosts file.

    DNS Lookup

    +This capability is configured in the TCP/IP setup area in the network configuration facility. If enabled an elaborate name resolution sequence -is followed the precise nature of which isdependant on what the NetBIOS +is followed the precise nature of which is dependant on what the NetBIOS Node Type parameter is configured to. A Node Type of 0 means use NetBIOS broadcast (over UDP broadcast) is first used if the name that is the subject of a name lookup is not found in the NetBIOS name cache. If that fails then DNS, HOSTS and LMHOSTS are checked. If set to Node Type 8, then a NetBIOS Unicast (over UDP Unicast) is sent to the WINS Server to obtain a lookup before DNS, HOSTS, LMHOSTS, or broadcast -lookup is used.

    WINS Lookup

    +A WINS (Windows Internet Name Server) service is the equivaent of the rfc1001/1002 specified NBNS (NetBIOS Name Server). A WINS server stores the names and IP addresses that are registered by a Windows client -if the TCP/IP setup has been given at least one WINS Server IP Address.

    To configure Samba to be a WINS server the following parameter needs -to be added to the smb.conf file:

    	wins support = Yes

    To configure Samba to use a WINS server the following parameters are -needed in the smb.conf file:

    	wins support = No
-	wins server = xxx.xxx.xxx.xxx

    where xxx.xxx.xxx.xxx is the IP address -of the WINS server.

    10.4. How browsing functions and how to deploy stable and -dependable browsing using Samba

    As stated above, MS Windows machines register their NetBIOS names -(i.e.: the machine name for each service type in operation) on start -up. Also, as stated above, the exact method by which this name registration -takes place is determined by whether or not the MS Windows client/server -has been given a WINS server address, whether or not LMHOSTS lookup -is enabled, or if DNS for NetBIOS name resolution is enabled, etc.

    In the case where there is no WINS server all name registrations as -well as name lookups are done by UDP broadcast. This isolates name -resolution to the local subnet, unless LMHOSTS is used to list all -names and IP addresses. In such situations Samba provides a means by -which the samba server name may be forcibly injected into the browse -list of a remote MS Windows network (using the "remote announce" parameter).

    Where a WINS server is used, the MS Windows client will use UDP -unicast to register with the WINS server. Such packets can be routed -and thus WINS allows name resolution to function across routed networks.

    During the startup process an election will take place to create a -local master browser if one does not already exist. On each NetBIOS network -one machine will be elected to function as the domain master browser. This -domain browsing has nothing to do with MS security domain control. -Instead, the domain master browser serves the role of contacting each local -master browser (found by asking WINS or from LMHOSTS) and exchanging browse -list contents. This way every master browser will eventually obtain a complete -list of all machines that are on the network. Every 11-15 minutes an election -is held to determine which machine will be the master browser. By the nature of -the election criteria used, the machine with the highest uptime, or the -most senior protocol version, or other criteria, will win the election -as domain master browser.

    Clients wishing to browse the network make use of this list, but also depend -on the availability of correct name resolution to the respective IP -address/addresses.

    Any configuration that breaks name resolution and/or browsing intrinsics -will annoy users because they will have to put up with protracted -inability to use the network services.

    Samba supports a feature that allows forced synchonisation -of browse lists across routed networks using the "remote -browse sync" parameter in the smb.conf file. This causes Samba -to contact the local master browser on a remote network and -to request browse list synchronisation. This effectively bridges -two networks that are separated by routers. The two remote -networks may use either broadcast based name resolution or WINS -based name resolution, but it should be noted that the "remote -browse sync" parameter provides browse list synchronisation - and -that is distinct from name to address resolution, in other -words, for cross subnet browsing to function correctly it is -essential that a name to address resolution mechanism be provided. -This mechanism could be via DNS, /etc/hosts, -and so on.

    10.5. MS Windows security options and how to configure -Samba for seemless integration

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

    When encrypted passwords are used a password that has been -entered by the user is encrypted in two ways:

    You should refer to the Password Encryption chapter in this HOWTO collection -for more details on the inner workings

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

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

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

    The following parameters can be used to work around the -issue of Windows 9x client upper casing usernames and -password before transmitting them to the SMB server -when using clear text authentication.

    	passsword level = integer
-	username level = integer

    By default Samba will lower case the username before attempting -to lookup the user in the database of local system accounts. -Because UNIX usernames conventionally only contain lower case -character, the username level parameter -is rarely even needed.

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

    The best option to adopt is to enable support for encrypted passwords -where ever Samba is used. There are three configuration possibilities -for support of encrypted passwords:

    10.5.1. Use MS Windows NT as an authentication server

    This method involves the additions of the following parameters -in the smb.conf file:

    	encrypt passwords = Yes
-	security = server
-	password server = "NetBIOS_name_of_PDC"

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

    The down-side of this mode of configuration is the fact that -for security reasons Samba will send the password server a bogus -username and a bogus password and if the remote server fails to -reject the username and password pair then an alternative mode -of identification of validation is used. Where a site uses password -lock out after a certain number of failed authentication attempts -this will result in user lockouts.

    Use of this mode of authentication does require there to be -a standard Unix account for the user, this account can be blocked -to prevent logons by other than MS Windows clients.

    10.5.2. Make Samba a member of an MS Windows NT security domain

    This method involves additon of the following paramters in the smb.conf file:

    	encrypt passwords = Yes
-	security = domain
-	workgroup = "name of NT domain"
-	password server = *

    The use of the "*" argument to "password server" will cause samba -to locate the domain controller in a way analogous to the way -this is done within MS Windows NT.

    In order for this method to work the Samba server needs to join the -MS Windows NT security domain. This is done as follows:

    Use of this mode of authentication does require there to be -a standard Unix account for the user in order to assign -a uid once the account has been authenticated by the remote -Windows DC. This account can be blocked to prevent logons by -other than MS Windows clients by things such as setting an invalid -shell in the /etc/passwd entry.

    An alternative to assigning UIDs to Windows users on a -Samba member server is presented in the Winbind Overview chapter in -this HOWTO collection.

    10.5.3. Configure Samba as an authentication server

    This mode of authentication demands that there be on the -Unix/Linux system both a Unix style account as well as an -smbpasswd entry for the user. The Unix system account can be -locked if required as only the encrypted password will be -used for SMB client authentication.

    This method involves addition of the following parameters to -the smb.conf file:

    ## please refer to the Samba PDC HOWTO chapter later in 
-## this collection for more details
-[global]
-	encrypt passwords = Yes
-	security = user
-	domain logons = Yes
-	; an OS level of 33 or more is recommended
-	os level = 33
+if the TCP/IP setup has been given at least one WINS Server IP Address.
+
    
+To configure Samba to be a WINS server the following parameter needs 
+to be added to the smb.conf file:
+
    +	wins support = Yes
+
    
+To configure Samba to use a WINS server the following parameters are 
+needed in the smb.conf file:
+
    +	wins support = No
+	wins server = xxx.xxx.xxx.xxx
+
    
+where xxx.xxx.xxx.xxx is the IP address 
+of the WINS server.
+

    Common Errors

    +TCP/IP network configuration problems find every network administrator sooner or later. +The cause can be anything from keybaord mishaps, forgetfulness, simple mistakes, and +carelessness. Of course, noone is every deliberately careless! +

    My Boomerang Won't Come Back

    + Well, the real complaint said, "I can ping my samba server from Windows, but I can + not ping my Windows machine from the samba server." +

    + The Windows machine was at IP Address 192.168.1.2 with netmask 255.255.255.0, the + Samba server (Linux) was at IP Address 192.168.1.130 with netmast 255.255.255.128. + The machines were on a local network with no external connections. +

    + Due to inconsistent netmasks, the Windows machine was on network 192.168.1.0/24, while + the Samba server was on network 192.168.1.128/25 - logically a different network. +

    Very Slow Network Connections

    + A common causes of slow network response includes: +

    • Client is configured to use DNS and DNS server is down

    • Client is configured to use remote DNS server, but remote connection is down

    • Client is configured to use a WINS server, but there is no WINS server

    • Client is NOT configured to use a WINS server, but there is a WINS server

    • Firewall is filtering our DNS or WINS traffic

    Samba server name change problem

    + The name of the samba server was changed, samba was restarted, samba server can not be + pinged by new name from MS Windows NT4 Workstation, but it does still respond to ping using + the old name. Why? +

    + From this description three (3) things are rather obvious: +

    • WINS is NOT in use, only broadcast based name resolution is used

    • The samba server was renamed and restarted within the last 10-15 minutes

    • The old samba server name is still in the NetBIOS name cache on the MS Windows NT4 Workstation

    + To find what names are present in the NetBIOS name cache on the MS Windows NT4 machine, + open a cmd shell, then: +

    + 

    +	C:\temp\>nbtstat -n
 
-[NETLOGON]
-	path = /somewhare/in/file/system
-	read only = yes

    in order for this method to work a Unix system account needs -to be created for each user, as well as for each MS Windows NT/2000 -machine. The following structure is required.

    PrevHomeNext
    Optional configurationUpUNIX Permission Bits and Windows NT Access Control Lists
    \ No newline at end of file + NetBIOS Local Name Table + + Name Type Status + ------------------------------------------------ + SLACK <03> UNIQUE Registered + ADMININSTRATOR <03> UNIQUE Registered + SLACK <00> UNIQUE Registered + SARDON <00> GROUP Registered + SLACK <20> UNIQUE Registered + SLACK <1F> UNIQUE Registered + + + C:\Temp\>nbtstat -c + + NetBIOS Remote Cache Name Table + + Name Type Host Address Life [sec] + -------------------------------------------------------------- + FRODO <20> UNIQUE 192.168.1.1 240 + + C:\Temp\> +

    +

    + In the above example, FRODO is the Samba server and SLACK is the MS Windows NT4 Workstation. + The first listing shows the contents of the Local Name Table (ie: Identity information on + the MS Windows workstation), the second shows the NetBIOS name in the NetBIOS name cache. + The name cache contains the remote machines known to this workstation. +

    Prev Up Next
    Chapter 25. PAM based Distributed Authentication Home Chapter 27. Unicode/Charsets
    diff --git a/docs/htmldocs/introduction.html b/docs/htmldocs/introduction.html index 762d56ba6a..b4e1765f2d 100644 --- a/docs/htmldocs/introduction.html +++ b/docs/htmldocs/introduction.html @@ -1,421 +1,5 @@ - -General installation
    SAMBA Project Documentation
    PrevNext

    I. General installation

    Introduction

    This part contains general info on how to install samba +Part I. General Installation

    Part I. General Installation
    Prev   Next

    General Installation

    Preparing Samba for Configuration

    This section of the Samba-HOWTO-Collection contains general info on how to install samba and how to configure the parts of samba you will most likely need. -PLEASE read this.

    Table of Contents
    1. How to Install and Test SAMBA
    1.1. Read the man pages
    1.2. Building the Binaries
    1.3. The all important step
    1.4. Create the smb configuration file.
    1.5. Test your config file with - testparm
    1.6. Starting the smbd and nmbd
    1.6.1. Starting from inetd.conf
    1.6.2. Alternative: starting it as a daemon
    1.7. Try listing the shares available on your - server
    1.8. Try connecting with the unix client
    1.9. Try connecting from a DOS, WfWg, Win9x, WinNT, - Win2k, OS/2, etc... client
    1.10. What If Things Don't Work?
    1.10.1. Diagnosing Problems
    1.10.2. Scope IDs
    1.10.3. Choosing the Protocol Level
    1.10.4. Printing from UNIX to a Client PC
    1.10.5. Locking
    1.10.6. Mapping Usernames
    2. Improved browsing in samba
    2.1. Overview of browsing
    2.2. Browsing support in samba
    2.3. Problem resolution
    2.4. Browsing across subnets
    2.4.1. How does cross subnet browsing work ?
    2.5. Setting up a WINS server
    2.6. Setting up Browsing in a WORKGROUP
    2.7. Setting up Browsing in a DOMAIN
    2.8. Forcing samba to be the master
    2.9. Making samba the domain master
    2.10. Note about broadcast addresses
    2.11. Multiple interfaces
    3. Quick Cross Subnet Browsing / Cross Workgroup Browsing guide
    3.1. Discussion
    3.2. Use of the "Remote Announce" parameter
    3.3. Use of the "Remote Browse Sync" parameter
    3.4. Use of WINS
    3.5. Do NOT use more than one (1) protocol on MS Windows machines
    3.6. Name Resolution Order
    4. LanMan and NT Password Encryption in Samba
    4.1. Introduction
    4.2. Important Notes About Security
    4.2.1. Advantages of SMB Encryption
    4.2.2. Advantages of non-encrypted passwords
    4.3. The smbpasswd Command
    PrevHomeNext
    SAMBA Project Documentation How to Install and Test SAMBA
    \ No newline at end of file +PLEASE read this.

    Table of Contents

    1. Introduction to Samba
    Background
    Terminology
    Related Projects
    SMB Methodology
    Epilogue
    Miscellaneous
    2. How to Install and Test SAMBA
    Obtaining and installing samba
    Configuring samba (smb.conf)
    Example Configuration
    SWAT
    Try listing the shares available on your + server
    Try connecting with the unix client
    Try connecting from a DOS, WfWg, Win9x, WinNT, + Win2k, OS/2, etc... client
    What If Things Don't Work?
    Common Errors
    Why are so many smbd processes eating memory?
    I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs
    3. FastStart for the Impatient
    Note
    Prev Up Next
    SAMBA Project Documentation Home Chapter 1. Introduction to Samba
    diff --git a/docs/htmldocs/lmhosts.5.html b/docs/htmldocs/lmhosts.5.html index 4d7f11e64b..b96ddf8ddb 100644 --- a/docs/htmldocs/lmhosts.5.html +++ b/docs/htmldocs/lmhosts.5.html @@ -1,210 +1,37 @@ - -lmhosts

    lmhosts

    Name

    lmhosts -- The Samba NetBIOS hosts file

    Synopsis

    lmhosts is the Samba NetBIOS name to IP address mapping file.

    DESCRIPTION

    This file is part of the Samba suite.

    lmhosts is the Samba - NetBIOS name to IP address mapping file. It - is very similar to the /etc/hosts file +lmhosts

    Name

    lmhosts — The Samba NetBIOS hosts file

    Synopsis

    lmhosts is the Samba(7) NetBIOS name to IP address mapping file.

    DESCRIPTION

    This file is part of the Samba(7) suite.

    lmhosts is the Samba + NetBIOS name to IP address mapping file. It + is very similar to the /etc/hosts file format, except that the hostname component must correspond - to the NetBIOS naming format.

    FILE FORMAT

    It is an ASCII file containing one line for NetBIOS name. + to the NetBIOS naming format.

    FILE FORMAT

    It is an ASCII file containing one line for NetBIOS name. The two fields on each line are separated from each other by white space. Any entry beginning with '#' is ignored. Each line - in the lmhosts file contains the following information :

    • IP Address - in dotted decimal format.

    • NetBIOS Name - This name format is a + in the lmhosts file contains the following information:

      • IP Address - in dotted decimal format.

      • NetBIOS Name - This name format is a maximum fifteen character host name, with an optional trailing '#' character followed by the NetBIOS name type - as two hexadecimal digits.

        If the trailing '#' is omitted then the given IP + as two hexadecimal digits.

        If the trailing '#' is omitted then the given IP address will be returned for all names that match the given - name, whatever the NetBIOS name type in the lookup.

      An example follows :

      #
+		name, whatever the NetBIOS name type in the lookup.

    An example follows:

    +#
 # Sample Samba lmhosts file.
 #
 192.9.200.1	TESTPC
 192.9.200.20	NTSERVER#20
 192.9.200.21	SAMBASERVER
-

    Contains three IP to NetBIOS name mappings. The first - and third will be returned for any queries for the names "TESTPC" - and "SAMBASERVER" respectively, whatever the type component of - the NetBIOS name requested.

    The second mapping will be returned only when the "0x20" name - type for a name "NTSERVER" is queried. Any other name type will not - be resolved.

    The default location of the lmhosts file - is in the same directory as the - smb.conf(5)> file.

    VERSION

    This man page is correct for version 2.2 of - the Samba suite.

    SEE ALSO

    smbclient(1) - , smb.conf(5), and smbpasswd(8) -

    AUTHOR

    The original Samba software and related utilities +

    Contains three IP to NetBIOS name mappings. The first + and third will be returned for any queries for the names "TESTPC" + and "SAMBASERVER" respectively, whatever the type component of + the NetBIOS name requested.

    The second mapping will be returned only when the "0x20" name + type for a name "NTSERVER" is queried. Any other name type will not + be resolved.

    The default location of the lmhosts file + is in the same directory as the smb.conf(5) file.

    VERSION

    This man page is correct for version 3.0 of the Samba suite.

    SEE ALSO

    smbclient(1), smb.conf(5), and smbpasswd(8) +

    AUTHOR

    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.

    The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

    The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

    \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 was done by Alexander Bokovoy.

    diff --git a/docs/htmldocs/msdfs.html b/docs/htmldocs/msdfs.html index f6fe1c7e1d..f8f2a3ea52 100644 --- a/docs/htmldocs/msdfs.html +++ b/docs/htmldocs/msdfs.html @@ -1,321 +1,62 @@ - -Hosting a Microsoft Distributed File System tree on Samba
    SAMBA Project Documentation
    PrevNext

    Chapter 13. Hosting a Microsoft Distributed File System tree on Samba

    13.1. Instructions

    The Distributed File System (or Dfs) provides a means of - separating the logical view of files and directories that users - see from the actual physical locations of these resources on the - network. It allows for higher availability, smoother storage expansion, - load balancing etc. For more information about Dfs, refer to Microsoft documentation.

    This document explains how to host a Dfs tree on a Unix - machine (for Dfs-aware clients to browse) using Samba.

    To enable SMB-based DFS for Samba, configure it with the - --with-msdfs option. Once built, a - Samba server can be made a Dfs server by setting the global - boolean host msdfs parameter in the smb.conf - file. You designate a share as a Dfs root using the share - level boolean msdfs root parameter. A Dfs root directory on - Samba hosts Dfs links in the form of symbolic links that point - to other servers. For example, a symbolic link - junction->msdfs:storage1\share1 in - the share directory acts as the Dfs junction. When Dfs-aware - clients attempt to access the junction link, they are redirected - to the storage location (in this case, \\storage1\share1).

    Dfs trees on Samba work with all Dfs-aware clients ranging - from Windows 95 to 2000.

    Here's an example of setting up a Dfs tree on a Samba - server.

    # The smb.conf file:
+Chapter 17. Hosting a Microsoft Distributed File System tree on Samba
    Chapter 17. Hosting a Microsoft Distributed File System tree on Samba
    Prev Part III. Advanced Configuration Next
    Chapter 17. Hosting a Microsoft Distributed File System tree on Samba
    Shirish Kalele
    Samba Team & Veritas Software

    
+				
    
+			
    12 Jul 2000
    Table of Contents
    Features and Benefits
    Common Errors
    Features and Benefits
    
+	The Distributed File System (or DFS) provides a means of separating the logical
+	view of files and directories that users see from the actual physical locations
+	of these resources on the network. It allows for higher availability, smoother
+	storage expansion, load balancing etc.
+	
    
+	For information about DFS, refer to
+	
+	Microsoft documentation at http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp.
+	
    
+	This document explains how to host a DFS tree on a Unix machine (for DFS-aware
+	clients to browse) using Samba.
+	
    
+	To enable SMB-based DFS for Samba, configure it with the --with-msdfs
+	option. Once built, a Samba server can be made a DFS server by setting the global 
+	boolean  host msdfs
+	parameter in the smb.conf  file. You designate a share as a DFS
+	root using the share level boolean 
+	msdfs root parameter. A DFS root directory on Samba hosts DFS
+	links in the form of symbolic links that point to other servers. For example, a symbolic link
+	junction->msdfs:storage1\share1 in the share directory acts
+	as the DFS junction. When DFS-aware clients attempt to access the junction link,
+	they are redirected to the storage location (in this case, \\storage1\share1).
+	
    
+	DFS trees on Samba work with all DFS-aware clients ranging from Windows 95 to 200x.
+	
    
+	Here's an example of setting up a DFS tree on a Samba server.
+	
    +# The smb.conf file:
 [global]
-	netbios name = SAMBA
+	netbios name = SMOKEY
 	host msdfs   = yes
 
 [dfs]
 	path = /export/dfsroot
 	msdfs root = yes
-	
    In the /export/dfsroot directory we set up our dfs links to 
-	other servers on the network.
    root# cd /export/dfsroot
    root# chown root /export/dfsroot
    root# chmod 755 /export/dfsroot
    root# ln -s msdfs:storageA\\shareA linka
    root# ln -s msdfs:serverB\\share,serverC\\share linkb
    You should set up the permissions and ownership of 
-	the directory acting as the Dfs root such that only designated 
+

    In the /export/dfsroot directory we set up our dfs links to + other servers on the network.

    +	root# cd /export/dfsroot
+	root# chown root /export/dfsroot
+	root# chmod 755 /export/dfsroot
+	root# ln -s msdfs:storageA\\shareA linka
+	root# ln -s msdfs:serverB\\share,serverC\\share linkb
+

    You should set up the permissions and ownership of + the directory acting as the DFS root such that only designated users can create, delete or modify the msdfs links. Also note that symlink names should be all lowercase. This limitation exists to have Samba avoid trying all the case combinations to get at the link name. Finally set up the symbolic links to point to the - network shares you want, and start Samba.

    Users on Dfs-aware clients can now browse the Dfs tree + network shares you want, and start Samba.

    Users on DFS-aware clients can now browse the DFS tree on the Samba server at \\samba\dfs. Accessing links linka or linkb (which appear as directories to the client) - takes users directly to the appropriate shares on the network.

    13.1.1. Notes

    PrevHomeNext
    Configuring PAM for distributed but centrally -managed authenticationUpPrinting Support
    \ No newline at end of file + takes users directly to the appropriate shares on the network.

    Common Errors

    • Windows clients need to be rebooted + if a previously mounted non-dfs share is made a dfs + root or vice versa. A better way is to introduce a + new share and make it the dfs root.

    • Currently there's a restriction that msdfs + symlink names should all be lowercase.

    • For security purposes, the directory + acting as the root of the DFS tree should have ownership + and permissions set so that only designated users can + modify the symbolic links in the directory.

    Prev Up Next
    Chapter 16. Interdomain Trust Relationships Home Chapter 18. Classical Printing Support
    diff --git a/docs/htmldocs/net.8.html b/docs/htmldocs/net.8.html index b7ed1357c3..13e4be81be 100644 --- a/docs/htmldocs/net.8.html +++ b/docs/htmldocs/net.8.html @@ -1,403 +1,146 @@ - -net

    net

    Name

    net -- Tool for administration of Samba and remote - CIFS servers.

    Synopsis

    net {<ads|rap|rpc>} [-h] [-w workgroup] [-W myworkgroup] [-U user] [-I ip-address] [-p port] [-n myname] [-s conffile] [-S server] [-C comment] [-M maxusers] [-F flags] [-j jobid] [-l] [-r] [-f] [-t timeout] [-P] [-D debuglevel]

    DESCRIPTION

    This tool is part of the Samba suite.

    The samba net utility is meant to work just like the net utility - available for windows and DOS.

    OPTIONS

    -h

    Display summary of all available options. - -

    -w target-workgroup

    Sets target workgroup or domain. You have to specify either this option or the IP address or the name of a server. -

    -W workgroup

    Sets client workgroup or domain -

    -U user

    User name to use -

    -I ip-address

    IP address of target server to use. You have to specify either this option or a target workgroup or a target server. -

    -p port

    Port on the target server to connect to. -

    -n myname

    Sets name of the client. -

    -s conffile

    Specify alternative configuration file that should be loaded. -

    -S server

    Name of target server. You should specify either this option or a target workgroup or a target IP address. -

    -C comment

    FIXME -

    -M maxusers

    FIXME -

    -F flags

    FIXME -

    -j jobid

    FIXME -

    -l

    FIXME -

    -r

    FIXME -

    -f

    FIXME -

    -t timeout

    FIXME -

    -P

    Make queries to the external server using the machine account of the local server. -

    -D debuglevel

    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 - BUGS.txt). -

    TIME

    The NET TIME command allows you to view the time on a remote server - or synchronise the time on the local server with the time on the remote server.

    Without any options, the NET TIME command - displays the time on the remote server. -

    SYSTEM

    Displays the time on the remote server in a format ready for /bin/date -

    SET

    Tries to set the date and time of the local server to that on - the remote server using /bin/date. -

    ZONE

    Displays the timezone in hours from GMT on the remote computer. -

    RPC

    The NET RPC command allows you to do various - NT4 operations.

    JOIN -U username[%password] [options]

    Join a domain with specified username and password. Password - will be prompted if none is specified.

    JOIN [options except -U]

    to join a domain created in server manager -

    USER [misc. options] [targets]

    List users -

    USER DELETE <name> [misc options]

    delete specified user -

    USER INFO <name> [misc options]

    list the domain groups of the specified user -

    USER ADD <name> [password] [-F user flags] [misc. options

    Add specified user -

    GROUP [misc options] [targets]

    List user groups -

    GROUP DELETE <name> [misc. options] [targets]

    Delete specified group -

    GROUP ADD <name> [-C comment]

    Create specified group -

    SHARE [misc. options] [targets]

    enumerates all exported resources (network shares) on target server -

    SHARE ADD <name=serverpath> [misc. options] [targets]

    Adds a share from a server (makes the export active) -

    SHARE DELETE <sharenam

    VERSION

    This man page is incomplete for version 3.0 of the Samba - suite.

    AUTHOR

    The original Samba software and related utilities +net

    Name

    net — Tool for administration of Samba and remote + CIFS servers. +

    Synopsis

    net {<ads|rap|rpc>} [-h] [-w workgroup] [-W myworkgroup] [-U user] [-I ip-address] [-p port] [-n myname] [-s conffile] [-S server] [-l] [-P] [-D debuglevel]

    DESCRIPTION

    This tool is part of the Samba(7) suite.

    The samba net utility is meant to work just like the net utility + available for windows and DOS. The first argument should be used + to specify the protocol to use when executing a certain command. + ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) + clients and RPC can be used for NT4 and Windows 2000. If this + argument is omitted, net will try to determine it automatically. + Not all commands are available on all protocols. +

    OPTIONS

    -h|--help

    Print a summary of command line options. +

    -w target-workgroup

    + Sets target workgroup or domain. You have to specify + either this option or the IP address or the name of a server. +

    -W workgroup

    + Sets client workgroup or domain +

    -U user

    + User name to use +

    -I ip-address

    + IP address of target server to use. You have to + specify either this option or a target workgroup or + a target server. +

    -p port

    + Port on the target server to connect to (usually 139 or 445). + Defaults to trying 445 first, then 139. +

    -n <primary NetBIOS name>

    This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the NetBIOS +name parameter in the smb.conf(5) file. However, a command +line setting will take precedence over settings in +smb.conf(5).

    -s <configuration file>

    The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

    -S server

    + Name of target server. You should specify either + this option or a target workgroup or a target IP address. +

    -l

    + When listing data, give more information on each item. +

    -P

    + Make queries to the external server using the machine account of the local server. +

    -d|--debug=debuglevel

    debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

    The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

    Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

    Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

    COMMANDS

    TIME

    The NET TIME command allows you to view the time on a remote server + or synchronise the time on the local server with the time on the remote server.

    TIME

    Without any options, the NET TIME command +displays the time on the remote server. +

    TIME SYSTEM

    Displays the time on the remote server in a format ready for /bin/date

    TIME SET

    Tries to set the date and time of the local server to that on +the remote server using /bin/date.

    TIME ZONE

    Displays the timezone in hours from GMT on the remote computer.

    [RPC|ADS] JOIN [TYPE] [-U username[%password]] [options]

    +Join a domain. If the account already exists on the server, and +[TYPE] is MEMBER, the machine will attempt to join automatically. +(Assuming that the machine has been created in server manager) +Otherwise, a password will be prompted for, and a new account may +be created.

    +[TYPE] may be PDC, BDC or MEMBER to specify the type of server +joining the domain. +

    [RPC] OLDJOIN [options]

    Join a domain. Use the OLDJOIN option to join the domain +using the old style of domain joining - you need to create a trust +account in server manager first.

    [RPC|ADS] USER

    [RPC|ADS] USER DELETE target

    Delete specified user

    [RPC|ADS] USER LIST

    List all users

    [RPC|ADS] USER INFO target

    List the domain groups of a the specified user.

    [RPC|ADS] USER ADD name [password] [-F user flags] [-C comment]

    Add specified user.

    [RPC|ADS] GROUP

    [RPC|ADS] GROUP [misc options] [targets]

    List user groups.

    [RPC|ADS] GROUP DELETE name [misc. options]

    Delete specified group.

    [RPC|ADS] GROUP ADD name [-C comment]

    Create specified group.

    [RAP|RPC] SHARE

    [RAP|RPC] SHARE [misc. options] [targets]

    Enumerates all exported resources (network shares) on target server.

    [RAP|RPC] SHARE ADD name=serverpath [-C comment] [-M maxusers] [targets]

    Adds a share from a server (makes the export active). Maxusers +specifies the number of users that can be connected to the +share simultaneously.

    SHARE DELETE sharenam

    Delete specified share.

    [RPC|RAP] FILE

    [RPC|RAP] FILE

    List all open files on remote server.

    [RPC|RAP] FILE CLOSE fileid

    Close file with specified fileid on +remote server.

    [RPC|RAP] FILE INFO fileid

    +Print information on specified fileid. +Currently listed are: file-id, username, locks, path, permissions. +

    [RAP|RPC] FILE USER

    Note

    Currently NOT implemented.

    SESSION

    RAP SESSION

    Without any other options, SESSION enumerates all active SMB/CIFS +sessions on the target server.

    RAP SESSION DELETE|CLOSE CLIENT_NAME

    Close the specified sessions.

    RAP SESSION INFO CLIENT_NAME

    Give a list with all the open files in specified session.

    RAP SERVER DOMAIN

    List all servers in specified domain or workgroup. Defaults +to local domain.

    RAP DOMAIN

    Lists all domains and workgroups visible on the +current network.

    RAP PRINTQ

    RAP PRINTQ LIST QUEUE_NAME

    Lists the specified print queue and print jobs on the server. +If the QUEUE_NAME is omitted, all +queues are listed.

    RAP PRINTQ DELETE JOBID

    Delete job with specified id.

    RAP VALIDATE user [password]

    +Validate whether the specified user can log in to the +remote server. If the password is not specified on the commandline, it +will be prompted. +

    Note

    Currently NOT implemented.

    RAP GROUPMEMBER

    RAP GROUPMEMBER LIST GROUP

    List all members of the specified group.

    RAP GROUPMEMBER DELETE GROUP USER

    Delete member from group.

    RAP GROUPMEMBER ADD GROUP USER

    Add member to group.

    RAP ADMIN command

    Execute the specified command on +the remote server. Only works with OS/2 servers. +

    Note

    Currently NOT implemented.

    RAP SERVICE

    RAP SERVICE START NAME [arguments...]

    Start the specified service on the remote server. Not implemented yet.

    Note

    Currently NOT implemented.

    RAP SERVICE STOP

    Stop the specified service on the remote server.

    Note

    Currently NOT implemented.

    RAP PASSWORD USER OLDPASS NEWPASS

    +Change password of USER from OLDPASS to NEWPASS. +

    LOOKUP

    LOOKUP HOST HOSTNAME [TYPE]

    +Lookup the IP address of the given host with the specified type (netbios suffix). +The type defaults to 0x20 (workstation). +

    LOOKUP LDAP [DOMAIN

    Give IP address of LDAP server of specified DOMAIN. Defaults to local domain.

    LOOKUP KDC [REALM]

    Give IP address of KDC for the specified REALM. +Defaults to local realm.

    LOOKUP DC [DOMAIN]

    Give IP's of Domain Controllers for specified +DOMAIN. Defaults to local domain.

    LOOKUP MASTER DOMAIN

    Give IP of master browser for specified DOMAIN +or workgroup. Defaults to local domain.

    CACHE

    Samba uses a general caching interface called 'gencache'. It +can be controlled using 'NET CACHE'.

    All the timeout parameters support the suffixes: + +

    s - Seconds
    m - Minutes
    h - Hours
    d - Days
    w - Weeks

    + +

    CACHE ADD key data time-out

    Add specified key+data to the cache with the given timeout.

    CACHE DEL key

    Delete key from the cache.

    CACHE SET key data time-out

    Update data of existing cache entry.

    CACHE SEARCH PATTERN

    Search for the specified pattern in the cache data.

    CACHE LIST

    +List all current items in the cache. +

    CACHE FLUSH

    Remove all the current items from the cache.

    GETLOCALSID [DOMAIN]

    Print the SID of the specified domain, or if the parameter is +omitted, the SID of the domain the local server is in.

    SETLOCALSID S-1-5-21-x-y-z

    Sets domain sid for the local server to the specified SID.

    GROUPMAP

    Manage the mappings between Windows group SIDs and UNIX groups. +Parameters take the for "parameter=value". Common options include:

    • unixgroup - Name of the UNIX group

    • ntgroup - Name of the Windows NT group (must be + resolvable to a SID

    • rid - Unsigned 32-bit integer

    • sid - Full SID in the form of "S-1-..."

    • type - Type of the group; either 'domain', 'local', + or 'builtin'

    • comment - Freeform text description of the group

    GROUPMAP ADD

    Add a new group mapping entry

    net groupmap add {rid=int|sid=string} unixgroup=string [type={domain|local|builtin}] [ntgroup=string] [comment=string]

    GROUPMAP DELETE

    Delete a group mapping entry

    net groupmap delete {ntgroup=string|sid=SID}

    GROUPMAP MODIFY

    Update en existing group entry

    net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] [comment=string] [type={domain|local}

    GROUPMAP LIST

    List existing group mapping entries

    net groupmap list [verbose] [ntgroup=string] [sid=SID]

    MAXRID

    Prints out the highest RID currently in use on the local +server (by the active 'passdb backend'). +

    RPC INFO

    Print information about the domain of the remote server, +such as domain name, domain sid and number of users and groups. +

    [RPC|ADS] TESTJOIN

    Check whether participation in a domain is still valid.

    [RPC|ADS] CHANGETRUSTPW

    Force change of domain trust password.

    RPC TRUSTDOM

    RPC TRUSTDOM ADD DOMAIN

    Add a interdomain trust account for +DOMAIN to the remote server. +

    RPC TRUSTDOM DEL DOMAIM

    Remove interdomain trust account for +DOMAIN from the remote server. +

    Note

    Currently NOT implemented.

    RPC TRUSTDOM ESTABLISH DOMAIN

    +Establish a trust relationship to a trusting domain. +Interdomain account must already be created on the remote PDC. +

    RPC TRUSTDOM REVOKE DOMAIN

    Abandon relationship to trusted domain

    RPC TRUSTDOM LIST

    List all current interdomain trust relationships.

    RPC ABORTSHUTDOWN

    Abort the shutdown of a remote server.

    SHUTDOWN [-t timeout] [-r] [-f] [-C message]

    Shut down the remote server.

    -r

    +Reboot after shutdown. +

    -f

    +Force shutting down all applications. +

    -t timeout

    +Timeout before system will be shut down. An interactive +user of the system can use this time to cancel the shutdown. +

    -C message

    Display the specified message on the screen to +announce the shutdown.

    SAMDUMP

    Print out sam database of remote server. You need +to run this on either a BDC.

    VAMPIRE

    Export users, aliases and groups from remote server to +local server. Can only be run an a BDC. +

    GETSID

    Fetch domain SID and store it in the local secrets.tdb.

    ADS LEAVE

    Make the remote host leave the domain it is part of.

    ADS STATUS

    Print out status of machine account of the local machine in ADS. +Prints out quite some debug info. Aimed at developers, regular +users should use NET ADS TESTJOIN.

    ADS PRINTER

    ADS PRINTER INFO [PRINTER] [SERVER]

    +Lookup info for PRINTER on SERVER. The printer name defaults to "*", the +server name defaults to the local host.

    ADS PRINTER PUBLISH PRINTER

    Publish specified printer using ADS.

    ADS PRINTER REMOVE PRINTER

    Remove specified printer from ADS directory.

    ADS SEARCH EXPRESSION ATTRIBUTES...

    Perform a raw LDAP search on a ADS server and dump the results. The +expression is a standard LDAP search expression, and the +attributes are a list of LDAP fields to show in the results.

    Example: net ads search '(objectCategory=group)' sAMAccountName +

    ADS DN DN (attributes)

    +Perform a raw LDAP search on a ADS server and dump the results. The +DN standard LDAP DN, and the attributes are a list of LDAP fields +to show in the result. +

    Example: net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName

    WORKGROUP

    Print out workgroup name for specified kerberos realm.

    HELP [COMMAND]

    Gives usage information for the specified command.

    VERSION

    This man page is complete for version 3.0 of the Samba + suite.

    AUTHOR

    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.

    The original Samba man pages were written by Karl Auer. - The current set of manpages and documentation is maintained - by the Samba Team in the same fashion as the Samba source code.

    \ No newline at end of file + to the way the Linux kernel is developed.

    The net manpage was written by Jelmer Vernooij.

    diff --git a/docs/htmldocs/nmbd.8.html b/docs/htmldocs/nmbd.8.html index 1183a14522..c282bde89d 100644 --- a/docs/htmldocs/nmbd.8.html +++ b/docs/htmldocs/nmbd.8.html @@ -1,754 +1,153 @@ - -nmbd

    nmbd

    Name

    nmbd -- NetBIOS name server to provide NetBIOS - over IP naming services to clients

    Synopsis

    nmbd [-D] [-F] [-S] [-a] [-i] [-o] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log directory>] [-n <primary netbios name>] [-p <port number>] [-s <configuration file>]

    DESCRIPTION

    This program is part of the Samba suite.

    nmbd is a server that understands +nmbd

    Name

    nmbd — NetBIOS name server to provide NetBIOS + over IP naming services to clients

    Synopsis

    nmbd [-D] [-F] [-S] [-a] [-i] [-o] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log directory>] [-n <primary netbios name>] [-p <port number>] [-s <configuration file>]

    DESCRIPTION

    This program is part of the Samba(7) suite.

    nmbd is a server that understands and can reply to NetBIOS over IP name service requests, like those produced by SMB/CIFS clients such as Windows 95/98/ME, Windows NT, Windows 2000, Windows XP and LanManager clients. It also participates in the browsing protocols which make up the - Windows "Network Neighborhood" view.

    SMB/CIFS clients, when they start up, may wish to + Windows "Network Neighborhood" view.

    SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS server. That is, they wish to know what - IP number a specified host is using.

    Amongst other services, nmbd will + IP number a specified host is using.

    Amongst other services, nmbd will listen for such requests, and if its own NetBIOS name is specified it will respond with the IP number of the host it - is running on. Its "own NetBIOS name" is by + is running on. Its "own NetBIOS name" is by default the primary DNS name of the host it is running on, - but this can be overridden with the -n - option (see OPTIONS below). Thus nmbd will + but this can be overridden with the -n + option (see OPTIONS below). Thus nmbd will reply to broadcast queries for its own name(s). Additional - names for nmbd to respond on can be set - via parameters in the smb.conf(5) configuration file.

    nmbd can also be used as a WINS + names for nmbd to respond on can be set + via parameters in the smb.conf(5) configuration file.

    nmbd can also be used as a WINS (Windows Internet Name Server) server. What this basically means is that it will act as a WINS database server, creating a database from name registration requests that it receives and - replying to queries from clients for these names.

    In addition, nmbd can act as a WINS + replying to queries from clients for these names.

    In addition, nmbd can act as a WINS proxy, relaying broadcast queries from clients that do not understand how to talk the WINS protocol to a WINS - server.

    OPTIONS

    -D

    If specified, this parameter causes - nmbd to operate as a daemon. That is, + server.

    OPTIONS

    -D

    If specified, this parameter causes + nmbd to operate as a daemon. That is, it detaches itself and runs in the background, fielding - requests on the appropriate port. By default, nmbd + requests on the appropriate port. By default, nmbd will operate as a daemon if launched from a command shell. - nmbd can also be operated from the inetd + nmbd can also be operated from the inetd meta-daemon, although this is not recommended. -

    -F

    If specified, this parameter causes - the main nmbd process to not daemonize, +

    -F

    If specified, this parameter causes + the main nmbd process to not daemonize, i.e. double-fork and disassociate with the terminal. Child processes are still created as normal to service each connection request, but the main process does not exit. This operation mode is suitable for running - nmbd under process supervisors such - as supervise and svscan - from Daniel J. Bernstein's daemontools + nmbd under process supervisors such + as supervise and svscan + from Daniel J. Bernstein's daemontools package, or the AIX process monitor. -

    -S

    If specified, this parameter causes - nmbd to log to standard output rather - than a file.

    -a

    If this parameter is specified, each new - connection will append log messages to the log file. - This is the default.

    -i

    If this parameter is specified it causes the - server to run "interactively", not as a daemon, even if the +

    -S

    If specified, this parameter causes + nmbd to log to standard output rather + than a file.

    -i

    If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell. Setting this parameter negates the implicit daemon mode when run from the - command line. nmbd also logs to standard - output, as if the -S parameter had been - given.

    -o

    If this parameter is specified, the - log files will be overwritten when opened. By default, - smbd will append entries to the log - files.

    -h

    Prints the help information (usage) - for nmbd.

    -H <filename>

    NetBIOS lmhosts file. The lmhosts + command line. nmbd also logs to standard + output, as if the -S parameter had been + given.

    -h|--help

    Print a summary of command line options. +

    -H <filename>

    NetBIOS lmhosts file. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name - resolution mechanism name resolve order described in smb.conf(5) - to resolve any NetBIOS name queries needed by the server. Note - that the contents of this file are NOT - used by nmbd to answer any name queries. + resolution mechanism name resolve + order described in smb.conf(5) to resolve any + NetBIOS name queries needed by the server. Note + that the contents of this file are NOT + used by nmbd to answer any name queries. Adding a line to this file affects name NetBIOS resolution - from this host ONLY.

    The default path to this file is compiled into + from this host ONLY.

    The default path to this file is compiled into Samba as part of the build process. Common defaults - are /usr/local/samba/lib/lmhosts, - /usr/samba/lib/lmhosts or - /etc/lmhosts. See the - lmhosts(5) - man page for details on the contents of this file.

    -V

    Prints the version number for - nmbd.

    -d <debug level>

    debuglevel is an integer - from 0 to 10. The default value if this parameter is - not specified is zero.

    The higher this value, the more detail will - be logged to the log files about the activities of the - server. At level 0, only critical errors and serious - warnings will be logged. Level 1 is a reasonable level for - day to day running - it generates a small amount of - information about operations carried out.

    Levels above 1 will generate considerable amounts - of log data, and should only be used when investigating - a problem. Levels above 3 are designed for use only by developers - and generate HUGE amounts of log data, most of which is extremely - cryptic.

    Note that specifying this parameter here will override - the log level - parameter in the smb.conf(5) file.

    -l <log directory>

    The -l parameter specifies a directory - into which the "log.nmbd" log file will be created - for operational data from the running nmbd - server. The default log directory is compiled into Samba - as part of the build process. Common defaults are /usr/local/samba/var/log.nmb, /usr/samba/var/log.nmb or - /var/log/log.nmb. Beware: - If the directory specified does not exist, nmbd - will log to the default debug log location defined at compile time. -

    -n <primary NetBIOS name>

    This option allows you to override - the NetBIOS name that Samba uses for itself. This is identical - to setting the NetBIOS name parameter in the - smb.conf file. However, a command - line setting will take precedence over settings in - smb.conf.

    -p <UDP port number>

    UDP port number is a positive integer value. + are /usr/local/samba/lib/lmhosts, + /usr/samba/lib/lmhosts or + /etc/samba/lmhosts. See the lmhosts(5) man page for details on the contents of this file.

    -V

    Prints the version number for +smbd.

    -s <configuration file>

    The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

    -d|--debug=debuglevel

    debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

    The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

    Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

    Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

    -l|--logfile=logbasename

    File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

    -p <UDP port number>

    UDP port number is a positive integer value. This option changes the default UDP port number (normally 137) - that nmbd responds to name queries on. Don't + that nmbd responds to name queries on. Don't use this option unless you are an expert, in which case you - won't need help!

    -s <configuration file>

    The default configuration file name - is set at build time, typically as /usr/local/samba/lib/smb.conf, but - this may be changed when Samba is autoconfigured.

    The file specified contains the configuration details - required by the server. See smb.conf(5) for more information. -

    FILES

    /etc/inetd.conf

    If the server is to be run by the - inetd meta-daemon, this file + won't need help!

    FILES

    /etc/inetd.conf

    If the server is to be run by the + inetd meta-daemon, this file must contain suitable startup information for the - meta-daemon. See the UNIX_INSTALL.html document + meta-daemon. See the install document for details. -

    /etc/rc

    or whatever initialization script your - system uses).

    If running the server as a daemon at startup, +

    /etc/rc

    or whatever initialization script your + system uses).

    If running the server as a daemon at startup, this file will need to contain an appropriate startup - sequence for the server. See the UNIX_INSTALL.html document - for details.

    /etc/services

    If running the server via the - meta-daemon inetd, this file + sequence for the server. See the "How to Install and Test SAMBA" document + for details.

    /etc/services

    If running the server via the + meta-daemon inetd, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). - See the UNIX_INSTALL.html - document for details.

    /usr/local/samba/lib/smb.conf

    This is the default location of the - smb.conf - server configuration file. Other common places that systems - install this file are /usr/samba/lib/smb.conf - and /etc/smb.conf.

    When run as a WINS server (see the - wins support - parameter in the smb.conf(5) man page), - nmbd - will store the WINS database in the file wins.dat - in the var/locks directory configured under - wherever Samba was configured to install itself.

    If nmbd is acting as a browse master (see the local master - parameter in the smb.conf(5) man page, - nmbd - will store the browsing database in the file browse.dat - in the var/locks directory + See the "How to Install and Test SAMBA" + document for details.

    /usr/local/samba/lib/smb.conf

    This is the default location of + the smb.conf(5) server + configuration file. Other common places that systems + install this file are /usr/samba/lib/smb.conf + and /etc/samba/smb.conf.

    When run as a WINS server (see the + wins support + parameter in the smb.conf(5) man page), + nmbd + will store the WINS database in the file wins.dat + in the var/locks directory configured under + wherever Samba was configured to install itself.

    If nmbd is acting as a + browse master (see the local master + parameter in the smb.conf(5) man page, nmbd + will store the browsing database in the file browse.dat + in the var/locks directory configured under wherever Samba was configured to install itself. -

    SIGNALS

    To shut down an nmbd process it is recommended - that SIGKILL (-9) NOT be used, except as a last +

    SIGNALS

    To shut down an nmbd process it is recommended + that SIGKILL (-9) NOT be used, except as a last resort, as this may leave the name database in an inconsistent state. - The correct way to terminate nmbd is to send it - a SIGTERM (-15) signal and wait for it to die on its own.

    nmbd will accept SIGHUP, which will cause - it to dump out its namelists into the file namelist.debug - in the /usr/local/samba/var/locks - directory (or the var/locks directory configured + The correct way to terminate nmbd is to send it + a SIGTERM (-15) signal and wait for it to die on its own.

    nmbd will accept SIGHUP, which will cause + it to dump out its namelists into the file namelist.debug + in the /usr/local/samba/var/locks + directory (or the var/locks directory configured under wherever Samba was configured to install itself). This will also - cause nmbd to dump out its server database in - the log.nmb file.

    The debug log level of nmbd may be raised or lowered using - smbcontrol(1) - (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is - to allow transient problems to be diagnosed, whilst still running - at a normally low log level.

    VERSION

    This man page is correct for version 3.0 of - the Samba suite.

    SEE ALSO

    inetd(8), smbd(8), - smb.conf(5) - , smbclient(1) - , testparm(1), testprns(1), and the Internet RFC's - rfc1001.txt, rfc1002.txt. + cause nmbd to dump out its server database in + the log.nmb file.

    The debug log level of nmbd may be raised or lowered + using smbcontrol(1) (SIGUSR[1|2] signals + are no longer used since Samba 2.2). This is to allow + transient problems to be diagnosed, whilst still running + at a normally low log level.

    VERSION

    This man page is correct for version 3.0 of + the Samba suite.

    SEE ALSO

    + inetd(8), smbd(8), smb.conf(5), smbclient(1), testparm(1), testprns(1), and the Internet + RFC's rfc1001.txt, rfc1002.txt. In addition the CIFS (formerly SMB) specification is available - as a link from the Web page - http://samba.org/cifs/.

    AUTHOR

    The original Samba software and related utilities + as a link from the Web page + http://samba.org/cifs/.

    AUTHOR

    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.

    The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

    The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

    \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.

    diff --git a/docs/htmldocs/nmblookup.1.html b/docs/htmldocs/nmblookup.1.html index 2ce322990f..46c17ce706 100644 --- a/docs/htmldocs/nmblookup.1.html +++ b/docs/htmldocs/nmblookup.1.html @@ -1,412 +1,107 @@ - -nmblookup

    nmblookup

    Name

    nmblookup -- NetBIOS over TCP/IP client used to lookup NetBIOS - names

    Synopsis

    nmblookup [-M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>] [-T] [-f] {name}

    DESCRIPTION

    This tool is part of the Samba suite.

    nmblookup is used to query NetBIOS names +nmblookup

    Name

    nmblookup — NetBIOS over TCP/IP client used to lookup NetBIOS + names

    Synopsis

    nmblookup [-M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>] [-T] [-f] {name}

    DESCRIPTION

    This tool is part of the Samba(7) suite.

    nmblookup is used to query NetBIOS names and map them to IP addresses in a network using NetBIOS over TCP/IP queries. The options allow the name queries to be directed at a particular IP broadcast area or to a particular machine. All queries - are done over UDP.

    OPTIONS

    -M

    Searches for a master browser by looking - up the NetBIOS name name with a - type of 0x1d. If name is "-" then it does a lookup on the special name - __MSBROWSE__.

    -R

    Set the recursion desired bit in the packet + are done over UDP.

    OPTIONS

    -M

    Searches for a master browser by looking + up the NetBIOS name name with a + type of 0x1d. If + name is "-" then it does a lookup on the special name + __MSBROWSE__. Please note that in order to + use the name "-", you need to make sure "-" isn't parsed as an + argument, e.g. use : + nmblookup -M -- -.

    -R

    Set the recursion desired bit in the packet to do a recursive lookup. This is used when sending a name query to a machine running a WINS server and the user wishes to query the names in the WINS server. If this bit is unset the normal (broadcast responding) NetBIOS processing code - on a machine is used instead. See rfc1001, rfc1002 for details. -

    -S

    Once the name query has returned an IP + on a machine is used instead. See RFC1001, RFC1002 for details. +

    -S

    Once the name query has returned an IP address then do a node status query as well. A node status query returns the NetBIOS names registered by a host. -

    -r

    Try and bind to UDP port 137 to send and receive UDP +

    -r

    Try and bind to UDP port 137 to send and receive UDP datagrams. The reason for this option is a bug in Windows 95 where it ignores the source port of the requesting packet and only replies to UDP port 137. Unfortunately, on most UNIX systems root privilege is needed to bind to this port, and - in addition, if the nmbd(8) - daemon is running on this machine it also binds to this port. -

    -A

    Interpret name as - an IP Address and do a node status query on this address.

    -h

    Print a help (usage) message.

    -B <broadcast address>

    Send the query to the given broadcast address. Without + in addition, if the nmbd(8) daemon is running on this machine it also binds to this port. +

    -A

    Interpret name as + an IP Address and do a node status query on this address.

    -n <primary NetBIOS name>

    This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the NetBIOS +name parameter in the smb.conf(5) file. However, a command +line setting will take precedence over settings in +smb.conf(5).

    -i <scope>

    This specifies a NetBIOS scope that +nmblookup will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +very rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.

    -W|--workgroup=domain

    Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM).

    -O socket options

    TCP socket options to set on the client +socket. See the socket options parameter in +the smb.conf(5) manual page for the list of valid +options.

    -h|--help

    Print a summary of command line options. +

    -B <broadcast address>

    Send the query to the given broadcast address. Without this option the default behavior of nmblookup is to send the query to the broadcast address of the network interfaces as - either auto-detected or defined in the interfaces - parameter of the smb.conf (5) file. -

    -U <unicast address>

    Do a unicast query to the specified address or - host unicast address. This option - (along with the -R option) is needed to - query a WINS server.

    -d <debuglevel>

    debuglevel is an integer from 0 to 10.

    The default value if this parameter is not specified - is zero.

    The higher this value, the more detail will be logged - about the activities of nmblookup. At level - 0, only critical errors and serious warnings will be logged.

    Levels above 1 will generate considerable amounts of - log data, and should only be used when investigating a problem. - Levels above 3 are designed for use only by developers and - generate HUGE amounts of data, most of which is extremely cryptic.

    Note that specifying this parameter here will override - the log level parameter in the smb.conf(5) file.

    -s <smb.conf>

    This parameter specifies the pathname to - the Samba configuration file, smb.conf(5). This file controls all aspects of - the Samba setup on the machine.

    -i <scope>

    This specifies a NetBIOS scope that - nmblookup will use to communicate with when - generating NetBIOS names. For details on the use of NetBIOS - scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are - very rarely used, only set this parameter - if you are the system administrator in charge of all the - NetBIOS systems you communicate with.

    -T

    This causes any IP addresses found in the + either auto-detected or defined in the interfaces + parameter of the smb.conf(5) file. +

    -U <unicast address>

    Do a unicast query to the specified address or + host unicast address. This option + (along with the -R option) is needed to + query a WINS server.

    -V

    Prints the version number for +smbd.

    -s <configuration file>

    The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

    -d|--debug=debuglevel

    debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

    The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

    Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

    Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

    -l|--logfile=logbasename

    File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

    -T

    This causes any IP addresses found in the lookup to be looked up via a reverse DNS lookup into a - DNS name, and printed out before each

    IP address .... NetBIOS name

    pair that is the normal output.

    -f

    Show which flags apply to the name that has been looked up. Possible + DNS name, and printed out before each

    IP address .... NetBIOS name

    pair that is the normal output.

    -f

    + Show which flags apply to the name that has been looked up. Possible answers are zero or more of: Response, Authoritative, Truncated, Recursion_Desired, Recursion_Available, Broadcast. -

    name

    This is the NetBIOS name being queried. Depending +

    name

    This is the NetBIOS name being queried. Depending upon the previous options this may be a NetBIOS name or IP address. If a NetBIOS name then the different name types may be specified by appending '#<type>' to the name. This name may also be '*', which will return all registered names within a broadcast - area.

    EXAMPLES

    nmblookup can be used to query - a WINS server (in the same way nslookup is - used to query DNS servers). To query a WINS server, - nmblookup must be called like this:

    nmblookup -U server -R 'name'

    For example, running :

    nmblookup -U samba.org -R 'IRIX#1B'

    would query the WINS server samba.org for the domain - master browser (1B name type) for the IRIX workgroup.

    VERSION

    This man page is correct for version 3.0 of - the Samba suite.

    SEE ALSO

    nmbd(8), - samba(7), and smb.conf(5) -

    AUTHOR

    The original Samba software and related utilities + area.

    EXAMPLES

    nmblookup can be used to query + a WINS server (in the same way nslookup is + used to query DNS servers). To query a WINS server, nmblookup + must be called like this:

    nmblookup -U server -R 'name'

    For example, running :

    nmblookup -U samba.org -R 'IRIX#1B'

    would query the WINS server samba.org for the domain + master browser (1B name type) for the IRIX workgroup.

    VERSION

    This man page is correct for version 3.0 of + the Samba suite.

    SEE ALSO

    nmbd(8), samba(7), and smb.conf(5).

    AUTHOR

    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.

    The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

    The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

    \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook + XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.

    diff --git a/docs/htmldocs/optional.html b/docs/htmldocs/optional.html index b15515ddab..22761de9c9 100644 --- a/docs/htmldocs/optional.html +++ b/docs/htmldocs/optional.html @@ -1,898 +1,26 @@ - -Optional configuration
    SAMBA Project Documentation
    PrevNext

    III. Optional configuration

    Introduction

    Samba has several features that you might want or might not want to use. The chapters in this -part each cover one specific feature.

    Table of Contents
    10. Integrating MS Windows networks with Samba
    10.1. Agenda
    10.2. Name Resolution in a pure Unix/Linux world
    10.2.1. /etc/hosts
    10.2.2. /etc/resolv.conf
    10.2.3. /etc/host.conf
    10.2.4. /etc/nsswitch.conf
    10.3. Name resolution as used within MS Windows networking
    10.3.1. The NetBIOS Name Cache
    10.3.2. The LMHOSTS file
    10.3.3. HOSTS file
    10.3.4. DNS Lookup
    10.3.5. WINS Lookup
    10.4. How browsing functions and how to deploy stable and -dependable browsing using Samba
    10.5. MS Windows security options and how to configure -Samba for seemless integration
    10.5.1. Use MS Windows NT as an authentication server
    10.5.2. Make Samba a member of an MS Windows NT security domain
    10.5.3. Configure Samba as an authentication server
    10.6. Conclusions
    11. UNIX Permission Bits and Windows NT Access Control Lists
    11.1. Viewing and changing UNIX permissions using the NT - security dialogs
    11.2. How to view file security on a Samba share
    11.3. Viewing file ownership
    11.4. Viewing file or directory permissions
    11.4.1. File Permissions
    11.4.2. Directory Permissions
    11.5. Modifying file or directory permissions
    11.6. Interaction with the standard Samba create mask - parameters
    11.7. Interaction with the standard Samba file attribute - mapping
    12. Configuring PAM for distributed but centrally -managed authentication
    12.1. Samba and PAM
    12.2. Distributed Authentication
    12.3. PAM Configuration in smb.conf
    13. Hosting a Microsoft Distributed File System tree on Samba
    13.1. Instructions
    13.1.1. Notes
    14. Printing Support
    14.1. Introduction
    14.2. Configuration
    14.2.1. Creating [print$]
    14.2.2. Setting Drivers for Existing Printers
    14.2.3. Support a large number of printers
    14.2.4. Adding New Printers via the Windows NT APW
    14.2.5. Samba and Printer Ports
    14.3. The Imprints Toolset
    14.3.1. What is Imprints?
    14.3.2. Creating Printer Driver Packages
    14.3.3. The Imprints server
    14.3.4. The Installation Client
    14.4. Diagnosis
    14.4.1. Introduction
    14.4.2. Debugging printer problems
    14.4.3. What printers do I have?
    14.4.4. Setting up printcap and print servers
    14.4.5. Job sent, no output
    14.4.6. Job sent, strange output
    14.4.7. Raw PostScript printed
    14.4.8. Advanced Printing
    14.4.9. Real debugging
    15. Unified Logons between Windows NT and UNIX using Winbind
    15.1. Abstract
    15.2. Introduction
    15.3. What Winbind Provides
    15.3.1. Target Uses
    15.4. How Winbind Works
    15.4.1. Microsoft Remote Procedure Calls
    15.4.2. Name Service Switch
    15.4.3. Pluggable Authentication Modules
    15.4.4. User and Group ID Allocation
    15.4.5. Result Caching
    15.5. Installation and Configuration
    15.5.1. Introduction
    15.5.2. Requirements
    15.5.3. Testing Things Out
    15.6. Limitations
    15.7. Conclusion
    16. Passdb MySQL plugin
    16.1. Building
    16.2. Configuring
    16.3. Using plaintext passwords or encrypted password
    16.4. Getting non-column data from the table
    17. Passdb XML plugin
    17.1. Building
    17.2. Usage
    18. Stackable VFS modules
    18.1. Introduction and configuration
    18.2. Included modules
    18.2.1. audit
    18.2.2. recycle
    18.2.3. netatalk
    18.3. VFS modules available elsewhere
    18.3.1. DatabaseFS
    18.3.2. vscan
    19. Storing Samba's User/Machine Account information in an LDAP Directory
    19.1. Purpose
    19.2. Introduction
    19.3. Supported LDAP Servers
    19.4. Schema and Relationship to the RFC 2307 posixAccount
    19.5. Configuring Samba with LDAP
    19.5.1. OpenLDAP configuration
    19.5.2. Configuring Samba
    19.6. Accounts and Groups management
    19.7. Security and sambaAccount
    19.8. LDAP specials attributes for sambaAccounts
    19.9. Example LDIF Entries for a sambaAccount
    19.10. Comments
    20. HOWTO Access Samba source code via CVS
    20.1. Introduction
    20.2. CVS Access to samba.org
    20.2.1. Access via CVSweb
    20.2.2. Access via cvs
    21. Group mapping HOWTO
    22. Samba performance issues
    22.1. Comparisons
    22.2. Socket options
    22.3. Read size
    22.4. Max xmit
    22.5. Log level
    22.6. Read raw
    22.7. Write raw
    22.8. Slow Clients
    22.9. Slow Logins
    22.10. Client tuning
    PrevHomeNext
    Samba as a NT4 domain member Integrating MS Windows networks with Samba
    \ No newline at end of file +Part III. Advanced Configuration
    Part III. Advanced Configuration
    Prev   Next

    Advanced Configuration

    Valuable Nuts and Bolts Information

    +Samba has several features that you might want or might not want to use. The chapters in this part each cover specific Samba features. +

    Table of Contents

    10. Samba / MS Windows Network Browsing Guide
    Features and Benefits
    What is Browsing?
    Discussion
    NetBIOS over TCP/IP
    TCP/IP - without NetBIOS
    DNS and Active Directory
    How Browsing Functions
    Setting up WORKGROUP Browsing
    Setting up DOMAIN Browsing
    Forcing samba to be the master
    Making samba the domain master
    Note about broadcast addresses
    Multiple interfaces
    Use of the Remote Announce parameter
    Use of the Remote Browse Sync parameter
    WINS - The Windows Internetworking Name Server
    Setting up a WINS server
    WINS Replication
    Static WINS Entries
    Helpful Hints
    Windows Networking Protocols
    Name Resolution Order
    Technical Overview of browsing
    Browsing support in samba
    Problem resolution
    Browsing across subnets
    Common Errors
    How can one flush the Samba NetBIOS name cache without restarting samba?
    My client reports "This server is not configured to list shared resources"
    11. Account Information Databases
    Features and Benefits
    Technical Information
    Important Notes About Security
    Mapping User Identifiers between MS Windows and Unix
    Account Management Tools
    The smbpasswd Command
    The pdbedit Command
    Password Backends
    Plain Text
    smbpasswd - Encrypted Password Database
    tdbsam
    ldapsam
    MySQL
    XML
    Common Errors
    Users can not logon - Users not in Samba SAM
    Users are being added to the wrong backend database
    auth methods does not work
    12. Mapping MS Windows and Unix Groups
    Features and Benefits
    Discussion
    Example Configuration
    Configuration Scripts
    Sample smb.conf add group script
    Script to configure Group Mapping
    Common Errors
    Adding Groups Fails
    Adding MS Windows Groups to MS Windows Groups Fails
    13. File, Directory and Share Access Controls
    Features and Benefits
    File System Access Controls
    MS Windows NTFS Comparison with Unix File Systems
    Managing Directories
    File and Directory Access Control
    Share Definition Access Controls
    User and Group Based Controls
    File and Directory Permissions Based Controls
    Miscellaneous Controls
    Access Controls on Shares
    Share Permissions Management
    MS Windows Access Control Lists and Unix Interoperability
    Managing UNIX permissions Using NT Security Dialogs
    Viewing File Security on a Samba Share
    Viewing file ownership
    Viewing File or Directory Permissions
    Modifying file or directory permissions
    Interaction with the standard Samba create mask + parameters
    Interaction with the standard Samba file attribute + mapping
    Common Errors
    Users can not write to a public share
    I have set force user and samba still makes root the owner of all the files + I touch!
    14. File and Record Locking
    Features and Benefits
    Discussion
    Opportunistic Locking Overview
    Samba Opportunistic Locking Control
    Example Configuration
    MS Windows Opportunistic Locking and Caching Controls
    Workstation Service Entries
    Server Service Entries
    Persistent Data Corruption
    Common Errors
    locking.tdb error messages
    Additional Reading
    15. Securing Samba
    Introduction
    Features and Benefits
    Technical Discussion of Protective Measures and Issues
    Using host based protection
    User based protection
    Using interface protection
    Using a firewall
    Using a IPC$ share deny
    NTLMv2 Security
    Upgrading Samba
    Common Errors
    Smbclient works on localhost, but the network is dead
    Why can users access home directories of other users?
    16. Interdomain Trust Relationships
    Features and Benefits
    Trust Relationship Background
    Native MS Windows NT4 Trusts Configuration
    NT4 as the Trusting Domain (ie. creating the trusted account)
    NT4 as the Trusted Domain (ie. creating trusted account's password)
    Configuring Samba NT-style Domain Trusts
    Samba-3 as the Trusting Domain
    Samba-3 as the Trusted Domain
    Common Errors
    Tell me about Trust Relationships using Samba
    17. Hosting a Microsoft Distributed File System tree on Samba
    Features and Benefits
    Common Errors
    18. Classical Printing Support
    Features and Benefits
    Technical Introduction
    What happens if you send a Job from a Client
    Printing Related Configuration Parameters
    Parameters Recommended for Use
    Parameters for Backwards Compatibility
    Parameters no longer in use
    A simple Configuration to Print with Samba-3
    Verification of "Settings in Use" with testparm
    A little Experiment to warn you
    Extended Sample Configuration to Print with Samba-3
    Detailed Explanation of the Example's Settings
    The [global] Section
    The [printers] Section
    Any [my_printer_name] Section
    Print Commands
    Default Print Commands for various Unix Print Subsystems
    Setting up your own Print Commands
    Innovations in Samba Printing since 2.2
    Client Drivers on Samba Server for Point'n'Print
    The [printer$] Section is removed from Samba-3
    Creating the [print$] Share
    Parameters in the [print$] Section
    Subdirectory Structure in [print$]
    Installing Drivers into [print$]
    Setting Drivers for existing Printers with a Client GUI
    Setting Drivers for existing Printers with +rpcclient
    "The Proof of the Pudding lies in the Eating" (Client Driver Insta +Procedure)
    The first Client Driver Installation
    IMPORTANT! Setting Device Modes on new Printers
    Further Client Driver Install Procedures
    Always make first Client Connection as root or "printer admin"
    Other Gotchas
    Setting Default Print Options for the Client Drivers
    Supporting large Numbers of Printers
    Adding new Printers with the Windows NT APW
    Weird Error Message Cannot connect under a +different Name
    Be careful when assembling Driver Files
    Samba and Printer Ports
    Avoiding the most common Misconfigurations of the Client Driver
    The Imprints Toolset
    What is Imprints?
    Creating Printer Driver Packages
    The Imprints Server
    The Installation Client
    Add Network Printers at Logon without User Interaction
    The addprinter command
    Migration of "Classical" printing to Samba-3
    Publishing Printer Information in Active Directory or LDAP
    Common Errors and Problems
    I give my root password but I don't get access
    My printjobs get spooled into the spooling directory, but then get lost
    19. CUPS Printing Support in Samba 3.0
    Introduction
    Features and Benefits
    Overview
    Basic Configuration of CUPS support
    Linking of smbd with libcups.so
    Simple smb.conf Settings for CUPS
    More complex smb.conf Settings for +CUPS
    Advanced Configuration
    Central spooling vs. "Peer-to-Peer" printing
    CUPS/Samba as a "spooling-only" Print Server; "raw" printing +with Vendor Drivers on Windows Clients
    Driver Installation Methods on Windows Clients
    Explicitly enable "raw" printing for +application/octet-stream!
    Three familiar Methods for driver upload plus a new one
    Using CUPS/Samba in an advanced Way -- intelligent printing +with PostScript Driver Download
    GDI on Windows -- PostScript on Unix
    Windows Drivers, GDI and EMF
    Unix Printfile Conversion and GUI Basics
    PostScript and Ghostscript
    Ghostscript -- the Software RIP for non-PostScript Printers
    PostScript Printer Description (PPD) Specification
    CUPS can use all Windows-formatted Vendor PPDs
    CUPS also uses PPDs for non-PostScript Printers
    The CUPS Filtering Architecture
    MIME types and CUPS Filters
    MIME type Conversion Rules
    Filter Requirements
    Prefilters
    pstops
    pstoraster
    imagetops and imagetoraster
    rasterto [printerspecific]
    CUPS Backends
    cupsomatic/Foomatic -- how do they fit into the Picture?
    The Complete Picture
    mime.convs
    "Raw" printing
    "application/octet-stream" printing
    PostScript Printer Descriptions (PPDs) for non-PS Printers
    Difference between cupsomatic/foomatic-rip and +native CUPS printing
    Examples for filtering Chains
    Sources of CUPS drivers / PPDs
    Printing with Interface Scripts
    Network printing (purely Windows)
    From Windows Clients to an NT Print Server
    Driver Execution on the Client
    Driver Execution on the Server
    Network Printing (Windows clients -- UNIX/Samba Print +Servers)
    From Windows Clients to a CUPS/Samba Print Server
    Samba receiving Jobfiles and passing them to CUPS
    Network PostScript RIP: CUPS Filters on Server -- clients use +PostScript Driver with CUPS-PPDs
    PPDs for non-PS Printers on UNIX
    PPDs for non-PS Printers on Windows
    Windows Terminal Servers (WTS) as CUPS Clients
    Printer Drivers running in "Kernel Mode" cause many +Problems
    Workarounds impose Heavy Limitations
    CUPS: a "Magical Stone"?
    PostScript Drivers with no major problems -- even in Kernel +Mode
    Setting up CUPS for driver Download
    cupsaddsmb: the unknown Utility
    Prepare your smb.conf for +cupsaddsmb
    CUPS Package of "PostScript Driver for WinNT/2k/XP"
    Recognize the different Driver Files
    Acquiring the Adobe Driver Files
    ESP Print Pro Package of "PostScript Driver for +WinNT/2k/XP"
    Caveats to be considered
    What are the Benefits of using the "CUPS PostScript Driver for +Windows NT/2k/XP" as compared to the Adobe Driver?
    Run "cupsaddsmb" (quiet Mode)
    Run "cupsaddsmb" with verbose Output
    Understanding cupsaddsmb
    How to recognize if cupsaddsm completed successfully
    cupsaddsmb with a Samba PDC
    cupsaddsmb Flowchart
    Installing the PostScript Driver on a Client
    Avoiding critical PostScript Driver Settings on the +Client
    Installing PostScript Driver Files manually (using +rpcclient)
    A Check of the rpcclient man Page
    Understanding the rpcclient man Page
    Producing an Example by querying a Windows Box
    What is required for adddriver and setdriver to succeed
    Manual Commandline Driver Installation in 15 little Steps
    Troubleshooting revisited
    The printing *.tdb Files
    Trivial DataBase Files
    Binary Format
    Losing *.tdb Files
    Using tdbbackup
    CUPS Print Drivers from Linuxprinting.org
    foomatic-rip and Foomatic explained
    foomatic-rip and Foomatic-PPD Download and Installation
    Page Accounting with CUPS
    Setting up Quotas
    Correct and incorrect Accounting
    Adobe and CUPS PostScript Drivers for Windows Clients
    The page_log File Syntax
    Possible Shortcomings
    Future Developments
    Other Accounting Tools
    Additional Material
    Auto-Deletion or Preservation of CUPS Spool Files
    CUPS Configuration Settings explained
    Pre-conditions
    Manual Configuration
    When not to use Samba to print to +CUPS
    In Case of Trouble.....
    Where to find Documentation
    How to ask for Help
    Where to find Help
    Appendix
    Printing from CUPS to Windows attached +Printers
    More CUPS filtering Chains
    Trouble Shooting Guidelines to fix typical Samba printing +Problems
    An Overview of the CUPS Printing Processes
    20. Stackable VFS modules
    Features and Benefits
    Discussion
    Included modules
    audit
    extd_audit
    fake_perms
    recycle
    netatalk
    VFS modules available elsewhere
    DatabaseFS
    vscan
    Common Errors
    21. Integrated Logon Support using Winbind
    Features and Benefits
    Introduction
    What Winbind Provides
    Target Uses
    How Winbind Works
    Microsoft Remote Procedure Calls
    Microsoft Active Directory Services
    Name Service Switch
    Pluggable Authentication Modules
    User and Group ID Allocation
    Result Caching
    Installation and Configuration
    Introduction
    Requirements
    Testing Things Out
    Conclusion
    Common Errors
    22. Advanced Network Manangement
    Features and Benefits
    Remote Server Administration
    Remote Desktop Management
    Remote Management from NoMachines.Com
    Network Logon Script Magic
    Adding printers without user intervention
    Common Errors
    23. System and Account Policies
    Features and Benefits
    Creating and Managing System Policies
    Windows 9x/Me Policies
    Windows NT4 Style Policy Files
    MS Windows 200x / XP Professional Policies
    Managing Account/User Policies
    Samba Editreg Toolset
    Windows NT4/200x
    Samba PDC
    System Startup and Logon Processing Overview
    Common Errors
    Policy Does Not Work
    24. Desktop Profile Management
    Features and Benefits
    Roaming Profiles
    Samba Configuration for Profile Handling
    Windows Client Profile Configuration Information
    Sharing Profiles between W9x/Me and NT4/200x/XP workstations
    Profile Migration from Windows NT4/200x Server to Samba
    Mandatory profiles
    Creating/Managing Group Profiles
    Default Profile for Windows Users
    MS Windows 9x/Me
    MS Windows NT4 Workstation
    MS Windows 200x/XP
    Common Errors
    How does one set up roaming profiles for just one (or a few) user/s or group/s?
    Can NOT use Roaming Profiles
    Changing the default profile
    25. PAM based Distributed Authentication
    Features and Benefits
    Technical Discussion
    PAM Configuration Syntax
    Example System Configurations
    smb.conf PAM Configuration
    Remote CIFS Authentication using winbindd.so
    Password Synchronization using pam_smbpass.so
    Common Errors
    pam_winbind problem
    26. Integrating MS Windows networks with Samba
    Features and Benefits
    Background Information
    Name Resolution in a pure Unix/Linux world
    /etc/hosts
    /etc/resolv.conf
    /etc/host.conf
    /etc/nsswitch.conf
    Name resolution as used within MS Windows networking
    The NetBIOS Name Cache
    The LMHOSTS file
    HOSTS file
    DNS Lookup
    WINS Lookup
    Common Errors
    My Boomerang Won't Come Back
    Very Slow Network Connections
    Samba server name change problem
    27. Unicode/Charsets
    Features and Benefits
    What are charsets and unicode?
    Samba and charsets
    Conversion from old names
    Japanese charsets
    28. Samba Backup Techniques
    Note
    Features and Benefits
    29. High Availability Options
    Note
    Prev Up Next
    Chapter 9. MS Windows Network Configuration Guide Home Chapter 10. Samba / MS Windows Network Browsing Guide
    diff --git a/docs/htmldocs/pam.html b/docs/htmldocs/pam.html index ba2bf6c922..6fa5727720 100644 --- a/docs/htmldocs/pam.html +++ b/docs/htmldocs/pam.html @@ -1,158 +1,290 @@ - -Configuring PAM for distributed but centrally -managed authentication
    SAMBA Project Documentation
    PrevNext

    Chapter 12. Configuring PAM for distributed but centrally -managed authentication

    12.1. Samba and PAM

    A number of Unix systems (eg: Sun Solaris), as well as the -xxxxBSD family and Linux, now utilize the Pluggable Authentication -Modules (PAM) facility to provide all authentication, -authorization and resource control services. Prior to the -introduction of PAM, a decision to use an alternative to -the system password database (/etc/passwd) -would require the provision of alternatives for all programs that provide -security services. Such a choice would involve provision of -alternatives to such programs as: login, -passwd, chown, etc.

    PAM provides a mechanism that disconnects these security programs -from the underlying authentication/authorization infrastructure. -PAM is configured either through one file /etc/pam.conf (Solaris), -or by editing individual files that are located in /etc/pam.d.

    The following is an example /etc/pam.d/login configuration file. +Chapter 25. PAM based Distributed Authentication

    Chapter 25. PAM based Distributed Authentication
    Prev Part III. Advanced Configuration Next

    Chapter 25. PAM based Distributed Authentication

    John H. Terpstra

    Samba Team

    Stephen Langasek

    May 31, 2003

    Table of Contents

    Features and Benefits
    Technical Discussion
    PAM Configuration Syntax
    Example System Configurations
    smb.conf PAM Configuration
    Remote CIFS Authentication using winbindd.so
    Password Synchronization using pam_smbpass.so
    Common Errors
    pam_winbind problem

    +This chapter you should help you to deploy winbind based authentication on any PAM enabled +Unix/Linux system. Winbind can be used to enable user level application access authentication +from any MS Windows NT Domain, MS Windows 200x Active Directory based domain, or any Samba +based domain environment. It will also help you to configure PAM based local host access +controls that are appropriate to your Samba configuration. +

    +In addition to knowing how to configure winbind into PAM, you will learn generic PAM managment +possibilities and in particular how to deploy tools like pam_smbpass.so to your adavantage. +

    Note

    +The use of Winbind require more than PAM configuration alone. Please refer to the Winbind chapter. +

    Features and Benefits

    +A number of Unix systems (eg: Sun Solaris), as well as the xxxxBSD family and Linux, +now utilize the Pluggable Authentication Modules (PAM) facility to provide all authentication, +authorization and resource control services. Prior to the introduction of PAM, a decision +to use an alternative to the system password database (/etc/passwd) +would require the provision of alternatives for all programs that provide security services. +Such a choice would involve provision of alternatives to such programs as: login, +passwd, chown, etc. +

    +PAM provides a mechanism that disconnects these security programs from the underlying +authentication/authorization infrastructure. PAM is configured either through one file +/etc/pam.conf (Solaris), or by editing individual files that are +located in /etc/pam.d. +

    +On PAM enabled Unix/Linux systems it is an easy matter to configure the system to use any +authentication backend, so long as the appropriate dynamically loadable library modules +are available for it. The backend may be local to the system, or may be centralised on a +remote server. +

    +PAM support modules are available for: +

    /etc/passwd

    -

    + There are several PAM modules that interact with this standard Unix user + database. The most common are called: pam_unix.so, pam_unix2.so, pam_pwdb.so + and pam_userdb.so. +

    Kerberos

    -

    + The pam_krb5.so module allows the use of any Kerberos compliant server. + This tool is used to access MIT Kerberos, Heimdal Kerberos, and potentially + Microsoft Active Directory (if enabled). +

    LDAP

    -

    + The pam_ldap.so module allows the use of any LDAP v2 or v3 compatible backend + server. Commonly used LDAP backend servers include: OpenLDAP v2.0 and v2.1, + Sun ONE iDentity server, Novell eDirectory server, Microsoft Active Directory. +

    NetWare Bindery

    -

    + The pam_ncp_auth.so module allows authentication off any bindery enabled + NetWare Core Protocol based server. +

    SMB Password

    -

    + This module, called pam_smbpass.so, will allow user authentication off + the passdb backend that is configured in the Samba smb.conf file. +

    SMB Server

    -

    + The pam_smb_auth.so module is the original MS Windows networking authentication + tool. This module has been somewhat outdated by the Winbind module. +

    Winbind

    -

    + The pam_winbind.so module allows Samba to obtain authentication from any + MS Windows Domain Controller. It can just as easily be used to authenticate + users for access to any PAM enabled application. +

    RADIUS

    -

    + There is a PAM RADIUS (Remote Access Dial-In User Service) authentication + module. In most cases the administrator will need to locate the source code + for this tool and compile and install it themselves. RADIUS protocols are + used by many routers and terminal servers. +

    +Of the above, Samba provides the pam_smbpasswd.so and the pam_winbind.so modules alone. +

    +Once configured, these permit a remarkable level of flexibility in the location and use +of distributed samba domain controllers that can provide wide are network bandwidth +efficient authentication services for PAM capable systems. In effect, this allows the +deployment of centrally managed and maintained distributed authentication from a single +user account database. +

    Technical Discussion

    +PAM is designed to provide the system administrator with a great deal of flexibility in +configuration of the privilege granting applications of their system. The local +configuration of system security controlled by PAM is contained in one of two places: +either the single system file, /etc/pam.conf; or the /etc/pam.d/ directory. +

    PAM Configuration Syntax

    +In this section we discuss the correct syntax of and generic options respected by entries to these files. +PAM specific tokens in the configuration file are case insensitive. The module paths, however, are case +sensitive since they indicate a file's name and reflect the case dependence of typical file-systems. +The case-sensitivity of the arguments to any given module is defined for each module in turn. +

    +In addition to the lines described below, there are two special characters provided for the convenience +of the system administrator: comments are preceded by a `#' and extend to the next end-of-line; also, +module specification lines may be extended with a `\' escaped newline. +

    +If the PAM authentication module (loadable link library file) is located in the +default location then it is not necessary to specify the path. In the case of +Linux, the default location is /lib/security. If the module +is located outside the default then the path must be specified as: +

    +

    +auth  required  /other_path/pam_strange_module.so
+

    +

    Anatomy of /etc/pam.d Entries

    +The remaining information in this subsection was taken from the documentation of the Linux-PAM +project. For more information on PAM, see + +http://ftp.kernel.org/pub/linux/libs/pam The Official Linux-PAM home page. +

    +A general configuration line of the /etc/pam.conf file has the following form: +

    +

    +service-name   module-type   control-flag   module-path   args
+

    +

    +Below, we explain the meaning of each of these tokens. The second (and more recently adopted) +way of configuring Linux-PAM is via the contents of the /etc/pam.d/ directory. +Once we have explained the meaning of the above tokens, we will describe this method. +

    service-name

    -

    + The name of the service associated with this entry. Frequently the service name is the conventional + name of the given application. For example, `ftpd', `rlogind' and `su', etc. . +

    + There is a special service-name, reserved for defining a default authentication mechanism. It has + the name `OTHER' and may be specified in either lower or upper case characters. Note, when there + is a module specified for a named service, the `OTHER' entries are ignored. +

    module-type

    -

    + One of (currently) four types of module. The four types are as follows: +

    • + auth: this module type provides two aspects of authenticating the user. + Firstly, it establishes that the user is who they claim to be, by instructing the application + to prompt the user for a password or other means of identification. Secondly, the module can + grant group membership (independently of the /etc/groups file discussed + above) or other privileges through its credential granting properties. +

    • + account: this module performs non-authentication based account management. + It is typically used to restrict/permit access to a service based on the time of day, currently + available system resources (maximum number of users) or perhaps the location of the applicant + user `root' login only on the console. +

    • + session: primarily, this module is associated with doing things that need + to be done for the user before/after they can be given service. Such things include the loggin + of information concerning the opening/closing of some data exchange with a user, mountin + directories, etc. +

    • + password: this last module type is required for updating the authentication + token associated with the user. Typically, there is one module for each `challenge/response' + based authentication (auth) module-type. +

    control-flag

    -

    + The control-flag is used to indicate how the PAM library will react to the success or failure of the + module it is associated with. Since modules can be stacked (modules of the same type execute in series, + one after another), the control-flags determine the relative importance of each module. The application + is not made aware of the individual success or failure of modules listed in the + /etc/pam.conf file. Instead, it receives a summary success or fail response from + the Linux-PAM library. The order of execution of these modules is that of the entries in the + /etc/pam.conf file; earlier entries are executed before later ones. + As of Linux-PAM v0.60, this control-flag can be defined with one of two syntaxes. +

    + The simpler (and historical) syntax for the control-flag is a single keyword defined to indicate the + severity of concern associated with the success or failure of a specific module. There are four such + keywords: required, requisite, sufficient and optional. +

    + The Linux-PAM library interprets these keywords in the following manner: +

    • + required: this indicates that the success of the module is required for the + module-type facility to succeed. Failure of this module will not be apparent to the user until all + of the remaining modules (of the same module-type) have been executed. +

    • + requisite: like required, however, in the case that such a module returns a + failure, control is directly returned to the application. The return value is that associated with + the first required or requisite module to fail. Note, this flag can be used to protect against the + possibility of a user getting the opportunity to enter a password over an unsafe medium. It is + conceivable that such behavior might inform an attacker of valid accounts on a system. This + possibility should be weighed against the not insignificant concerns of exposing a sensitive + password in a hostile environment. +

    • + sufficient: the success of this module is deemed `sufficient' to satisfy + the Linux-PAM library that this module-type has succeeded in its purpose. In the event that no + previous required module has failed, no more `stacked' modules of this type are invoked. (Note, + in this case subsequent required modules are not invoked.). A failure of this module is not deemed + as fatal to satisfying the application that this module-type has succeeded. +

    • + optional: as its name suggests, this control-flag marks the module as not + being critical to the success or failure of the user's application for service. In general, + Linux-PAM ignores such a module when determining if the module stack will succeed or fail. + However, in the absence of any definite successes or failures of previous or subsequent stacked + modules this module will determine the nature of the response to the application. One example of + this latter case, is when the other modules return something like PAM_IGNORE. +

    + The more elaborate (newer) syntax is much more specific and gives the administrator a great deal of control + over how the user is authenticated. This form of the control flag is delimeted with square brackets and + consists of a series of value=action tokens: + 

    +		[value1=action1 value2=action2 ...]
+

    + Here, valueI is one of the following return values: success; open_err; symbol_err; service_err; + system_err; buf_err; perm_denied; auth_err; cred_insufficient; authinfo_unavail; user_unknown; maxtries; + new_authtok_reqd; acct_expired; session_err; cred_unavail; cred_expired; cred_err; no_module_data; conv_err; + authtok_err; authtok_recover_err; authtok_lock_busy; authtok_disable_aging; try_again; ignore; abort; + authtok_expired; module_unknown; bad_item; and default. The last of these (default) can be used to set + the action for those return values that are not explicitly defined. +

    + The actionI can be a positive integer or one of the following tokens: ignore; ok; done; bad; die; and reset. + A positive integer, J, when specified as the action, can be used to indicate that the next J modules of the + current module-type will be skipped. In this way, the administrator can develop a moderately sophisticated + stack of modules with a number of different paths of execution. Which path is taken can be determined by the + reactions of individual modules. +

    • + ignore: when used with a stack of modules, the module's return status will not + contribute to the return code the application obtains. +

    • + bad: this action indicates that the return code should be thought of as indicative + of the module failing. If this module is the first in the stack to fail, its status value will be used + for that of the whole stack. +

    • + die: equivalent to bad with the side effect of terminating the module stack and + PAM immediately returning to the application. +

    • + ok: this tells PAM that the administrator thinks this return code should + contribute directly to the return code of the full stack of modules. In other words, if the former + state of the stack would lead to a return of PAM_SUCCESS, the module's return code will override + this value. Note, if the former state of the stack holds some value that is indicative of a modules + failure, this 'ok' value will not be used to override that value. +

    • + done: equivalent to ok with the side effect of terminating the module stack and + PAM immediately returning to the application. +

    • + reset: clear all memory of the state of the module stack and start again with + the next stacked module. +

    + Each of the four keywords: required; requisite; sufficient; and optional, have an equivalent expression in + terms of the [...] syntax. They are as follows: +

    +

    • + required is equivalent to [success=ok new_authtok_reqd=ok ignore=ignore default=bad] +

    • + requisite is equivalent to [success=ok new_authtok_reqd=ok ignore=ignore default=die] +

    • + sufficient is equivalent to [success=done new_authtok_reqd=done default=ignore] +

    • + optional is equivalent to [success=ok new_authtok_reqd=ok default=ignore] +

    +

    + Just to get a feel for the power of this new syntax, here is a taste of what you can do with it. With Linux-PAM-0.63, + the notion of client plug-in agents was introduced. This is something that makes it possible for PAM to support + machine-machine authentication using the transport protocol inherent to the client/server application. With the + [ ... value=action ... ] control syntax, it is possible for an application to be configured + to support binary prompts with compliant clients, but to gracefully fall over into an alternative authentication + mode for older, legacy, applications. +

    module-path

    -

    + The path-name of the dynamically loadable object file; the pluggable module itself. If the first character of the + module path is `/', it is assumed to be a complete path. If this is not the case, the given module path is appended + to the default module path: /lib/security (but see the notes above). +

    + The args are a list of tokens that are passed to the module when it is invoked. Much like arguments to a typical + Linux shell command. Generally, valid arguments are optional and are specific to any given module. Invalid arguments + are ignored by a module, however, when encountering an invalid argument, the module is required to write an error + to syslog(3). For a list of generic options see the next section. +

    + Note, if you wish to include spaces in an argument, you should surround that argument with square brackets. For example: + 

    +squid auth required pam_mysql.so user=passwd_query passwd=mada \
+        db=eminence [query=select user_name from internet_service where \
+                     user_name='%u' and password=PASSWORD('%p') and \
+                     service='web_proxy']
+

    + Note, when using this convention, you can include `[' characters inside the string, and if you wish to include a `]' + character inside the string that will survive the argument parsing, you should use `\['. In other words: + 

    +[..[..\]..]    -->   ..[..]..
+

    + Any line in (one of) the configuration file(s), that is not formatted correctly, will generally tend (erring on the + side of caution) to make the authentication process fail. A corresponding error is written to the system log files + with a call to syslog(3). +

    Example System Configurations

    +The following is an example /etc/pam.d/login configuration file. This example had all options been uncommented is probably not usable as it stacks many conditions before allowing successful completion of the login process. Essentially all conditions can be disabled -by commenting them out except the calls to pam_pwdb.so.

    #%PAM-1.0
+by commenting them out except the calls to pam_pwdb.so.
+
    PAM: original login config
    +#%PAM-1.0
 # The PAM configuration file for the `login' service
 #
-auth 		required	pam_securetty.so
-auth 		required	pam_nologin.so
-# auth 		required	pam_dialup.so
-# auth 		optional	pam_mail.so
-auth		required	pam_pwdb.so shadow md5
-# account    	requisite  	pam_time.so
-account		required	pam_pwdb.so
-session		required	pam_pwdb.so
-# session 	optional	pam_lastlog.so
-# password   	required   	pam_cracklib.so retry=3
-password	required	pam_pwdb.so shadow md5
    PAM allows use of replacable modules. Those available on a 
-sample system include:
    $ /bin/ls /lib/security
+auth         required    pam_securetty.so
+auth         required    pam_nologin.so
+# auth       required    pam_dialup.so
+# auth       optional    pam_mail.so
+auth         required    pam_pwdb.so shadow md5
+# account    requisite   pam_time.so
+account      required    pam_pwdb.so
+session      required    pam_pwdb.so
+# session    optional    pam_lastlog.so
+# password   required    pam_cracklib.so retry=3
+password     required    pam_pwdb.so shadow md5
+
    PAM: login using pam_smbpass
    
+PAM allows use of replacable modules. Those available on a sample system include:
+
    $/bin/ls /lib/security
+
     pam_access.so    pam_ftp.so          pam_limits.so     
 pam_ncp_auth.so  pam_rhosts_auth.so  pam_stress.so     
 pam_cracklib.so  pam_group.so        pam_listfile.so   
@@ -164,262 +296,227 @@ pam_pwdb.so      pam_shells.so       pam_unix.so
 pam_env.so       pam_ldap.so         pam_motd.so       
 pam_radius.so    pam_smbpass.so      pam_unix_acct.so  
 pam_wheel.so     pam_unix_auth.so    pam_unix_passwd.so
-pam_userdb.so    pam_warn.so         pam_unix_session.so
    The following example for the login program replaces the use of 
-the pam_pwdb.so module which uses the system 
-password database (/etc/passwd,
-/etc/shadow, /etc/group) with 
-the module pam_smbpass.so which uses the Samba 
+pam_userdb.so    pam_warn.so         pam_unix_session.so
+

    +The following example for the login program replaces the use of +the pam_pwdb.so module which uses the system +password database (/etc/passwd, +/etc/shadow, /etc/group) with +the module pam_smbpass.so which uses the Samba database which contains the Microsoft MD4 encrypted password hashes. This database is stored in either -/usr/local/samba/private/smbpasswd, -/etc/samba/smbpasswd, or in -/etc/samba.d/smbpasswd, depending on the +/usr/local/samba/private/smbpasswd, +/etc/samba/smbpasswd, or in +/etc/samba.d/smbpasswd, depending on the Samba implementation for your Unix/Linux system. The -pam_smbpass.so module is provided by +pam_smbpass.so module is provided by Samba version 2.2.1 or later. It can be compiled by specifying the ---with-pam_smbpass options when running Samba's -configure script. For more information -on the pam_smbpass module, see the documentation -in the source/pam_smbpass directory of the Samba -source distribution.

    #%PAM-1.0
+--with-pam_smbpass options when running Samba's
+configure script.  For more information
+on the pam_smbpass module, see the documentation
+in the source/pam_smbpass directory of the Samba 
+source distribution.
+
    +#%PAM-1.0
 # The PAM configuration file for the `login' service
 #
-auth		required	pam_smbpass.so nodelay
-account		required	pam_smbpass.so nodelay
-session		required	pam_smbpass.so nodelay
-password	required	pam_smbpass.so nodelay
    The following is the PAM configuration file for a particular 
-Linux system. The default condition uses pam_pwdb.so.
    #%PAM-1.0
+auth        required    pam_smbpass.so nodelay
+account     required    pam_smbpass.so nodelay
+session     required    pam_smbpass.so nodelay
+password    required    pam_smbpass.so nodelay
+
    
+The following is the PAM configuration file for a particular 
+Linux system. The default condition uses pam_pwdb.so.
+
    +#%PAM-1.0
 # The PAM configuration file for the `samba' service
 #
-auth       required     /lib/security/pam_pwdb.so nullok nodelay shadow audit
-account    required     /lib/security/pam_pwdb.so audit nodelay
-session    required     /lib/security/pam_pwdb.so nodelay
-password   required     /lib/security/pam_pwdb.so shadow md5
    In the following example the decision has been made to use the 
+auth       required     pam_pwdb.so nullok nodelay shadow audit
+account    required     pam_pwdb.so audit nodelay
+session    required     pam_pwdb.so nodelay
+password   required     pam_pwdb.so shadow md5
+

    +In the following example the decision has been made to use the smbpasswd database even for basic samba authentication. Such a decision could also be made for the passwd program and would thus allow the smbpasswd passwords to be changed using the passwd -program.

    #%PAM-1.0
+program.
+
    +#%PAM-1.0
 # The PAM configuration file for the `samba' service
 #
-auth       required     /lib/security/pam_smbpass.so nodelay
-account    required     /lib/security/pam_pwdb.so audit nodelay
-session    required     /lib/security/pam_pwdb.so nodelay
-password   required     /lib/security/pam_smbpass.so nodelay smbconf=/etc/samba.d/smb.conf
    Note: PAM allows stacking of authentication mechanisms. It is 
+auth       required     pam_smbpass.so nodelay
+account    required     pam_pwdb.so audit nodelay
+session    required     pam_pwdb.so nodelay
+password   required     pam_smbpass.so nodelay smbconf=/etc/samba.d/smb.conf
+

    Note

    PAM allows stacking of authentication mechanisms. It is also possible to pass information obtained within one PAM module through to the next module in the PAM stack. Please refer to the documentation for your particular system implementation for details regarding the specific capabilities of PAM in this environment. Some Linux implmentations also -provide the pam_stack.so module that allows all +provide the pam_stack.so module that allows all authentication to be configured in a single central file. The -pam_stack.so method has some very devoted followers +pam_stack.so method has some very devoted followers on the basis that it allows for easier administration. As with all issues in life though, every decision makes trade-offs, so you may want examine the -PAM documentation for further helpful information.

    12.2. Distributed Authentication

    The astute administrator will realize from this that the -combination of pam_smbpass.so, -winbindd, and rsync (see -http://rsync.samba.org/) -will allow the establishment of a centrally managed, distributed -user/password database that can also be used by all -PAM (eg: Linux) aware programs and applications. This arrangement -can have particularly potent advantages compared with the -use of Microsoft Active Directory Service (ADS) in so far as -reduction of wide area network authentication traffic.

    12.3. PAM Configuration in smb.conf

    There is an option in smb.conf called obey pam restrictions. -The following is from the on-line help for this option in SWAT;

    When Samba 2.2 is configure to enable PAM support (i.e. ---with-pam), this parameter will +PAM documentation for further helpful information. +

    smb.conf PAM Configuration

    +There is an option in smb.conf called obey pam restrictions. +The following is from the on-line help for this option in SWAT; +

    +When Samba-3 is configured to enable PAM support (i.e. +--with-pam), this parameter will control whether or not Samba should obey PAM's account and session management directives. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management. Note that Samba always ignores PAM for authentication in the case of -encrypt passwords = yes. +encrypt passwords = yes. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB -password encryption.

    Default: obey pam restrictions = no

    PrevHomeNext
    UNIX Permission Bits and Windows NT Access Control ListsUpHosting a Microsoft Distributed File System tree on Samba
    \ No newline at end of file +password encryption. +

    Default: obey pam restrictions = no

    Remote CIFS Authentication using winbindd.so

    +All operating systems depend on the provision of users credentials accecptable to the platform. +Unix requires the provision of a user identifier (UID) as well as a group identifier (GID). +These are both simple integer type numbers that are obtained from a password backend such +as /etc/passwd. +

    +Users and groups on a Windows NT server are assigned a relative id (rid) which is unique for +the domain when the user or group is created. To convert the Windows NT user or group into +a unix user or group, a mapping between rids and unix user and group ids is required. This +is one of the jobs that winbind performs. +

    +As winbind users and groups are resolved from a server, user and group ids are allocated +from a specified range. This is done on a first come, first served basis, although all +existing users and groups will be mapped as soon as a client performs a user or group +enumeration command. The allocated unix ids are stored in a database file under the Samba +lock directory and will be remembered. +

    +The astute administrator will realize from this that the combination of pam_smbpass.so, +winbindd, and a distributed passdb backend, such as ldap, will allow the establishment of a +centrally managed, distributed user/password database that can also be used by all PAM (eg: Linux) aware +programs and applications. This arrangement can have particularly potent advantages compared with the use of +Microsoft Active Directory Service (ADS) in so far as reduction of wide area network authentication traffic. +

    Warning

    +The rid to unix id database is the only location where the user and group mappings are +stored by winbindd. If this file is deleted or corrupted, there is no way for winbindd +to determine which user and group ids correspond to Windows NT user and group rids. +

    Password Synchronization using pam_smbpass.so

    +pam_smbpass is a PAM module which can be used on conforming systems to +keep the smbpasswd (Samba password) database in sync with the unix +password file. PAM (Pluggable Authentication Modules) is an API supported +under some Unices, such as Solaris, HPUX and Linux, that provides a +generic interface to authentication mechanisms. +

    +This module authenticates a local smbpasswd user database. If you require +support for authenticating against a remote SMB server, or if you're +concerned about the presence of suid root binaries on your system, it is +recommended that you use pam_winbind instead. +

    +Options recognized by this module are as follows: +

    Table 25.1. Options recognized by pam_smbpass

    debuglog more debugging info
    auditlike debug, but also logs unknown usernames
    use_first_passdon't prompt the user for passwords; take them from PAM_ items instead
    try_first_passtry to get the password from a previous PAM module, fall back to prompting the user
    use_authtoklike try_first_pass, but *fail* if the new PAM_AUTHTOK has not been previously set. (intended for stacking password modules only)
    not_set_passdon't make passwords used by this module available to other modules.
    nodelaydon't insert ~1 second delays on authentication failure.
    nulloknull passwords are allowed.
    nonullnull passwords are not allowed. Used to override the Samba configuration.
    migrateonly meaningful in an "auth" context; used to update smbpasswd file with a password used for successful authentication.
    smbconf=filespecify an alternate path to the smb.conf file.

    +

    +Thanks go to the following people: +

    Andrew Morgan, for providing the Linux-PAM + framework, without which none of this would have happened
    Christian Gafton and Andrew Morgan again, for the + pam_pwdb module upon which pam_smbpass was originally based
    Luke Leighton for being receptive to the idea, + and for the occasional good-natured complaint about the project's status + that keep me working on it :)

    . +

    +The following are examples of the use of pam_smbpass.so in the format of Linux +/etc/pam.d/ files structure. Those wishing to implement this +tool on other platforms will need to adapt this appropriately. +

    Password Synchronisation Configuration

    +A sample PAM configuration that shows the use of pam_smbpass to make +sure private/smbpasswd is kept in sync when /etc/passwd (/etc/shadow) +is changed. Useful when an expired password might be changed by an +application (such as ssh). +

    +#%PAM-1.0
+# password-sync
+#
+auth       requisite    pam_nologin.so
+auth       required     pam_unix.so
+account    required     pam_unix.so
+password   requisite    pam_cracklib.so retry=3
+password   requisite    pam_unix.so shadow md5 use_authtok try_first_pass
+password   required     pam_smbpass.so nullok use_authtok try_first_pass
+session    required     pam_unix.so
+

    Password Migration Configuration

    +A sample PAM configuration that shows the use of pam_smbpass to migrate +from plaintext to encrypted passwords for Samba. Unlike other methods, +this can be used for users who have never connected to Samba shares: +password migration takes place when users ftp in, login using ssh, pop +their mail, etc. +

    +#%PAM-1.0
+# password-migration
+#
+auth       requisite   pam_nologin.so
+# pam_smbpass is called IF pam_unix succeeds.
+auth       requisite   pam_unix.so
+auth       optional    pam_smbpass.so migrate
+account    required    pam_unix.so
+password   requisite   pam_cracklib.so retry=3
+password   requisite   pam_unix.so shadow md5 use_authtok try_first_pass
+password   optional    pam_smbpass.so nullok use_authtok try_first_pass
+session    required    pam_unix.so
+

    Mature Password Configuration

    +A sample PAM configuration for a 'mature' smbpasswd installation. +private/smbpasswd is fully populated, and we consider it an error if +the smbpasswd doesn't exist or doesn't match the Unix password. +

    +#%PAM-1.0
+# password-mature
+#
+auth       requisite    pam_nologin.so
+auth       required     pam_unix.so
+account    required     pam_unix.so
+password   requisite    pam_cracklib.so retry=3
+password   requisite    pam_unix.so shadow md5 use_authtok try_first_pass
+password   required     pam_smbpass.so use_authtok use_first_pass
+session    required     pam_unix.so
+

    Kerberos Password Integration Configuration

    +A sample PAM configuration that shows pam_smbpass used together with +pam_krb5. This could be useful on a Samba PDC that is also a member of +a Kerberos realm. +

    +#%PAM-1.0
+# kdc-pdc
+#
+auth       requisite   pam_nologin.so
+auth       requisite   pam_krb5.so
+auth       optional    pam_smbpass.so migrate
+account    required    pam_krb5.so
+password   requisite   pam_cracklib.so retry=3
+password   optional    pam_smbpass.so nullok use_authtok try_first_pass
+password   required    pam_krb5.so use_authtok try_first_pass
+session    required    pam_krb5.so
+

    Common Errors

    +PAM can be a very fickle and sensitive to configuration glitches. Here we look at a few cases from +the Samba mailing list. +

    pam_winbind problem

    + I have the following PAM configuration: +

    +

    +auth required /lib/security/pam_securetty.so
+auth sufficient /lib/security/pam_winbind.so
+auth sufficient /lib/security/pam_unix.so use_first_pass nullok
+auth required /lib/security/pam_stack.so service=system-auth
+auth required /lib/security/pam_nologin.so
+account required /lib/security/pam_stack.so service=system-auth
+account required /lib/security/pam_winbind.so
+password required /lib/security/pam_stack.so service=system-auth
+

    +

    + When I open a new console with [ctrl][alt][F1], then I cant log in with my user "pitie". + I've tried with user "scienceu+pitie" also. +

    + Answer: The problem may lie with your inclusion of pam_stack.so + service=system-auth. That file often contains a lot of stuff that may + duplicate what you're already doing. Try commenting out the pam_stack lines + for auth and account and see if things work. If they do, look at + /etc/pam.d/system-auth and copy only what you need from it into your + /etc/pam.d/login file. Alternatively, if you want all services to use + winbind, you can put the winbind-specific stuff in /etc/pam.d/system-auth. +

    Prev Up Next
    Chapter 24. Desktop Profile Management Home Chapter 26. Integrating MS Windows networks with Samba
    diff --git a/docs/htmldocs/pdbedit.8.html b/docs/htmldocs/pdbedit.8.html index 7b85e2bb80..d77f8fcec2 100644 --- a/docs/htmldocs/pdbedit.8.html +++ b/docs/htmldocs/pdbedit.8.html @@ -1,606 +1,136 @@ - -pdbedit

    pdbedit

    Name

    pdbedit -- manage the SAM database

    Synopsis

    pdbedit [-l] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-m] [-x] [-i passdb-backend] [-e passdb-backend] [-g] [-b passdb-backend] [-d debuglevel] [-s configfile] [-P account-policy] [-V value]

    DESCRIPTION

    This tool is part of the Samba suite.

    The pdbedit program is used to manage the users accounts - stored in the sam database and can only be run by root.

    The pdbedit tool uses the passdb modular interface and is +pdbedit

    Name

    pdbedit — manage the SAM database

    Synopsis

    pdbedit [-L] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-m] [-x] [-i passdb-backend] [-e passdb-backend] [-b passdb-backend] [-g] [-d debuglevel] [-s configfile] [-P account-policy] [-C value]

    DESCRIPTION

    This tool is part of the Samba(7) suite.

    The pdbedit program is used to manage the users accounts + stored in the sam database and can only be run by root.

    The pdbedit tool uses the passdb modular interface and is independent from the kind of users database used (currently there are smbpasswd, ldap, nis+ and tdb based and more can be added - without changing the tool).

    There are five main ways to use pdbedit: adding a user account, + without changing the tool).

    There are five main ways to use pdbedit: adding a user account, removing a user account, modifing a user account, listing user - accounts, importing users accounts.

    OPTIONS

    -l

    This option lists all the user accounts + accounts, importing users accounts.

    OPTIONS

    -L

    This option lists all the user accounts present in the users database. This option prints a list of user/uid pairs separated by - the ':' character.

    Example: pdbedit -l

    		sorce:500:Simo Sorce
-		samba:45:Test User
-

    -v

    This option enables the verbose listing format. + the ':' character.

    Example: pdbedit -L

    +sorce:500:Simo Sorce
+samba:45:Test User
+
    -v

    This option enables the verbose listing format. It causes pdbedit to list the users in the database, printing - out the account fields in a descriptive format.

    Example: pdbedit -l -v

    		---------------
-		username:       sorce
-		user ID/Group:  500/500
-		user RID/GRID:  2000/2001
-		Full Name:      Simo Sorce
-		Home Directory: \\BERSERKER\sorce
-		HomeDir Drive:  H:
-		Logon Script:   \\BERSERKER\netlogon\sorce.bat
-		Profile Path:   \\BERSERKER\profile
-		---------------
-		username:       samba
-		user ID/Group:  45/45
-		user RID/GRID:  1090/1091
-		Full Name:      Test User
-		Home Directory: \\BERSERKER\samba
-		HomeDir Drive:  
-		Logon Script:   
-		Profile Path:   \\BERSERKER\profile
-

    -w

    This option sets the "smbpasswd" listing format. + out the account fields in a descriptive format.

    Example: pdbedit -l -v

    +---------------
+username:       sorce
+user ID/Group:  500/500
+user RID/GRID:  2000/2001
+Full Name:      Simo Sorce
+Home Directory: \\BERSERKER\sorce
+HomeDir Drive:  H:
+Logon Script:   \\BERSERKER\netlogon\sorce.bat
+Profile Path:   \\BERSERKER\profile
+---------------
+username:       samba
+user ID/Group:  45/45
+user RID/GRID:  1090/1091
+Full Name:      Test User
+Home Directory: \\BERSERKER\samba
+HomeDir Drive:  
+Logon Script:   
+Profile Path:   \\BERSERKER\profile
+
    -w

    This option sets the "smbpasswd" listing format. It will make pdbedit list the users in the database, printing out the account fields in a format compatible with the - smbpasswd file format. (see the smbpasswd(5) for details)

    Example: pdbedit -l -w

    		sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX         ]:LCT-00000000:
-		samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX         ]:LCT-3BFA1E8D:
-

    -u username

    This option specifies the username to be + smbpasswd file format. (see the + smbpasswd(5) for details)

    Example: pdbedit -L -w

    +sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX         ]:LCT-00000000:
+samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX         ]:LCT-3BFA1E8D:
+
    -u username

    This option specifies the username to be used for the operation requested (listing, adding, removing). - It is required in add, remove and modify - operations and optional in list - operations.

    -f fullname

    This option can be used while adding or + It is required in add, remove and modify + operations and optional in list + operations.

    -f fullname

    This option can be used while adding or modifing a user account. It will specify the user's full - name.

    Example: -f "Simo Sorce"

    -h homedir

    This option can be used while adding or + name.

    Example: -f "Simo Sorce"

    -h homedir

    This option can be used while adding or modifing a user account. It will specify the user's home - directory network path.

    Example: -h "\\\\BERSERKER\\sorce" -

    -D drive

    This option can be used while adding or + directory network path.

    Example: -h "\\\\BERSERKER\\sorce" +

    -D drive

    This option can be used while adding or modifing a user account. It will specify the windows drive - letter to be used to map the home directory.

    Example: -d "H:" -

    -S script

    This option can be used while adding or + letter to be used to map the home directory.

    Example: -d "H:" +

    -S script

    This option can be used while adding or modifing a user account. It will specify the user's logon - script path.

    Example: -s "\\\\BERSERKER\\netlogon\\sorce.bat" -

    -p profile

    This option can be used while adding or + script path.

    Example: -s "\\\\BERSERKER\\netlogon\\sorce.bat" +

    -p profile

    This option can be used while adding or modifing a user account. It will specify the user's profile - directory.

    Example: -p "\\\\BERSERKER\\netlogon" -

    -a

    This option is used to add a user into the + directory.

    Example: -p "\\\\BERSERKER\\netlogon" +

    -G SID|rid

    + This option can be used while adding or modifying a user account. It + will specify the users' new primary group SID (Security Identifier) or + rid.

    Example: -G S-1-5-21-2447931902-1787058256-3961074038-1201

    -U SID|rid

    + This option can be used while adding or modifying a user account. It + will specify the users' new SID (Security Identifier) or + rid.

    Example: -U S-1-5-21-2447931902-1787058256-3961074038-5004

    -c account-control

    This option can be used while adding or modifying a user + account. It will specify the users' account control property. Possible + flags that can be set are: N, D, H, L, X. +

    Example: -c "[X ]"

    -a

    This option is used to add a user into the database. This command needs a user name specified with the -u switch. When adding a new user, pdbedit will also - ask for the password to be used.

    Example: pdbedit -a -u sorce - 
    new password:
-		retype new password
    -

    -m

    This option may only be used in conjunction - with the -a option. It will make + ask for the password to be used.

    Example: pdbedit -a -u sorce +

    new password:
+retype new password
+

    +

    -r

    This option is used to modify an existing user + in the database. This command needs a user name specified with the -u + switch. Other options can be specified to modify the properties of + the specified user. This flag is kept for backwards compatibility, but + it is no longer necessary to specify it. +

    -m

    This option may only be used in conjunction + with the -a option. It will make pdbedit to add a machine trust account instead of a user - account (-u username will provide the machine name).

    Example: pdbedit -a -m -u w2k-wks -

    -x

    This option causes pdbedit to delete an account + account (-u username will provide the machine name).

    Example: pdbedit -a -m -u w2k-wks +

    -x

    This option causes pdbedit to delete an account from the database. It needs a username specified with the - -u switch.

    Example: pdbedit -x -u bob

    -i passdb-backend

    Use a different passdb backend to retrieve users + -u switch.

    Example: pdbedit -x -u bob

    -i passdb-backend

    Use a different passdb backend to retrieve users than the one specified in smb.conf. Can be used to import data into - your local user database.

    This option will ease migration from one passdb backend to - another.

    Example: pdbedit -i smbpasswd:/etc/smbpasswd.old -

    -e passdb-backend

    Exports all currently available users to the - specified password database backend.

    This option will ease migration from one passdb backend to - another and will ease backing up.

    Example: pdbedit -e smbpasswd:/root/samba-users.backup

    -g

    If you specify -g, - then -i in-backend -e out-backend - applies to the group mapping instead of the user database. -

    This option will ease migration from one passdb backend to - another and will ease backing up.

    -b passdb-backend

    Use a different default passdb backend.

    Example: pdbedit -b xml:/root/pdb-backup.xml -l

    -P account-policy

    Display an account policy

    Valid policies are: minimum password age, reset count minutes, disconnect time, + your local user database.

    This option will ease migration from one passdb backend to + another.

    Example: pdbedit -i smbpasswd:/etc/smbpasswd.old +

    -e passdb-backend

    Exports all currently available users to the + specified password database backend.

    This option will ease migration from one passdb backend to + another and will ease backing up.

    Example: pdbedit -e smbpasswd:/root/samba-users.backup

    -g

    If you specify -g, + then -i in-backend -e out-backend + applies to the group mapping instead of the user database.

    This option will ease migration from one passdb backend to + another and will ease backing up.

    -b passdb-backend

    Use a different default passdb backend.

    Example: pdbedit -b xml:/root/pdb-backup.xml -l

    -P account-policy

    Display an account policy

    Valid policies are: minimum password age, reset count minutes, disconnect time, user must logon to change password, password history, lockout duration, min password length, - maximum password age and bad lockout attempt.

    Example: pdbedit -P "bad lockout attempt"

    		account policy value for bad lockout attempt is 0
-

    -V account-policy-value

    Sets an account policy to a specified value. + maximum password age and bad lockout attempt.

    Example: pdbedit -P "bad lockout attempt"

    +account policy value for bad lockout attempt is 0
+
    -C account-policy-value

    Sets an account policy to a specified value. This option may only be used in conjunction - with the -P option. -

    Example: pdbedit -P "bad lockout attempt" -V 3

    		account policy value for bad lockout attempt was 0
-		account policy value for bad lockout attempt is now 3
-

    -d|--debug=debuglevel

    debuglevel is an integer + with the -P option. +

    Example: pdbedit -P "bad lockout attempt" -C 3

    +account policy value for bad lockout attempt was 0
+account policy value for bad lockout attempt is now 3
+
    -h|--help

    Print a summary of command line options. +

    -V

    Prints the version number for +smbd.

    -s <configuration file>

    The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

    -d|--debug=debuglevel

    debuglevel is an integer from 0 to 10. The default value if this parameter is -not specified is zero.

    The higher this value, the more detail will be +not specified is zero.

    The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day to day running - it generates a small amount of -information about operations carried out.

    Levels above 1 will generate considerable +information about operations carried out.

    Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.

    Note that specifying this parameter here will -override the log -level parameter in the smb.conf(5) file.

    -h|--help

    Print a summary of command line options.

    -s <configuration file>

    The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See smb.conf(5) for more information. -The default configuration file name is determined at -compile time.

    NOTES

    This command may be used only by root.

    VERSION

    This man page is correct for version 2.2 of - the Samba suite.

    SEE ALSO

    smbpasswd(8), - samba(7) -

    AUTHOR

    The original Samba software and related utilities +data, most of which is extremely cryptic.

    Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

    -l|--logfile=logbasename

    File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

    NOTES

    This command may be used only by root.

    VERSION

    This man page is correct for version 3.0 of + the Samba suite.

    SEE ALSO

    smbpasswd(5), samba(7)

    AUTHOR

    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.

    The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

    \ No newline at end of file + to the way the Linux kernel is developed.

    diff --git a/docs/htmldocs/printing.html b/docs/htmldocs/printing.html index 46ebbcdf84..62856e7ecf 100644 --- a/docs/htmldocs/printing.html +++ b/docs/htmldocs/printing.html @@ -1,1386 +1,2240 @@ - -Printing Support
    SAMBA Project Documentation
    PrevNext

    Chapter 14. Printing Support

    14.1. Introduction

    Beginning with the 2.2.0 release, Samba supports -the native Windows NT printing mechanisms implemented via -MS-RPC (i.e. the SPOOLSS named pipe). Previous versions of -Samba only supported LanMan printing calls.

    The additional functionality provided by the new -SPOOLSS support includes:

    There has been some initial confusion about what all this means -and whether or not it is a requirement for printer drivers to be -installed on a Samba host in order to support printing from Windows -clients. As a side note, Samba does not use these drivers in any way to process -spooled files. They are utilized entirely by the clients.

    The following MS KB article, may be of some help if you are dealing with -Windows 2000 clients: How to Add Printers with No User -Interaction in Windows 2000

    http://support.microsoft.com/support/kb/articles/Q189/1/05.ASP

    14.2. Configuration

    [print$] vs. [printer$]
     

    Previous versions of Samba recommended using a share named [printer$]. -This name was taken from the printer$ service created by Windows 9x -clients when a printer was shared. Windows 9x printer servers always have -a printer$ service which provides read-only access via no -password in order to support printer driver downloads.

    However, the initial implementation allowed for a -parameter named printer driver location -to be used on a per share basis to specify the location of -the driver files associated with that printer. Another -parameter named printer driver provided -a means of defining the printer driver name to be sent to -the client.

    14.2.1. Creating [print$]

    In order to support the uploading of printer driver -files, you must first configure a file share named [print$]. -The name of this share is hard coded in Samba's internals so -the name is very important (print$ is the service used by -Windows NT print servers to provide support for printer driver -download).

    You should modify the server's smb.conf file to add the global -parameters and to create the -following file share (of course, some of the parameter values, -such as 'path' are arbitrary and should be replaced with -appropriate values for your site):

    [global]
-    ; members of the ntadmin group should be able
-    ; to add drivers and set printer properties
-    ; root is implicitly a 'printer admin'
-    printer admin = @ntadmin
+Chapter 18. Classical Printing Support
    Chapter 18. Classical Printing Support
    Prev Part III. Advanced Configuration Next
    Chapter 18. Classical Printing Support
    Kurt Pfeifle
     Danka Deutschland GmbH 
    May 32, 2003
    Table of Contents
    Features and Benefits
    Technical Introduction
    What happens if you send a Job from a Client
    Printing Related Configuration Parameters
    Parameters Recommended for Use
    Parameters for Backwards Compatibility
    Parameters no longer in use
    A simple Configuration to Print with Samba-3
    Verification of "Settings in Use" with testparm
    A little Experiment to warn you
    Extended Sample Configuration to Print with Samba-3
    Detailed Explanation of the Example's Settings
    The [global] Section
    The [printers] Section
    Any [my_printer_name] Section
    Print Commands
    Default Print Commands for various Unix Print Subsystems
    Setting up your own Print Commands
    Innovations in Samba Printing since 2.2
    Client Drivers on Samba Server for Point'n'Print
    The [printer$] Section is removed from Samba-3
    Creating the [print$] Share
    Parameters in the [print$] Section
    Subdirectory Structure in [print$]
    Installing Drivers into [print$]
    Setting Drivers for existing Printers with a Client GUI
    Setting Drivers for existing Printers with
+rpcclient
    "The Proof of the Pudding lies in the Eating" (Client Driver Insta
+Procedure)
    The first Client Driver Installation
    IMPORTANT! Setting Device Modes on new Printers
    Further Client Driver Install Procedures
    Always make first Client Connection as root or "printer admin"
    Other Gotchas
    Setting Default Print Options for the Client Drivers
    Supporting large Numbers of Printers
    Adding new Printers with the Windows NT APW
    Weird Error Message Cannot connect under a
+different Name
    Be careful when assembling Driver Files
    Samba and Printer Ports
    Avoiding the most common Misconfigurations of the Client Driver
    The Imprints Toolset
    What is Imprints?
    Creating Printer Driver Packages
    The Imprints Server
    The Installation Client
    Add Network Printers at Logon without User Interaction
    The addprinter command
    Migration of "Classical" printing to Samba-3
    Publishing Printer Information in Active Directory or LDAP
    Common Errors and Problems
    I give my root password but I don't get access
    My printjobs get spooled into the spooling directory, but then get lost
    Features and Benefits
    
+Printing is often a mission-critical service for the users.  Samba can
+provide this service reliably and seamlessly for a client network
+consisting of Windows workstations.
+
    
+A Samba-3.0 print service may be run on a Standalone or a Domain
+member server, side by side with file serving functions, or on a
+dedicated print server. It can be made as tight or as loosely secured
+as needs dictate. Configurations may be simple or complex.  Available
+authentication schemes are essentially the same as described for file
+services in previous chapters. Overall, Samba's printing support is
+now able to replace an NT or Windows 2000 print server full-square,
+with additional benefits in many cases. Clients may download and
+install drivers and printers through their familiar "Point'n'Print"
+mechanism. Printer installations executed by "Logon Scripts" are no
+problem. Administrators can upload and manage drivers to be used by
+clients through the familiar "Add Printer Wizard". As an additional
+benefit, driver and printer management may be run from the commandline
+or through scripts, making it more efficient in case of large numbers
+of printers. If a central accounting of print jobs (tracking every
+single page and supplying the raw data for all sorts of statistical
+reports) is required, this is best supported by CUPS as the print
+subsystem underneath the Samba hood.
+
    
+This chapter deals with the foundations of Samba printing, as they
+implemented by the more traditional UNIX (BSD- and System V-style)
+printing systems. Many things apply to CUPS, the newer Common UNIX
+Printing System, too; so if you use CUPS, you might be tempted to jump
+to the next chapter -- but you will certainly miss a few things if you
+do so. Better read this chapter too.
+
    Note
    
+Most of the given examples have been verified on Windows XP
+Professional clients. Where this document describes the responses to
+commands given, bear in mind that Windows 2000 clients are very
+similar, but may differ in details. Windows NT is somewhat different
+again.
+
    Technical Introduction
    
+Samba's printing support always relies on the installed print
+subsystem of the Unix OS it runs on. Samba is a "middleman". It takes
+printfiles from Windows (or other SMB) clients and passes them to the
+real printing system for further processing. Therefore it needs to
+"talk" to two sides: to the Windows print clients and to the Unix
+printing system. Hence we must differentiate between the various
+client OS types each of which behave differently, as well as the
+various UNIX print subsystems, which themselves have different
+features and are accessed differently. This part of the Samba HOWTO
+Collection deals with the "traditional" way of Unix printing first;
+the next chapter covers in great detail the more modern
+Common UNIX Printing System
+(CUPS).
 
-[print$]
-    path = /usr/local/samba/printers
-    guest ok = yes
-    browseable = yes
-    read only = yes
-    ; since this share is configured as read only, then we need
-    ; a 'write list'.  Check the file system permissions to make
-    ; sure this account can copy files to the share.  If this
-    ; is setup to a non-root account, then it should also exist
-    ; as a 'printer admin'
-    write list = @ntadmin,root

    The write list is used to allow administrative -level user accounts to have write access in order to update files -on the share. See the smb.conf(5) -man page for more information on configuring file shares.

    The requirement for guest -ok = yes depends upon how your -site is configured. If users will be guaranteed to have -an account on the Samba host, then this is a non-issue.

    Author's Note
     

    The non-issue is that if all your Windows NT users are guaranteed to be -authenticated by the Samba server (such as a domain member server and the NT -user has already been validated by the Domain Controller in -order to logon to the Windows NT console), then guest access -is not necessary. Of course, in a workgroup environment where -you just want to be able to print without worrying about -silly accounts and security, then configure the share for -guest access. You'll probably want to add map to guest = Bad User in the [global] section as well. Make sure -you understand what this parameter does before using it -though. --jerry

    In order for a Windows NT print server to support -the downloading of driver files by multiple client architectures, -it must create subdirectories within the [print$] service -which correspond to each of the supported client architectures. -Samba follows this model as well.

    Next create the directory tree below the [print$] share -for each architecture you wish to support.

    [print$]-----
-        |-W32X86           ; "Windows NT x86"
-        |-WIN40            ; "Windows 95/98"
-        |-W32ALPHA         ; "Windows NT Alpha_AXP"
-        |-W32MIPS          ; "Windows NT R4000"
-        |-W32PPC           ; "Windows NT PowerPC"

    ATTENTION! REQUIRED PERMISSIONS
     

    In order to currently add a new driver to you Samba host, -one of two conditions must hold true:

    • The account used to connect to the Samba host - must have a uid of 0 (i.e. a root account)

    • The account used to connect to the Samba host - must be a member of the printer - admin list.

    Of course, the connected account must still possess access -to add files to the subdirectories beneath [print$]. Remember -that all file shares are set to 'read only' by default.

    Once you have created the required [print$] service and -associated subdirectories, simply log onto the Samba server using -a root (or printer admin) account -from a Windows NT 4.0/2k client. Open "Network Neighbourhood" or -"My Network Places" and browse for the Samba host. Once you have located -the server, navigate to the "Printers..." folder. -You should see an initial listing of printers -that matches the printer shares defined on your Samba host.

    14.2.2. Setting Drivers for Existing Printers

    The initial listing of printers in the Samba host's -Printers folder will have no real printer driver assigned -to them. This defaults to a NULL string to allow the use -of the local Add Printer Wizard on NT/2000 clients. -Attempting to view the printer properties for a printer -which has this default driver assigned will result in -the error message:

    Device settings cannot be displayed. The driver -for the specified printer is not installed, only spooler -properties will be displayed. Do you want to install the -driver now?

    Click "No" in the error dialog and you will be presented with -the printer properties window. The way to assign a driver to a -printer is to either

    If you wish to install printer drivers for client -operating systems other than "Windows NT x86", you will need -to use the "Sharing" tab of the printer properties dialog.

    Assuming you have connected with a root account, you -will also be able modify other printer properties such as -ACLs and device settings using this dialog box.

    A few closing comments for this section, it is possible -on a Windows NT print server to have printers -listed in the Printers folder which are not shared. Samba does -not make this distinction. By definition, the only printers of -which Samba is aware are those which are specified as shares in -smb.conf.

    Another interesting side note is that Windows NT clients do -not use the SMB printer share, but rather can print directly -to any printer on another Windows NT host using MS-RPC. This -of course assumes that the printing client has the necessary -privileges on the remote host serving the printer. The default -permissions assigned by Windows NT to a printer gives the "Print" -permissions to the "Everyone" well-known group.

    14.2.3. Support a large number of printers

    One issue that has arisen during the development -phase of Samba 2.2 is the need to support driver downloads for -100's of printers. Using the Windows NT APW is somewhat -awkward to say the list. If more than one printer are using the -same driver, the rpcclient's -setdriver command can be used to set the driver -associated with an installed driver. The following is example -of how this could be accomplished:

     
-$ rpcclient pogo -U root%secret -c "enumdrivers"
-Domain=[NARNIA] OS=[Unix] Server=[Samba 2.2.0-alpha3]
+
    Important
    CUPS users, be warned: don't just jump on to the next
+chapter. You might miss important information contained only
+here!
    
+
    What happens if you send a Job from a Client
    
+To successfully print a job from a Windows client via a Samba
+print server to a UNIX printer, there are 6 (potentially 7)
+stages:
+
    1. Windows opens a connection to the printershare
    2. Samba must authenticate the user
    3. Windows sends a copy of the printfile over the network
+into Samba's spooling area
    4. Windows closes the connection again
    5. Samba invokes the print command to hand the file over
+to the UNIX print subsystem's spooling area
    6. The Unix print subsystem processes the print
+job
    7. The printfile may need to be explicitely deleted
+from the Samba spooling area.
    Printing Related Configuration Parameters
    
+There are a number of configuration parameters in
+ controlling Samba's printing
+behaviour. Please also refer to the man page for smb.conf to
+acquire an overview about these. As with other parameters, there are
+Global Level (tagged with a "G" in the listings) and
+Service Level ("S") parameters.
+
    Service Level Parameters
    These may go into the
+[global] section of
+. In this case they define the default
+behaviour of all individual or service level shares (provided those
+don't have a different setting defined for the same parameter, thus
+overriding the global default).
    Global Parameters
    These may not go into individual
+shares.  If they go in by error, the "testparm" utility can discover
+this (if you run it) and tell you so.
    Parameters Recommended for Use
    The following smb.conf parameters directly
+related to printing are used in Samba-3. See also the
+smb.conf man page for detailed explanations:
+
    List of printing related parameters in Samba-3. 
+
    Global level parameters:
    • addprinter command (G)
    • deleteprinter command (G)
    • disable spoolss (G)
    • enumports command (G)
    • load printers (G)
    • lpq cache time (G)
    • os2 driver map (G)
    • printcap name (G), printcap (G)
    • show add printer wizard (G)
    • total print jobs (G)
    • use client driver (G)
    
+
+
    Service level parameters:
    • hosts allow (S)
    • hosts deny (S)
    • lppause command (S)
    • lpq command (S)
    • lpresume command (S)
    • lprm command (S)
    • max print jobs (S)
    • min print space (S)
    • print command (S)
    • printable (S), print ok (S)
    • printer name (S), printer (S)
    • printer admin (S)
    • printing = [cups|bsd|lprng...] (S)
    • queuepause command (S)
    • queueresume command (S)
    • total print jobs (S)
    
+
    
+Samba's printing support implements the Microsoft Remote Procedure
+Calls (MS-RPC) methods for printing. These are used by Windows NT (and
+later) print servers. The old "LanMan" protocol is still supported as
+a fallback resort, and for older clients to use.  More details will
+follow further beneath.
+
    Parameters for Backwards Compatibility
    
+Two new parameters that were added in Samba 2.2.2, are still present
+in Samba-3.0. Both of these options are described in the
+smb.conf man page and are disabled by
+default. Use them with caution!
+
    disable spoolss(G)
     This is
+provided for better support of Samba 2.0.x backwards capability. It
+will disable Samba's support for MS-RPC printing and yield identical
+printing behaviour to Samba 2.0.x.
    use client driver (G)
     was provided
+for using local printer drivers on Windows NT/2000 clients. It does
+not apply to Windows 95/98/ME clients.
    Parameters "for backward compatibility only", use with caution. 
+
    • disable spoolss (G)
    • use client driver (S)
    
+
    Parameters no longer in use
    
+Samba users upgrading from 2.2.x to 3.0 need to be aware that some
+previously available settings are no longer supported (as was
+announced some time ago). Here is a list of them:
+
    "old" parameters, removed in Samba-3. 
+The following smb.conf parameters have been
+deprecated already in Samba 2.2 and are now completely removed from
+Samba-3.  You cannot use them in new 3.0 installations:
+
+
    • printer driver file (G)
    • total print jobs (G)
    • postscript (S)
    • printer driver (S)
    • printer driver location (S)
    
+

    A simple Configuration to Print with Samba-3

    +Here is a very simple example configuration for print related settings +in the file. If you compare it with your +own system's , you probably find some +additional parameters included there (as pre-configured by your OS +vendor). Further below is a discussion and explanation of the +parameters. Note, that this example doesn't use many parameters. +However, in many environments these are enough to provide a valid + which enables all clients to print. +

    + [global]
+         printing = bsd
+         load printers = yes
+
+ [printers]
+         path = /var/spool/samba
+         printable = yes
+         public = yes
+         writable = no
+

    +This is only an example configuration. Many settings, if not +explicitly set to a specific value, are used and set by Samba +implicitly to its own default, because these have been compiled in. +To see all settings, let root use the testparm +utility. testparm also gives warnings if you have +mis-configured certain things. Its complete output is easily 340 lines +and more. You may want to pipe it through a pager program. +

    +The syntax for the configuration file is easy to grasp. You should +know that is not very picky about its +syntax. It has been explained elsewhere in this document. A short +reminder: It even tolerates some spelling errors (like "browsable" +instead of "browseable"). Most spelling is case-insensitive. Also, you +can use "Yes|No" or "True|False" for boolean settings. Lists of names +may be separated by commas, spaces or tabs. +

    Verification of "Settings in Use" with testparm

    +To see all (or at least most) printing related settings in Samba, +including the implicitly used ones, try the command outlined below +(hit "ENTER" twice!). It greps for all occurrences of "lp", "print", +"spool", "driver", "ports" and "[" in testparm's output and gives you +a nice overview about the running smbd's print configuration. (Note +that this command does not show individually created printer shares, +or the spooling paths in each case). Here is the output of my Samba +setup, with exactly the same settings in +as shown above: +

    +root# testparm -v | egrep "(lp|print|spool|driver|ports|\[)"
+ Load smb config files from /etc/samba/smb.conf.simpleprinting
+ Processing section "[homes]"
+ Processing section "[printers]"
+ 
+ [global]
+        smb ports = 445 139
+        lpq cache time = 10
+        total print jobs = 0
+        load printers = Yes
+        printcap name = /etc/printcap
+        disable spoolss = No
+        enumports command =
+        addprinter command = 
+        deleteprinter command = 
+        show add printer wizard = Yes
+        os2 driver map =
+        printer admin =
+        min print space = 0
+        max print jobs = 1000
+        printable = No
+        printing = bsd
+        print command = lpr -r -P'%p' %s
+        lpq command = lpq -P'%p'
+        lprm command = lprm -P'%p' %j
+        lppause command =
+        lpresume command =
+        printer name =
+        use client driver = No
+
+ [homes]
+
+ [printers]
+        path = /var/spool/samba
+        printable = Yes
+
+

    +You can easily verify which settings were implicitly added by Samba's +default behaviour. Don't forget about this point: it may +be important in your future dealings with Samba. +

    Note

    testparm in Samba-3.0 behaves differently from 2.2.x: used +without the "-v" switch it only shows you the settings actually +written into ! To see the complete +configuration used, add the "-v" parameter to testparm.

    A little Experiment to warn you

    +Should you need to troubleshoot at any stage, please always come back +to this point first and verify if "testparm" shows the parameters you +expect! To give you an example from personal experience as a warning, +try to just "comment out" the load printers" +parameter. If your 2.2.x system behaves like mine, you'll see this: +

    +root# grep "load printers" /etc/samba/smb.conf
+ #      load printers = Yes
+        # This setting is commented ooouuuuut!!
+
+root# testparm -v /etc/samba/smb.conf | egrep "(load printers)"
+        load printers = Yes
+
+

    +Despite my imagination that the commenting out of this setting should +prevent Samba from publishing my printers, it still did! Oh Boy -- it +cost me quite some time to find out the reason. But I am not fooled +any more... at least not by this ;-) +

    +root# grep -A1 "load printers" /etc/samba/smb.conf
+        load printers = No
+        # This setting is what I mean!!
+ #      load printers = Yes
+        # This setting is commented ooouuuuut!!
+
+root# testparm -v smb.conf.simpleprinting | egrep "(load printers)"
+        load printers = No
+
+

    +Only when setting the parameter explicitly to +"load printers = No" +would Samba recognize my intentions. So my strong advice is: +

    • Never rely on "commented out" parameters!

    • Always set it up explicitly as you intend it to +behave.

    • Use testparm to uncover hidden +settings which might not reflect your intentions.

    +You can have a working Samba print configuration with this +minimal : +

    +root# cat /etc/samba/smb.conf-minimal
+        [printers]
+
+

    +This example should show you that you can use testparm to test any +filename for fitness as a Samba configuration. Actually, we want to +encourage you not to change your + on a working system (unless you know +exactly what you are doing)! Don't rely on an assumption that changes +will only take effect after you re-start smbd! This is not the +case. Samba re-reads its every 60 +seconds and on each new client connection. You might have to face +changes for your production clients that you didn't intend to apply at +this time! You will now note a few more interesting things. Let's now +ask testparm what the Samba print configuration +would be, if you used this minimalistic file as your real +: +

    +root#  testparm -v /etc/samba/smb.conf-minimal | egrep "(print|lpq|spool|driver|ports|[)"
+ Processing section "[printers]"
+ WARNING: [printers] service MUST be printable!
+ No path in service printers - using /tmp
+
+        lpq cache time = 10
+        total print jobs = 0
+        load printers = Yes
+        printcap name = /etc/printcap
+        disable spoolss = No
+        enumports command =
+        addprinter command =
+        deleteprinter command =
+        show add printer wizard = Yes
+        os2 driver map =
+        printer admin =
+        min print space = 0
+        max print jobs = 1000
+        printable = No
+        printing = bsd
+        print command = lpr -r -P%p %s
+        lpq command = lpq -P%p
+        printer name =
+        use client driver = No
+ [printers]
+        printable = Yes
+
+

    +testparm issued 2 warnings: +

    • because we didn't specify the +[printers] section as printable, +and

    • because we didn't tell it which spool directory to +use.

    +However, this was not fatal, and Samba-3.0 will default to values that +will work here. But, please!, don't rely on this and don't use this +example! This was only meant to make you careful to design and specify +your setup to be what you really want it to be. The outcome on your +system may vary for some parameters, since you may have a Samba built +with a different compile-time configuration. +Warning: don't put a comment sign at +the end of a valid line. It +will cause the parameter to be ignored (just as if you had put the +comment sign at the front). At first I regarded this as a bug in my +Samba version(s). But the man page states: “Internal whitespace +in a parameter value is retained verbatim.” This means that a +line consisting of, for example, +

    +printing =lprng     #This defines LPRng as the printing system"
+

    +will regard the whole of the string after the "=" +sign as the value you want to define. And this is an invalid value +that will be ignored, and a default value used instead.] +

    Extended Sample Configuration to Print with Samba-3

    +Here we show a more verbose example configuration for print related +settings in an . Below is a discussion +and explanation of the various parameters. We chose to use BSD-style +printing here, because we guess it is still the most commonly used +system on legacy Linux installations (new installs now predominantly +have CUPS, which is discussed entirely in the next chapter of this +document). Note, that this example explicitly names many parameters +which don't need to be stated because they are set by default. You +might be able to do with a leaner .

    Tip

    +if you read access it with the Samba Web Administration Tool (SWAT), +and then write it to disk again, it will be optimized in a way such +that it doesn't contain any superfluous parameters and comments. SWAT +organizes the file for best performance. Remember that each smbd +re-reads the Samba configuration once a minute, and that each +connection spawns an smbd process of its own, so it is not a bad idea +to optimize the in environments with +hundreds or thousands of clients.

    + [global]
+         printing = bsd
+         load printers = yes
+         show add printer wizard = yes
+         printcap name = /etc/printcap
+         printer admin = @ntadmin, root
+         total print jobs = 100
+         lpq cache time = 20
+         use client driver = no
+
+ [printers]
+         comment = All Printers
+         printable = yes
+         path = /var/spool/samba
+         browseable = no
+         guest ok = yes
+         public = yes
+         read only = yes
+         writable = no       
+
+ [my_printer_name]
+         comment = Printer with Restricted Access
+         path = /var/spool/samba_my_printer
+         printer admin = kurt
+         browseable = yes
+         printable = yes
+         writeable = no
+         hosts allow = 0.0.0.0
+         hosts deny = turbo_xp, 10.160.50.23, 10.160.51.60
+         guest ok = no
+

    +This also is only an example configuration. You +may not find all the settings in your own + (as pre-configured by your OS +vendor). Many configuration parameters, if not explicitly set to a +specific value, are used and set by Samba implicitly to its own +default, because these have been compiled in. To see all settings, let +root use the testparm +utility. testparm also gives warnings if you have +mis-configured certain things.. +

    Detailed Explanation of the Example's Settings

    +Following is a discussion of the settings from above shown example. +

    The [global] Section

    +The [global] section is one of 4 special +sections (along with [[homes], +[printers] and +[print$]...) It contains all parameters which +apply to the server as a whole. It is the place for parameters which +have only a "global" meaning (G). It may also contain service level +parameters (S) which then define default settings for all other +sections and shares. This way you can simplify the configuration and +avoid setting the same value repeatedly. (Within each individual +section or share you may however override these globally set "share +level" settings and specify other values). +

    printing = bsd

    this causes Samba to use default print commands +applicable for the BSD (a.k.a. RFC 1179 style or LPR/LPD) printing +system. In general, the "printing" parameter informs Samba about the +print subsystem it should expect. Samba supports CUPS, LPD, LPRNG, +SYSV, HPUX, AIX, QNX and PLP. Each of these systems defaults to a +different print command (and other queue control +commands).

    Caution

    The printing parameter is +normally a service level parameter. Since it is included here in the +[global] section, it will take effect for all +printer shares that are not defined differently. Samba-3.0 no longer +supports the SOFTQ printing system.

    load printers = yes

    this tells Samba to create automatically all +available printer shares. "Available" printer shares are discovered by +scanning the printcap file. All created printer shares are also loaded +for browsing. If you use this parameter, you do not need to specify +separate shares for each printer. Each automatically created printer +share will clone the configuration options found in the +[printers] section. (A load printers += no setting will allow you to specify each UNIX printer +you want to share separately, leaving out some you don't want to be +publicly visible and available).

    show add printer wizard = +yes

    this setting is normally +enabled by default (even if the parameter is not written into the +). It makes the Add Printer Wizard icon +show up in the Printers folder of the Samba host's +share listing (as shown in Network Neighbourhood or +by the net view command). To disable it, you need to +explicitly set it to no (commenting it out +will not suffice!). The Add Printer Wizard lets you upload printer +drivers to the [print$] share and associate it +with a printer (if the respective queue exists there before the +action), or exchange a printer's driver against any other previously +uploaded driver.

    total print jobs = 100

    this setting sets the upper limit to 100 print jobs +being active on the Samba server at any one time. Should a client +submit a job which exceeds this number, a “no more space +available on server” type of error message will be returned by +Samba to the client. A setting of "0" (the default) means there is +no limit at all! +

    printcap name = /etc/printcap

    this tells Samba where to look for a list of +available printer names. (If you use CUPS, make sure that a printcap +file is written: this is controlled by the "Printcap" directive of +cupsd.conf). +

    printer admin = @ntadmin

    members of the ntadmin group should be able to add +drivers and set printer properties ("ntadmin" is only an example name, +it needs to be a valid UNIX group name); root is implicitly always a +printer admin. The "@" sign precedes group names in +. A printer admin can do anything to +printers via the remote administration interfaces offered by MS-RPC +(see below). Note that the printer admin +parameter is normally a share level parameter, so you may associate +different groups to different printer shares in larger installations, +if you use the printer admin parameter on the +share levels). +

    lpq cache time = 20

    this controls the cache time for the results of the +lpq command. It prevents the lpq command being called too often and +reduces load on a heavily used print server. +

    use client driver = no

    if set to yes, this setting only +takes effect for Win NT/2k/XP clients (and not for Win 95/98/ME). Its +default value is No (or False). +It must not be enabled on print shares +(with a yes or true setting) which +have valid drivers installed on the Samba server! For more detailed +explanations see the man page of smb.conf. +

    The [printers] Section

    +This is the second special section. If a section with this name +appears in the smb.conf, users are able to +connect to any printer specified in the Samba host's printcap file, +because Samba on startup then creates a printer share for every +printername it finds in the printcap file. You could regard this +section as a general convenience shortcut to share all printers with +minimal configuration. It is also a container for settings which +should apply as default to all printers. (For more details see the +smb.conf man page.) Settings inside this +container must be share level parameters (S). +

    comment = All printers

    the comment is shown next to +the share if a client queries the server, either via Network +Neighbourhood or with the net view command to list +available shares. +

    printable = yes

    please note well, that the +[printers] service must be +declared as printable. If you specify otherwise, smbd will refuse to +load at startup. This parameter allows +connected clients to open, write to and submit spool files into the +directory specified with the path parameter for +this service. It is used by Samba to differentiate printer shares from +file shares.

    path = /var/spool/samba

    this must point to a directory used by Samba to spool +incoming print files. It must not be the same as the spool +directory specified in the configuration of your UNIX print +subsystem! The path would typically point to a directory +which is world writeable, with the "sticky" bit set to it. +

    browseable = no

    this is always set to no if +printable = yes. It makes the +[printer] share itself invisible in the +list of available shares in a net view command or +in the Explorer browse list. (Note that you will of course see the +individual printers). +

    guest ok = yes

    +if set to yes, then no password is required to +connect to the printers service. Access will be granted with the +privileges of the guest account. On many systems the +guest account will map to a user named "nobody". This user is in the UNIX +passwd file with an empty password, but with no valid UNIX login. +(Note: on some systems the guest account might not have the +privilege to be able to print. Test this by logging in as your +guest user using su - guest and run a system print +command like +

    lpr -P printername /etc/motd

    public = yes

    this is a synonym for guest ok = +yes. Since we have guest ok = yes, +it really doesn't need to be here! (This leads to the interesting +question: “What, if I by accident have to contradictory settings +for the same share?” The answer is: the last one encountered by +Sambe wins. The "winner" is shown by testparm. Testparm doesn't +complain about different settings of the same parameter for the same +share! You can test this by setting up multiple lines for the "guest +account" parameter with different usernames, and then run testparm to +see which one is actually used by Samba.) +

    read only = yes

    this normally (for other types of shares) prevents +users creating or modifying files in the service's directory. However, +in a "printable" service, it is always allowed to +write to the directory (if user privileges allow the connection), but +only via print spooling operations. "Normal" write operations are not +allowed.

    writeable = no

    +synonym for read only = yes +

    Any [my_printer_name] Section

    +If a section appears in the , which is +tagged as printable = yes, Samba presents it as +a printer share to its clients. Note, that Win95/98/ME clients may +have problems with connecting or loading printer drivers if the share +name has more than 8 characters! Also be very careful if you give a +printer the same name as an existing user or file share name: upon a +client's connection request to a certain sharename, Samba always tries +to find file shares with that name first; if it finds one, it will +connect to this and will never ultimately connect to a printer with +the same name! +

    comment = Printer with Restricted Access

    the comment says it all. +

    path = /var/spool/samba_my_printer

    here we set the spooling area for this printer to +another directory than the default. It is not a requirement to set it +differently, but the option is available. +

    printer admin = kurt

    the printer admin definition is different for this +explicitly defined printer share from the general +[printers] share. It is not a requirement; we +did it to show that it is possible if you want it. +

    browseable = yes

    we also made this printer browseable (so that the +clients may conveniently find it when browsing the Network +Neighbourhood). +

    printable = yes

    see explanation in last subsection. +

    writeable = no

    see explanation in last subsection. +

    hosts allow = 10.160.50.,10.160.51.

    here we exercise a certain degree of access control +by using the hosts allow and hosts deny parameters. Note, that +this is not by any means a safe bet. It is not a way to secure your +printers. This line accepts all clients from a certain subnet in a +first evaluation of access control +

    hosts deny = turbo_xp,10.160.50.23,10.160.51.60 +

    all listed hosts are not allowed here (even if they +belong to the "allowed subnets"). As you can see, you could name IP +addresses as well as NetBIOS hostnames +here. +

    guest ok = no

    this printer is not open for the guest account! +

    Print Commands

    +In each section defining a printer (or in the +[printers] section), a print +command parameter may be defined. It sets a command to +process the files which have been placed into the Samba print spool +directory for that printer. (That spool directory was, if you +remember, set up with the path +parameter). Typically, this command will submit the spool file to the +Samba host's print subsystem, using the suitable system print +command. But there is no requirement that this needs to be the +case. For debugging purposes or some other reason you may want to do +something completely different than "print" the file. An example is a +command that just copies the print file to a temporary location for +further investigation when you need to debug printing. If you craft +your own print commands (or even develop print command shell scripts), +make sure you pay attention to the need to remove the files from the +Samba spool directory. Otherwise your hard disk may soon suffer from +shortage of free space. +

    Default Print Commands for various Unix Print Subsystems

    +You learned earlier on, that Samba in most cases uses its built-in +settings for many parameters if it can not find an explicitly stated +one in its configuration file. The same is true for the +print command. The default print command varies +depending on the printing =... parameter +setting. In the commands listed below, you will notice some parameters +of the form %X where X is +p, s, J etc. These letters stand for +"printername", "spoolfile" and "job ID" respectively. They are +explained in more detail further below. Here is an overview (excluding +the special case of CUPS, which is discussed in the next chapter): +

    If this setting is active......this is used in lieu of an explicit command:
    printing = bsd|aix|lprng|plpprint command is lpr -r -P%p %s
    printing = sysv|hpuxprint command is lp -c -P%p %s; rm %s
    printing = qnxprint command is lp -r -P%p -s %s
    printing = bsd|aix|lprng|plplpq command is lpq -P%p
    printing = sysv|hpuxlpq command is lpstat -o%p
    printing = qnxlpq command is lpq -P%p
    printing = bsd|aix|lprng|plplprm command is lprm -P%p %j
    printing = sysv|hpuxlprm command is cancel %p-%j
    printing = qnxlprm command is cancel %p-%j
    printing = bsd|aix|lprng|plplppause command is lp -i %p-%j -H hold
    printing = sysv|hpuxlppause command (...is empty)
    printing = qnxlppause command (...is empty)
    printing = bsd|aix|lprng|plplpresume command is lp -i %p-%j -H resume
    printing = sysv|hpuxlpresume command (...is empty)
    printing = qnxlpresume command (...is empty)

    +We excluded the special CUPS case here, because it is discussed in the +next chapter. Just a short summary. For printing = +CUPS: If SAMBA is compiled against libcups, it uses the +CUPS API to submit jobs, etc. (It is a good idea also to set +printcap = cups in case your +cupsd.conf is set to write its autogenerated +printcap file to an unusual place). Otherwise Samba maps to the System +V printing commands with the -oraw option for printing, i.e. it uses +lp -c -d%p -oraw; rm %s With printing = +cups , and if SAMBA is compiled against libcups, any +manually set print command will be ignored! +

    +Having listed the above mappings here, you should note that there used +to be a bug in recent 2.2.x versions which +prevented the mapping from taking effect. It lead to the +"bsd|aix|lprng|plp" settings taking effect for all other systems, for +the most important commands (the print command, the +lpq command and the lprm +command). The lppause command and the +lpresume command remained empty. Of course, these +commands worked on bsd|aix|lprng|plp but they didn't work on +sysv|hpux|qnx systems. To work around this bug, you need to +explicitly set the commands. Use testparm -v to +check which command takes effect. Then check that this command is +adequate and actually works for your installed print subsystem. It is +always a good idea to explicitly set up your configuration files the +way you want them to work and not rely on any built-in defaults. +

    Setting up your own Print Commands

    +After a print job has finished spooling to a service, the +print command will be used by Samba via a +system() call to process the spool file. Usually +the command specified will submit the spool file to the host's +printing subsystem. But there is no requirement at all that this must +be the case. The print subsystem will probably not remove the spool +file on its own. So whatever command you specify on your own you +should ensure that the spool file is deleted after it has been +processed. +

    +There is no difficulty with using your own customized print commands +with the traditional printing systems. However, if you don't wish to +"roll your own", you should be well informed about the default +built-in commands that Samba uses for each printing subsystem (see the +table above). In all the commands listed in the last paragraphs you +see parameters of the form %X These are +macros, or shortcuts, used as place holders for +the names of real objects. At the time of running a command with such +a placeholder, Samba will insert the appropriate value +automatically. Print commands can handle all Samba macro +substitutions. In regard to printing, the following ones do have +special relevance: +

    • %s, %f - the path to the spool +file name

    • %p - the appropriate printer +name

    • %J - the job name as +transmitted by the client.

    • %c - the number of printed +pages of the spooled job (if known).

    • %z - the size of the spooled +print job (in bytes)

    +The print command MUST contain at least one occurrence of +%s or %f. -- The +%p is optional. If no printer name is supplied, +the %p will be silently removed from the print +command. In this case the job is sent to the default printer. +

    +If specified in the [global] section, the print +command given will be used for any printable service that does not +have its own print command specified. If there is neither a specified +print command for a printable service nor a global print command, +spool files will be created but not processed! And (most importantly): +print files will not be removed, so they will start filling your Samba +hard disk. +

    +Note that printing may fail on some UNIXes from the "nobody" +account. If this happens, create an alternative guest account and +supply it with the privilege to print. Set up this guest account in +the [global] section with the guest +account parameter. +

    +You can form quite complex print commands. You need to realize that +print commands are just passed to a UNIX shell. The shell is able to +expand the included environment variables as usual. (The syntax to +include a UNIX environment variable $variable +in or in the Samba print command is +%$variable.) To give you a working +print command example, the following will log a +print job to /tmp/print.log, print the file, then +remove it. Note that ';' is the usual separator for commands in shell +scripts: +

    +
+ print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s
+
+

    +You may have to vary your own command considerably from this example +depending on how you normally print files on your system. The default +for the print command parameter varies depending on the setting of +the printing parameter. Another example is: +

    + print command = /usr/local/samba/bin/myprintscript %p %s
+

    Innovations in Samba Printing since 2.2

    +Before version 2.2.0, Samba's print server support for Windows clients +was limited to the level of LanMan printing +calls. This is the same protocol level as Windows 9x PCs offer when +they share printers. Beginning with the 2.2.0 release, Samba started +to support the native Windows NT printing mechanisms. These are +implemented via MS-RPC (RPC = Remote +Procedure Calls ). MS-RPCs use the +SPOOLSS named pipe for all printing. +

    +The additional functionality provided by the new SPOOLSS support includes: +

    • Support for downloading printer driver files to Windows +95/98/NT/2000 clients upon demand (Point'n'Print); +

    • Uploading of printer drivers via the Windows NT +Add Printer Wizard (APW) or the +Imprints tool set (refer to http://imprints.sourceforge.net); +

    • Support for the native MS-RPC printing calls such as +StartDocPrinter, EnumJobs(), etc... (See the MSDN documentation +at http://msdn.microsoft.com/ +for more information on the Win32 printing API);

    • Support for NT Access Control +Lists (ACL) on printer objects;

    • Improved support for printer queue manipulation +through the use of internal databases for spooled job information +(implemented by various *.tdb +files).

    +One other benefit of an update is this: Samba-3 is able to publish +all its printers in Active Directory (or LDAP)! +

    +One slight difference is here: it is possible on a Windows NT print +server to have printers listed in the Printers folder which are +not shared. Samba does not make this +distinction. By definition, the only printers of which Samba is aware +are those which are specified as shares in +. The reason is that Windows NT/2k/XPprof +clients do not normally need to use the standard SMB printer share; +rather they can print directly to any printer on another Windows NT +host using MS-RPC. This of course assumes that the printing client has +the necessary privileges on the remote host serving the printer. The +default permissions assigned by Windows NT to a printer gives the +"Print" permissions to the well-known Everyone +group. (The older clients of type Win9x can only print to "shared" +printers). +

    Client Drivers on Samba Server for Point'n'Print

    +There is still confusion about what all this means: Is it or +is it not a requirement for printer drivers to be installed on a Samba +host in order to support printing from Windows clients? The +answer to this is: No, it is not a +requirement. Windows NT/2000 clients can, of +course, also run their APW to install drivers +locally (which then connect to a Samba served +print queue). This is the same method as used by Windows 9x +clients. (However, a bug existed in Samba 2.2.0 +which made Windows NT/2000 clients require that the Samba server +possess a valid driver for the printer. This was fixed in Samba +2.2.1). +

    +But it is a new option to install the printer +drivers into the [print$] share of the Samba +server, and a big convenience too. Then all +clients (including 95/98/ME) get the driver installed when they first +connect to this printer share. The uploading or +depositing of the driver into this +[print$] share, and the following binding of +this driver to an existing Samba printer share can be achieved by +different means: +

    • running the APW on an +NT/2k/XPprof client (this doesn't work from 95/98/ME +clients);

    • using the Imprints +toolset;

    • using the smbclient and +rpcclient commandline tools;

    • using cupsaddsmb(only works for +the CUPS printing system, not for LPR/LPD, LPRng +etc.).

    +Please take additional note of the following fact: Samba +does not use these uploaded drivers in any way to process spooled +files. Drivers are utilized entirely by the clients, who +download and install them via the "Point 'n'Print" mechanism supported +by Samba. The clients use these drivers to generate print files in the +format the printer (or the Unix print system) requires. Print files +received by Samba are handed over to the Unix printing system, which +is responsible for all further processing, if needed. +

    The [printer$] Section is removed from Samba-3

    +[print$] vs. [printer$] +.  +Versions of Samba prior to 2.2 made it possible to use a share +named [printer$]. This name was taken from the +same named service created by Windows 9x clients when a printer was +shared by them. Windows 9x printer servers always have a +[printer$] service which provides read-only +access (with no password required) in order to support printer driver +downloads. However, Samba's initial implementation allowed for a +parameter named printer driver location to be +used on a per share basis. This specified the location of the driver +files associated with that printer. Another parameter named +printer driver provided a means of defining the +printer driver name to be sent to the client. These parameters, +including the printer driver file parameter, +are now removed and can not be used in installations of Samba-3.0. +Now the share name [print$] is used for the +location of downloadable printer drivers. It is taken from the +[print$] service created by Windows NT PCs when +a printer is shared by them. Windows NT print servers always have a +[print$] service which provides read-write +access (in the context of its ACLs) in order to support printer driver +down- and uploads. Don't fear -- this does not mean Windows 9x +clients are thrown aside now. They can use Samba's +[print$] share support just fine. +

    Creating the [print$] Share

    +In order to support the up- and downloading of printer driver files, +you must first configure a file share named +[print$]. The "public" name of this share is +hard coded in Samba's internals (because it is hardcoded in the MS +Windows clients too). It cannot be renamed since Windows clients are +programmed to search for a service of exactly this name if they want +to retrieve printer driver files. +

    +You should modify the server's file to +add the global parameters and create the +[print$] file share (of course, some of the +parameter values, such as 'path' are arbitrary and should be replaced +with appropriate values for your site): +

    + [global]
+      ; members of the ntadmin group should be able to add drivers and set
+      ; printer properties. root is implicitly always a 'printer admin'.
+      printer admin = @ntadmin
+      [....]
+
+ [printers]
+      [....]
+
+ [print$]
+      comment = Printer Driver Download Area
+      path = /etc/samba/drivers
+      browseable = yes
+      guest ok = yes
+      read only = yes
+      write list = @ntadmin, root
+

    +Of course, you also need to ensure that the directory named by the +path parameter exists on the Unix file system. +

    Parameters in the [print$] Section

    +[print$] is a special section in +. It contains settings relevant to +potential printer driver download and local installation by clients. +

    comment = Printer Driver +Download Area

    the comment appears next to the share name if it is +listed in a share list (usually Windows clients won't see it often but +it will also appear up in a smbclient -L sambaserver + output).

    path = /etc/samba/printers

    this is the path to the location of the Windows +driver file deposit from the UNIX point of +view.

    browseable = no

    this makes the [print$] share +"invisible" in Network Neighbourhood to clients. However, you can +still "mount" it from any client using the net use +g:\\sambaserver\print$ command in a "DOS box" or the +"Connect network drive" menu from Windows +Explorer.

    guest ok = yes

    this gives read only access to this share for all +guest users. Access may be used to download and install printer +drivers on clients. The requirement for guest ok = +yes depends upon how your site is configured. If users +will be guaranteed to have an account on the Samba host, then this is +a non-issue.

    Note

    +The non-issue is this: if all your Windows NT users are guaranteed to +be authenticated by the Samba server (for example if Samba +authenticates via an NT domain server and the NT user has already been +validated by the Domain Controller in order to logon to the Windows NT +session), then guest access is not necessary. Of course, in a +workgroup environment where you just want to be able to print without +worrying about silly accounts and security, then configure the share +for guest access. You'll probably want to add map to guest += Bad User in the [global] section +as well. Make sure you understand what this parameter does before +using it. +

    read only = yes

    as we don't want everybody to upload driver files (or +even change driver settings) we tagged this share as not +writeable.

    write list = @ntadmin,root

    since the [print$] was made +read only by the previous setting, we need to create a "write list" +also. UNIX groups (denoted with a leading "@" character) and users +listed here are allowed write access (as an exception to the general +public's "read-only" access), which they need to update files on the +share. Normally you will want to only name administrative level user +accounts in this setting. Check the file system permissions to make +sure these accounts can copy files to the share. If this is a non-root +account, then the account should also be mentioned in the global +printer admin parameter. See the + man page for more information on +configuring file shares.

    Subdirectory Structure in [print$]

    +In order for a Windows NT print server to support the downloading of +driver files by multiple client architectures, you must create several +subdirectories within the [print$] service +(i.e. the Unix directory named by the path +parameter). These correspond to each of the supported client +architectures. Samba follows this model as well. Just like the name of +the [print$] share itself, the subdirectories +*must* be exactly the names listed below (you may leave out the +subdirectories of architectures you don't want to support). +

    +Therefore, create a directory tree below the +[print$] share for each architecture you wish +to support. +

    +[print$]--+--
+          |--W32X86           # serves drivers to "Windows NT x86"
+          |--WIN40            # serves drivers to "Windows 95/98"
+          |--W32ALPHA         # serves drivers to "Windows NT Alpha_AXP"
+          |--W32MIPS          # serves drivers to "Windows NT R4000"
+          |--W32PPC           # serves drivers to "Windows NT PowerPC"
+

    Required permissions

    +In order to add a new driver to your Samba host, one of two conditions +must hold true: +

    • The account used to connect to the Samba host must +have a UID of 0 (i.e. a root account)

    • The account used to connect to the Samba host must be +named in the printer adminlist.

    +Of course, the connected account must still possess access to add +files to the subdirectories beneath +[print$]. Remember that all file shares are set +to 'read only' by default. +

    +Once you have created the required [print$] +service and associated subdirectories, go to a Windows NT 4.0/2k/XP +client workstation. Open Network Neighbourhood or +My Network Places and browse for the Samba host. +Once you have located the server, navigate to its Printers and +Faxes folder. You should see an initial listing of printers +that matches the printer shares defined on your Samba host. +

    Installing Drivers into [print$]

    +You have successfully created the [print$] +share in ? And Samba has re-read its +configuration? Good. But you are not yet ready to take off. The +driver files need to be present in this share, +too! So far it is still an empty share. Unfortunatly, it is not enough +to just copy the driver files over. They need to be set +up too. And that is a bit tricky, to say the least. We +will now discuss two alternative ways to install the drivers into +[print$]: +

    • using the Samba commandline utility +rpcclient with its various subcommands (here: +adddriver and setdriver) from +any UNIX workstation;

    • running a GUI (Printer +Properties and Add Printer Wizard) +from any Windows NT/2k/XP client workstation.

    +The latter option is probably the easier one (even if the only +entrance to this realm seems a little bit weird at first). +

    Setting Drivers for existing Printers with a Client GUI

    +The initial listing of printers in the Samba host's +Printers folder accessed from a client's Explorer +will have no real printer driver assigned to them. By default, in +Samba-3 (as in 2.2.1 and later) this driver name is set to a NULL +string. This must be changed now. The local Add Printer +Wizard, run from NT/2000/XP clients, will help us in this +task. +

    +However, the job to set a valid driver for the printer is not a +straightforward one: You must attempt to view the printer properties +for the printer to which you want the driver assigned. Open the +Windows Explorer, open Network Neighbourhood, browse to the Samba +host, open Samba's Printers folder, right-click the printer icon and +select Properties.... You are now trying to view printer and driver +properties for a queue which has this default NULL driver +assigned. This will result in an error message (this is normal here): +

    Device settings cannot be displayed. The driver +for the specified printer is not installed, only spooler properties +will be displayed. Do you want to install the driver +now?

    +Important:Don't click Yes! Instead, +click No in the error dialog. +Only now you will be presented with the printer properties window. From here, +the way to assign a driver to a printer is open to us. You have now the choice +either: +

    • select a driver from the popup list of installed +drivers. Initially this list will be empty. +Or

    • use the New Driver... button to +install a new printer driver (which will in fact start up the +APW).

    +Once the APW is started, the procedure is exactly the same as the one +you are familiar with in Wiindows (we assume here that you are +familiar with the printer driver installations procedure on Windows +NT). Make sure your connection is in fact setup as a user with +printer admin privileges (if in doubt, use +smbstatus to check for this). If you wish to +install printer drivers for client operating systems other than +Windows NT x86, you will need to use the +Sharing tab of the printer properties dialog. +

    +Assuming you have connected with an administrative (or root) account +(as named by the printer admin parameter), +you will also be able to modify other printer properties such as ACLs +and default device settings using this dialog. For the default device +settings, please consider the advice given further below. +

    Setting Drivers for existing Printers with +rpcclient

    +The second way to install printer drivers into +[print$] and set them up in a valid way can be +done from the UNIX command line. This involves four distinct steps: +

    1. gathering the info about the required driver files +and collecting the files together;

    2. deposit the driver files into the +[print$] share's correct subdirectories +(possibly by using smbclient);

    3. running the rpcclient +commandline utility once with the addriver +subcommand,

    4. running rpcclient a second +time with the setdriver +subcommand.

    +We will provide detailed hints for each of these steps in the next few +paragraphs. +

    Identifying the Driver Files

    +To find out about the driver files, you have two options: you could +investigate the driver CD which comes with your printer. Study the +*.inf file on the CD, if it is contained. This +may not be the possible, since the *.inf file might be +missing. Unfortunately, many vendors have now started to use their own +installation programs. These installations packages are often some +sort of Windows platform archive format, plus, the files may get +re-named during the installation process. This makes it extremely +difficult to identify the driver files you need. +

    +Then you only have the second option: install the driver first on a +Windows client *locally* and investigate which file names and paths it +uses after they are installed. (Note, that you need to repeat this +procedure for every client platform you want to support. We are going +to show it here for the W32X86 platform only, a +name used by Microsoft for all WinNT/2k/XP clients...) +

    +A good method to recognize the driver files this is to print the test +page from the driver's Properties Dialog +(General tab). Then look at the list of driver +files named on the printout. You'll need to recognize what Windows +(and Samba) are calling the Driver File , the +Data File, the Config File, +the Help File and (optionally) the +Dependent Driver Files (this may vary slightly +for Windows NT). You need to remember all names (or better take a +note) for the next steps. +

    +Another method to quickly test the driver filenames and related paths +is provided by the rpcclient utility. Run it with +enumdrivers or with the +getdriver subcommand, each in the +3 level. In the following example, +TURBO_XP is the name of the Windows PC (in this +case it was a Windows XP Professional laptop, BTW). I had installed +the driver locally to TURBO_XP while kde-bitshop is +the name of the Linux host from which I am working. We could run an +interactive rpcclient session; +then we'd get an rpcclient /> prompt and would +type the subcommands at this prompt. This is left as a good exercise +to the reader. For now we use rpcclient with the +-c parameter to execute a single subcommand +line and exit again. This is the method you would use if you want to +create scripts to automate the procedure for a large number of +printers and drivers. Note the different quotes used to overcome the +different spaces in between words: +

    +root# rpcclient -U'Danka%xxxx' -c 'getdriver "Heidelberg Digimaster 9110 (PS)" 3' TURBO_XP
+  cmd = getdriver "Heidelberg Digimaster 9110 (PS)" 3
+
+  [Windows NT x86]
+  Printer Driver Info 3:
+          Version: [2]
+          Driver Name: [Heidelberg Digimaster 9110 (PS)]
+          Architecture: [Windows NT x86]
+          Driver Path: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.DLL]
+          Datafile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.ppd]
+          Configfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.DLL]
+          Helpfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.HLP]
+  
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.DLL]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.INI]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1KMMin.DLL]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.dat]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.cat]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.def]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hre]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.vnd]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hlp]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de_reg.HLP]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01Aux.dll]
+          Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.NTF]
+  
+          Monitorname: []
+          Defaultdatatype: []
+
+

    +You may notice, that this driver has quite a big number of +Dependentfiles (I know worse cases however). Also, +strangely, the Driver File is here tagged as +Driver Path.... oh, well. Here we don't have yet +support for the so-called WIN40 architecture +installed. This name is used by Microsoft for the Win95/98/ME platforms. +If we want to support these, we need to install the Win95/98/ME driver +files in addition to those for W32X86 +(i.e. the WinNT72000/XP clients) onto a Windows PC. This PC +can also host the Win9x drivers, even if itself runs on Windows NT, +2000 or XP. +

    +Since the [print$] share is usually accessible +through the Network Neighbourhood, you can also use the UNC notation +from Windows Explorer to poke at it. The Win9x driver files will end +up in subdirectory "0" of the "WIN40" directory. The full path to +access them will be +\\WINDOWSHOST\print$\WIN40\0\. +

    Note

    more recent drivers on Windows 2000 and Wndows XP are +installed into the "3" subdirectory instead of the "2". The version 2 +of drivers, as used in Windows NT, were running in Kernel Mode. +Windows 2000 changed this. While it still can use the Kernel Mode +drivers (if this is enabled by the Admin), its native mode for printer +drivers is User Mode execution. This requires drivers designed for +this. These type of drivers install into the "3" subdirectory. +

    Collecting the Driver Files from a Windows Host's +[print$] Share

    +Now we need to collect all the driver files we identified. in our +previous step. Where do we get them from? Well, why not retrieve them +from the very PC and the same [print$] share +which we investigated in our last step to identify the files? We can +use smbclient to do this. We will use the paths and +names which were leaked to us by getdriver. The +listing is edited to include linebreaks for readability: +

    +root# smbclient //TURBO_XP/print\$ -U'Danka%xxxx'	\ 
+	-c 'cd W32X86/2;mget HD*_de.*             \
+	hd*ppd Hd*_de.* Hddm*dll HDN*Aux.DLL'
+  added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
+  Got a positive name query response from 10.160.50.8 ( 10.160.50.8 )
+  Domain=[DEVELOPMENT] OS=[Windows 5.1] Server=[Windows 2000 LAN Manager]
+  Get file Hddm91c1_de.ABD? n
+  Get file Hddm91c1_de.def? y
+  getting file \W32X86\2\Hddm91c1_de.def of size 428 as Hddm91c1_de.def (22.0 kb/s) (average 22.0 kb/s)
+  Get file Hddm91c1_de.DLL? y
+  getting file \W32X86\2\Hddm91c1_de.DLL of size 876544 as Hddm91c1_de.DLL (737.3 kb/s) (average 737.3 kb/s)
+  [...]
+
+

    +After this command is complete, the files are in our current local +directory. You probably have noticed that this time we passed several +commands to the -c parameter, separated by semi-colons. This +effects that all commands are executed in sequence on the remote +Windows server before smbclient exits again. +

    +Don't forget to repeat the procedure for the WIN40 +architecture should you need to support Win95/98/XP clients. Remember, the +files for these architectures are in the WIN40/0/ subdir. Once we are +complete, we can run smbclient ... put to store +the collected files on the Samba server's +[print$] share. +

    Depositing the Driver Files into [print$]

    +So, now we are going to put the driver files into the +[print$] share. Remember, the UNIX path to this +share has been defined previously in your +. You also have created subdirectories +for the different Windows client types you want to support. Supposing +your [print$] share maps to the UNIX path +/etc/samba/drivers/, your driver files should now +go here: +

    • for all Windows NT, 2000 and XP clients into +/etc/samba/drivers/W32X86/ but +*not*(yet) into the "2" subdir!

    • for all Windows 95, 98 and ME clients into +/etc/samba/drivers/WIN40/ -- but *not* +(yet) into the "0" subdir!

    +We again use smbclient to transfer the driver files across the +network. We specify the same files and paths as were leaked to us by +running getdriver against the original +Windows install. However, now we are going to +store the files into a Samba/UNIX print server's +[print$] share... +

    +root# smbclient //SAMBA-CUPS/print\$ -U'root%xxxx' -c 'cd W32X86; put HDNIS01_de.DLL; \
+  put Hddm91c1_de.ppd; put HDNIS01U_de.DLL;        \
+  put HDNIS01U_de.HLP; put Hddm91c1_de.DLL;        \
+  put Hddm91c1_de.INI; put Hddm91c1KMMin.DLL;      \
+  put Hddm91c1_de.dat; put Hddm91c1_de.dat;        \
+  put Hddm91c1_de.def; put Hddm91c1_de.hre;        \
+  put Hddm91c1_de.vnd; put Hddm91c1_de.hlp;        \
+  put Hddm91c1_de_reg.HLP; put HDNIS01Aux.dll;     \
+  put HDNIS01_de.NTF'
+ added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
+ Got a positive name query response from 10.160.51.162 ( 10.160.51.162 )
+ Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a]
+ putting file HDNIS01_de.DLL as \W32X86\HDNIS01_de.DLL (4465.5 kb/s) (average 4465.5 kb/s)
+ putting file Hddm91c1_de.ppd as \W32X86\Hddm91c1_de.ppd (12876.8 kb/s) (average 4638.9 kb/s)
+ putting file HDNIS01U_de.DLL as \W32X86\HDNIS01U_de.DLL (20249.8 kb/s) (average 5828.3 kb/s)
+ putting file HDNIS01U_de.HLP as \W32X86\HDNIS01U_de.HLP (9652.8 kb/s) (average 5899.8 kb/s)
+ putting file Hddm91c1_de.DLL as \W32X86\Hddm91c1_de.DLL (23777.7 kb/s) (average 10400.6 kb/s)
+ putting file Hddm91c1_de.INI as \W32X86\Hddm91c1_de.INI (98.6 kb/s) (average 10329.0 kb/s)
+ putting file Hddm91c1KMMin.DLL as \W32X86\Hddm91c1KMMin.DLL (22931.5 kb/s) (average 10501.7 kb/s)
+ putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat (2462.8 kb/s) (average 10393.0 kb/s)
+ putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat (4925.3 kb/s) (average 10356.3 kb/s)
+ putting file Hddm91c1_de.def as \W32X86\Hddm91c1_de.def (417.9 kb/s) (average 10290.1 kb/s)
+ putting file Hddm91c1_de.hre as \W32X86\Hddm91c1_de.hre (22571.3 kb/s) (average 11338.5 kb/s)
+ putting file Hddm91c1_de.vnd as \W32X86\Hddm91c1_de.vnd (3384.6 kb/s) (average 10754.3 kb/s)
+ putting file Hddm91c1_de.hlp as \W32X86\Hddm91c1_de.hlp (18406.8 kb/s) (average 10839.8 kb/s)
+ putting file Hddm91c1_de_reg.HLP as \W32X86\Hddm91c1_de_reg.HLP (20278.3 kb/s) (average 11386.3 kb/s)
+ putting file HDNIS01Aux.dll as \W32X86\HDNIS01Aux.dll (14994.6 kb/s) (average 11405.2 kb/s)
+ putting file HDNIS01_de.NTF as \W32X86\HDNIS01_de.NTF (23390.2 kb/s) (average 13170.8 kb/s)
+
+

    +Phewww -- that was a lot of typing! Most drivers are a lot smaller -- +many only having 3 generic PostScript driver files plus 1 PPD. Note, +that while we did retrieve the files from the "2" subdirectory of the +"W32X86" directory from the Windows box, we don't +put them (for now) in this same subdirectory of the Samba box! This +re-location will automatically be done by the +adddriver command which we will run shortly (and +don't forget to also put the files for the Win95/98/ME architecture +into the WIN40/ subdirectory should you need +them). +

    Check if the Driver Files are there (with smbclient)

    +For now we verify that our files are there. This can be done with +smbclient too (but of course you can log in via SSH +also and do this through a standard UNIX shell access too): +

    +root# smbclient //SAMBA-CUPS/print\$ -U 'root%xxxx' -c 'cd W32X86; pwd; dir; cd 2; pwd; dir'
+ added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
+ Got a positive name query response from 10.160.51.162 ( 10.160.51.162 )
+ Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a]
+
+  Current directory is \\SAMBA-CUPS\print$\W32X86\
+  .                                   D        0  Sun May  4 03:56:35 2003
+  ..                                  D        0  Thu Apr 10 23:47:40 2003
+  2                                   D        0  Sun May  4 03:56:18 2003
+  HDNIS01Aux.dll                      A    15356  Sun May  4 03:58:59 2003
+  Hddm91c1KMMin.DLL                   A    46966  Sun May  4 03:58:59 2003
+  HDNIS01_de.DLL                      A   434400  Sun May  4 03:58:59 2003
+  HDNIS01_de.NTF                      A   790404  Sun May  4 03:56:35 2003
+  Hddm91c1_de.DLL                     A   876544  Sun May  4 03:58:59 2003
+  Hddm91c1_de.INI                     A      101  Sun May  4 03:58:59 2003
+  Hddm91c1_de.dat                     A     5044  Sun May  4 03:58:59 2003
+  Hddm91c1_de.def                     A      428  Sun May  4 03:58:59 2003
+  Hddm91c1_de.hlp                     A    37699  Sun May  4 03:58:59 2003
+  Hddm91c1_de.hre                     A   323584  Sun May  4 03:58:59 2003
+  Hddm91c1_de.ppd                     A    26373  Sun May  4 03:58:59 2003
+  Hddm91c1_de.vnd                     A    45056  Sun May  4 03:58:59 2003
+  HDNIS01U_de.DLL                     A   165888  Sun May  4 03:58:59 2003
+  HDNIS01U_de.HLP                     A    19770  Sun May  4 03:58:59 2003
+  Hddm91c1_de_reg.HLP                 A   228417  Sun May  4 03:58:59 2003
+                40976 blocks of size 262144. 709 blocks available
+
+  Current directory is \\SAMBA-CUPS\print$\W32X86\2\
+  .                                   D        0  Sun May  4 03:56:18 2003
+  ..                                  D        0  Sun May  4 03:56:35 2003
+  ADOBEPS5.DLL                        A   434400  Sat May  3 23:18:45 2003
+  laserjet4.ppd                       A     9639  Thu Apr 24 01:05:32 2003
+  ADOBEPSU.DLL                        A   109568  Sat May  3 23:18:45 2003
+  ADOBEPSU.HLP                        A    18082  Sat May  3 23:18:45 2003
+  PDFcreator2.PPD                     A    15746  Sun Apr 20 22:24:07 2003
+                40976 blocks of size 262144. 709 blocks available
+
+

    +Notice that there are already driver files present in the +2 subdir (probably from a previous +installation). Once the files for the new driver are there too, you +are still a few steps away from being able to use them on the +clients. The only thing you could do *now* is to retrieve them from a +client just like you retrieve ordinary files from a file share, by +opening print$ in Windows Explorer. But that wouldn't install them per +Point'n'Print. The reason is: Samba doesn't know yet that these files +are something special, namely printer driver +files and it doesn't know yet to which print queue(s) these +driver files belong. +

    Running rpcclient with +adddriver

    +So, next you must tell Samba about the special category of the files +you just uploaded into the [print$] share. This +is done by the adddriver command. It will +prompt Samba to register the driver files into its internal TDB +database files. The following command and its output has been edited, +again, for readability: +

    +root# rpcclient -Uroot%xxxx -c 'adddriver "Windows NT x86" "dm9110:HDNIS01_de.DLL: \
+  Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP:   \
+  NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI,          \
+  Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,   \
+  Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \
+  HDNIS01Aux.dll,HDNIS01_de.NTF,                     \
+  Hddm91c1_de_reg.HLP' SAMBA-CUPS
+
+ cmd = adddriver "Windows NT x86" "dm9110:HDNIS01_de.DLL:Hddm91c1_de.ppd:HDNIS01U_de.DLL:    \
+  HDNIS01U_de.HLP:NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \
+  Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,          \
+  Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL,        \
+  HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP"
+
+ Printer Driver dm9110 successfully installed.
+
+

    +After this step the driver should be recognized by Samba on the print +server. You need to be very carefull when typing the command. Don't +exchange the order of the fields. Some changes would lead to a +NT_STATUS_UNSUCCESSFUL error +message. These become obvious. Other changes might install the driver +files successfully, but render the driver unworkable. So take care! +Hints about the syntax of the adddriver command are in the man +page. The CUPS printing chapter of this HOWTO collection provides a +more detailed description, if you should need it. +

    Check how Driver Files have been moved after +adddriver finished

    +One indication for Samba's recognition of the files as driver files is +the successfully installed message. +Another one is the fact, that our files have been moved by the +adddriver command into the 2 +subdirectory. You can check this again with +smbclient: +

    +root# smbclient //SAMBA-CUPS/print\$ -Uroot%xxxx -c 'cd W32X86;dir;pwd;cd 2;dir;pwd'
+ added interface ip=10.160.51.162 bcast=10.160.51.255 nmask=255.255.252.0
+ Domain=[CUPS-PRINT] OS=[Unix] Server=[Samba 2.2.7a]
+
+  Current directory is \\SAMBA-CUPS\print$\W32X86\
+  .                                   D        0  Sun May  4 04:32:48 2003
+  ..                                  D        0  Thu Apr 10 23:47:40 2003
+  2                                   D        0  Sun May  4 04:32:48 2003
+                40976 blocks of size 262144. 731 blocks available 
+
+  Current directory is \\SAMBA-CUPS\print$\W32X86\2\
+  .                                   D        0  Sun May  4 04:32:48 2003
+  ..                                  D        0  Sun May  4 04:32:48 2003
+  DigiMaster.PPD                      A   148336  Thu Apr 24 01:07:00 2003
+  ADOBEPS5.DLL                        A   434400  Sat May  3 23:18:45 2003
+  laserjet4.ppd                       A     9639  Thu Apr 24 01:05:32 2003
+  ADOBEPSU.DLL                        A   109568  Sat May  3 23:18:45 2003
+  ADOBEPSU.HLP                        A    18082  Sat May  3 23:18:45 2003
+  PDFcreator2.PPD                     A    15746  Sun Apr 20 22:24:07 2003
+  HDNIS01Aux.dll                      A    15356  Sun May  4 04:32:18 2003
+  Hddm91c1KMMin.DLL                   A    46966  Sun May  4 04:32:18 2003
+  HDNIS01_de.DLL                      A   434400  Sun May  4 04:32:18 2003
+  HDNIS01_de.NTF                      A   790404  Sun May  4 04:32:18 2003
+  Hddm91c1_de.DLL                     A   876544  Sun May  4 04:32:18 2003
+  Hddm91c1_de.INI                     A      101  Sun May  4 04:32:18 2003
+  Hddm91c1_de.dat                     A     5044  Sun May  4 04:32:18 2003
+  Hddm91c1_de.def                     A      428  Sun May  4 04:32:18 2003
+  Hddm91c1_de.hlp                     A    37699  Sun May  4 04:32:18 2003
+  Hddm91c1_de.hre                     A   323584  Sun May  4 04:32:18 2003
+  Hddm91c1_de.ppd                     A    26373  Sun May  4 04:32:18 2003
+  Hddm91c1_de.vnd                     A    45056  Sun May  4 04:32:18 2003
+  HDNIS01U_de.DLL                     A   165888  Sun May  4 04:32:18 2003
+  HDNIS01U_de.HLP                     A    19770  Sun May  4 04:32:18 2003
+  Hddm91c1_de_reg.HLP                 A   228417  Sun May  4 04:32:18 2003
+                40976 blocks of size 262144. 731 blocks available
+
+

    +Another verification is that the timestamp of the printing TDB files +is now updated (and possibly their filesize has increased). +

    Check if the Driver is recognized by Samba

    +Now the driver should be registered with Samba. We can easily verify +this, and will do so in a moment. However, this driver is +not yet associated with a particular +printer. We may check the driver status of the +files by at least three methods: +

    • from any Windows client browse Network Neighbourhood, +finde the Samba host and open the Samba Printers and +Faxes folder. Select any printer icon, right-click and +select the printer Properties. Click on the +Advanced tab. Here is a field indicating the +driver for that printer. A drop down menu allows you to change that +driver (be carefull to not do this unwittingly.). You can use this +list to view all drivers know to Samba. Your new one should be amongst +them. (Each type of client will only see his own architecture's +list. If you don't have every driver installed for each platform, the +list will differ if you look at it from Windows95/98/ME or +WindowsNT/2000/XP.)

    • from a Windows 2000 or XP client (not WinNT) browse +Network Neighbourhood, search for the Samba +server and open the server's Printers folder, +right-click the white background (with no printer highlighted). Select +Server Properties. On the +Drivers tab you will see the new driver listed +now. This view enables you to also inspect the list of files belonging +to that driver (this doesn't work on Windows NT, but only on +Windows 2000 and Windows XP. WinNT doesn't provide the "Drivers" +tab).. An alternative, much quicker method for Windows +2000/XP to start this dialog is by typing into a DOS box (you must of +course adapt the name to your Samba server instead of SAMBA-CUPS): +

      rundll32 printui.dll,PrintUIEntry /s /t2 /n\\SAMBA-CUPS

    • from a UNIX prompt run this command (or a variant +thereof), where SAMBA-CUPS is the name of the Samba +host and "xxxx" represents the actual Samba password assigned to root: +

      rpcclient -U'root%xxxx' -c 'enumdrivers' SAMBA-CUPS

      +You will see a listing of all drivers Samba knows about. Your new one +should be amongst them. But it is only listed under the [Windows NT +x86] heading, not under [Windows 4.0], +since we didn't install that part. Or did *you*? -- You will see a listing of +all drivers Samba knows about. Your new one should be amongst them. In our +example it is named dm9110. Note that the 3rd column +shows the other installed drivers twice, for each supported architecture one +time. Our new driver only shows up for +Windows NT 4.0 or 2000. To +have it present for Windows 95, 98 and ME you'll +have to repeat the whole procedure with the WIN40 architecture and subdirectory. +

    A sidenote: you are not bound to specific driver names

    +You can name the driver as you like. If you repeat the +adddriver step, with the same files as before, but +with a different driver name, it will work the same: +

    +root# rpcclient -Uroot%xxxx                                        \
+      -c 'adddriver "Windows NT x86"                     \
+      "myphantasydrivername:HDNIS01_de.DLL:              \
+      Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP:   \
+      NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI,          \
+      Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,   \
+      Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \
+      HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP' SAMBA-CUPS
+  
+
+ cmd = adddriver "Windows NT x86" 
+                 "myphantasydrivername:HDNIS01_de.DLL:Hddm91c1_de.ppd:HDNIS01U_de.DLL:\
+                  HDNIS01U_de.HLP:NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI,           \
+                  Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,                    \
+                  Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL,                  \
+                  HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP"
+
+ Printer Driver myphantasydrivername successfully installed.
+
+

    +You will also be able to bind that driver to any print queue (however, +you are responsible yourself that you associate drivers to queues +which make sense to the target printer). Note, that you can't run the +rpcclient adddriver command +repeatedly. Each run "consumes" the files you had put into the +[print$] share by moving them into the +respective subdirectories. So you must precede an +smbclient ... put command before each +rpcclient ... addriver" command. +

    La Grande Finale: Running rpcclient with +setdriver

    +Samba still needs to know which printer's driver +this is. It needs to create a mapping of the driver to a printer, and +store this info in its "memory", the TDB files. The rpcclient +setdriver command achieves exactly this: +

    +root# rpcclient -U'root%xxxx' -c 'setdriver dm9110 myphantasydrivername' SAMBA-CUPS
+ cmd = setdriver dm9110 myphantasydrivername
+ Successfully set dm9110 to driver myphantasydrivername.
+

    +Ahhhhh -- no, I didn't want to do that. Repeat, this time with the +name I intended: +

    +root# rpcclient -U'root%xxxx' -c 'setdriver dm9110 dm9110' SAMBA-CUPS
+ cmd = setdriver dm9110 dm9110
+ Succesfully set dm9110 to driver dm9110.
+

    +The syntax of the command is rpcclient +-U'root%sambapassword' -c 'setdriver +"printername" +"drivername' +SAMBA-Hostname . -- +Now we have done *most* of the work. But not yet all.... +

    Note

    +the setdriver command will only succeed if the printer is +known to +Samba already. A bug in 2.2.x prevented Samba from recognizing freshly +installed printers. You had to restart Samba, or at least send a HUP +signal to all running smbd processes to work around this: +kill -HUP `pidof smbd`.

    "The Proof of the Pudding lies in the Eating" (Client Driver Insta +Procedure)

    +A famous philosopher said once: “The Proof of the Pudding lies +in the Eating”. The proof for our setup lies in the printing. +So let's install the printer driver onto the client PCs. This is not +as straightforward as it may seem. Read on. +

    The first Client Driver Installation

    +Especially important is the installation onto the first client PC (for +each architectural platform separately). Once this is done correctly, +all further clients are easy to setup and shouldn't need further +attention. What follows is a description for the recommended first +procedure. You work now from a client workstation. First you should +guarantee that your connection is not unwittingly mapped to +bad user "nobody". In a DOS box type: +

    net use \\SAMBA-SERVER\print$ /user:root

    +Replace root, if needed, by another valid +printer admin user as given in the definition. +Should you already be connected as a different user, you'll get an error +message. There is no easy way to get rid of that connection, because +Windows doesn't seem to know a concept of "logging off" from a share +connection (don't confuse this with logging off from the local +workstation; that is a different matter). You can try to close +all Windows file explorer and Internet Explorer +windows. As a last resort, you may have to reboot. Make sure there is +no automatic re-connection set up. It may be easier to go to a +different workstation and try from there. After you have made sure you +are connected as a printer admin user (you can check this with the +smbstatus command on Samba) do this from the +Windows workstation: +

    • Open Network +Neighbourhood

    • Browse to Samba server

    • Open its Printers and +Faxes folder

    • Highlight and right-click the printer

    • Select Connect... (for WinNT4/2K +it is possibly Install...)

    +A new printer (named printername on +samba-server) should now have appeared in your +local Printer folder (check Start -- +Settings -- Control Panel +-- Printers and Faxes). +

    +Most likely you are now tempted to try and print a test page. After +all, you now can open the printer properties and on the "General" tab, +there is a button offering to do just that. But chances are that you +get an error message saying Unable to print Test +Page. The reason might be that there is not yet a +valid Device Mode set for the driver, or that the "Printer Driver +Data" set is still incomplete. +

    +You must now make sure that a valid "Device Mode" is set for the +driver. Don't fear -- we will explain now what that means. +

    IMPORTANT! Setting Device Modes on new Printers

    +In order for a printer to be truly usable by a Windows NT/2K/XP +client, it must possess: +

    • a valid Device Mode generated by +the driver for the printer (defining things like paper size, +orientation and duplex settings), and

    • a complete set of +Printer Driver Data generated by the +driver.

    +If either one of these is incomplete, the clients can produce less +than optimal output at best. In the worst cases, unreadable garbage or +nothing at all comes from the printer or they produce a harvest of +error messages when attempting to print. Samba stores the named values +and all printing related info in its internal TDB database files +(ntprinters.tdb, +ntdrivers.tdb, printing.tdb +and ntforms.tdb). +

    +What do these two words stand for? Basically, the Device Mode and the +set of Printer Driver Data is a collection of settings for all print +queue properties, initialized in a sensible way. Device Modes and +Printer Driver Data should initially be set on the print server (that is +here: the Samba host) to healthy values so that the clients can start +to use them immediately. How do we set these initial healthy values? +This can be achieved by accessing the drivers remotely from an NT (or +2k/XP) client, as is discussed in the next paragraphs. +

    +Be aware, that a valid Device Mode can only be initiated by a +printer admin, or root (the reason should be +obvious). Device Modes can only correctly be set by executing the +printer driver program itself. Since Samba can not execute this Win32 +platform driver code, it sets this field initially to NULL (which is +not a valid setting for clients to use). Fortunately, most drivers +generate themselves the Printer Driver Data that is needed, when they +are uploaded to the [print$] share with the +help of the APW or rpcclient. +

    +The generation and setting of a first valid Device Mode however +requires some "tickling" from a client, to set it on the Samba +server. The easiest means of doing so is to simply change the page +orientation on the server's printer. This "executes" enough of the +printer driver program on the client for the desired effect to happen, +and feeds back the new Device Mode to our Samba server. You can use the +native Windows NT/2K/XP printer properties page from a Window client +for this: +

    • Browse the Network Neighbourhood

    • Find the Samba server

    • Open the Samba server's Printers and + Faxes folder

    • Highlight the shared printer in question

    • Right-click the printer (you may already be here, if you +followed the last section's description)

    • At the bottom of the context menu select +Properties.... (if the menu still offers the +Connect... entry +further above, you need to click that one first to achieve the driver +installation as shown in the last section)

    • Go to the Advanced tab; click on +Printing Defaults...

    • Change the "Portrait" page setting to "Landscape" (and +back)

    • (Oh, and make sure to apply +changes between swapping the page orientation to cause the change to +actually take effect...).

    • While you're at it, you may optionally also want to +set the desired printing defaults here, which then apply to all future +client driver installations on the remaining from now +on.

    +This procedure has executed the printer driver program on the client +platform and fed back the correct Device Mode to Samba, which now +stored it in its TDB files. Once the driver is installed on the +client, you can follow the analogous steps by accessing the +local Printers folder too if you are +a Samba printer admin user. From now on printing should work as expected. +

    +Samba also includes a service level parameter name default +devmode for generating a default Device Mode for a +printer. Some drivers will function well with Samba's default set of +properties. Others may crash the client's spooler service. So use this +parameter with caution. It is always better to have the client +generate a valid device mode for the printer and store it on the +server for you. +

    Further Client Driver Install Procedures

    +Every further driver may be done by any user, along the lines +described above: Browse network, open printers folder on Samba server, +right-click printer and choose Connect.... Once +this completes (should be not more than a few seconds, but could also take +a minute, depending on network conditions), you should find the new printer in +your client workstation local Printers and +Faxes folder. +

    +You can also open your local Printers and Faxes folder by +using this command on Windows 2000 and Windows XP Professional workstations: +

    rundll32 shell32.dll,SHHelpShortcuts_RunDLL PrintersFolder +

    +or this command on Windows NT 4.0 workstations: +

    +rundll32 shell32.dll,Control_RunDLL MAIN.CPL @2 +

    +You can enter the commands either inside a DOS box window +or in the Run command... field from the +Start menu. +

    Always make first Client Connection as root or "printer admin"

    +After you installed the driver on the Samba server (in its +[print$] share, you should always make sure +that your first client installation completes correctly. Make it a habit for +yourself to build that the very first connection from a client as +printer admin. This is to make sure that: +

    • a first valid Device Mode is +really initialized (see above for more explanation details), and +that

    • the default print settings of your printer for all +further client installations are as you want them

    +Do this by changing the orientation to landscape, click +Apply, and then change it back again. Then modify +the other settings (for example, you don't want the default media size +set to Letter, when you are all using +A4, right? You may want to set the printer for +duplex as the default; etc.). +

    +To connect as root to a Samba printer, try this command from a Windows +2K/XP DOS box command prompt: +

    runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry /p /t3 /n \\SAMBA-SERVER\printername" +

    +You will be prompted for root's Samba-password; type it, wait a few +seconds, click on Printing Defaults... and +proceed to set the job options as should be used as defaults by all +clients. Alternatively, instead of root you can name one other member +of the printer admins from the setting. +

    +Now all the other users downloading and installing the driver +the same way (called Point'n'Print) will +have the same defaults set for them. If you miss this step you'll +get a lot of helpdesk calls from your users. But maybe you like to +talk to people.... ;-) +

    Other Gotchas

    +Your driver is installed. It is ready for +Point'n'Print installation by the clients +now. You may have tried to download and use it +onto your first client machine now. But wait... let's make you +acquainted first with a few tips and tricks you may find useful. For +example, suppose you didn't manage to "set the defaults" on the +printer, as advised in the preceeding paragraphs? And your users +complain about various issues (such as “We need to set the paper +size for each job from Letter to A4 and it won't store it!”) +

    Setting Default Print Options for the Client Drivers

    +The last sentence might be viewed with mixed feelings by some users and +admins. They have struggled for hours and hours and couldn't arrive at +a point were their settings seemed to be saved. It is not their +fault. The confusing thing is this: in the multi-tabbed dialog that pops +up when you right-click the printer name and select +Properties..., you can arrive at two identically +looking dialogs, each claiming that they help you to set printer options, +in three different ways. Here is the definite answer to the "Samba +Default Driver Setting FAQ": +

    “I can't set and save default print options +for all users on Win2K/XP! Why not?”  +How are you doing it? I bet the wrong way.... (it is not very +easy to find out, though). There are 3 different ways to bring you to +a dialog that seems to set everything. All three +dialogs look the same. Only one of them +does what you intend. +Important: you need to be Administrator or Print +Administrator to do this for all users. Here is how I reproduce it in +on XP Professional: + +

    1. The first "wrong" way: + +

      1. Open the Printers +folder.

      2. Right-click on the printer +(remoteprinter on cupshost) and +select in context menu Printing +Preferences...

      3. Look at this dialog closely and remember what it looks +like.

      +

    2. The second "wrong" way: + +

      1. Open the Printers +folder.

      2. Right-click on the printer (remoteprinter on +cupshost) and select in the context menu +Properties

      3. Click on the General +tab

      4. Click on the button Printing +Preferences...

      5. A new dialog opens. Keep this dialog open and go back +to the parent dialog.

      +

    3. The third, the "correct" way: (should you do +this from the beginning, just carry out steps 1. and 2. from second +"way" above) + +

      1. Click on the Advanced +tab. (Hmmm... if everything is "Grayed Out", then you are not logged +in as a user with enough privileges).

      2. Click on the Printing +Defaults... button.

      3. On any of the two new tabs, click on the +Advanced... button.

      4. A new dialog opens. Compare this one to the other, +identical looking one from "B.5" or A.3".

      +

    + +Do you see any difference in the two settings dialogs? I don't +either. However, only the last one, which you arrived at with steps +C.1.-6. will permanently save any settings which will then become the +defaults for new users. If you want all clients to have the same +defaults, you need to conduct these steps as administrator +(printer admin in ) +before a client downloads the driver (the clients +can later set their own per-user defaults by +following the proceduresA. +orB. above...). (This is new: Windows 2000 and +Windows XP allow per-user default settings and +the ones the administrator gives them, before they set up their own). +The "parents" of the identically looking dialogs have a slight +difference in their window names: one is called +Default Print Values for Printer Foo on Server +Bar" (which is the one you need) and the other is +called "Print Settings for Printer Foo on Server +Bar". The last one is the one you arrive at when you +right-click on the printer and select Print +Settings.... This is the one what you were +taught to use back in the days of Windows NT! So it is only natural to +try the same way with Win2k or WinXP. You wouldn't dream +that there is now a different "clicking path" to arrive at an +identically looking, but functionally different dialog to set defaults +for all users! +

    Tip

    Try (on Win2000 and WinXP) to run this command (as a user +with the right privileges): +

    +rundll32 printui.dll,PrintUIEntry /p /t3 /n\\SAMBA-SERVER\printersharename +

    +to see the tab with the Printing Defaults... +button (the one you need). Also run this command: +

    +rundll32 printui.dll,PrintUIEntry /p /t0 /n\\SAMBA-SERVER\printersharename +

    +to see the tab with the Printing Preferences... +button (the one which doesn't set system-wide defaults). You can +start the commands from inside a DOS box" or from the Start +-- Run... menu. +

    Supporting large Numbers of Printers

    +One issue that has arisen during the recent development phase of Samba +is the need to support driver downloads for 100's of printers. Using +Windows NT APW here is somewhat awkward (to say the least). If you +don't want to acquire RSS pains from such the printer installation +clicking orgy alone, you need to think about a non-interactive script. +

    +If more than one printer is using the same driver, the +rpcclient setdriver command can be used to set the +driver associated with an installed queue. If the driver is uploaded +to [print$] once and registered with the +printing TDBs, it can be used by multiple print queues. In this case +you just need to repeat the setprinter subcommand +of rpcclient for every queue (without the need to +conduct the adddriver again and again). The +following is an example of how this could be accomplished: +

    +root# rpcclient SAMBA-CUPS -U root%secret -c 'enumdrivers'
+ cmd = enumdrivers
+ 
+ [Windows NT x86]
+ Printer Driver Info 1:
+   Driver Name: [infotec  IS 2075 PCL 6]
  
-[Windows NT x86]
-Printer Driver Info 1:
-     Driver Name: [HP LaserJet 4000 Series PS]
+ Printer Driver Info 1:
+   Driver Name: [DANKA InfoStream]
  
-Printer Driver Info 1:
-     Driver Name: [HP LaserJet 2100 Series PS]
+ Printer Driver Info 1:
+   Driver Name: [Heidelberg Digimaster 9110 (PS)]
  
-Printer Driver Info 1:
-     Driver Name: [HP LaserJet 4Si/4SiMX PS]
-				  
-$ rpcclient pogo -U root%secret -c "enumprinters"
-Domain=[NARNIA] OS=[Unix] Server=[Samba 2.2.0-alpha3]
-     flags:[0x800000]
-     name:[\\POGO\hp-print]
-     description:[POGO\\POGO\hp-print,NO DRIVER AVAILABLE FOR THIS PRINTER,]
-     comment:[]
-				  
-$ rpcclient pogo -U root%secret \
->  -c "setdriver hp-print \"HP LaserJet 4000 Series PS\""
-Domain=[NARNIA] OS=[Unix] Server=[Samba 2.2.0-alpha3]
-Successfully set hp-print to driver HP LaserJet 4000 Series PS.

    14.2.4. Adding New Printers via the Windows NT APW

    By default, Samba offers all printer shares defined in smb.conf -in the "Printers..." folder. Also existing in this folder is the Windows NT -Add Printer Wizard icon. The APW will be show only if

    In order to be able to use the APW to successfully add a printer to a Samba -server, the add -printer command must have a defined value. The program -hook must successfully add the printer to the system (i.e. -/etc/printcap or appropriate files) and -smb.conf if necessary.

    When using the APW from a client, if the named printer share does -not exist, smbd will execute the add printer -command and reparse to the smb.conf -to attempt to locate the new printer share. If the share is still not defined, -an error of "Access Denied" is returned to the client. Note that the -add printer program is executed under the context -of the connected user, not necessarily a root account.

    There is a complementary delete -printer command for removing entries from the "Printers..." -folder.

    The following is an example add printer command script. It adds the appropriate entries to /etc/printcap.local (change that to what you need) and returns a line of 'Done' which is needed for the whole process to work.

    #!/bin/sh
+ Printer Driver Info 1:
+   Driver Name: [dm9110]
+
+ Printer Driver Info 1:
+   Driver Name: [myphantasydrivername]
+
+ [....]
+

    + +

    +root# rpcclient SAMBA-CUPS -U root%secret -c 'enumprinters'
+ cmd = enumprinters
+   flags:[0x800000]
+   name:[\\SAMBA-CUPS\dm9110]
+   description:[\\SAMBA-CUPS\dm9110,,110ppm HiVolume DANKA Stuttgart]
+   comment:[110 ppm HiVolume DANKA Stuttgart]
+ [....]
+

    + +

    +root# rpcclient SAMBA-CUPS -U root%secret -c 'setdriver dm9110 "Heidelberg Digimaster 9110 (PS)"'
+ cmd = setdriver dm9110 Heidelberg Digimaster 9110 (PPD)
+ Successfully set dm9110 to driver Heidelberg Digimaster 9110 (PS).
+

    + +

    +root# rpcclient SAMBA-CUPS -U root%secret -c 'enumprinters'
+ cmd = enumprinters
+   flags:[0x800000]
+   name:[\\SAMBA-CUPS\dm9110]
+   description:[\\SAMBA-CUPS\dm9110,Heidelberg Digimaster 9110 (PS),110ppm HiVolume DANKA Stuttgart]
+   comment:[110ppm HiVolume DANKA Stuttgart]
+ [....]
+

    + +

    +root# rpcclient SAMBA-CUPS -U root%secret -c 'setdriver dm9110 myphantasydrivername'
+ cmd = setdriver dm9110 myphantasydrivername
+ Successfully set dm9110 to myphantasydrivername.
+

    + +

    +root# rpcclient SAMBA-CUPS -U root%secret -c 'enumprinters'
+ cmd = enumprinters
+   flags:[0x800000]
+   name:[\\SAMBA-CUPS\dm9110]
+   description:[\\SAMBA-CUPS\dm9110,myphantasydrivername,110ppm HiVolume DANKA Stuttgart]
+   comment:[110ppm HiVolume DANKA Stuttgart]
+ [....]
+

    +It may be not easy to recognize: but the first call to +enumprinters showed the "dm9110" printer with an +empty string where the driver should have been listed (between the 2 +commas in the "description" field). After the +setdriver command succeeded, all is well. (The +CUPS Printing chapter has more info about the installation of printer +drivers with the help of rpccclient). +

    Adding new Printers with the Windows NT APW

    +By default, Samba exhibits all printer shares defined in +smb.conf in the +Printers... folder. Also located in this folder +is the Windows NT Add Printer Wizard icon. The APW will be shown only +if: +

    • ...the connected user is able to successfully execute +an OpenPrinterEx(\\server) with administrative +privileges (i.e. root or printer admin). +

      Tip

      Try this from a Windows 2K/XP DOS box command prompt: +

      +runas /netonly /user:root rundll32 printui.dll,PrintUIEntry /p /t0 /n \\SAMBA-SERVER\printersharename +

      +and click on Printing Preferences... +

    • ... contains the setting +show add printer wizard = yes (the +default).

    +The APW can do various things: +

    • upload a new driver to the Samba +[print$] share;

    • associate an uploaded driver with an existing (but +still "driverless") print queue;

    • exchange the currently used driver for an existing +print queue with one that has been uploaded before;

    • add an entirely new printer to the Samba host (only in +conjunction with a working add printer command; +a corresponding delete printer command for +removing entries from the Printers... folder +may be provided too)

    +The last one (add a new printer) requires more effort than the +previous ones. In order to use the APW to successfully add a printer +to a Samba server, the add printer command must +have a defined value. The program hook must successfully add the +printer to the Unix print system (i.e. to +/etc/printcap, +/etc/cups/printers.conf or other appropriate +files) and to if necessary. +

    +When using the APW from a client, if the named printer share does not +exist, smbd will execute the add printer +command and reparse to the +to attempt to locate the new printer share. If the share is still not +defined, an error of Access Denied is +returned to the client. Note that the add printer +command is executed under the context of the connected +user, not necessarily a root account. A map to guest = bad +user may have connected you unwittingly under the wrong +privilege; you should check it by using the +smbstatus command. +

    Weird Error Message Cannot connect under a +different Name

    +Once you are connected with the wrong credentials, there is no means +to reverse the situation other than to close all Explorer windows, and +perhaps reboot. +

    • The net use \\SAMBA-SERVER\sharename +/user:root gives you an error message: Multiple +connections to a server or a shared resource by the same user +utilizing the several user names are not allowed. Disconnect all +previous connections to the server, resp. the shared resource, and try +again.

    • Every attempt to "connect a network drive" to +\\SAMBASERVER\\print$ to z: is countered by the +pertinacious message. This network folder is currently +connected under different credentials (username and password). +Disconnect first any existing connection to this network share in +order to connect again under a different username and +password.

    +So you close all connections. You try again. You get the same +message. You check from the Samba side, using +smbstatus. Yes, there are some more +connections. You kill them all. The client still gives you the same +error message. You watch the smbd.log file on a very high debug level +and try re-connect. Same error message, but not a single line in the +log. You start to wonder if there was a connection attempt at all. You +run ethereal and tcpdump while you try to connect. Result: not a +single byte goes on the wire. Windows still gives the error +message. You close all Explorer Windows and start it again. You try to +connect - and this times it works! Windows seems to cache connection +info somewhere and doesn't keep it up to date (if you are unlucky you +might need to reboot to get rid of the error message). +

    Be careful when assembling Driver Files

    +You need to be very careful when you take notes about the files and +belonging to a particular driver. Don't confuse the files for driver +version "0" (for Win95/98/ME, going into +[print$]/WIN/0/), driver version "2" (Kernel Mode +driver for WinNT, going into [print$]/W32X86/2/ +may be used on Win2K/XP too), and driver version +"3" (non-Kernel Mode driver going into +[print$]/W32X86/3/ can not +be used on WinNT). Very often these different driver versions contain +files carrying the same name; but still the files are very different! +Also, if you look at them from the Windows Explorer (they reside in +%WINDOWS%\system32\spool\drivers\W32X86\) you +will probably see names in capital letters, while an "enumdrivers" +command from Samba would show mixed or lower case letters. So it is +easy to confuse them. If you install them manually using +rpcclient and subcommands, you may even succeed +without an error message. Only later, when you try install on a +client, you will encounter error messages like This +server has no appropriate driver for the printer. +

    +Here is an example. You are invited to look very closely at the +various files, compare their names and their spelling, and discover +the differences in the composition of the version-2 and -3 sets +Note: the version-0 set contained 40 (!) +Dependentfiles, so I left it out for space +reasons: +

    +root# rpcclient -U 'Administrator%secret' -c 'enumdrivers 3' 10.160.50.8 
+
+ Printer Driver Info 3:
+         Version: [3]
+         Driver Name: [Canon iR8500 PS3]
+         Architecture: [Windows NT x86]
+         Driver Path: [\\10.160.50.8\print$\W32X86\3\cns3g.dll]
+         Datafile: [\\10.160.50.8\print$\W32X86\3\iR8500sg.xpd]
+         Configfile: [\\10.160.50.8\print$\W32X86\3\cns3gui.dll]
+         Helpfile: [\\10.160.50.8\print$\W32X86\3\cns3g.hlp]
+ 
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aucplmNT.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\ucs32p.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\tnl32.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aussdrv.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cnspdc.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aussapi.dat]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cns3407.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\CnS3G.cnt]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\NBAPI.DLL]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\NBIPC.DLL]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcview.exe]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcdspl.exe]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcedit.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcqm.exe]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcspl.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cfine32.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcr407.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\Cpcqm407.hlp]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcqm407.cnt]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cns3ggr.dll]
+ 
+         Monitorname: []
+         Defaultdatatype: []
+
+ Printer Driver Info 3:
+         Version: [2]
+         Driver Name: [Canon iR5000-6000 PS3]
+         Architecture: [Windows NT x86]
+         Driver Path: [\\10.160.50.8\print$\W32X86\2\cns3g.dll]
+         Datafile: [\\10.160.50.8\print$\W32X86\2\IR5000sg.xpd]
+         Configfile: [\\10.160.50.8\print$\W32X86\2\cns3gui.dll]
+         Helpfile: [\\10.160.50.8\print$\W32X86\2\cns3g.hlp]
+ 
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\AUCPLMNT.DLL]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\aussdrv.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cnspdc.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\aussapi.dat]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cns3407.dll]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\CnS3G.cnt]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\NBAPI.DLL]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\NBIPC.DLL]
+         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cns3gum.dll]
+ 
+         Monitorname: [CPCA Language Monitor2]
+         Defaultdatatype: []
+
+

    +If we write the "version 2" files and the "version 3" files +into different text files and compare the result, we see this +picture: +

    +root# sdiff 2-files 3-files
 
-# Script to insert a new printer entry into printcap.local
-#
-# $1, printer name, used as the descriptive name
-# $2, share name, used as the printer name for Linux
-# $3, port name
-# $4, driver name
-# $5, location, used for the device file of the printer
-# $6, win9x location
 
-#
-# Make sure we use the location that RedHat uses for local printer defs
-PRINTCAP=/etc/printcap.local
-DATE=`date +%Y%m%d-%H%M%S`
-LP=lp
-RESTART="service lpd restart"
+ cns3g.dll                     cns3g.dll
+ iR8500sg.xpd                  iR8500sg.xpd
+ cns3gui.dll                   cns3gui.dll
+ cns3g.hlp                     cns3g.hlp
+ AUCPLMNT.DLL                | aucplmNT.dll
+                             > ucs32p.dll
+                             > tnl32.dll
+ aussdrv.dll                   aussdrv.dll
+ cnspdc.dll                    cnspdc.dll
+ aussapi.dat                   aussapi.dat
+ cns3407.dll                   cns3407.dll
+ CnS3G.cnt                     CnS3G.cnt
+ NBAPI.DLL                     NBAPI.DLL
+ NBIPC.DLL                     NBIPC.DLL
+ cns3gum.dll                 | cpcview.exe
+                             > cpcdspl.exe 
+                             > cpcqm.exe
+                             > cpcspl.dll
+                             > cfine32.dll
+                             > cpcr407.dll
+                             > Cpcqm407.hlp
+                             > cpcqm407.cnt
+                             > cns3ggr.dll
 
-# Keep a copy
-cp $PRINTCAP $PRINTCAP.$DATE
-# Add the printer to $PRINTCAP
-echo ""				 			>> $PRINTCAP
-echo "$2|$1:\\" 					>> $PRINTCAP
-echo "  :sd=/var/spool/lpd/$2:\\" 			>> $PRINTCAP
-echo "  :mx=0:ml=0:sh:\\" 				>> $PRINTCAP
-echo "  :lp=/usr/local/samba/var/print/$5.prn:" 	>> $PRINTCAP
+

    +Don't be fooled though! Driver files for each version with identical +names may be different in their content, as you can see from this size +comparison: +

    +root# for i in cns3g.hlp cns3gui.dll cns3g.dll; do                  \
+           smbclient //10.160.50.8/print\$ -U 'Administrator%xxxx' \
+           -c "cd W32X86/3; dir $i; cd .. ; cd 2; dir $i";      \
+		   done
 
-touch "/usr/local/samba/var/print/$5.prn" >> /tmp/printadd.$$ 2>&1
-chown $LP "/usr/local/samba/var/print/$5.prn" >> /tmp/printadd.$$ 2>&1
+  CNS3G.HLP               A   122981  Thu May 30 02:31:00 2002
+  CNS3G.HLP               A    99948  Thu May 30 02:31:00 2002
 
-mkdir /var/spool/lpd/$2
-chmod 700 /var/spool/lpd/$2
-chown $LP /var/spool/lpd/$2
-#echo $1 >> "/usr/local/samba/var/print/$5.prn"
-#echo $2 >> "/usr/local/samba/var/print/$5.prn"
-#echo $3 >> "/usr/local/samba/var/print/$5.prn"
-#echo $4 >> "/usr/local/samba/var/print/$5.prn"
-#echo $5 >> "/usr/local/samba/var/print/$5.prn"
-#echo $6 >> "/usr/local/samba/var/print/$5.prn"
-$RESTART >> "/usr/local/samba/var/print/$5.prn"
-# Not sure if this is needed
-touch /usr/local/samba/lib/smb.conf
-#
-# You need to return a value, but I am not sure what it means.
-#
-echo "Done"
-exit 0

    14.2.5. Samba and Printer Ports

    Windows NT/2000 print servers associate a port with each printer. These normally -take the form of LPT1:, COM1:, FILE:, etc... Samba must also support the -concept of ports associated with a printer. By default, only one printer port, -named "Samba Printer Port", exists on a system. Samba does not really a port in -order to print, rather it is a requirement of Windows clients.

    Note that Samba does not support the concept of "Printer Pooling" internally -either. This is when a logical printer is assigned to multiple ports as -a form of load balancing or fail over.

    If you require that multiple ports be defined for some reason, -smb.conf possesses a enumports -command which can be used to define an external program -that generates a listing of ports on a system.

    14.3. The Imprints Toolset

    The Imprints tool set provides a UNIX equivalent of the - Windows NT Add Printer Wizard. For complete information, please - refer to the Imprints web site at http://imprints.sourceforge.net/ as well as the documentation - included with the imprints source distribution. This section will - only provide a brief introduction to the features of Imprints.

    14.3.1. What is Imprints?

    Imprints is a collection of tools for supporting the goals - of

    14.3.2. Creating Printer Driver Packages

    The process of creating printer driver packages is beyond - the scope of this document (refer to Imprints.txt also included - with the Samba distribution for more information). In short, - an Imprints driver package is a gzipped tarball containing the - driver files, related INF files, and a control file needed by the - installation client.

    14.3.3. The Imprints server

    The Imprints server is really a database server that - may be queried via standard HTTP mechanisms. Each printer - entry in the database has an associated URL for the actual - downloading of the package. Each package is digitally signed - via GnuPG which can be used to verify that package downloaded - is actually the one referred in the Imprints database. It is - not recommended that this security check - be disabled.

    14.3.4. The Installation Client

    More information regarding the Imprints installation client - is available in the Imprints-Client-HOWTO.ps - file included with the imprints source package.

    The Imprints installation client comes in two forms.

    The installation client (in both forms) provides a means - of querying the Imprints database server for a matching - list of known printer model names as well as a means to - download and install the drivers on remote Samba and Windows - NT print servers.

    The basic installation process is in four steps and - perl code is wrapped around smbclient - and rpcclient.

    	
-foreach (supported architecture for a given driver)
-{
-     1.  rpcclient: Get the appropriate upload directory 
-         on the remote server
-     2.  smbclient: Upload the driver files
-     3.  rpcclient: Issues an AddPrinterDriver() MS-RPC
-}
-	
-4.  rpcclient: Issue an AddPrinterEx() MS-RPC to actually
-    create the printer

    One of the problems encountered when implementing - the Imprints tool set was the name space issues between - various supported client architectures. For example, Windows - NT includes a driver named "Apple LaserWriter II NTX v51.8" - and Windows 95 calls its version of this driver "Apple - LaserWriter II NTX"

    The problem is how to know what client drivers have - been uploaded for a printer. As astute reader will remember - that the Windows NT Printer Properties dialog only includes - space for one printer driver name. A quick look in the - Windows NT 4.0 system registry at

    HKLM\System\CurrentControlSet\Control\Print\Environment -

    will reveal that Windows NT always uses the NT driver - name. This is ok as Windows NT always requires that at least - the Windows NT version of the printer driver is present. - However, Samba does not have the requirement internally. - Therefore, how can you use the NT driver name if is has not - already been installed?

    The way of sidestepping this limitation is to require - that all Imprints printer driver packages include both the Intel - Windows NT and 95/98 printer drivers and that NT driver is - installed first.

    14.4. Diagnosis

    14.4.1. Introduction

    This is a short description of how to debug printing problems with -Samba. This describes how to debug problems with printing from a SMB -client to a Samba server, not the other way around. For the reverse -see the examples/printing directory.

    Ok, so you want to print to a Samba server from your PC. The first -thing you need to understand is that Samba does not actually do any -printing itself, it just acts as a middleman between your PC client -and your Unix printing subsystem. Samba receives the file from the PC -then passes the file to a external "print command". What print command -you use is up to you.

    The whole things is controlled using options in smb.conf. The most -relevant options (which you should look up in the smb.conf man page) -are:

          [global]
-        print command     - send a file to a spooler
-        lpq command       - get spool queue status
-        lprm command      - remove a job
-      [printers]
-        path = /var/spool/lpd/samba

    The following are nice to know about:

            queuepause command   - stop a printer or print queue
-        queueresume command  - start a printer or print queue

    Example:

            print command = /usr/bin/lpr -r -P%p %s
-        lpq command   = /usr/bin/lpq    -P%p %s
-        lprm command  = /usr/bin/lprm   -P%p %j
-        queuepause command = /usr/sbin/lpc -P%p stop
-        queuepause command = /usr/sbin/lpc -P%p start

    Samba should set reasonable defaults for these depending on your -system type, but it isn't clairvoyant. It is not uncommon that you -have to tweak these for local conditions. The commands should -always have fully specified pathnames, as the smdb may not have -the correct PATH values.

    When you send a job to Samba to be printed, it will make a temporary -copy of it in the directory specified in the [printers] section. -and it should be periodically cleaned out. The lpr -r option -requests that the temporary copy be removed after printing; If -printing fails then you might find leftover files in this directory, -and it should be periodically cleaned out. Samba used the lpq -command to determine the "job number" assigned to your print job -by the spooler.

    The %>letter< are "macros" that get dynamically replaced with appropriate -values when they are used. The %s gets replaced with the name of the spool -file that Samba creates and the %p gets replaced with the name of the -printer. The %j gets replaced with the "job number" which comes from -the lpq output.

    14.4.2. Debugging printer problems

    One way to debug printing problems is to start by replacing these -command with shell scripts that record the arguments and the contents -of the print file. A simple example of this kind of things might -be:

    	print command = /tmp/saveprint %p %s
+  CNS3GUI.DLL             A  1805824  Thu May 30 02:31:00 2002
+  CNS3GUI.DLL             A  1785344  Thu May 30 02:31:00 2002
 
-    #!/bin/saveprint
-    # we make sure that we are the right user
-    /usr/bin/id -p >/tmp/tmp.print
-    # we run the command and save the error messages
-    # replace the command with the one appropriate for your system
-    /usr/bin/lpr -r -P$1 $2 2>>&/tmp/tmp.print

    Then you print a file and try removing it. You may find that the -print queue needs to be stopped in order to see the queue status -and remove the job:

    
h4: {42} % echo hi >/tmp/hi
-h4: {43} % smbclient //localhost/lw4
-added interface ip=10.0.0.4 bcast=10.0.0.255 nmask=255.255.255.0
-Password: 
-Domain=[ASTART] OS=[Unix] Server=[Samba 2.0.7]
-smb: \> print /tmp/hi
-putting file /tmp/hi as hi-17534 (0.0 kb/s) (average 0.0 kb/s)
-smb: \> queue
-1049     3            hi-17534
-smb: \> cancel 1049
-Error cancelling job 1049 : code 0
-smb: \> cancel 1049
-Job 1049 cancelled
-smb: \> queue
-smb: \> exit

    The 'code 0' indicates that the job was removed. The comment -by the smbclient is a bit misleading on this. -You can observe the command output and then and look at the -/tmp/tmp.print file to see what the results are. You can quickly -find out if the problem is with your printing system. Often people -have problems with their /etc/printcap file or permissions on -various print queues.

    14.4.3. What printers do I have?

    You can use the 'testprns' program to check to see if the printer -name you are using is recognized by Samba. For example, you can -use:

        testprns printer /etc/printcap

    Samba can get its printcap information from a file or from a program. -You can try the following to see the format of the extracted -information:

        testprns -a printer /etc/printcap
+  CNS3G.DLL               A  1145088  Thu May 30 02:31:00 2002
+  CNS3G.DLL               A    15872  Thu May 30 02:31:00 2002
 
-    testprns -a printer '|/bin/cat printcap'

    14.4.4. Setting up printcap and print servers

    You may need to set up some printcaps for your Samba system to use. -It is strongly recommended that you use the facilities provided by -the print spooler to set up queues and printcap information.

    Samba requires either a printcap or program to deliver printcap -information. This printcap information has the format:

      name|alias1|alias2...:option=value:...

    For almost all printing systems, the printer 'name' must be composed -only of alphanumeric or underscore '_' characters. Some systems also -allow hyphens ('-') as well. An alias is an alternative name for the -printer, and an alias with a space in it is used as a 'comment' -about the printer. The printcap format optionally uses a \ at the end of lines -to extend the printcap to multiple lines.

    Here are some examples of printcap files:

    1. pr just printer name

    2. pr|alias printer name and alias

    3. pr|My Printer printer name, alias used as comment

    4. pr:sh:\ Same as pr:sh:cm= testing - :cm= \ - testing

    5. pr:sh Same as pr:sh:cm= testing - :cm= testing

    Samba reads the printcap information when first started. If you make -changes in the printcap information, then you must do the following:

    1. make sure that the print spooler is aware of these changes. -The LPRng system uses the 'lpc reread' command to do this.

    2. make sure that the spool queues, etc., exist and have the -correct permissions. The LPRng system uses the 'checkpc -f' -command to do this.

    3. You now should send a SIGHUP signal to the smbd server to have -it reread the printcap information.

    14.4.5. Job sent, no output

    This is the most frustrating part of printing. You may have sent the -job, verified that the job was forwarded, set up a wrapper around -the command to send the file, but there was no output from the printer.

    First, check to make sure that the job REALLY is getting to the -right print queue. If you are using a BSD or LPRng print spooler, -you can temporarily stop the printing of jobs. Jobs can still be -submitted, but they will not be printed. Use:

      lpc -Pprinter stop

    Now submit a print job and then use 'lpq -Pprinter' to see if the -job is in the print queue. If it is not in the print queue then -you will have to find out why it is not being accepted for printing.

    Next, you may want to check to see what the format of the job really -was. With the assistance of the system administrator you can view -the submitted jobs files. You may be surprised to find that these -are not in what you would expect to call a printable format. -You can use the UNIX 'file' utitily to determine what the job -format actually is:

        cd /var/spool/lpd/printer   # spool directory of print jobs
-    ls                          # find job files
-    file dfA001myhost

    You should make sure that your printer supports this format OR that -your system administrator has installed a 'print filter' that will -convert the file to a format appropriate for your printer.

    14.4.6. Job sent, strange output

    Once you have the job printing, you can then start worrying about -making it print nicely.

    The most common problem is extra pages of output: banner pages -OR blank pages at the end.

    If you are getting banner pages, check and make sure that the -printcap option or printer option is configured for no banners. -If you have a printcap, this is the :sh (suppress header or banner -page) option. You should have the following in your printer.

       printer: ... :sh

    If you have this option and are still getting banner pages, there -is a strong chance that your printer is generating them for you -automatically. You should make sure that banner printing is disabled -for the printer. This usually requires using the printer setup software -or procedures supplied by the printer manufacturer.

    If you get an extra page of output, this could be due to problems -with your job format, or if you are generating PostScript jobs, -incorrect setting on your printer driver on the MicroSoft client. -For example, under Win95 there is a option:

      Printers|Printer Name|(Right Click)Properties|Postscript|Advanced|

    that allows you to choose if a Ctrl-D is appended to all jobs. -This is a very bad thing to do, as most spooling systems will -automatically add a ^D to the end of the job if it is detected as -PostScript. The multiple ^D may cause an additional page of output.

    14.4.7. Raw PostScript printed

    This is a problem that is usually caused by either the print spooling -system putting information at the start of the print job that makes -the printer think the job is a text file, or your printer simply -does not support PostScript. You may need to enable 'Automatic -Format Detection' on your printer.

    14.4.8. Advanced Printing

    Note that you can do some pretty magic things by using your -imagination with the "print command" option and some shell scripts. -Doing print accounting is easy by passing the %U option to a print -command shell script. You could even make the print command detect -the type of output and its size and send it to an appropriate -printer.

    14.4.9. Real debugging

    If the above debug tips don't help, then maybe you need to bring in -the bug guns, system tracing. See Tracing.txt in this directory.

    PrevHomeNext
    Hosting a Microsoft Distributed File System tree on SambaUpUnified Logons between Windows NT and UNIX using Winbind
    \ No newline at end of file +

    +In my example were even more differences than shown here. Conclusion: +you must be very careful to select the correct driver files for each +driver version. Don't rely on the names alone. Don't interchange files +belonging to different driver versions. +

    Samba and Printer Ports

    +Windows NT/2000 print servers associate a port with each +printer. These normally take the form of LPT1:, +COM1:, FILE:, etc. Samba +must also support the concept of ports associated with a printer. By +default, only one printer port, named "Samba Printer Port", exists on +a system. Samba does not really need such a "port" in order to print; +it rather is a requirement of Windows clients. They insist on being +told about an available port when they request this info, otherwise +they throw an error message at you. So Samba fakes the port +information to keep the Windows clients happy. +

    +Note that Samba does not support the concept of "Printer Pooling" +internally either. Printer Pooling assigns a logical printer to +multiple ports as a form of load balancing or fail over. +

    +If you require that multiple ports be defined for some reason or +another (“My users and my Boss should not know that they are +working with Samba”), possesses a +enumports command which can be used to define +an external program that generates a listing of ports on a system. +

    Avoiding the most common Misconfigurations of the Client Driver

    +So - printing works, but there are still problems. Most jobs print +well, some don't print at all. Some jobs have problems with fonts, +which don't look good at all. Some jobs print fast, and some are +dead-slow. We can't cover it all; but we want to encourage you to read +the little paragraph about "Avoiding the wrong PostScript Driver +Settings" in the CUPS Printing part of this document. +

    The Imprints Toolset

    +The Imprints tool set provides a UNIX equivalent of the +Windows NT Add Printer Wizard. For complete information, please +refer to the Imprints web site +athttp://imprints.sourceforge.net/ +as well as the documentation included with the imprints source +distribution. This section will only provide a brief introduction +to the features of Imprints. +

    Attention! Maintainer required.  +Unfortunately, the Imprints toolset is no longer maintained. As of +December, 2000, the project is in need of a new maintainer. The most +important skill to have is decent perl coding and an interest in +MS-RPC based printing using Samba. If you wish to volunteer, please +coordinate your efforts on the samba-technical mailing list. The +toolset is still in usable form; but only for a series of older +printer models, where there are prepared packages to use. Packages for +more up to date print devices are needed if Imprints should have a +future.

    What is Imprints?

    +Imprints is a collection of tools for supporting these goals: +

    • Providing a central repository information regarding +Windows NT and 95/98 printer driver packages

    • Providing the tools necessary for creating the +Imprints printer driver packages.

    • Providing an installation client which will obtain +printer drivers from a central internet (or intranet) Imprints Server +repository and install them on remote Samba and Windows NT4 print +servers.

    Creating Printer Driver Packages

    +The process of creating printer driver packages is beyond the scope of +this document (refer to Imprints.txt also included with the Samba +distribution for more information). In short, an Imprints driver +package is a gzipped tarball containing the driver files, related INF +files, and a control file needed by the installation client. +

    The Imprints Server

    +The Imprints server is really a database server that may be queried +via standard HTTP mechanisms. Each printer entry in the database has +an associated URL for the actual downloading of the package. Each +package is digitally signed via GnuPG which can be used to verify that +package downloaded is actually the one referred in the Imprints +database. It is strongly recommended that this security check +not be disabled. +

    The Installation Client

    +More information regarding the Imprints installation client is +available in the Imprints-Client-HOWTO.ps file +included with the imprints source package. +

    +The Imprints installation client comes in two forms. +

    • a set of command line Perl scripts

    • a GTK+ based graphical interface to the command line Perl +scripts

    +The installation client (in both forms) provides a means of querying +the Imprints database server for a matching list of known printer +model names as well as a means to download and install the drivers on +remote Samba and Windows NT print servers. +

    +The basic installation process is in four steps and perl code is +wrapped around smbclient and rpcclient +

    • + foreach (supported architecture for a given driver) +

      1. rpcclient: Get the appropriate upload directory on the remote server

      2. smbclient: Upload the driver files

      3. rpcclient: Issues an AddPrinterDriver() MS-RPC

      +

    • rpcclient: Issue an AddPrinterEx() MS-RPC to actually create the printer

    +One of the problems encountered when implementing the Imprints tool +set was the name space issues between various supported client +architectures. For example, Windows NT includes a driver named "Apple +LaserWriter II NTX v51.8" and Windows 95 calls its version of this +driver "Apple LaserWriter II NTX" +

    +The problem is how to know what client drivers have been uploaded for +a printer. An astute reader will remember that the Windows NT Printer +Properties dialog only includes space for one printer driver name. A +quick look in the Windows NT 4.0 system registry at +

    + HKLM\System\CurrentControlSet\Control\Print\Environment +

    +will reveal that Windows NT always uses the NT driver name. This is +ok as Windows NT always requires that at least the Windows NT version +of the printer driver is present. However, Samba does not have the +requirement internally. Therefore, how can you use the NT driver name +if is has not already been installed? +

    +The way of sidestepping this limitation is to require that all +Imprints printer driver packages include both the Intel Windows NT and +95/98 printer drivers and that NT driver is installed first. +

    Add Network Printers at Logon without User Interaction

    +The following MS Knowledge Base article may be of some help if you +need to handle Windows 2000 clients: How to Add Printers +with No User Interaction in Windows 2000. ( http://support.microsoft.com/default.aspx?scid=kb;en-us;189105 +). It also applies to Windows XP Professional clients. +

    +The ideas sketched out below are inspired by this article. It +describes a commandline method which can be applied to install +network and local printers and their drivers. This is most useful +if integrated in Logon Scripts. You can see what options are +available by typing in a command prompt ("DOS box") this: +

    rundll32 printui.dll,PrintUIEntry /?

    +A window pops up which shows you all of the commandline switches +available. An extensive list of examples is also provided. This is +only for Win 2k/XP. It doesn't work on WinNT. WinNT has probably some +other tools in the respective Resource Kit. Here is a suggestion about +what a client logon script might contain, with a short explanation of +what the lines actually do (it works if 2k/XP Windows clients access +printers via Samba, but works for Windows-based print servers too): +

    +rundll32 printui.dll,PrintUIEntry /dn /n "\\sambacupsserver\infotec2105-IPDS" /q
+rundll32 printui.dll,PrintUIEntry /in /n "\\sambacupsserver\infotec2105-PS"
+rundll32 printui.dll,PrintUIEntry /y /n "\\sambacupsserver\infotec2105-PS"
+

    +Here is a list of the used commandline parameters: +

    /dn

    deletes a network printer

    /q

    quiet modus

    /n

    names a printer

    /in

    adds a network printer connection

    /y

    sets printer as default printer

    +I have tested this with a Samba 2.2.7a and a Samba-3alpha24 +installation and Windows XP Professional clients. Note that this +specific command set works with network print queues (installing +local print queues requires different parameters, but this is of no +interest here). +

    • Line 1 deletes a possibly existing previous network +printer infotec2105-IPDS (which had used native +Windows drivers with LPRng that were removed from the server which was +converted to CUPS). The /q at the end eliminates +"Confirm" or error dialog boxes popping up. They should not be +presented to the user logging on.

    • Line 2 adds the new printer +infotec2105-PS (which actually is same physical +device but is now run by the new CUPS printing system and associated +with the CUPS/Adobe PS drivers). The printer and its driver +must have been added to Samba prior to the user +logging in (e.g. by a procedure as discussed earlier in this chapter, +or by running cupsaddsmb). The driver is now +auto-downloaded to the client PC where the user is about to log +in.

    • Line 3 sets the default printer to this new network +printer (there might be several other printers installed with this +same method and some may be local as well -- so we deside for a +default printer). The default printer selection may of course be +different for different users.

    +Note that the second line only works if the printer +infotec2105-PS has an already working printqueue +on "sambacupsserver", and if the printer drivers have sucessfully been +uploaded (via APW , +smbclient/rpcclient or +cupsaddsmb) into the +[print$] driver repository of Samba. Also, some +Samba versions prior to version 3.0 required a re-start of smbd after +the printer install and the driver upload, otherwise the script (or +any other client driver download) would fail. +

    +Since there no easy way to test for the existence of an installed +network printer from the logon script, the suggestion is: don't bother +checking and just allow the deinstallation/reinstallation to occur +every time a user logs in; it's really quick anyway (1 to 2 seconds). +

    +The additional benefits for this are: +

    • It puts in place any printer default setup changes +automatically at every user logon.

    • It allows for "roaming" users' login into the domain from +different workstations.

    +Since network printers are installed per user this much simplifies the +process of keeping the installation up-to-date. The extra few seconds +at logon time will not really be noticeable. Printers can be centrally +added, changed, and deleted at will on the server with no user +intervention required on the clients (you just need to keep the logon +scripts up to date). +

    The addprinter command

    +The addprinter command can be configured to be a +shell script or program executed by Samba. It is triggered by running +the APW from a client against the Samba print server. The APW asks the +user to fill in several fields (such as printer name, driver to be +used, comment, port monitor, etc.). These parameters are passed on to +Samba by the APW. If the addprinter command is designed in a way that +it can create a new printer (through writing correct printcap entries +on legacy systems, or execute the lpadmin command +on more modern systems) and create the associated share in +, then the APW will in effect really +create a new printer on Samba and the UNIX print subsystem! +

    Migration of "Classical" printing to Samba-3

    +The basic "NT-style" printer driver management has not changed +considerably in 3.0 over the 2.2.x releases (apart from many small +improvements). Here migration should be quite easy, especially if you +followed previous advice to stop using deprecated parameters in your +setup. For migrations from an existing 2.0.x setup, or if you +continued "Win9x-style" printing in your Samba 2.2 installations, it +is more of an effort. Please read the appropriate release notes and +the HOWTO Collection for 2.2. You can follow several paths. Here are +possible scenarios for migration: +

    • You need to study and apply the new Windows NT printer +and driver support. Previously used parameters "printer +driver file", " printer driver" and +"printer driver location" are no longer +supported.

    • If you want to take advantage of WinNT printer driver +support you also need to migrate theWin9x/ME drivers to the new +setup.

    • An existing printers.def file +(the one specified in the now removed parameter printer +driver file = ...) will work no longer with Samba-3.0. In +3.0, smbd attempts to locate a Win9x/ME driver files for the printer +in [print$] and additional settings in the TDB +and only there; if it fails it will not (as 2.2.x +used to do) drop down to using a printers.def +(and all associated parameters). The make_printerdef tool is removed +and there is no backwards compatibility for this.

    • You need to install a Windows 9x driver into the +[print$] share for a printer on your Samba +host. The driver files will be stored in the "WIN40/0" subdirectory of +[print$], and some other settings and info go +into the printing-related TDBs.

    • If you want to migrate an existing +printers.def file into the new setup, the current +only solution is to use the Windows NT APW to install the NT drivers +and the 9x drivers. This can be scripted using smbclient and +rpcclient. See the Imprints installation client at: +

      +http://imprints.sourceforge.net/ +

      +for an example. See also the discussion of rpcclient usage in the +"CUPS Printing" section.

    Publishing Printer Information in Active Directory or LDAP

    +We will publish an update to this section shortly. +

    Common Errors and Problems

    +Here are a few typical errors and problems people have +encountered. You can avoid them. Read on. +

    I give my root password but I don't get access

    +Don't confuse the root password which is valid for the Unix system +(and in most cases stored in the form of a one-way hash in a file +named /etc/shadow) with the password used to +authenticate against Samba!. Samba doesn't know the UNIX password; for +root to access Samba resources via Samba-type access, a Samba account +for root must be created first. This is often done with the +smbpasswd command. +

    My printjobs get spooled into the spooling directory, but then get lost

    +Don't use the existing Unix print system spool directory for the Samba +spool directory. It may seem convenient and a saving of space, but it +only leads to problems. The two must be separate. +

    Prev Up Next
    Chapter 17. Hosting a Microsoft Distributed File System tree on Samba Home Chapter 19. CUPS Printing Support in Samba 3.0
    diff --git a/docs/htmldocs/rpcclient.1.html b/docs/htmldocs/rpcclient.1.html index e695663c8a..47c4d914a5 100644 --- a/docs/htmldocs/rpcclient.1.html +++ b/docs/htmldocs/rpcclient.1.html @@ -1,781 +1,198 @@ - -rpcclient

    rpcclient

    Name

    rpcclient -- tool for executing client side - MS-RPC functions

    Synopsis

    rpcclient [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logfile] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}

    DESCRIPTION

    This tool is part of the Samba suite.

    rpcclient is a utility initially developed +rpcclient

    Name

    rpcclient — tool for executing client side + MS-RPC functions

    Synopsis

    rpcclient [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logfile] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}

    DESCRIPTION

    This tool is part of the Samba(7) suite.

    rpcclient is a utility initially developed to test MS-RPC functionality in Samba itself. It has undergone several stages of development and stability. Many system administrators have now written scripts around it to manage Windows NT clients from - their UNIX workstation.

    OPTIONS

    server

    NetBIOS name of Server to which to connect. + their UNIX workstation.

    OPTIONS

    server

    NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is - resolved using the name resolve order line from - smb.conf(5).

    -A|--authfile=filename

    This option allows - you to specify a file from which to read the username and - password used in the connection. The format of the file is - 

    		username = <value> 
-		password = <value>
-		domain   = <value>
-

    Make certain that the permissions on the file restrict - access from unwanted users.

    -c|--command='command string'

    execute semicolon separated commands (listed - below))

    -d|--debug=debuglevel

    debuglevel is an integer + resolved using the + name resolve order line from smb.conf(5).

    -c|--command='command string'

    execute semicolon separated commands (listed + below))

    -I IP-address

    IP address is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation.

    Normally the client would attempt to locate a named + SMB/CIFS server by looking it up via the NetBIOS name resolution + mechanism described above in the name resolve order + parameter above. Using this parameter will force the client + to assume that the server is on the machine with the specified IP + address and the NetBIOS name component of the resource being + connected to will be ignored.

    There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above.

    -V

    Prints the version number for +smbd.

    -s <configuration file>

    The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

    -d|--debug=debuglevel

    debuglevel is an integer from 0 to 10. The default value if this parameter is -not specified is zero.

    The higher this value, the more detail will be +not specified is zero.

    The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day to day running - it generates a small amount of -information about operations carried out.

    Levels above 1 will generate considerable +information about operations carried out.

    Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.

    Note that specifying this parameter here will -override the log -level parameter in the smb.conf(5) file.

    -h|--help

    Print a summary of command line options.

    -I IP-address

    IP address is the address of the server to connect to. - It should be specified in standard "a.b.c.d" notation.

    Normally the client would attempt to locate a named - SMB/CIFS server by looking it up via the NetBIOS name resolution - mechanism described above in the name resolve order - parameter above. Using this parameter will force the client - to assume that the server is on the machine with the specified IP - address and the NetBIOS name component of the resource being - connected to will be ignored.

    There is no default for this parameter. If not supplied, - it will be determined automatically by the client as described - above.

    -l|--logfile=logbasename

    File name for log/debug files. The extension - '.client' will be appended. The log file is - never removed by the client. -

    -N|--nopass

    instruct rpcclient not to ask - for a password. By default, rpcclient will - prompt for a password. See also the -U - option.

    -s|--conf=smb.conf

    Specifies the location of the all-important - smb.conf file.

    -U|--user=username[%password]

    Sets the SMB username or username and password.

    If %password is not specified, the user will be prompted. The - client will first check the USER environment variable, then the - LOGNAME variable and if either exists, the - string is uppercased. If these environmental variables are not - found, the username GUEST is used.

    A third option is to use a credentials file which - contains the plaintext of the username and password. This - option is mainly provided for scripts where the admin does not - wish to pass the credentials on the command line or via environment - variables. If this method is used, make certain that the permissions - on the file restrict access from unwanted users. See the - -A for more details.

    Be cautious about including passwords in scripts. Also, on - many systems the command line of a running process may be seen - via the ps command. To be safe always allow - rpcclient to prompt for a password and type - it in directly.

    -W|--workgroup=domain

    Set the SMB domain of the username. This - overrides the default domain which is the domain defined in - smb.conf. If the domain specified is the same as the server's NetBIOS name, - it causes the client to log on using the server's local SAM (as - opposed to the Domain SAM).

    COMMANDS

    LSARPC

    • lsaquery

    • lookupsids - Resolve a list +data, most of which is extremely cryptic.

      Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

      -l|--logfile=logbasename

      File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

      -N

      If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password.

      Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.

      -k

      +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +

      -A|--authfile=filename

      This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +

      +username = <value>
+password = <value>
+domain   = <value>
+

      Make certain that the permissions on the file restrict +access from unwanted users.

      -U|--user=username[%password]

      Sets the SMB username or username and password.

      If %password is not specified, the user will be prompted. The +client will first check the USER environment variable, then the +LOGNAME variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username GUEST is used.

      A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +-A for more details.

      Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the ps command. To be safe always allow +rpcclient to prompt for a password and type +it in directly.

      -n <primary NetBIOS name>

      This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the NetBIOS +name parameter in the smb.conf(5) file. However, a command +line setting will take precedence over settings in +smb.conf(5).

      -i <scope>

      This specifies a NetBIOS scope that +nmblookup will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +very rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.

      -W|--workgroup=domain

      Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM).

      -O socket options

      TCP socket options to set on the client +socket. See the socket options parameter in +the smb.conf(5) manual page for the list of valid +options.

      -h|--help

      Print a summary of command line options. +

    COMMANDS

    LSARPC

    lsaquery

    Query info policy

    lookupsids

    Resolve a list of SIDs to usernames. -

  • lookupnames - Resolve a list +

    • lookupnames

    Resolve a list of usernames to SIDs. -

  • enumtrusts

    • SAMR

    • queryuser

    • querygroup

    • queryusergroups

    • querygroupmem

    • queryaliasmem

    • querydispinfo

    • querydominfo

    • enumdomgroups

    SPOOLSS

    • adddriver <arch> <config> - - Execute an AddPrinterDriver() RPC to install the printer driver +

    enumtrusts

    Enumerate trusted domains

    enumprivs

    Enumerate privileges

    getdispname

    Get the privilege name

    lsaenumsid

    Enumerate the LSA SIDS

    lsaenumprivsaccount

    Enumerate the privileges of an SID

    lsaenumacctrights

    Enumerate the rights of an SID

    lsaenumacctwithright

    Enumerate accounts with a right

    lsaaddacctrights

    Add rights to an account

    lsaremoveacctrights

    Remove rights from an account

    lsalookupprivvalue

    Get a privilege value given its name

    lsaquerysecobj

    Query LSA security object

    LSARPC-DS

    dsroledominfo

    Get Primary Domain Information

    DFS

    dfsexist

    Query DFS support

    dfsadd

    Add a DFS share

    dfsremove

    Remove a DFS share

    dfsgetinfo

    Query DFS share info

    dfsenum

    Enumerate dfs shares

    REG

    shutdown

    Remote Shutdown

    abortshutdown

    Abort Shutdown

    SRVSVC

    srvinfo

    Server query info

    netshareenum

    Enumerate shares

    netfileenum

    Enumerate open files

    netremotetod

    Fetch remote time of day

    SAMR

    queryuser

    Query user info

    querygroup

    Query group info

    queryusergroups

    Query user groups

    querygroupmem

    Query group membership

    queryaliasmem

    Query alias membership

    querydispinfo

    Query display info

    querydominfo

    Query domain info

    enumdomusers

    Enumerate domain users

    enumdomgroups

    Enumerate domain groups

    enumalsgroups

    Enumerate alias groups

    createdomuser

    Create domain user

    samlookupnames

    Look up names

    samlookuprids

    Look up names

    deletedomuser

    Delete domain user

    samquerysecobj

    Query SAMR security object

    getdompwinfo

    Retrieve domain password info

    lookupdomain

    Look up domain

    SPOOLSS

    adddriver <arch> <config>

    + Execute an AddPrinterDriver() RPC to install the printer driver information on the server. Note that the driver files should already exist in the directory returned by - getdriverdir. Possible values for - arch are the same as those for - the getdriverdir command. - The config parameter is defined as - follows: 

    		Long Printer Name:\
-		Driver File Name:\
-		Data File Name:\
-		Config File Name:\
-		Help File Name:\
-		Language Monitor Name:\
-		Default Data Type:\
-		Comma Separated list of Files
-

    Any empty fields should be enter as the string "NULL".

    Samba does not need to support the concept of Print Monitors + getdriverdir. Possible values for + arch are the same as those for + the getdriverdir command. + The config parameter is defined as + follows: 

    +Long Printer Name:\
+Driver File Name:\
+Data File Name:\
+Config File Name:\
+Help File Name:\
+Language Monitor Name:\
+Default Data Type:\
+Comma Separated list of Files
+

    Any empty fields should be enter as the string "NULL".

    Samba does not need to support the concept of Print Monitors since these only apply to local printers whose driver can make use of a bi-directional link for communication. This field should - be "NULL". On a remote NT print server, the Print Monitor for a + be "NULL". On a remote NT print server, the Print Monitor for a driver must already be installed prior to adding the driver or - else the RPC will fail.

  • addprinter <printername> - <sharename> <drivername> <port> - - Add a printer on the remote server. This printer + else the RPC will fail.

    • addprinter <printername> + <sharename> <drivername> <port>

    + Add a printer on the remote server. This printer will be automatically shared. Be aware that the printer driver - must already be installed on the server (see adddriver) - and the portmust be a valid port name (see - enumports.

  • deldriver - Delete the + must already be installed on the server (see adddriver) + and the portmust be a valid port name (see + enumports.

    • deldriver

    Delete the specified printer driver for all architectures. This does not delete the actual driver files from the server, only the entry from the server's list of drivers. -

  • enumdata - Enumerate all +

    • enumdata

    Enumerate all printer setting data stored on the server. On Windows NT clients, these values are stored in the registry, while Samba servers store them in the printers TDB. This command corresponds to the MS Platform SDK GetPrinterData() function (* This - command is currently unimplemented).

  • enumjobs <printer> - - List the jobs and status of a given printer. + command is currently unimplemented).

    • enumdataex

    Enumerate printer data for a key

    enumjobs <printer>

    List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() - function (* This command is currently unimplemented).

  • enumports [level] - - Executes an EnumPorts() call using the specified + function

    • enumkey

    Enumerate + printer keys

    enumports [level]

    + Executes an EnumPorts() call using the specified info level. Currently only info levels 1 and 2 are supported. -

  • enumdrivers [level] - - Execute an EnumPrinterDrivers() call. This lists the various installed +

    • enumdrivers [level]

    + Execute an EnumPrinterDrivers() call. This lists the various installed printer drivers for all architectures. Refer to the MS Platform SDK documentation for more details of the various flags and calling - options. Currently supported info levels are 1, 2, and 3.

  • enumprinters [level] - - Execute an EnumPrinters() call. This lists the various installed + options. Currently supported info levels are 1, 2, and 3.

    • enumprinters [level]

    Execute an EnumPrinters() call. This lists the various installed and share printers. Refer to the MS Platform SDK documentation for more details of the various flags and calling options. Currently - supported info levels are 0, 1, and 2.

  • getdata <printername> - - Retrieve the data for a given printer setting. See - the enumdata command for more information. + supported info levels are 1, 2 and 5.

    • getdata <printername> <valuename;>

    Retrieve the data for a given printer setting. See + the enumdata command for more information. This command corresponds to the GetPrinterData() MS Platform - SDK function (* This command is currently unimplemented).

  • getdriver <printername> - - Retrieve the printer driver information (such as driver file, + SDK function.

    • getdataex

    Get + printer driver data with + keyname

    getdriver <printername>

    + Retrieve the printer driver information (such as driver file, config file, dependent files, etc...) for the given printer. This command corresponds to the GetPrinterDriver() MS Platform SDK function. Currently info level 1, 2, and 3 are supported. -

  • getdriverdir <arch> - - Execute a GetPrinterDriverDirectory() +

    • getdriverdir <arch>

    + Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture. Possible - values for arch are "Windows 4.0" - (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows - Alpha_AXP", and "Windows NT R4000".

  • getprinter <printername> - - Retrieve the current printer information. This command + values for arch are "Windows 4.0" + (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows + Alpha_AXP", and "Windows NT R4000".

    • getprinter <printername>

    Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function. -

  • openprinter <printername> - - Execute an OpenPrinterEx() and ClosePrinter() RPC - against a given printer.

  • setdriver <printername> - <drivername> - - Execute a SetPrinter() command to update the printer driver +

    • getprintprocdir

    Get + print processor + directory

    openprinter <printername>

    Execute an OpenPrinterEx() and ClosePrinter() RPC + against a given printer.

    setdriver <printername> + <drivername>

    Execute a SetPrinter() command to update the printer driver associated with an installed printer. The printer driver must - already be correctly installed on the print server.

    See also the enumprinters and - enumdrivers commands for obtaining a list of - of installed printers and drivers.

    GENERAL OPTIONS

    • debuglevel - Set the current - debug level used to log information.

    • help (?) - Print a listing of all + already be correctly installed on the print server.

      See also the enumprinters and + enumdrivers commands for obtaining a list of + of installed printers and drivers.

    addform

    Add form

    setform

    Set form

    getform

    Get form

    deleteform

    Delete form

    enumforms

    Enumerate form

    setprinter

    Set printer comment

    setprinterdata

    Set REG_SZ printer data

    rffpcnex

    Rffpcnex test

    NETLOGON

    logonctrl2

    Logon Control 2

    logonctrl

    Logon Control

    samsync

    Sam Synchronisation

    samdeltas

    Query Sam Deltas

    samlogon

    Sam Logon

    GENERAL COMMANDS

    debuglevel

    Set the current + debug level used to log information.

    help (?)

    Print a listing of all known commands or extended help on a particular command. -

  • quit (exit) - Exit rpcclient - .

    • BUGS

    rpcclient is designed as a developer testing tool +

    quit (exit)

    Exit rpcclient + .

    BUGS

    rpcclient is designed as a developer testing tool and may not be robust in certain areas (such as command line parsing). It has been known to generate a core dump upon failures when invalid - parameters where passed to the interpreter.

    From Luke Leighton's original rpcclient man page:

    "WARNING! The MSRPC over SMB code has + parameters where passed to the interpreter.

    From Luke Leighton's original rpcclient man page:

    WARNING! The MSRPC over SMB code has been developed from examining Network traces. No documentation is available from the original creators (Microsoft) on how MSRPC over SMB works, or how the individual MSRPC services work. Microsoft's implementation of these services has been demonstrated (and reported) - to be... a bit flaky in places.

    The development of Samba's implementation is also a bit rough, - and as more of the services are understood, it can even result in - versions of smbd(8) and rpcclient(1) - that are incompatible for some commands or services. Additionally, + to be... a bit flaky in places.

    The development of Samba's implementation is also a bit rough, + and as more of the services are understood, it can even result in + versions of smbd(8) and rpcclient(1) that are incompatible for some commands or services. Additionally, the developers are sending reports to Microsoft, and problems found or reported to Microsoft are fixed in Service Packs, which may - result in incompatibilities."

    VERSION

    This man page is correct for version 3.0 of the Samba - suite.

    AUTHOR

    The original Samba software and related utilities + result in incompatibilities.

    VERSION

    This man page is correct for version 3.0 of the Samba + suite.

    AUTHOR

    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.

    The original rpcclient man page was written by Matthew + to the way the Linux kernel is developed.

    The original rpcclient man page was written by Matthew Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. The conversion to DocBook for Samba 2.2 was done by Gerald - Carter.

    \ No newline at end of file + Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was + done by Alexander Bokovoy.

    diff --git a/docs/htmldocs/samba-bdc.html b/docs/htmldocs/samba-bdc.html index ef06a89416..95d1cc4e5f 100644 --- a/docs/htmldocs/samba-bdc.html +++ b/docs/htmldocs/samba-bdc.html @@ -1,348 +1,246 @@ - -How to Act as a Backup Domain Controller in a Purely Samba Controlled Domain
    SAMBA Project Documentation
    PrevNext

    Chapter 7. How to Act as a Backup Domain Controller in a Purely Samba Controlled Domain

    7.1. Prerequisite Reading

    Before you continue reading in this chapter, please make sure -that you are comfortable with configuring a Samba PDC -as described in the Samba-PDC-HOWTO.

    7.2. Background

    What is a Domain Controller? It is a machine that is able to answer -logon requests from workstations in a Windows NT Domain. Whenever a -user logs into a Windows NT Workstation, the workstation connects to a -Domain Controller and asks him whether the username and password the -user typed in is correct. The Domain Controller replies with a lot of -information about the user, for example the place where the users -profile is stored, the users full name of the user. All this -information is stored in the NT user database, the so-called SAM.

    There are two kinds of Domain Controller in a NT 4 compatible Domain: -A Primary Domain Controller (PDC) and one or more Backup Domain -Controllers (BDC). The PDC contains the master copy of the -SAM. Whenever the SAM has to change, for example when a user changes -his password, this change has to be done on the PDC. A Backup Domain -Controller is a machine that maintains a read-only copy of the -SAM. This way it is able to reply to logon requests and authenticate -users in case the PDC is not available. During this time no changes to -the SAM are possible. Whenever changes to the SAM are done on the PDC, -all BDC receive the changes from the PDC.

    Since version 2.2 Samba officially supports domain logons for all -current Windows Clients, including Windows 2000 and XP. This text -assumes the domain to be named SAMBA. To be able to act as a PDC, some -parameters in the [global]-section of the smb.conf have to be set:

    workgroup = SAMBA
-domain master = yes
-domain logons = yes

    Several other things like a [homes] and a [netlogon] share also may be -set along with settings for the profile path, the users home drive and -others. This will not be covered in this document.

    7.3. What qualifies a Domain Controller on the network?

    Every machine that is a Domain Controller for the domain SAMBA has to -register the NetBIOS group name SAMBA#1c with the WINS server and/or -by broadcast on the local network. The PDC also registers the unique -NetBIOS name SAMBA#1b with the WINS server. The name type #1b is -normally reserved for the domain master browser, a role that has -nothing to do with anything related to authentication, but the -Microsoft Domain implementation requires the domain master browser to -be on the same machine as the PDC.

    7.3.1. How does a Workstation find its domain controller?

    A NT workstation in the domain SAMBA that wants a local user to be -authenticated has to find the domain controller for SAMBA. It does -this by doing a NetBIOS name query for the group name SAMBA#1c. It -assumes that each of the machines it gets back from the queries is a -domain controller and can answer logon requests. To not open security -holes both the workstation and the selected (TODO: How is the DC -chosen) domain controller authenticate each other. After that the -workstation sends the user's credentials (his name and password) to -the domain controller, asking for approval.

    7.3.2. When is the PDC needed?

    Whenever a user wants to change his password, this has to be done on -the PDC. To find the PDC, the workstation does a NetBIOS name query -for SAMBA#1b, assuming this machine maintains the master copy of the -SAM. The workstation contacts the PDC, both mutually authenticate and -the password change is done.

    7.4. Can Samba be a Backup Domain Controller?

    With version 2.2, no. The native NT SAM replication protocols have -not yet been fully implemented. The Samba Team is working on -understanding and implementing the protocols, but this work has not -been finished for version 2.2.

    Can I get the benefits of a BDC with Samba? Yes. The main reason for -implementing a BDC is availability. If the PDC is a Samba machine, -a second Samba machine can be set up to -service logon requests whenever the PDC is down.

    7.5. How do I set up a Samba BDC?

    Several things have to be done:

    Finally, the BDC has to be found by the workstations. This can be done -by setting

    workgroup = samba
-domain master = no
-domain logons = yes

    in the [global]-section of the smb.conf of the BDC. This makes the BDC -only register the name SAMBA#1c with the WINS server. This is no -problem as the name SAMBA#1c is a NetBIOS group name that is meant to +Chapter 6. Backup Domain Control

    Chapter 6. Backup Domain Control
    Prev Part II. Server Configuration Basics Next

    Chapter 6. Backup Domain Control

    John H. Terpstra

    Samba Team

    Volker Lendecke

    Samba Team

    Table of Contents

    Features And Benefits
    Essential Background Information
    MS Windows NT4 Style Domain Control
    Active Directory Domain Control
    What qualifies a Domain Controller on the network?
    How does a Workstation find its domain controller?
    Backup Domain Controller Configuration
    Example Configuration
    Common Errors
    Machine Accounts keep expiring, what can I do?
    Can Samba be a Backup Domain Controller to an NT4 PDC?
    How do I replicate the smbpasswd file?
    Can I do this all with LDAP?

    +Before you continue reading in this section, please make sure that you are comfortable +with configuring a Samba Domain Controller as described in the +Domain Control Chapter. +

    Features And Benefits

    +This is one of the most difficult chapters to summarise. It matters not what we say here +for someone will still draw conclusions and / or approach the Samba-Team with expectations +that are either not yet capable of being delivered, or that can be achieved for more +effectively using a totally different approach. Since this HOWTO is already so large and +extensive, we have taken the decision to provide sufficient (but not comprehensive) +information regarding Backup Domain Control. In the event that you should have a persistent +concern that is not addressed in this HOWTO document then please email +John H Terpstra clearly setting out your requirements +and / or question and we will do our best to provide a solution. +

    +Samba-3 is capable of acting as a Backup Domain Controller to another Samba Primary Domain +Controller. A Samba-3 PDC can operate with an LDAP Account backend. The Samba-3 BDC can +operate with a slave LDAP server for the Account backend. This effectively gives samba a high +degree of scalability. This is a very sweet (nice) solution for large organisations. +

    +While it is possible to run a Samba-3 BDC with non-LDAP backend, the administrator will +need to figure out precisely what is the best way to replicate (copy / distribute) the +user and machine Accounts backend. +

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

    +Considering the number of comments and questions raised concerning how to configure a BDC +lets consider each possible option and look at the pro's and con's for each theoretical solution: +

    Backup Domain Backend Account Distribution Options

    • + Solution: Passwd Backend is LDAP based, BDCs use a slave LDAP server +

      + Arguments For: This is a neat and manageable solution. The LDAP based SAM (ldapsam) + is constantly kept up to date. +

      + Arguments Against: Complexity +

    • + Passdb Backend is tdbsam based, BDCs use cron based "net rcp vampire" to + suck down the Accounts database from the PDC +

      + Arguments For: It would be a nice solution +

      + Arguments Against: It does not work because Samba-3 does not support the required + protocols. This may become a later feature but is not available today. +

    • + Make use of rsync to replicate (pull down) copies of the essential account files +

      + Arguments For: It is a simple solution, easy to set up as a scheduled job +

      + Arguments Against: This will over-write the locally changed machine trust account + passwords. This is a broken and flawed solution. Do NOT do this. +

    • + Operate with an entirely local accounts database (not recommended) +

      + Arguments For: Simple, easy to maintain +

      + Arguments Against: All machine trust accounts and user accounts will be locally + maintained. Domain users will NOT be able to roam from office to office. This is + a broken and flawed solution. Do NOT do this. +

    Essential Background Information

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

    +When MS Windows NT3.10 was first released it supported an new style of Domain Control +and with it a new form of the network logon service that has extended functionality. +This service became known as the NT NetLogon Service. The nature of this service has +changed with the evolution of MS Windows NT and today provides a very complex array of +services that are implemented over a complex spectrum of technologies. +

    MS Windows NT4 Style Domain Control

    +Whenever a user logs into a Windows NT4 / 200x / XP Profresional Workstation, +the workstation connects to a Domain Controller (authentication server) to validate +the username and password that the user entered are valid. If the information entered +does not validate against the account information that has been stored in the Domain +Control database (the SAM, or Security Accounts Manager database) then a set of error +codes is returned to the workstation that has made the authentication request. +

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

    +The account information (user and machine) on Domain Controllers is stored in two files, +one containing the Security information and the other the SAM. These are stored in files +by the same name in the C:\WinNT\System32\config directory. These +are the files that are involved in replication of the SAM database where Backup Domain +Controllers are present on the network. +

    +There are two situations in which it is desirable to install Backup Domain Controllers: +

    • + On the local network that the Primary Domain Controller is on if there are many + workstations and/or where the PDC is generally very busy. In this case the BDCs + will pick up network logon requests and help to add robustness to network services. +

    • + At each remote site, to reduce wide area network traffic and to add stability to + remote network operations. The design of the network, the strategic placement of + Backup Domain Controllers, together with an implementation that localises as much + of network to client interchange as possible will help to minimise wide area network + bandwidth needs (and thus costs). +

    +The PDC contains the master copy of the SAM. In the event that an administrator makes a +change to the user account database while physically present on the local network that +has the PDC, the change will likely be made directly to the PDC instance of the master +copy of the SAM. In the event that this update may be performed in a branch office the +change will likely be stored in a delta file on the local BDC. The BDC will then send +a trigger to the PDC to commence the process of SAM synchronisation. The PDC will then +request the delta from the BDC and apply it to the master SAM. THe PDC will then contact +all the BDCs in the Domain and trigger them to obtain the update and then apply that to +their own copy of the SAM. +

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

    +In the event that the PDC should need to be taken out of service, or if it dies, then +one of the BDCs can be promoted to a PDC. If this happens while the original PDC is on +line then it is automatically demoted to a BDC. This is an important aspect of Domain +Controller management. The tool that is used to affect a promotion or a demotion is the +Server Manager for Domains. +

    Example PDC Configuration

    +Since version 2.2 Samba officially supports domain logons for all current Windows Clients, +including Windows NT4, 2003 and XP Professional. For samba to be enabled as a PDC some +parameters in the [global]-section of the smb.conf have to be set: +

    +	workgroup = SAMBA
+	domain master = yes
+	domain logons = yes
+

    +Several other things like a [homes] and a [netlogon] share also need to be set along with +settings for the profile path, the users home drive, etc.. This will not be covered in this +chapter, for more information please refer to the chapter on Domain Control. +

    Active Directory Domain Control

    +As of the release of MS Windows 2000 and Active Directory, this information is now stored +in a directory that can be replicated and for which partial or full administrative control +can be delegated. Samba-3 is NOT able to be a Domain Controller within an Active Directory +tree, and it can not be an Active Directory server. This means that Samba-3 also can NOT +act as a Backup Domain Contoller to an Active Directory Domain Controller. +

    What qualifies a Domain Controller on the network?

    +Every machine that is a Domain Controller for the domain SAMBA has to register the NetBIOS +group name SAMBA<#1c> with the WINS server and/or by broadcast on the local network. +The PDC also registers the unique NetBIOS name SAMBA<#1b> with the WINS server. +The name type <#1b> name is normally reserved for the Domain Master Browser, a role +that has nothing to do with anything related to authentication, but the Microsoft Domain +implementation requires the domain master browser to be on the same machine as the PDC. +

    How does a Workstation find its domain controller?

    +An MS Windows NT4 / 200x / XP Professional workstation in the domain SAMBA that wants a +local user to be authenticated has to find the domain controller for SAMBA. It does this +by doing a NetBIOS name query for the group name SAMBA<#1c>. It assumes that each +of the machines it gets back from the queries is a domain controller and can answer logon +requests. To not open security holes both the workstation and the selected domain controller +authenticate each other. After that the workstation sends the user's credentials (name and +password) to the local Domain Controller, for valdation. +

    Backup Domain Controller Configuration

    +Several things have to be done: +

    • + The domain SID has to be the same on the PDC and the BDC. This used to + be stored in the file private/MACHINE.SID. This file is not created + anymore since Samba 2.2.5 or even earlier. Nowadays the domain SID is + stored in the file private/secrets.tdb. Simply copying the secrets.tdb + from the PDC to the BDC does not work, as the BDC would + generate a new SID for itself and override the domain SID with this + new BDC SID.

      + To retrieve the domain SID from the PDC or an existing BDC and store it in the + secrets.tdb, execute 'net rpc getsid' on the BDC. +

    • + The Unix user database has to be synchronized from the PDC to the + BDC. This means that both the /etc/passwd and /etc/group have to be + replicated from the PDC to the BDC. This can be done manually + whenever changes are made, or the PDC is set up as a NIS master + server and the BDC as a NIS slave server. To set up the BDC as a + mere NIS client would not be enough, as the BDC would not be able to + access its user database in case of a PDC failure. +

    • + The Samba password database in the file private/smbpasswd has to be + replicated from the PDC to the BDC. This is a bit tricky, see the + next section. +

    • + Any netlogon share has to be replicated from the PDC to the + BDC. This can be done manually whenever login scripts are changed, + or it can be done automatically together with the smbpasswd + synchronization. +

    Example Configuration

    +Finally, the BDC has to be found by the workstations. This can be done by setting: +

    +	workgroup = SAMBA
+	domain master = no
+	domain logons = yes
+

    +in the [global]-section of the smb.conf of the BDC. This makes the BDC +only register the name SAMBA<#1c> with the WINS server. This is no +problem as the name SAMBA<#1c> is a NetBIOS group name that is meant to be registered by more than one machine. The parameter 'domain master = -no' forces the BDC not to register SAMBA#1b which as a unique NetBIOS -name is reserved for the Primary Domain Controller.

    PrevHomeNext
    How to Configure Samba as a NT4 Primary Domain ControllerUpSamba as a ADS domain member
    \ No newline at end of file +no' forces the BDC not to register SAMBA<#1b> which as a unique NetBIOS +name is reserved for the Primary Domain Controller. +

    Common Errors

    +As this is a rather new area for Samba there are not many examples that we may refer to. Keep +watching for updates to this section. +

    Machine Accounts keep expiring, what can I do?

    +This problem will occur when occur when the passdb (SAM) files are copied from a central +server but the local Backup Domain Controllers. Local machine trust account password updates +are not copied back to the central server. The newer machine account password is then over +written when the SAM is copied from the PDC. The result is that the Domain member machine +on start up will find that it's passwords does not match the one now in the database and +since the startup security check will now fail, this machine will not allow logon attempts +to procede and the account expiry error will be reported. +

    Can Samba be a Backup Domain Controller to an NT4 PDC?

    +With version 2.2, no. The native NT4 SAM replication protocols have not yet been fully +implemented. The Samba Team is working on understanding and implementing the protocols, +but this work has not been finished for version 2.2. +

    +With version 3.0, the work on both the replication protocols and a suitable storage +mechanism has progressed, and some form of NT4 BDC support is expected soon. +

    +Can I get the benefits of a BDC with Samba? Yes. The main reason for implementing a +BDC is availability. If the PDC is a Samba machine, a second Samba machine can be set up to +service logon requests whenever the PDC is down. +

    How do I replicate the smbpasswd file?

    +Replication of the smbpasswd file is sensitive. It has to be done whenever changes +to the SAM are made. Every user's password change is done in the smbpasswd file and +has to be replicated to the BDC. So replicating the smbpasswd file very often is necessary. +

    +As the smbpasswd file contains plain text password equivalents, it must not be +sent unencrypted over the wire. The best way to set up smbpasswd replication from +the PDC to the BDC is to use the utility rsync. rsync can use ssh as a transport. +Ssh itself can be set up to accept *only* rsync transfer without requiring the user +to type a password. +

    Can I do this all with LDAP?

    +The simple answer is YES. Samba's pdb_ldap code supports binding to a replica +LDAP server, and will also follow referrals and rebind to the master if it ever +needs to make a modification to the database. (Normally BDCs are read only, so +this will not occur often). +

    Prev Up Next
    Chapter 5. Domain Control Home Chapter 7. Domain Membership
    diff --git a/docs/htmldocs/samba-pdc.html b/docs/htmldocs/samba-pdc.html index 93bbc727d4..65c39d9399 100644 --- a/docs/htmldocs/samba-pdc.html +++ b/docs/htmldocs/samba-pdc.html @@ -1,2606 +1,550 @@ - -How to Configure Samba as a NT4 Primary Domain Controller
    SAMBA Project Documentation
    PrevNext

    Chapter 6. How to Configure Samba as a NT4 Primary Domain Controller

    6.1. Prerequisite Reading

    Before you continue reading in this chapter, please make sure -that you are comfortable with configuring basic files services -in smb.conf and how to enable and administer password -encryption in Samba. Theses two topics are covered in the -smb.conf(5) -manpage and the Encryption chapter -of this HOWTO Collection.

    6.2. Background

    Author's Note: This document is a combination -of David Bannon's "Samba 2.2 PDC HOWTO" and "Samba NT Domain FAQ". -Both documents are superseded by this one.

    Versions of Samba prior to release 2.2 had marginal capabilities to act -as a Windows NT 4.0 Primary Domain Controller - -(PDC). With Samba 2.2.0, we are proud to announce official support for -Windows NT 4.0-style domain logons from Windows NT 4.0 and Windows -2000 clients. This article outlines the steps -necessary for configuring Samba as a PDC. It is necessary to have a -working Samba server prior to implementing the PDC functionality. If -you have not followed the steps outlined in UNIX_INSTALL.html, please make sure -that your server is configured correctly before proceeding. Another -good resource in the smb.conf(5) man -page. The following functionality should work in 2.2:

    • domain logons for Windows NT 4.0/2000 clients. -

    • placing a Windows 9x client in user level security -

    • retrieving a list of users and groups from a Samba PDC to - Windows 9x/NT/2000 clients -

    • roving (roaming) user profiles -

    • Windows NT 4.0-style system policies -

    The following pieces of functionality are not included in the 2.2 release:

    • Windows NT 4 domain trusts -

    • SAM replication with Windows NT 4.0 Domain Controllers +Chapter 5. Domain Control

      Chapter 5. Domain Control
      Prev Part II. Server Configuration Basics Next

      Chapter 5. Domain Control

      John H. Terpstra

      Samba Team

      Gerald (Jerry) Carter

      Samba Team

      David Bannon

      Samba Team

      Table of Contents

      Features and Benefits
      Basics of Domain Control
      Domain Controller Types
      Preparing for Domain Control
      Domain Control - Example Configuration
      Samba ADS Domain Control
      Domain and Network Logon Configuration
      Domain Network Logon Service
      Security Mode and Master Browsers
      Common Problems and Errors
      I cannot include a '$' in a machine name
      I get told "You already have a connection to the Domain...." +or "Cannot join domain, the credentials supplied conflict with an +existing set.." when creating a machine trust account.
      The system can not log you on (C000019B)....
      The machine trust account for this computer either does not +exist or is not accessible.
      When I attempt to login to a Samba Domain from a NT4/W2K workstation, +I get a message about my account being disabled.
      Until a few minutes after Samba has started, clients get the error "Domain Controller Unavailable"

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

      +The reader is advised NOT to tackle this section without having first understood +and mastered some basics. MS Windows networking is not particularly forgiving of +misconfiguration. Users of MS Windows networking are likely to complain bitterly +of persistent niggles that may be caused by broken network or system configuration. +To a great many people however, MS Windows networking starts with a domain controller +that in some magical way is expected to solve all ills. +

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

      Basic TCP/IP configuration
      NetBIOS name resolution
      Authentication configuration
      User and Group configuration
      Basic File and Directory Permission Control in Unix/Linux
      Understanding of how MS Windows clients interoperate in a network + environment

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

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

      Features and Benefits

      +What is the key benefit of Microsoft Domain security? +

      +In a word, Single Sign On, or SSO for short. To many, this is the holy +grail of MS Windows NT and beyond networking. SSO allows users in a well designed network +to log onto any workstation that is a member of the domain that their user account is in +(or in a domain that has an appropriate trust relationship with the domain they are visiting) +and they will be able to log onto the network and access resources (shares, files, and printers) +as if they are sitting at their home (personal) workstation. This is a feature of the Domain +security protocols. +

      +The benefits of Domain security are fully available to those sites that deploy a Samba PDC. +

      Note

      +Network clients of an MS Windows Domain security environment must be Domain members to be +able to gain access to the advanced features provided. Domain membership involves more than just +setting the workgroup name to the Domain name. It requires the creation of a Domain trust account +for the workstation (called a machine account). Please refer to the chapter on +Domain Membership for more information. +

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

      • + Windows NT4 domain trusts +

      • + Adding users via the User Manager for Domains. This can be done on any MS Windows + client using the Nexus toolkit that is available from Microsoft's web site. + At some later date Samba-3 may get support for the use of the Microsoft Management + Console for user management. +

      • + Introduces replaceable and multiple user account (authentication) + back ends. In the case where the back end is placed in an LDAP database, + Samba-3 confers the benefits of a back end that can be distributed, replicated, + and is highly scalable. +

      • + Implements full Unicode support. This simplifies cross locale internationalisation + support. It also opens up the use of protocols that Samba-2.2.x had but could not use due + to the need to fully support Unicode. +

      +The following functionalities are NOT provided by Samba-3: +

      • + SAM replication with Windows NT4 Domain Controllers (i.e. a Samba PDC and a Windows NT BDC or vice versa) -

      • Adding users via the User Manager for Domains -

      • Acting as a Windows 2000 Domain Controller (i.e. Kerberos and - Active Directory) -

      Please note that Windows 9x clients are not true members of a domain -for reasons outlined in this article. Therefore the protocol for -support Windows 9x-style domain logons is completely different -from NT4 domain logons and has been officially supported for some -time.

      Implementing a Samba PDC can basically be divided into 2 broad -steps.

      1. Configuring the Samba PDC -

      2. Creating machine trust accounts and joining clients - to the domain -

      There are other minor details such as user profiles, system -policies, etc... However, these are not necessarily specific -to a Samba PDC as much as they are related to Windows NT networking -concepts. They will be mentioned only briefly here.

      6.3. Configuring the Samba Domain Controller

      The first step in creating a working Samba PDC is to -understand the parameters necessary in smb.conf. I will not -attempt to re-explain the parameters here as they are more that -adequately covered in the smb.conf -man page. For convenience, the parameters have been -linked with the actual smb.conf description.

      Here is an example smb.conf for acting as a PDC:

      [global]
-    ; Basic server settings
-    netbios name = POGO
-    workgroup = NARNIA
+

    • + Acting as a Windows 2000 Domain Controller (i.e. Kerberos and + Active Directory) - In point of fact, Samba-3 DOES have some + Active Directory Domain Control ability that is at this time + purely experimental AND that is certain + to change as it becomes a fully supported feature some time + during the Samba-3 (or later) life cycle. +

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

    +Samba-3 has an implementation of group mapping between Windows NT groups +and Unix groups (this is really quite complicated to explain in a short space). This is +discussed more fully in the Group Mapping chapter. +

    +Samba-3, like an MS Windows NT4 PDC or a Windows 200x Active Directory, needs to store +user and machine trust account information in a suitable backend data store. With Samba-3 +there can be multiple back-ends for this including: +

    • + smbpasswd - the plain ascii file stored used by + earlier versions of Samba. This file configuration option requires + a Unix/Linux system account for EVERY entry (ie: both for user and for + machine accounts). This file will be located in the private + directory (default is /usr/local/samba/lib/private or on linux /etc/samba). +

    • + tdbsam - a binary database backend that will be + stored in the private directory in a file called + passdb.tdb. The key benefit of this binary format + file is that it can store binary objects that can not be accomodated + in the traditional plain text smbpasswd file. These permit the extended + account controls that MS Windows NT4 and later also have. +

    • + ldapsam - An LDAP based back-end. Permits the + LDAP server to be specified. eg: ldap://localhost or ldap://frodo.murphy.com. + Like the tdbsam, ldapsam permits the storing of extended account attributes + for control of things like: Permitted access times, password activation and + expiry, permitted points of access (workstation names), per user profile + location, and much more. +

    • + ldapsam_compat - An LDAP back-end that maintains backwards + compatibility with the behaviour of samba-2.2.x. You should use this in the process + of migrating from samba-2.2.x to samba-3 if you do not want to rebuild your LDAP + database. +

    +Read the chapter about Account Information Database for details +regarding the choices available and how to configure them. +

    Note

    +The new tdbsam and ldapsam account backends store substantially more information than +smbpasswd is capable of. The new backend database includes capacity to specify +per user settings for many parameters, over-riding global settings given in the +smb.conf file. eg: logon drive, logon home, logon path, etc. +Thus, with samba-3 it is possible to have a default system configuration for profiles, +and on a per user basis to over-ride this for those users who should not be subject +to the default configuration. +

    Basics of Domain Control

    +Over the years, public perceptions of what Domain Control really is has taken on an +almost mystical nature. Before we branch into a brief overview of Domain Control, +there are three basic types of domain controllers: +

    Domain Controller Types

    • Primary Domain Controller

    • Backup Domain Controller

    • ADS Domain Controller

    +The Primary Domain Controller or PDC plays an important role in the MS +Windows NT4 and Windows 200x Domain Control architecture, but not in the manner that so many +expect. There is folk lore that dictates that because of it's role in the MS Windows +network, the PDC should be the most powerful and most capable machine in the network. +As strange as it may seem to say this here, good over all network performance dictates that +the entire infrastructure needs to be balanced. It is advisable to invest more in the Backup +Domain Controllers and Stand-Alone (or Domain Member) servers than in the PDC. +

    +In the case of MS Windows NT4 style domains, it is the PDC seeds the Domain Control database, +a part of the Windows registry called the SAM (Security Account Manager). It plays a key +part in NT4 type domain user authentication and in synchronisation of the domain authentication +database with Backup Domain Controllers. +

    +With MS Windows 200x Server based Active Directory domains, one domain controller seeds a potential +hierachy of domain controllers, each with their own area of delegated control. The master domain +controller has the ability to override any down-stream controller, but a down-line controller has +control only over it's down-line. With Samba-3 this functionality can be implemented using an +LDAP based user and machine account back end. +

    +New to Samba-3 is the ability to use a back-end database that holds the same type of data as +the NT4 style SAM (Security Account Manager) database (one of the registry files). +The Samba-3 SAM can be specified via the smb.conf file parameter +passwd backend and valid options include +smbpasswd, tdbsam, ldapsam, nisplussam, xmlsam, mysqlsam, guest. +

    +The Backup Domain Controller or BDC plays a key role in servicing network +authentication requests. The BDC is biased to answer logon requests in preference to the PDC. +On a network segment that has a BDC and a PDC the BDC will be most likely to service network +logon requests. The PDC will answer network logon requests when the BDC is too busy (high load). +A BDC can be promoted to a PDC. If the PDC is on line at the time that a BDC is promoted to +PDC, the previous PDC is automatically demoted to a BDC. With Samba-3 this is NOT an automatic +operation; the PDB and BDC must be manually configured and changes need to be made likewise. +

    +With MS Windows NT4, it is an install time decision what type of machine the server will be. +It is possible to change the promote a BDC to a PDC and vica versa only, but the only way +to convert a domain controller to a domain member server or a stand-alone server is to +reinstall it. The install time choices offered are: +

    • Primary Domain Controller - The one that seeds the domain SAM

    • Backup Domain Controller - One that obtains a copy of the domain SAM

    • Domain Member Server - One that has NO copy of the domain SAM, rather it obtains authentication from a Domain Controller for all access controls.

    • Stand-Alone Server - One that plays NO part is SAM synchronisation, has it's own authentication database and plays no role in Domain security.

    +With MS Windows 2000 the configuration of domain control is done after the server has been +installed. Samba-3 is capable of acting fully as a native member of a Windows 200x server +Active Directory domain. +

    +New to Samba-3 is the ability to function fully as an MS Windows NT4 style Domain Controller, +excluding the SAM replication components. However, please be aware that Samba-3 support the +MS Windows 200x domain control protocols also. +

    +At this time any appearance that Samba-3 is capable of acting as an +ADS Domain Controller is limited and experimental in nature. +This functionality should not be used until the Samba-Team offers formal support for it. +At such a time, the documentation will be revised to duly reflect all configuration and +management requirements. +

    Preparing for Domain Control

    +There are two ways that MS Windows machines may interact with each other, with other servers, +and with Domain Controllers: Either as Stand-Alone systems, more commonly +called Workgroup members, or as full participants in a security system, +more commonly called Domain members. +

    +It should be noted that Workgroup membership involve no special configuration +other than the machine being configured so that the network configuration has a commonly used name +for it's workgroup entry. It is not uncommon for the name WORKGROUP to be used for this. With this +mode of configuration there are NO machine trust accounts and any concept of membership as such +is limited to the fact that all machines appear in the network neighbourhood to be logically +grouped together. Again, just to be clear: workgroup mode does not involve any security machine +accounts. +

    +Domain member machines have a machine account in the Domain accounts database. A special procedure +must be followed on each machine to affect Domain membership. This procedure, which can be done +only by the local machine Administrator account, will create the Domain machine account (if +if does not exist), and then initializes that account. When the client first logs onto the +Domain it triggers a machine password change. +

    Note

    +When running a Domain all MS Windows NT / 200x / XP Professional clients should be configured +as full Domain Members - IF A SECURE NETWORK IS WANTED. If the machine is NOT made a member of the +Domain, then it will operate like a workgroup (stand-alone) machine. Please refer the +Domain Membership chapter for information regarding + HOW to make your MS Windows clients Domain members. +

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

    Configuration of basic TCP/IP and MS Windows Networking
    Correct designation of the Server Role (security = user)
    Consistent configuration of Name Resolution (See chapter on Browsing and on + MS Windows network Integration)
    Domain logons for Windows NT4 / 200x / XP Professional clients
    Configuration of Roaming Profiles or explicit configuration to force local profile usage
    Configuration of Network/System Policies
    Adding and managing domain user accounts
    Configuring MS Windows client machines to become domain members

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

    Configuration of basic TCP/IP and MS Windows Networking
    Correct designation of the Server Role (security = user)
    Network Logon Configuration (Since Windows 9x / XP Home are not technically domain + members, they do not really particpate in the security aspects of Domain logons as such)
    Roaming Profile Configuration
    Configuration of System Policy handling
    Installation of the Network driver "Client for MS Windows Networks" and configuration + to log onto the domain
    Placing Windows 9x / Me clients in user level security - if it is desired to allow + all client share access to be controlled according to domain user / group identities.
    Adding and managing domain user accounts

    Note

    +Roaming Profiles and System/Network policies are advanced network administration topics +that are covered in the Profile Management and +Policy Management chapters of this document. However, these are not necessarily specific +to a Samba PDC as much as they are related to Windows NT networking concepts. +

    +A Domain Controller is an SMB/CIFS server that: +

    • + Registers and advertises itself as a Domain Controller (through NetBIOS broadcasts + as well as by way of name registrations either by Mailslot Broadcasts over UDP broadcast, + to a WINS server over UDP unicast, or via DNS and Active Directory) +

    • + Provides the NETLOGON service (actually a collection of services that runs over + a number of protocols. These include the LanMan Logon service, the Netlogon service, + the Local Security Account service, and variations of them) +

    • + Provides a share called NETLOGON +

    +For Samba to provide these is rather easy to configure. Each Samba Domain Controller must provide +the NETLOGON service which Samba calls the domain logons functionality +(after the name of the parameter in the smb.conf file). Additionally, one (1) server in a Samba-3 +Domain must advertise itself as the domain master browser. This causes the Primary Domain Controller +to claim domain specific NetBIOS name that identifies it as a domain master browser for its given +domain/workgroup. Local master browsers in the same domain/workgroup on broadcast-isolated subnets +then ask for a complete copy of the browse list for the whole wide area network. Browser clients +will then contact their local master browser, and will receive the domain-wide browse list, +instead of just the list for their broadcast-isolated subnet. +

    Domain Control - Example Configuration

    +The first step in creating a working Samba PDC is to understand the parameters necessary +in smb.conf. Here we attempt to explain the parameters that are covered in +the smb.conf man page. +

    +Here is an example smb.conf for acting as a PDC: +

    +	[global]
+	    ; Basic server settings
+	    netbios name = POGO
+	    workgroup = NARNIA
+
+	    ; User and Machine Account Backends
+	    ; Choices are: tdbsam, smbpasswd, ldapsam, mysqlsam, xmlsam, guest
+	    passdb backend = ldapsam, guest
+
+	    ; we should act as the domain and local master browser
+	    os level = 64
+	    preferred master = yes
+	    domain master = yes
+	    local master = yes
+	    
+	    ; security settings (must user security = user)
+	    security = user
+	    
+	    ; encrypted passwords are a requirement for a PDC (default = Yes)
+	    encrypt passwords = yes
+	    
+	    ; support domain logons
+	    domain logons = yes
+	    
+	    ; where to store user profiles?
+	    logon path = \\%N\profiles\%u
+	    
+	    ; where is a user's home directory and where should it be mounted at?
+	    logon drive = H:
+	    logon home = \\homeserver\%u\winprofile
+	    
+	    ; specify a generic logon script for all users
+	    ; this is a relative **DOS** path to the [netlogon] share
+	    logon script = logon.cmd
 
-    ; we should act as the domain and local master browser
-    os level = 64
-    preferred master = yes
-    domain master = yes
-    local master = yes
-    
-    ; security settings (must user security = user)
-    security = user
-    
-    ; encrypted passwords are a requirement for a PDC
-    encrypt passwords = yes
-    
-    ; support domain logons
-    domain logons = yes
-    
-    ; where to store user profiles?
-    logon path = \\%N\profiles\%u
-    
-    ; where is a user's home directory and where should it
-    ; be mounted at?
-    logon drive = H:
-    logon home = \\homeserver\%u
-    
-    ; specify a generic logon script for all users
-    ; this is a relative **DOS** path to the [netlogon] share
-    logon script = logon.cmd
+	; necessary share for domain controller
+	[netlogon]
+	    path = /usr/local/samba/lib/netlogon
+	    read only = yes
+	    write list = ntadmin
+	    
+	; share for storing user profiles
+	[profiles]
+	    path = /export/smb/ntprofile
+	    read only = no
+	    create mask = 0600
+	    directory mask = 0700
+

    Note

    +The above parameters make for a full set of parameters that may define the server's mode +of operation. The following parameters are the essentials alone: -; necessary share for domain controller -[netlogon] - path = /usr/local/samba/lib/netlogon - read only = yes - write list = ntadmin - -; share for storing user profiles -[profiles] - path = /export/smb/ntprofile - read only = no - create mask = 0600 - directory mask = 0700

    There are a couple of points to emphasize in the above configuration.

    • Encrypted passwords must be enabled. For more details on how - to do this, refer to ENCRYPTION.html. -

    • The server must support domain logons and a - [netlogon] share -

    • The server must be the domain master browser in order for Windows +

      +	workgroup = NARNIA
+	domain logons = Yes
+	domain master = Yes
+	security = User
+

      + +The additional parameters shown in the longer listing above just makes for a +more complete environment. +

    +There are a couple of points to emphasize in the above configuration. +

    • + Encrypted passwords must be enabled. For more details on how + to do this, refer to Account Information Database chapter. +

    • + The server must support domain logons and have a + [netlogon] share +

    • + The server must be the domain master browser in order for Windows client to locate the server as a DC. Please refer to the various Network Browsing documentation included with this distribution for details. -

    As Samba 2.2 does not offer a complete implementation of group mapping -between Windows NT groups and Unix groups (this is really quite -complicated to explain in a short space), you should refer to the -domain admin -group smb.conf parameter for information of creating "Domain -Admins" style accounts.

    6.4. Creating Machine Trust Accounts and Joining Clients to the -Domain

    A machine trust account is a Samba account that is used to -authenticate a client machine (rather than a user) to the Samba -server. In Windows terminology, this is known as a "Computer -Account."

    The password of a machine trust account acts as the shared secret for -secure communication with the Domain Controller. This is a security -feature to prevent an unauthorized machine with the same NetBIOS name -from joining the domain and gaining access to domain user/group -accounts. Windows NT and 2000 clients use machine trust accounts, but -Windows 9x clients do not. Hence, a Windows 9x client is never a true -member of a domain because it does not possess a machine trust -account, and thus has no shared secret with the domain controller.

    A Windows PDC stores each machine trust account in the Windows -Registry. A Samba PDC, however, stores each machine trust account -in two parts, as follows: +

    Samba ADS Domain Control

    +Samba-3 is not and can not act as an Active Directory Server. It can not truly function as +an Active Directory Primary Domain Controller. The protocols for some of the functionality +the Active Directory Domain Controllers is have been partially implemented on an experimental +only basis. Please do NOT expect Samba-3 to support these protocols - nor should you depend +on any such functionality either now or in the future. The Samba-Team may well remove such +experiemental features or may change their behaviour. +

    Domain and Network Logon Configuration

    +The subject of Network or Domain Logons is discussed here because it rightly forms +an integral part of the essential functionality that is provided by a Domain Controller. +

    Domain Network Logon Service

    +All Domain Controllers must run the netlogon service (domain logons +in Samba). One Domain Controller must be configured with domain master = Yes +(the Primary Domain Controller); on ALL Backup Domain Controllers domain master = No +must be set. +

    Example Configuration

    +	[globals]
+		domain logons = Yes
+		domain master = (Yes on PDC, No on BDCs)
 
-
    • A Samba account, stored in the same location as user
-    LanMan and NT password hashes (currently
-    smbpasswd). The Samba account 
-    possesses and uses only the NT password hash.
    • A corresponding Unix account, typically stored in
-    /etc/passwd. (Future releases will alleviate the need to
-    create /etc/passwd entries.) 
    There are two ways to create machine trust accounts:
    •  Manual creation. Both the Samba and corresponding
-	Unix account are created by hand.
    •  "On-the-fly" creation. The Samba machine trust
-	account is automatically created by Samba at the time the client
-	is joined to the domain. (For security, this is the
-	recommended method.) The corresponding Unix account may be
-	created automatically or manually. 
    6.4.1. Manual Creation of Machine Trust Accounts
    The first step in manually creating a machine trust account is to
-manually create the corresponding Unix account in
-/etc/passwd.  This can be done using
-vipw or other 'add user' command that is normally
-used to create new Unix accounts.  The following is an example for a
-Linux based Samba server:
      root# /usr/sbin/useradd -g 100 -d /dev/null -c "machine 
-nickname" -s /bin/false machine_name$ 
    root# passwd -l machine_name$
    On *BSD systems, this can be done using the 'chpass' utility:
    root# chpass -a "machine_name$:*:101:100::0:0:Workstation machine_name:/dev/null:/sbin/nologin"
    The /etc/passwd entry will list the machine name 
-with a "$" appended, won't have a password, will have a null shell and no 
-home directory. For example a machine named 'doppy' would have an 
-/etc/passwd entry like this:
    doppy$:x:505:501:machine_nickname:/dev/null:/bin/false
    Above, machine_nickname can be any
-descriptive name for the client, i.e., BasementComputer.
-machine_name absolutely must be the NetBIOS
-name of the client to be joined to the domain.  The "$" must be
-appended to the NetBIOS name of the client or Samba will not recognize
-this as a machine trust account.
    Now that the corresponding Unix account has been created, the next step is to create 
-the Samba account for the client containing the well-known initial 
-machine trust account password.  This can be done using the smbpasswd(8) command 
-as shown here:
    root# smbpasswd -a -m machine_name
    where machine_name is the machine's NetBIOS
-name.  The RID of the new machine account is generated from the UID of 
-the corresponding Unix account.
    Join the client to the domain immediately
     
    	Manually creating a machine trust account using this method is the 
-	equivalent of creating a machine trust account on a Windows NT PDC using 
-	the "Server Manager".  From the time at which the account is created
-	to the time which the client joins the domain and changes the password,
-	your domain is vulnerable to an intruder joining your domain using a
-	a machine with the same NetBIOS name.  A PDC inherently trusts
-	members of the domain and will serve out a large degree of user 
-	information to such clients.  You have been warned!
-	
    6.4.2. "On-the-Fly" Creation of Machine Trust Accounts
    The second (and recommended) way of creating machine trust accounts is
-simply to allow the Samba server to create them as needed when the client
-is joined to the domain. 
    Since each Samba machine trust account requires a corresponding
-Unix account, a method for automatically creating the
-Unix account is usually supplied; this requires configuration of the
-add user script 
-option in smb.conf.  This
-method is not required, however; corresponding Unix accounts may also
-be created manually.
    Below is an example for a RedHat 6.2 Linux system.
    [global]
-   # <...remainder of parameters...>
-   add user script = /usr/sbin/useradd -d /dev/null -g 100 -s /bin/false -M %u 
    6.4.3. Joining the Client to the Domain
    The procedure for joining a client to the domain varies with the
-version of Windows.

    6.5. Common Problems and Errors

    6.6. System Policies and Profiles

    Much of the information necessary to implement System Policies and -Roving User Profiles in a Samba domain is the same as that for -implementing these same items in a Windows NT 4.0 domain. -You should read the white paper Implementing -Profiles and Policies in Windows NT 4.0 available from Microsoft.

    Here are some additional details:

    • What about Windows NT Policy Editor? -

      To create or edit ntconfig.pol you must use - the NT Server Policy Editor, poledit.exe which - is included with NT Server but not NT Workstation. - There is a Policy Editor on a NTws - but it is not suitable for creating Domain Policies. - Further, although the Windows 95 - Policy Editor can be installed on an NT Workstation/Server, it will not - work with NT policies because the registry key that are set by the policy templates. - However, the files from the NT Server will run happily enough on an NTws. - You need poledit.exe, common.adm and winnt.adm. It is convenient - to put the two *.adm files in c:\winnt\inf which is where - the binary will look for them unless told otherwise. Note also that that - directory is 'hidden'. -

      The Windows NT policy editor is also included with the Service Pack 3 (and - later) for Windows NT 4.0. Extract the files using servicepackname /x, - i.e. that's Nt4sp6ai.exe /x for service pack 6a. The policy editor, - poledit.exe and the associated template files (*.adm) should - be extracted as well. It is also possible to downloaded the policy template - files for Office97 and get a copy of the policy editor. Another possible - location is with the Zero Administration Kit available for download from Microsoft. -

    • Can Win95 do Policies? -

      Install the group policy handler for Win9x to pick up group - policies. Look on the Win98 CD in \tools\reskit\netadmin\poledit. - Install group policies on a Win9x client by double-clicking - grouppol.inf. Log off and on again a couple of - times and see if Win98 picks up group policies. Unfortunately this needs - to be done on every Win9x machine that uses group policies.... -

      If group policies don't work one reports suggests getting the updated - (read: working) grouppol.dll for Windows 9x. The group list is grabbed - from /etc/group. -

    • How do I get 'User Manager' and 'Server Manager' -

      Since I don't need to buy an NT Server CD now, how do I get - the 'User Manager for Domains', the 'Server Manager'? -

      Microsoft distributes a version of these tools called nexus for - installation on Windows 95 systems. The tools set includes -

      • Server Manager

      • User Manager for Domains

      • Event Viewer

      Click here to download the archived file ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE -

      The Windows NT 4.0 version of the 'User Manager for - Domains' and 'Server Manager' are available from Microsoft via ftp - from ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE -

    6.7. What other help can I get?

    There are many sources of information available in the form -of mailing lists, RFC's and documentation. The docs that come -with the samba distribution contain very good explanations of -general SMB topics such as browsing.

    • How do I get help from the mailing lists? -

      There are a number of Samba related mailing lists. Go to http://samba.org, click on your nearest mirror - and then click on Support and then click on Samba related mailing lists. -

      For questions relating to Samba TNG go to - http://www.samba-tng.org/ - It has been requested that you don't post questions about Samba-TNG to the - main stream Samba lists.

      If you post a message to one of the lists please observe the following guide lines : -

      • Always remember that the developers are volunteers, they are - not paid and they never guarantee to produce a particular feature at - a particular time. Any time lines are 'best guess' and nothing more. -

      • Always mention what version of samba you are using and what - operating system its running under. You should probably list the - relevant sections of your smb.conf file, at least the options - in [global] that affect PDC support.

      • In addition to the version, if you obtained Samba via - CVS mention the date when you last checked it out.

      • Try and make your question clear and brief, lots of long, - convoluted questions get deleted before they are completely read ! - Don't post html encoded messages (if you can select colour or font - size its html).

      • If you run one of those nifty 'I'm on holidays' things when - you are away, make sure its configured to not answer mailing lists. -

      • Don't cross post. Work out which is the best list to post to - and see what happens, i.e. don't post to both samba-ntdom and samba-technical. - Many people active on the lists subscribe to more - than one list and get annoyed to see the same message two or more times. - Often someone will see a message and thinking it would be better dealt - with on another, will forward it on for you.

      • You might include partial - log files written at a debug level set to as much as 20. - Please don't send the entire log but enough to give the context of the - error messages.

      • (Possibly) If you have a complete netmon trace ( from the opening of - the pipe to the error ) you can send the *.CAP file as well.

      • Please think carefully before attaching a document to an email. - Consider pasting the relevant parts into the body of the message. The samba - mailing lists go to a huge number of people, do they all need a copy of your - smb.conf in their attach directory?

    • How do I get off the mailing lists? -

      To have your name removed from a samba mailing list, go to the - same place you went to to get on it. Go to http://lists.samba.org, - click on your nearest mirror and then click on Support and - then click on Samba related mailing lists. Or perhaps see - here -

      Please don't post messages to the list asking to be removed, you will just - be referred to the above address (unless that process failed in some way...) -

    6.8. Domain Control for Windows 9x/ME

    The following section contains much of the original -DOMAIN.txt file previously included with Samba. Much of -the material is based on what went into the book Special -Edition, Using Samba, by Richard Sharpe.

    A domain and a workgroup are exactly the same thing in terms of network + [netlogon] + comment = Network Logon Service + path = /var/lib/samba/netlogon + guest ok = Yes + browseable = No +

    The Special Case of MS Windows XP Home Edition

    Note

    +MS Windows XP Home Edition does not have the ability to join any type of Domain +security facility. Unlike, MS Windows 9x / Me, MS Windows XP Home Edition also completely +lacks the ability to log onto a network. +

    +To be completely clear: If you want MS Windows XP Home Edition to integrate with your +MS Windows NT4 or Active Directory Domain security understand - IT CAN NOT BE DONE. +Your only choice is to buy the upgrade pack from MS Windows XP Home Edition to +MS Windows XP Professional. +

    +Now that this has been said, please do NOT ask the mailing list, or email any of the +Samba-Team members with your questions asking how to make this work. It can't be done. +

    The Special Case of Windows 9x / Me

    +A domain and a workgroup are exactly the same thing in terms of network browsing. The difference is that a distributable authentication database is associated with a domain, for secure login access to a network. Also, different access rights can be granted to users if they -successfully authenticate against a domain logon server (NT server and -other systems based on NT server support this, as does at least Samba TNG now).

    The SMB client logging on to a domain has an expectation that every other +successfully authenticate against a domain logon server. Samba-3 does this +now in the same way that MS Windows NT/2K. +

    +The SMB client logging on to a domain has an expectation that every other server in the domain should accept the same authentication information. -Network browsing functionality of domains and workgroups is -identical and is explained in BROWSING.txt. It should be noted, that browsing -is totally orthogonal to logon support.

    Issues related to the single-logon network model are discussed in this +Network browsing functionality of domains and workgroups is identical and +is explained in this documentation under the browsing discussions. +It should be noted, that browsing is totally orthogonal to logon support. +

    +Issues related to the single-logon network model are discussed in this section. Samba supports domain logons, network logon scripts, and user profiles for MS Windows for workgroups and MS Windows 9X/ME clients -which will be the focus of this section.

    When an SMB client in a domain wishes to logon it broadcast requests for a +which are the focus of this section. +

    +When an SMB client in a domain wishes to logon, it broadcasts requests for a logon server. The first one to reply gets the job, and validates its password using whatever mechanism the Samba administrator has installed. It is possible (but very stupid) to create a domain where the user database is not shared between servers, i.e. they are effectively workgroup servers advertising themselves as participating in a domain. This demonstrates how authentication is quite different from but closely -involved with domains.

    Using these features you can make your clients verify their logon via +involved with domains. +

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

    Before launching into the configuration instructions, it is -worthwhile lookingat how a Windows 9x/ME client performs a logon:

    1. The client broadcasts (to the IP broadcast address of the subnet it is in) - a NetLogon request. This is sent to the NetBIOS name DOMAIN<1c> at the +the network and download their preferences, desktop and start menu. +

      +MS Windows XP Home edition is NOT able to join a domain and does not permit +the use of domain logons. +

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

      1. + The client broadcasts (to the IP broadcast address of the subnet it is in) + a NetLogon request. This is sent to the NetBIOS name DOMAIN<#1c> at the NetBIOS layer. The client chooses the first response it receives, which contains the NetBIOS name of the logon server to use in the format of - \\SERVER. -

      2. The client then connects to that server, logs on (does an SMBsessetupX) and + \\SERVER. +

      3. + The client then connects to that server, logs on (does an SMBsessetupX) and then connects to the IPC$ share (using an SMBtconX). -

      4. The client then does a NetWkstaUserLogon request, which retrieves the name +

      5. + The client then does a NetWkstaUserLogon request, which retrieves the name of the user's logon script. -

      6. The client then connects to the NetLogon share and searches for this +

      7. + The client then connects to the NetLogon share and searches for said script and if it is found and can be read, is retrieved and executed by the client. After this, the client disconnects from the NetLogon share. -

      8. The client then sends a NetUserGetInfo request to the server, to retrieve +

      9. + The client then sends a NetUserGetInfo request to the server, to retrieve the user's home share, which is used to search for profiles. Since the - response to the NetUserGetInfo request does not contain much more + response to the NetUserGetInfo request does not contain much more than the user's home share, profiles for Win9X clients MUST reside in the user home directory. -

      10. The client then connects to the user's home share and searches for the +

      11. + The client then connects to the user's home share and searches for the user's profile. As it turns out, you can specify the user's home share as - a sharename and path. For example, \\server\fred\.profile. + a sharename and path. For example, \\server\fred\.winprofile. If the profiles are found, they are implemented. -

      12. The client then disconnects from the user's home share, and reconnects to - the NetLogon share and looks for CONFIG.POL, the policies file. If this is +

      13. + The client then disconnects from the user's home share, and reconnects to + the NetLogon share and looks for CONFIG.POL, the policies file. If this is found, it is read and implemented. -

      6.8.1. Configuration Instructions: Network Logons

      The main difference between a PDC and a Windows 9x logon -server configuration is that

      Therefore, a Samba PDC will also act as a Windows 9x logon -server.

      security mode and master browsers
       

      There are a few comments to make in order to tie up some +

      +The main difference between a PDC and a Windows 9x logon server configuration is that +

      • + Password encryption is not required for a Windows 9x logon server. But note + that beginning with MS Windows 98 the default setting is that plain-text + password support has been disabled. It can be re-enabled with the registry + changes that are documented in the chapter on Policies. +

      • + Windows 9x/ME clients do not require and do not use machine trust accounts. +

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

      Security Mode and Master Browsers

      +There are a few comments to make in order to tie up some loose ends. There has been much debate over the issue of whether or not it is ok to configure Samba as a Domain Controller in security -modes other than USER. The only security mode -which will not work due to technical reasons is SHARE -mode security. DOMAIN and SERVER -mode security is really just a variation on SMB user level security.

      Actually, this issue is also closely tied to the debate on whether +modes other than USER. The only security mode +which will not work due to technical reasons is SHARE +mode security. DOMAIN and SERVER +mode security are really just a variation on SMB user level security. +

      +Actually, this issue is also closely tied to the debate on whether or not Samba must be the domain master browser for its workgroup when operating as a DC. While it may technically be possible to configure a server as such (after all, browsing and domain logons -are two distinctly different functions), it is not a good idea to -so. You should remember that the DC must register the DOMAIN#1b NetBIOS +are two distinctly different functions), it is not a good idea to do +so. You should remember that the DC must register the DOMAIN<#1b> NetBIOS name. This is the name used by Windows clients to locate the DC. Windows clients do not distinguish between the DC and the DMB. -For this reason, it is very wise to configure the Samba DC as the DMB.

      Now back to the issue of configuring a Samba DC to use a mode other -than "security = user". If a Samba host is configured to use +For this reason, it is very wise to configure the Samba DC as the DMB. +

      +Now back to the issue of configuring a Samba DC to use a mode other +than security = user. If a Samba host is configured to use another SMB server or DC in order to validate user connection requests, then it is a fact that some other machine on the network -(the "password server") knows more about user than the Samba host. +(the password server) knows more about the user than the Samba host. 99% of the time, this other host is a domain controller. Now -in order to operate in domain mode security, the "workgroup" parameter +in order to operate in domain mode security, the workgroup parameter must be set to the name of the Windows NT domain (which already -has a domain controller, right?)

      Therefore configuring a Samba box as a DC for a domain that -already by definition has a PDC is asking for trouble. -Therefore, you should always configure the Samba DC to be the DMB -for its domain.

      6.8.2. Configuration Instructions: Setting up Roaming User Profiles

      NOTE! Roaming profiles support is different -for Win9X and WinNT.

      Before discussing how to configure roaming profiles, it is useful to see how -Win9X and WinNT clients implement these features.

      Win9X clients send a NetUserGetInfo request to the server to get the user's -profiles location. However, the response does not have room for a separate -profiles location field, only the user's home share. This means that Win9X -profiles are restricted to being in the user's home directory.

      WinNT clients send a NetSAMLogon RPC request, which contains many fields, -including a separate field for the location of the user's profiles. -This means that support for profiles is different for Win9X and WinNT.

      6.8.2.2. Windows 9X Configuration

      To support Win9X clients, you must use the "logon home" parameter. Samba has -now been fixed so that "net use/home" now works as well, and it, too, relies -on the "logon home" parameter.

      By using the logon home parameter, you are restricted to putting Win9X -profiles in the user's home directory. But wait! There is a trick you -can use. If you set the following in the [global] section of your -smb.conf file:

      logon home = \\%L\%U\.profiles

      then your Win9X clients will dutifully put their clients in a subdirectory -of your home directory called .profiles (thus making them hidden).

      Not only that, but 'net use/home' will also work, because of a feature in -Win9X. It removes any directory stuff off the end of the home directory area -and only uses the server and share portion. That is, it looks like you -specified \\%L\%U for "logon home".

      6.8.2.4. Windows 9X Profile Setup

      When a user first logs in on Windows 9X, the file user.DAT is created, -as are folders "Start Menu", "Desktop", "Programs" and "Nethood". -These directories and their contents will be merged with the local -versions stored in c:\windows\profiles\username on subsequent logins, -taking the most recent from each. You will need to use the [global] -options "preserve case = yes", "short preserve case = yes" and -"case sensitive = no" in order to maintain capital letters in shortcuts -in any of the profile folders.

      The user.DAT file contains all the user's preferences. If you wish to -enforce a set of preferences, rename their user.DAT file to user.MAN, -and deny them write access to this file.

      1. On the Windows 95 machine, go to Control Panel | Passwords and - select the User Profiles tab. Select the required level of - roaming preferences. Press OK, but do _not_ allow the computer - to reboot. -

      2. On the Windows 95 machine, go to Control Panel | Network | - Client for Microsoft Networks | Preferences. Select 'Log on to - NT Domain'. Then, ensure that the Primary Logon is 'Client for - Microsoft Networks'. Press OK, and this time allow the computer - to reboot. -

      Under Windows 95, Profiles are downloaded from the Primary Logon. -If you have the Primary Logon as 'Client for Novell Networks', then -the profiles and logon script will be downloaded from your Novell -Server. If you have the Primary Logon as 'Windows Logon', then the -profiles will be loaded from the local machine - a bit against the -concept of roaming profiles, if you ask me.

      You will now find that the Microsoft Networks Login box contains -[user, password, domain] instead of just [user, password]. Type in -the samba server's domain name (or any other domain known to exist, -but bear in mind that the user will be authenticated against this -domain and profiles downloaded from it, if that domain logon server -supports it), user name and user's password.

      Once the user has been successfully validated, the Windows 95 machine -will inform you that 'The user has not logged on before' and asks you -if you wish to save the user's preferences? Select 'yes'.

      Once the Windows 95 client comes up with the desktop, you should be able -to examine the contents of the directory specified in the "logon path" -on the samba server and verify that the "Desktop", "Start Menu", -"Programs" and "Nethood" folders have been created.

      These folders will be cached locally on the client, and updated when -the user logs off (if you haven't made them read-only by then :-). -You will find that if the user creates further folders or short-cuts, -that the client will merge the profile contents downloaded with the -contents of the profile directory already on the local client, taking -the newest folders and short-cuts from each set.

      If you have made the folders / files read-only on the samba server, -then you will get errors from the w95 machine on logon and logout, as -it attempts to merge the local and the remote profile. Basically, if -you have any errors reported by the w95 machine, check the Unix file -permissions and ownership rights on the profile directory contents, -on the samba server.

      If you have problems creating user profiles, you can reset the user's -local desktop cache, as shown below. When this user then next logs in, -they will be told that they are logging in "for the first time".

      1. instead of logging in under the [user, password, domain] dialog, - press escape. -

      2. run the regedit.exe program, and look in: -

        HKEY_LOCAL_MACHINE\Windows\CurrentVersion\ProfileList -

        you will find an entry, for each user, of ProfilePath. Note the - contents of this key (likely to be c:\windows\profiles\username), - then delete the key ProfilePath for the required user. -

        [Exit the registry editor]. -

      3. WARNING - before deleting the contents of the - directory listed in - the ProfilePath (this is likely to be c:\windows\profiles\username), - ask them if they have any important files stored on their desktop - or in their start menu. delete the contents of the directory - ProfilePath (making a backup if any of the files are needed). -

        This will have the effect of removing the local (read-only hidden - system file) user.DAT in their profile directory, as well as the - local "desktop", "nethood", "start menu" and "programs" folders. -

      4. search for the user's .PWL password-caching file in the c:\windows - directory, and delete it. -

      5. log off the windows 95 client. -

      6. check the contents of the profile path (see "logon path" described - above), and delete the user.DAT or user.MAN file for the user, - making a backup if required. -

      If all else fails, increase samba's debug log levels to between 3 and 10, -and / or run a packet trace program such as tcpdump or netmon.exe, and -look for any error reports.

      If you have access to an NT server, then first set up roaming profiles -and / or netlogons on the NT server. Make a packet trace, or examine -the example packet traces provided with NT server, and see what the -differences are with the equivalent samba trace.

      6.8.2.5. Windows NT Workstation 4.0

      When a user first logs in to a Windows NT Workstation, the profile -NTuser.DAT is created. The profile location can be now specified -through the "logon path" parameter.

      [lkcl 10aug97 - i tried setting the path to -\\samba-server\homes\profile, and discovered that this fails because -a background process maintains the connection to the [homes] share -which does _not_ close down in between user logins. you have to -have \\samba-server\%L\profile, where user is the username created -from the [homes] share].

      There is a parameter that is now available for use with NT Profiles: -"logon drive". This should be set to "h:" or any other drive, and -should be used in conjunction with the new "logon home" parameter.

      The entry for the NT 4.0 profile is a _directory_ not a file. The NT -help on profiles mentions that a directory is also created with a .PDS -extension. The user, while logging in, must have write permission to -create the full profile path (and the folder with the .PDS extension) -[lkcl 10aug97 - i found that the creation of the .PDS directory failed, -and had to create these manually for each user, with a shell script. -also, i presume, but have not tested, that the full profile path must -be browseable just as it is for w95, due to the manner in which they -attempt to create the full profile path: test existence of each path -component; create path component].

      In the profile directory, NT creates more folders than 95. It creates -"Application Data" and others, as well as "Desktop", "Nethood", -"Start Menu" and "Programs". The profile itself is stored in a file -NTuser.DAT. Nothing appears to be stored in the .PDS directory, and -its purpose is currently unknown.

      You can use the System Control Panel to copy a local profile onto -a samba server (see NT Help on profiles: it is also capable of firing -up the correct location in the System Control Panel for you). The -NT Help file also mentions that renaming NTuser.DAT to NTuser.MAN -turns a profile into a mandatory one.

      [lkcl 10aug97 - i notice that NT Workstation tells me that it is -downloading a profile from a slow link. whether this is actually the -case, or whether there is some configuration issue, as yet unknown, -that makes NT Workstation _think_ that the link is a slow one is a -matter to be resolved].

      [lkcl 20aug97 - after samba digest correspondence, one user found, and -another confirmed, that profiles cannot be loaded from a samba server -unless "security = user" and "encrypt passwords = yes" (see the file -ENCRYPTION.txt) or "security = server" and "password server = ip.address. -of.yourNTserver" are used. Either of these options will allow the NT -workstation to access the samba server using LAN manager encrypted -passwords, without the user intervention normally required by NT -workstation for clear-text passwords].

      [lkcl 25aug97 - more comments received about NT profiles: the case of -the profile _matters_. the file _must_ be called NTuser.DAT or, for -a mandatory profile, NTuser.MAN].

      6.8.2.7. Sharing Profiles between W95 and NT Workstation 4.0

      Potentially outdated or incorrect material follows
       

      I think this is all bogus, but have not deleted it. (Richard Sharpe)

      The default logon path is \\%N\%U. NT Workstation will attempt to create -a directory "\\samba-server\username.PDS" if you specify the logon path -as "\\samba-server\username" with the NT User Manager. Therefore, you -will need to specify (for example) "\\samba-server\username\profile". -NT 4.0 will attempt to create "\\samba-server\username\profile.PDS", which -is more likely to succeed.

      If you then want to share the same Start Menu / Desktop with W95, you will -need to specify "logon path = \\samba-server\username\profile" [lkcl 10aug97 -this has its drawbacks: i created a shortcut to telnet.exe, which attempts -to run from the c:\winnt\system32 directory. this directory is obviously -unlikely to exist on a Win95-only host].

      If you have this set up correctly, you will find separate user.DAT and -NTuser.DAT files in the same profile directory.

      [lkcl 25aug97 - there are some issues to resolve with downloading of -NT profiles, probably to do with time/date stamps. i have found that -NTuser.DAT is never updated on the workstation after the first time that -it is copied to the local workstation profile directory. this is in -contrast to w95, where it _does_ transfer / update profiles correctly].

      6.9. DOMAIN_CONTROL.txt : Windows NT Domain Control & Samba

      Possibly Outdated Material
       

      This appendix was originally authored by John H Terpstra of - the Samba Team and is included here for posterity. -

      NOTE : -The term "Domain Controller" and those related to it refer to one specific -method of authentication that can underly an SMB domain. Domain Controllers -prior to Windows NT Server 3.1 were sold by various companies and based on -private extensions to the LAN Manager 2.1 protocol. Windows NT introduced -Microsoft-specific ways of distributing the user authentication database. -See DOMAIN.txt for examples of how Samba can participate in or create -SMB domains based on shared authentication database schemes other than the -Windows NT SAM.

      Windows NT Server can be installed as either a plain file and print server -(WORKGROUP workstation or server) or as a server that participates in Domain -Control (DOMAIN member, Primary Domain controller or Backup Domain controller). -The same is true for OS/2 Warp Server, Digital Pathworks and other similar -products, all of which can participate in Domain Control along with Windows NT.

      To many people these terms can be confusing, so let's try to clear the air.

      Every Windows NT system (workstation or server) has a registry database. -The registry contains entries that describe the initialization information -for all services (the equivalent of Unix Daemons) that run within the Windows -NT environment. The registry also contains entries that tell application -software where to find dynamically loadable libraries that they depend upon. -In fact, the registry contains entries that describes everything that anything -may need to know to interact with the rest of the system.

      The registry files can be located on any Windows NT machine by opening a -command prompt and typing:

      C:\WINNT\> dir %SystemRoot%\System32\config

      The environment variable %SystemRoot% value can be obtained by typing:

      C:\WINNT>echo %SystemRoot%

      The active parts of the registry that you may want to be familiar with are -the files called: default, system, software, sam and security.

      In a domain environment, Microsoft Windows NT domain controllers participate -in replication of the SAM and SECURITY files so that all controllers within -the domain have an exactly identical copy of each.

      The Microsoft Windows NT system is structured within a security model that -says that all applications and services must authenticate themselves before -they can obtain permission from the security manager to do what they set out -to do.

      The Windows NT User database also resides within the registry. This part of -the registry contains the user's security identifier, home directory, group -memberships, desktop profile, and so on.

      Every Windows NT system (workstation as well as server) will have its own -registry. Windows NT Servers that participate in Domain Security control -have a database that they share in common - thus they do NOT own an -independent full registry database of their own, as do Workstations and -plain Servers.

      The User database is called the SAM (Security Access Manager) database and -is used for all user authentication as well as for authentication of inter- -process authentication (i.e. to ensure that the service action a user has -requested is permitted within the limits of that user's privileges).

      The Samba team have produced a utility that can dump the Windows NT SAM into -smbpasswd format: see ENCRYPTION.txt for information on smbpasswd and -/pub/samba/pwdump on your nearest Samba mirror for the utility. This -facility is useful but cannot be easily used to implement SAM replication -to Samba systems.

      Windows for Workgroups, Windows 95, and Windows NT Workstations and Servers -can participate in a Domain security system that is controlled by Windows NT -servers that have been correctly configured. Almost every domain will have -ONE Primary Domain Controller (PDC). It is desirable that each domain will -have at least one Backup Domain Controller (BDC).

      The PDC and BDCs then participate in replication of the SAM database so that -each Domain Controlling participant will have an up to date SAM component -within its registry.

    PrevHomeNext
    User and Share security level (for servers not in a domain)UpHow to Act as a Backup Domain Controller in a Purely Samba Controlled Domain
    \ No newline at end of file +has a domain controller). If the domain does NOT already have a Domain Controller +then you do not yet have a Domain! +

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

    Common Problems and Errors

    I cannot include a '$' in a machine name

    +A 'machine account', (typically) stored in /etc/passwd, +takes the form of the machine name with a '$' appended. FreeBSD (and other BSD +systems?) won't create a user with a '$' in their name. +

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

    I get told "You already have a connection to the Domain...." +or "Cannot join domain, the credentials supplied conflict with an +existing set.." when creating a machine trust account.

    +This happens if you try to create a machine trust account from the +machine itself and already have a connection (e.g. mapped drive) +to a share (or IPC$) on the Samba PDC. The following command +will remove all network drive connections: +

    +	C:\WINNT\> net use * /d
+

    +Further, if the machine is already a 'member of a workgroup' that +is the same name as the domain you are joining (bad idea) you will +get this message. Change the workgroup name to something else, it +does not matter what, reboot, and try again. +

    The system can not log you on (C000019B)....

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

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

    +The reset or change the domain SID you can use the net command as follows: + +

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

    +

    The machine trust account for this computer either does not +exist or is not accessible.

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

    +This problem is caused by the PDC not having a suitable machine trust account. +If you are using the add machine script method to create +accounts then this would indicate that it has not worked. Ensure the domain +admin user system is working. +

    +Alternatively if you are creating account entries manually then they +have not been created correctly. Make sure that you have the entry +correct for the machine trust account in smbpasswd file on the Samba PDC. +If you added the account using an editor rather than using the smbpasswd +utility, make sure that the account name is the machine NetBIOS name +with a '$' appended to it ( i.e. computer_name$ ). There must be an entry +in both /etc/passwd and the smbpasswd file. +

    +Some people have also reported +that inconsistent subnet masks between the Samba server and the NT +client can cause this problem. Make sure that these are consistent +for both client and server. +

    When I attempt to login to a Samba Domain from a NT4/W2K workstation, +I get a message about my account being disabled.

    +Enable the user accounts with smbpasswd -e username +, this is normally done as an account is created. +

    Until a few minutes after Samba has started, clients get the error "Domain Controller Unavailable"

    + A domain controller has to announce on the network who it is. This usually takes a while. +

    Prev Up Next
    Chapter 4. Server Types and Security Modes Home Chapter 6. Backup Domain Control
    diff --git a/docs/htmldocs/samba.7.html b/docs/htmldocs/samba.7.html index 0851e99bd5..1e7add51c6 100644 --- a/docs/htmldocs/samba.7.html +++ b/docs/htmldocs/samba.7.html @@ -1,384 +1,113 @@ - -samba

    samba

    Name

    SAMBA -- A Windows SMB/CIFS fileserver for UNIX

    Synopsis

    Samba

    DESCRIPTION

    The Samba software suite is a collection of programs +samba

    Name

    Samba — A Windows SMB/CIFS fileserver for UNIX

    Synopsis

    Samba

    DESCRIPTION

    The Samba software suite is a collection of programs that implements the Server Message Block (commonly abbreviated as SMB) protocol for UNIX systems. This protocol is sometimes also referred to as the Common Internet File System (CIFS). For a - more thorough description, see http://www.ubiqx.org/cifs/. Samba also implements the NetBIOS - protocol in nmbd.

    smbd

    The smbd - daemon provides the file and print services to + more thorough description, see + http://www.ubiqx.org/cifs/. Samba also implements the NetBIOS + protocol in nmbd.

    smbd(8)

    The smbd daemon provides the file and print services to SMB clients, such as Windows 95/98, Windows NT, Windows for Workgroups or LanManager. The configuration file - for this daemon is described in smb.conf -

    nmbd

    The nmbd + for this daemon is described in smb.conf(5) +

    nmbd(8)

    The nmbd daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon - is described in smb.conf

    smbclient

    The smbclient + is described in smb.conf(5)

    smbclient(1)

    The smbclient program implements a simple ftp-like client. This is useful for accessing SMB shares on other compatible servers (such as Windows NT), and can also be used to allow a UNIX box to print to a printer attached to - any SMB server (such as a PC running Windows NT).

    testparm

    The testparm - utility is a simple syntax checker for Samba's - smb.confconfiguration file.

    testprns

    The testprns + any SMB server (such as a PC running Windows NT).

    testparm(1)

    The testparm + utility is a simple syntax checker for Samba's smb.conf(5) configuration file.

    testprns(1)

    The testprns utility supports testing printer names defined - in your printcap file used - by Samba.

    smbstatus

    The smbstatus + in your printcap file used + by Samba.

    smbstatus(1)

    The smbstatus tool provides access to information about the - current connections to smbd.

    nmblookup

    The nmblookup + current connections to smbd.

    nmblookup(1)

    The nmblookup tools allows NetBIOS name queries to be made - from a UNIX host.

    make_smbcodepage

    The make_smbcodepage - utility provides a means of creating SMB code page - definition files for your smbd server.

    smbpasswd

    The smbpasswd + from a UNIX host.

    smbgroupedit(8)

    The smbgroupedit + tool allows for mapping unix groups to NT Builtin, + Domain, or Local groups. Also it allows setting + priviledges for that group, such as saAddUser, etc.

    smbpasswd(8)

    The smbpasswd command is a tool for changing LanMan and Windows NT - password hashes on Samba and Windows NT servers.

    COMPONENTS

    The Samba suite is made up of several components. Each + password hashes on Samba and Windows NT servers.

    smbcacls(1)

    The smbcacls command is + a tool to set ACL's on remote CIFS servers.

    smbsh(1)

    The smbsh command is + a program that allows you to run a unix shell with + with an overloaded VFS.

    smbtree(1)

    The smbtree command + is a text-based network neighborhood tool.

    smbtar(1)

    The smbtar can make + backups of data on CIFS/SMB servers.

    smbspool(8)

    smbspool is a + helper utility for printing on printers connected + to CIFS servers.

    smbcontrol(1)

    smbcontrol is a utility + that can change the behaviour of running samba daemons. +

    rpcclient(1)

    rpcclient is a utility + that can be used to execute RPC commands on remote + CIFS servers.

    pdbedit(8)

    The pdbedit command + can be used to maintain the local user database on + a samba server.

    findsmb(1)

    The findsmb command + can be used to find SMB servers on the local network. +

    net(8)

    The net command + is supposed to work similar to the DOS/Windows + NET.EXE command.

    swat(8)

    swat is a web-based + interface to configuring smb.conf. +

    winbindd(8)

    winbindd is a daemon + that is used for integrating authentication and + the user database into unix.

    wbinfo(1)

    wbinfo is a utility + that retrieves and stores information related to winbind. +

    editreg(1)

    editreg is a command-line + utility that can edit windows registry files. +

    profiles(1)

    profiles is a command-line + utility that can be used to replace all occurences of + a certain SID with another SID. +

    vfstest(1)

    vfstest is a utility + that can be used to test vfs modules.

    ntlm_auth(1)

    ntlm_auth is a helper-utility + for external programs wanting to do NTLM-authentication. +

    smbmount(8), smbumount(8), smbmount(8)

    smbmount,smbmnt and smbmnt are commands that can be used to + mount CIFS/SMB shares on Linux. +

    smbcquotas(1)

    smbcquotas is a tool that + can set remote QUOTA's on server with NTFS 5.

    COMPONENTS

    The Samba suite is made up of several components. Each component is described in a separate manual page. It is strongly recommended that you read the documentation that comes with Samba and the manual pages of those components that you use. If the manual pages and documents aren't clear enough then please visit - http://devel.samba.org - for information on how to file a bug report or submit a patch.

    If you require help, visit the Samba webpage at - http://www.samba.org/ and + http://devel.samba.org + for information on how to file a bug report or submit a patch.

    If you require help, visit the Samba webpage at + http://www.samba.org/ and explore the many option available to you. -

    AVAILABILITY

    The Samba software suite is licensed under the +

    AVAILABILITY

    The Samba software suite is licensed under the GNU Public License(GPL). A copy of that license should have come with the package in the file COPYING. You are encouraged to distribute copies of the Samba suite, but - please obey the terms of this license.

    The latest version of the Samba suite can be + please obey the terms of this license.

    The latest version of the Samba suite can be obtained via anonymous ftp from samba.org in the directory pub/samba/. It is also available on several - mirror sites worldwide.

    You may also find useful information about Samba - on the newsgroup comp.protocol.smb and the Samba mailing + mirror sites worldwide.

    You may also find useful information about Samba + on the newsgroup + comp.protocol.smb and the Samba mailing list. Details on how to join the mailing list are given in - the README file that comes with Samba.

    If you have access to a WWW viewer (such as Netscape - or Mosaic) then you will also find lots of useful information, + the README file that comes with Samba.

    If you have access to a WWW viewer (such as Mozilla + or Konqueror) then you will also find lots of useful information, including back issues of the Samba mailing list, at - http://lists.samba.org.

    VERSION

    This man page is correct for version 2.2 of the - Samba suite.

    CONTRIBUTIONS

    If you wish to contribute to the Samba project, + http://lists.samba.org.

    VERSION

    This man page is correct for version 3.0 of the + Samba suite.

    CONTRIBUTIONS

    If you wish to contribute to the Samba project, then I suggest you join the Samba mailing list at - http://lists.samba.org. -

    If you have patches to submit, visit - http://devel.samba.org/ - for information on how to do it properly. We prefer patches in - diff -u format.

    CONTRIBUTORS

    Contributors to the project are now too numerous + http://lists.samba.org. +

    If you have patches to submit, visit + http://devel.samba.org/ + for information on how to do it properly. We prefer patches + in diff -u format.

    CONTRIBUTORS

    Contributors to the project are now too numerous to mention here but all deserve the thanks of all Samba - users. To see a full list, look at ftp://samba.org/pub/samba/alpha/change-log - for the pre-CVS changes and at ftp://samba.org/pub/samba/alpha/cvs.log + users. To see a full list, look at the + change-log in the source package + for the pre-CVS changes and at + http://cvs.samba.org/ for the contributors to Samba post-CVS. CVS is the Open Source source code control system used by the Samba Team to develop - Samba. The project would have been unmanageable without it.

    In addition, several commercial organizations now help - fund the Samba Team with money and equipment. For details see - the Samba Web pages at http://samba.org/samba/samba-thanks.html.

    AUTHOR

    The original Samba software and related utilities + Samba. The project would have been unmanageable without it.

    AUTHOR

    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.

    The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

    The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

    \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML + 4.2 for Samba 3.0 was done by Alexander Bokovoy.

    diff --git a/docs/htmldocs/smb.conf.5.html b/docs/htmldocs/smb.conf.5.html index 4f02951a9c..c154347a86 100644 --- a/docs/htmldocs/smb.conf.5.html +++ b/docs/htmldocs/smb.conf.5.html @@ -1,19776 +1,269 @@ - -smb.conf

    smb.conf

    Name

    smb.conf -- The configuration file for the Samba suite

    SYNOPSIS

    The smb.conf file is a configuration - file for the Samba suite. smb.conf contains - runtime configuration information for the Samba programs. The - smb.conf file is designed to be configured and - administered by the swat(8) - program. The complete description of the file format and - possible parameters held within are here for reference purposes.

    FILE FORMAT

    The file consists of sections and parameters. A section +smb.conf

    Name

    smb.conf — The configuration file for the Samba suite

    SYNOPSIS

    The smb.conf file is a configuration + file for the Samba suite. smb.conf contains + runtime configuration information for the Samba programs. The smb.conf file + is designed to be configured and administered by the swat(8) program. The complete + description of the file format and possible parameters held within + are here for reference purposes.

    FILE FORMAT

    The file consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section begins. Sections contain parameters of the - form

    name = value -

    The file is line-based - that is, each newline-terminated - line represents either a comment, a section name or a parameter.

    Section and parameter names are not case sensitive.

    Only the first equals sign in a parameter is significant. + form

    name = value +

    The file is line-based - that is, each newline-terminated + line represents either a comment, a section name or a parameter.

    Section and parameter names are not case sensitive.

    Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value - is retained verbatim.

    Any line beginning with a semicolon (';') or a hash ('#') - character is ignored, as are lines containing only whitespace.

    Any line ending in a '\' is continued - on the next line in the customary UNIX fashion.

    The values following the equals sign in parameters are all + is retained verbatim.

    Any line beginning with a semicolon (';') or a hash ('#') + character is ignored, as are lines containing only whitespace.

    Any line ending in a '\' is continued + on the next line in the customary UNIX fashion.

    The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved in string values. Some items such as - create modes are numeric.

    SECTION DESCRIPTIONS

    Each section in the configuration file (except for the + create modes are numeric.

    SECTION DESCRIPTIONS

    Each section in the configuration file (except for the [global] section) describes a shared resource (known - as a "share"). The section name is the name of the + as a "share"). The section name is the name of the shared resource and the parameters within the section define - the shares attributes.

    There are three special sections, [global], + the shares attributes.

    There are three special sections, [global], [homes] and [printers], which are - described under special sections. The - following notes apply to ordinary section descriptions.

    A share consists of a directory to which access is being + described under special sections. The + following notes apply to ordinary section descriptions.

    A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service. Some housekeeping options are - also specifiable.

    Sections are either file share services (used by the + also specifiable.

    Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services - on the host running the server).

    Sections may be designated guest services, + on the host running the server).

    Sections may be designated guest services, in which case no password is required to access them. A specified - UNIX guest account is used to define access - privileges in this case.

    Sections other than guest services will require a password + UNIX guest account is used to define access + privileges in this case.

    Sections other than guest services will require a password to access them. The client provides the username. As older clients only provide passwords and not usernames, you may specify a list - of usernames to check against the password using the "user =" + of usernames to check against the password using the "user =" option in the share definition. For modern clients such as - Windows 95/98/ME/NT/2000, this should not be necessary.

    Note that the access rights granted by the server are + Windows 95/98/ME/NT/2000, this should not be necessary.

    Note that the access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system. The server does not grant more - access than the host system grants.

    The following sample section defines a file space share. - The user has write access to the path /home/bar. - The share is accessed via the share name "foo":

    	 	[foo]
- 		path = /home/bar
- 		read only = no
-	
-

    The following sample section defines a printable share. + access than the host system grants.

    The following sample section defines a file space share. + The user has write access to the path /home/bar. + The share is accessed via the share name "foo":

    +
+[foo]
+	path = /home/bar
+	read only = no
+
+

    The following sample section defines a printable share. The share is readonly, but printable. That is, the only write access permitted is via calls to open, write to and close a - spool file. The guest ok parameter means + spool file. The guest ok parameter means access will be permitted as the default guest user (specified - elsewhere):

    	 	[aprinter]
- 		path = /usr/spool/public
- 		read only = yes
- 		printable = yes
- 		guest ok = yes
-	
-

    SPECIAL SECTIONS

    The [global] section

    parameters in this section apply to the server + elsewhere):

    +
+[aprinter]
+	path = /usr/spool/public
+	read only = yes
+	printable = yes
+	guest ok = yes
+
+

    SPECIAL SECTIONS

    The [global] section

    parameters in this section apply to the server as a whole, or are defaults for sections which do not specifically define certain items. See the notes - under PARAMETERS for more information.

    The [homes] section

    If a section called homes is included in the + under PARAMETERS for more information.

    The [homes] section

    If a section called homes is included in the configuration file, services connecting clients to their - home directories can be created on the fly by the server.

    When the connection request is made, the existing + home directories can be created on the fly by the server.

    When the connection request is made, the existing sections are scanned. If a match is found, it is used. If no match is found, the requested section name is treated as a user name and looked up in the local password file. If the name exists and the correct password has been given, a share is - created by cloning the [homes] section.

    Some modifications are then made to the newly - created share:

    • The share name is changed from homes to - the located username.

    • If no path was given, the path is set to - the user's home directory.

    If you decide to use a path = line + created by cloning the [homes] section.

    Some modifications are then made to the newly + created share:

    • The share name is changed from homes to + the located username.

    • If no path was given, the path is set to + the user's home directory.

    If you decide to use a path = line in your [homes] section then you may find it useful - to use the %S macro. For example :

    path = /data/pchome/%S

    would be useful if you have different home directories - for your PCs than for UNIX access.

    This is a fast and simple way to give a large number + to use the %S macro. For example :

    path = /data/pchome/%S

    would be useful if you have different home directories + for your PCs than for UNIX access.

    This is a fast and simple way to give a large number of clients access to their home directories with a minimum - of fuss.

    A similar process occurs if the requested section - name is "homes", except that the share name is not + of fuss.

    A similar process occurs if the requested section + name is "homes", except that the share name is not changed to that of the requesting user. This method of using the [homes] section works well if different users share - a client PC.

    The [homes] section can specify all the parameters + a client PC.

    The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others. The following is a typical and suitable [homes] - section:

    			 	[homes]
- 			read only = no
-		
-

    An important point is that if guest access is specified + section:

    +
+[homes]
+	read only = no
+
+

    An important point is that if guest access is specified in the [homes] section, all home directories will be - visible to all clients without a password. + visible to all clients without a password. In the very unlikely event that this is actually desirable, it - would be wise to also specify read only - access.

    Note that the browseable flag for + would be wise to also specify read only + access.

    Note that the browseable flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag. This is useful as - it means setting browseable = no in + it means setting browseable = no in the [homes] section will hide the [homes] share but make - any auto home directories visible.

    The [printers] section

    This section works like [homes], - but for printers.

    If a [printers] section occurs in the + any auto home directories visible.

    The [printers] section

    This section works like [homes], + but for printers.

    If a [printers] section occurs in the configuration file, users are able to connect to any printer - specified in the local host's printcap file.

    When a connection request is made, the existing sections + specified in the local host's printcap file.

    When a connection request is made, the existing sections are scanned. If a match is found, it is used. If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name. If a match is found, a new printer share is created by cloning - the [printers] section.

    A few modifications are then made to the newly created - share:

    • The share name is set to the located printer - name

    • If no printer name was given, the printer name - is set to the located printer name

    • If the share does not permit guest access and + the [printers] section.

      A few modifications are then made to the newly created + share:

      • The share name is set to the located printer + name

      • If no printer name was given, the printer name + is set to the located printer name

      • If the share does not permit guest access and no username was given, the username is set to the located - printer name.

      Note that the [printers] service MUST be + printer name.

    Note that the [printers] service MUST be printable - if you specify otherwise, the server will refuse - to load the configuration file.

    Typically the path specified would be that of a + to load the configuration file.

    Typically the path specified would be that of a world-writeable spool directory with the sticky bit set on it. A typical [printers] entry would look like - this:

    	 	[printers]
- 			path = /usr/spool/public
- 			guest ok = yes
- 			printable = yes 
-

    All aliases given for a printer in the printcap file + this:

    
+[printers]
+	path = /usr/spool/public
+	guest ok = yes
+	printable = yes 
+

    All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file consisting of one or - more lines like this:

    			        alias|alias|alias|alias...    
-		
-

    Each alias should be an acceptable printer name for + more lines like this:

    +
+alias|alias|alias|alias...    
+
+

    Each alias should be an acceptable printer name for your printing subsystem. In the [global] section, specify the new file as your printcap. The server will then only recognize names found in your pseudo-printcap, which of course can contain whatever aliases you like. The same technique could be used - simply to limit access to a subset of your local printers.

    An alias, by the way, is defined as any component of the + simply to limit access to a subset of your local printers.

    An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines, components (if there are more than one) are separated by vertical - bar symbols ('|').

    NOTE: On SYSV systems which use lpstat to determine what + bar symbols ('|').

    Note

    On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use - "printcap name = lpstat" to automatically obtain a list - of printers. See the "printcap name" option - for more details.

    PARAMETERS

    parameters define the specific attributes of sections.

    Some parameters are specific to the [global] section - (e.g., security). Some parameters are usable - in all sections (e.g., create mode). All others + "printcap name = lpstat" to automatically obtain a list + of printers. See the "printcap name" option + for more details.

    PARAMETERS

    parameters define the specific attributes of sections.

    Some parameters are specific to the [global] section + (e.g., security). Some parameters are usable + in all sections (e.g., create mode). All others are permissible only in normal sections. For the purposes of the following descriptions the [homes] and [printers] - sections will be considered normal. The letter G + sections will be considered normal. The letter G in parentheses indicates that a parameter is specific to the - [global] section. The letter S + [global] section. The letter S indicates that a parameter can be specified in a service specific - section. Note that all S parameters can also be specified in + section. Note that all S parameters can also be specified in the [global] section - in which case they will define - the default behavior for all services.

    parameters are arranged here in alphabetical order - this may + the default behavior for all services.

    parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer - to the preferred synonym.

    VARIABLE SUBSTITUTIONS

    Many of the strings that are settable in the config file - can take substitutions. For example the option "path = - /tmp/%u" would be interpreted as "path = - /tmp/john" if the user connected with the username john.

    These substitutions are mostly noted in the descriptions below, + to the preferred synonym.

    VARIABLE SUBSTITUTIONS

    Many of the strings that are settable in the config file + can take substitutions. For example the option "path = + /tmp/%u" would be interpreted as "path = + /tmp/john" if the user connected with the username john.

    These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they - might be relevant. These are:

    %U

    session user name (the user name that the client - wanted, not necessarily the same as the one they got).

    %G

    primary group name of %U.

    %h

    the Internet hostname that Samba is running - on.

    %m

    the NetBIOS name of the client machine - (very useful).

    %L

    the NetBIOS name of the server. This allows you + might be relevant. These are:

    %U

    session user name (the user name that the client + wanted, not necessarily the same as the one they got).

    %G

    primary group name of %U.

    %h

    the Internet hostname that Samba is running + on.

    %m

    the NetBIOS name of the client machine + (very useful).

    %L

    the NetBIOS name of the server. This allows you to change your config based on what the client calls you. Your - server can have a "dual personality".

    Note that this parameter is not available when Samba listens - on port 445, as clients no longer send this information

    %M

    the Internet name of the client machine. -

    %R

    the selected protocol level after + server can have a "dual personality".

    Note that this parameter is not available when Samba listens + on port 445, as clients no longer send this information

    %M

    the Internet name of the client machine. +

    %R

    the selected protocol level after protocol negotiation. It can be one of CORE, COREPLUS, - LANMAN1, LANMAN2 or NT1.

    %d

    The process id of the current server - process.

    %a

    the architecture of the remote + LANMAN1, LANMAN2 or NT1.

    %d

    The process id of the current server + process.

    %a

    the architecture of the remote machine. Only some are recognized, and those may not be 100% reliable. It currently recognizes Samba, WfWg, Win95, WinNT and Win2k. Anything else will be known as - "UNKNOWN". If it gets it wrong then sending a level - 3 log to samba@samba.org - should allow it to be fixed.

    %I

    The IP address of the client machine.

    %T

    the current date and time.

    %D

    Name of the domain or workgroup of the current user.

    %$(envvar)

    The value of the environment variable - envar.

    The following substitutes apply only to some configuration options(only those - that are used when a connection has been established):

    %S

    the name of the current service, if any.

    %P

    the root directory of the current service, - if any.

    %u

    user name of the current service, if any.

    %g

    primary group name of %u.

    %H

    the home directory of the user given - by %u.

    %N

    the name of your NIS home directory server. + "UNKNOWN". If it gets it wrong then sending a level + 3 log to samba@samba.org + should allow it to be fixed.

    %I

    The IP address of the client machine.

    %T

    the current date and time.

    %D

    Name of the domain or workgroup of the current user.

    %$(envvar)

    The value of the environment variable + envar.

    The following substitutes apply only to some configuration options(only those + that are used when a connection has been established):

    %S

    the name of the current service, if any.

    %P

    the root directory of the current service, + if any.

    %u

    user name of the current service, if any.

    %g

    primary group name of %u.

    %H

    the home directory of the user given + by %u.

    %N

    the name of your NIS home directory server. This is obtained from your NIS auto.map entry. If you have - not compiled Samba with the --with-automount - option then this value will be the same as %L.

    %p

    the path of the service's home directory, + not compiled Samba with the --with-automount + option then this value will be the same as %L.

    %p

    the path of the service's home directory, obtained from your NIS auto.map entry. The NIS auto.map entry - is split up as "%N:%p".

    There are some quite creative things that can be done - with these substitutions and other smb.conf options.

    NAME MANGLING

    Samba supports "name mangling" so that DOS and + is split up as "%N:%p".

    There are some quite creative things that can be done + with these substitutions and other smb.conf options.

    NAME MANGLING

    Samba supports "name mangling" so that DOS and Windows clients can use files that don't conform to the 8.3 format. - It can also be set to adjust the case of 8.3 format filenames.

    There are several options that control the way mangling is + It can also be set to adjust the case of 8.3 format filenames.

    There are several options that control the way mangling is performed, and they are grouped here rather than listed separately. - For the defaults look at the output of the testparm program.

    All of these options can be set separately for each service - (or globally, of course).

    The options are:

    mangle case = yes/no

    controls if names that have characters that - aren't of the "default" case are mangled. For example, - if this is yes then a name like "Mail" would be mangled. - Default no.

    case sensitive = yes/no

    controls whether filenames are case sensitive. If + For the defaults look at the output of the testparm program.

    All of these options can be set separately for each service + (or globally, of course).

    The options are:

    mangle case = yes/no

    controls if names that have characters that + aren't of the "default" case are mangled. For example, + if this is yes then a name like "Mail" would be mangled. + Default no.

    case sensitive = yes/no

    controls whether filenames are case sensitive. If they aren't then Samba must do a filename search and match on passed - names. Default no.

    default case = upper/lower

    controls what the default case is for new - filenames. Default lower.

    preserve case = yes/no

    controls if new files are created with the + names. Default no.

    default case = upper/lower

    controls what the default case is for new + filenames. Default lower.

    preserve case = yes/no

    controls if new files are created with the case that the client passes, or if they are forced to be the - "default" case. Default yes. -

    short preserve case = yes/no

    controls if new files which conform to 8.3 syntax, + "default" case. Default yes. +

    short preserve case = yes/no

    controls if new files which conform to 8.3 syntax, that is all in upper case and of suitable length, are created - upper case, or if they are forced to be the "default" - case. This option can be use with "preserve case = yes" + upper case, or if they are forced to be the "default" + case. This option can be use with "preserve case = yes" to permit long filenames to retain their case, while short names - are lowercased. Default yes.

    By default, Samba 3.0 has the same semantics as a Windows - NT server, in that it is case insensitive but case preserving.

    NOTE ABOUT USERNAME/PASSWORD VALIDATION

    There are a number of ways in which a user can connect + are lowercased. Default yes.

    By default, Samba 3.0 has the same semantics as a Windows + NT server, in that it is case insensitive but case preserving.

    NOTE ABOUT USERNAME/PASSWORD VALIDATION

    There are a number of ways in which a user can connect to a service. The server uses the following steps in determining if it will allow a connection to a specified service. If all the steps fail, then the connection request is rejected. However, if one of the - steps succeeds, then the following steps are not checked.

    If the service is marked "guest only = yes" and the - server is running with share-level security ("security = share") - then steps 1 to 5 are skipped.

    1. If the client has passed a username/password + steps succeeds, then the following steps are not checked.

      If the service is marked "guest only = yes" and the + server is running with share-level security ("security = share") + then steps 1 to 5 are skipped.

      1. If the client has passed a username/password pair and that username/password pair is validated by the UNIX system's password programs then the connection is made as that username. Note that this includes the - \\server\service%username method of passing - a username.

      2. If the client has previously registered a username + \\server\service%username method of passing + a username.

      3. If the client has previously registered a username with the system and now supplies a correct password for that - username then the connection is allowed.

      4. The client's NetBIOS name and any previously + username then the connection is allowed.

      5. The client's NetBIOS name and any previously used user names are checked against the supplied password, if they match then the connection is allowed as the corresponding - user.

      6. If the client has previously validated a + user.

      7. If the client has previously validated a username/password pair with the server and the client has passed - the validation token then that username is used.

      8. If a "user = " field is given in the - smb.conf file for the service and the client + the validation token then that username is used.

      9. If a "user = " field is given in the + smb.conf file for the service and the client has supplied a password, and that password matches (according to the UNIX system's password checking) with one of the usernames - from the "user =" field then the connection is made as - the username in the "user =" line. If one - of the username in the "user =" list begins with a + from the "user =" field then the connection is made as + the username in the "user =" line. If one + of the username in the "user =" list begins with a '@' then that name expands to a list of names in - the group of the same name.

      10. If the service is a guest service then a - connection is made as the username given in the "guest - account =" for the service, irrespective of the - supplied password.

      COMPLETE LIST OF GLOBAL PARAMETERS

      Here is a list of all global parameters. See the section of - each parameter for details. Note that some are synonyms.

      COMPLETE LIST OF SERVICE PARAMETERS

      Here is a list of all service parameters. See the section on - each parameter for details. Note that some are synonyms.

      EXPLANATION OF EACH PARAMETER

      abort shutdown script (G)

      This parameter only exists in the HEAD cvs branch - This a full path name to a script called by - smbd(8) that - should stop a shutdown procedure issued by the shutdown script.

      This command will be run as user.

      Default: None.

      Example: abort shutdown script = /sbin/shutdown -c

      addprinter command (G)

      With the introduction of MS-RPC based printing - support for Windows NT/2000 clients in Samba 2.2, The MS Add - Printer Wizard (APW) icon is now also available in the - "Printers..." folder displayed a share listing. The APW - allows for printers to be add remotely to a Samba or Windows - NT/2000 print server.

      For a Samba host this means that the printer must be - physically added to the underlying printing system. The add - printer command defines a script to be run which - will perform the necessary operations for adding the printer - to the print system and to add the appropriate service definition - to the smb.conf file in order that it can be - shared by smbd(8) - .

      The addprinter command is - automatically invoked with the following parameter (in - order:

      • printer name

      • share name

      • port name

      • driver name

      • location

      • Windows 9x driver location -

      All parameters are filled in from the PRINTER_INFO_2 structure sent - by the Windows NT/2000 client with one exception. The "Windows 9x - driver location" parameter is included for backwards compatibility - only. The remaining fields in the structure are generated from answers - to the APW questions.

      Once the addprinter command has - been executed, smbd will reparse the smb.conf to determine if the share defined by the APW - exists. If the sharename is still invalid, then smbd - will return an ACCESS_DENIED error to the client.

      See also deleteprinter command, printing, - show add - printer wizard

      Default: none

      Example: addprinter command = /usr/bin/addprinter -

      add share command (G)

      Samba 2.2.0 introduced the ability to dynamically - add and delete shares via the Windows NT 4.0 Server Manager. The - add share command is used to define an - external program or script which will add a new service definition - to smb.conf. In order to successfully - execute the add share command, smbd - requires that the administrator be connected using a root account (i.e. - uid == 0). -

      When executed, smbd will automatically invoke the - add share command with four parameters. -

      • configFile - the location - of the global smb.conf file. -

      • shareName - the name of the new - share. -

      • pathName - path to an **existing** - directory on disk. -

      • comment - comment string to associate - with the new share. -

      This parameter is only used for add file shares. To add printer shares, - see the addprinter - command. -

      See also change share - command, delete share - command. -

      Default: none

      Example: add share command = /usr/local/bin/addshare

      add machine script (G)

      This is the full pathname to a script that will - be run by smbd(8) when a machine is added - to it's domain using the administrator username and password method.

      This option is only required when using sam back-ends tied to the - Unix uid method of RID calculation such as smbpasswd. This option is only - available in Samba 3.0.

      Default: add machine script = <empty string> -

      Example: add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u -

      ads server (G)

      If this option is specified, samba does - not try to figure out what ads server to use itself, but - uses the specified ads server. Either one DNS name or IP - address can be used.

      Default: ads server =

      Example: ads server = 192.168.1.2

      add user script (G)

      This is the full pathname to a script that will - be run AS ROOT by smbd(8) - under special circumstances described below.

      Normally, a Samba server requires that UNIX users are - created for all users accessing files on this server. For sites - that use Windows NT account databases as their primary user database - creating these users and keeping the user list in sync with the - Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users - ON DEMAND when a user accesses the Samba server.

      In order to use this option, smbd - must NOT be set to security = share - and add user script - must be set to a full pathname for a script that will create a UNIX - user given one argument of %u, which expands into - the UNIX user name to create.

      When the Windows user attempts to access the Samba server, - at login (session setup in the SMB protocol) time, smbd contacts the password server and - attempts to authenticate the given user with the given password. If the - authentication succeeds then smbd - attempts to find a UNIX user in the UNIX password database to map the - Windows user into. If this lookup fails, and add user script - is set then smbd will - call the specified script AS ROOT, expanding - any %u argument to be the user name to create.

      If this script successfully creates the user then smbd - will continue on as though the UNIX user - already existed. In this way, UNIX users are dynamically created to - match existing Windows NT accounts.

      See also security, password server, - delete user - script.

      Default: add user script = <empty string> -

      Example: add user script = /usr/local/samba/bin/add_user - %u

      add group script (G)

      This is the full pathname to a script that will - be run AS ROOT by smbd(8) when a new group is - requested. It will expand any - %g to the group name passed. - This script is only useful for installations using the - Windows NT domain administration tools. The script is - free to create a group with an arbitrary name to - circumvent unix group name restrictions. In that case - the script must print the numeric gid of the created - group on stdout. -

      admin users (S)

      This is a list of users who will be granted - administrative privileges on the share. This means that they - will do all file operations as the super-user (root).

      You should use this option very carefully, as any user in - this list will be able to do anything they like on the share, - irrespective of file permissions.

      Default: no admin users

      Example: admin users = jason

      add user to group script (G)

      Full path to the script that will be called when - a user is added to a group using the Windows NT domain administration - tools. It will be run by smbd(8) - AS ROOT. Any %g will be - replaced with the group name and any %u will - be replaced with the user name. -

      Default: add user to group script =

      Example: add user to group script = /usr/sbin/adduser %u %g

      allow hosts (S)

      Synonym for hosts allow.

      algorithmic rid base (G)

      This determines how Samba will use its - algorithmic mapping from uids/gid to the RIDs needed to construct - NT Security Identifiers.

      Setting this option to a larger value could be useful to sites - transitioning from WinNT and Win2k, as existing user and - group rids would otherwise clash with sytem users etc. -

      All UIDs and GIDs must be able to be resolved into SIDs for - the correct operation of ACLs on the server. As such the algorithmic - mapping can't be 'turned off', but pushing it 'out of the way' should - resolve the issues. Users and groups can then be assigned 'low' RIDs - in arbitary-rid supporting backends.

      Default: algorithmic rid base = 1000

      Example: algorithmic rid base = 100000

      allow trusted domains (G)

      This option only takes effect when the security option is set to - server or domain. - If it is set to no, then attempts to connect to a resource from - a domain or workgroup other than the one which smbd is running - in will fail, even if that domain is trusted by the remote server - doing the authentication.

      This is useful if you only want your Samba server to - serve resources to users in the domain it is a member of. As - an example, suppose that there are two domains DOMA and DOMB. DOMB - is trusted by DOMA, which contains the Samba server. Under normal - circumstances, a user with an account in DOMB can then access the - resources of a UNIX account with the same account name on the - Samba server even if they do not have an account in DOMA. This - can make implementing a security boundary difficult.

      Default: allow trusted domains = yes

      announce as (G)

      This specifies what type of server - nmbd - will announce itself as, to a network neighborhood browse - list. By default this is set to Windows NT. The valid options - are : "NT Server" (which can also be written as "NT"), - "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, - Windows NT Workstation, Windows 95 and Windows for Workgroups - respectively. Do not change this parameter unless you have a - specific need to stop Samba appearing as an NT server as this - may prevent Samba servers from participating as browser servers - correctly.

      Default: announce as = NT Server

      Example: announce as = Win95

      announce version (G)

      This specifies the major and minor version numbers - that nmbd will use when announcing itself as a server. The default - is 4.9. Do not change this parameter unless you have a specific - need to set a Samba server to be a downlevel server.

      Default: announce version = 4.9

      Example: announce version = 2.0

      auto services (G)

      This is a synonym for the preload.

      auth methods (G)

      This option allows the administrator to chose what - authentication methods smbd will use when authenticating - a user. This option defaults to sensible values based on security. - - Each entry in the list attempts to authenticate the user in turn, until - the user authenticates. In practice only one method will ever actually - be able to complete the authentication. -

      Default: auth methods = <empty string>

      Example: auth methods = guest sam ntdomain

      available (S)

      This parameter lets you "turn off" a service. If - available = no, then ALL - attempts to connect to the service will fail. Such failures are - logged.

      Default: available = yes

      bind interfaces only (G)

      This global parameter allows the Samba admin - to limit what interfaces on a machine will serve SMB requests. It - affects file service smbd(8) and - name service nmbd(8) in slightly - different ways.

      For name service it causes nmbd to bind - to ports 137 and 138 on the interfaces listed in the interfaces parameter. nmbd - also binds to the "all addresses" interface (0.0.0.0) - on ports 137 and 138 for the purposes of reading broadcast messages. - If this option is not set then nmbd will service - name requests on all of these sockets. If bind interfaces - only is set then nmbd will check the - source address of any packets coming in on the broadcast sockets - and discard any that don't match the broadcast addresses of the - interfaces in the interfaces parameter list. - As unicast packets are received on the other sockets it allows - nmbd to refuse to serve names to machines that - send packets that arrive through any interfaces not listed in the - interfaces list. IP Source address spoofing - does defeat this simple check, however, so it must not be used - seriously as a security feature for nmbd.

      For file service it causes smbd(8) - to bind only to the interface list given in the interfaces parameter. This restricts the networks that - smbd will serve to packets coming in those - interfaces. Note that you should not use this parameter for machines - that are serving PPP or other intermittent or non-broadcast network - interfaces as it will not cope with non-permanent interfaces.

      If bind interfaces only is set then - unless the network address 127.0.0.1 is added - to the interfaces parameter list smbpasswd(8) - and swat(8) may - not work as expected due to the reasons covered below.

      To change a users SMB password, the smbpasswd - by default connects to the localhost - 127.0.0.1 - address as an SMB client to issue the password change request. If - bind interfaces only is set then unless the - network address 127.0.0.1 is added to the - interfaces parameter list then smbpasswd will fail to connect in it's default mode. - smbpasswd can be forced to use the primary IP interface - of the local host by using its -r remote machine - parameter, with remote machine set - to the IP name of the primary interface of the local host.

      The swat status page tries to connect with - smbd and nmbd at the address - 127.0.0.1 to determine if they are running. - Not adding 127.0.0.1 will cause smbd and nmbd to always show - "not running" even if they really are. This can prevent swat from starting/stopping/restarting smbd - and nmbd.

      Default: bind interfaces only = no

      blocking locks (S)

      This parameter controls the behavior of smbd(8) when given a request by a client - to obtain a byte range lock on a region of an open file, and the - request has a time limit associated with it.

      If this parameter is set and the lock range requested - cannot be immediately satisfied, samba will internally - queue the lock request, and periodically attempt to obtain - the lock until the timeout period expires.

      If this parameter is set to no, then - samba will behave as previous versions of Samba would and - will fail the lock request immediately if the lock range - cannot be obtained.

      Default: blocking locks = yes

      block size (S)

      This parameter controls the behavior of - smbd(8) when reporting disk free - sizes. By default, this reports a disk block size of 1024 bytes. -

      Changing this parameter may have some effect on the - efficiency of client writes, this is not yet confirmed. This - parameter was added to allow advanced administrators to change - it (usually to a higher value) and test the effect it has on - client write performance without re-compiling the code. As this - is an experimental option it may be removed in a future release. -

      Changing this option does not change the disk free reporting - size, just the block size unit reported to the client.

      Default: block size = 1024

      Example: block size = 65536

      browsable (S)

      See the browseable.

      browse list (G)

      This controls whether smbd(8) will serve a browse list to - a client doing a NetServerEnum call. Normally - set to yes. You should never need to change - this.

      Default: browse list = yes

      browseable (S)

      This controls whether this share is seen in - the list of available shares in a net view and in the browse list.

      Default: browseable = yes

      case sensitive (S)

      See the discussion in the section NAME MANGLING.

      Default: case sensitive = no

      casesignames (S)

      Synonym for case - sensitive.

      change notify timeout (G)

      This SMB allows a client to tell a server to - "watch" a particular directory for any changes and only reply to - the SMB request when a change has occurred. Such constant scanning of - a directory is expensive under UNIX, hence an smbd(8) daemon only performs such a scan - on each requested directory once every change notify - timeout seconds.

      Default: change notify timeout = 60

      Example: change notify timeout = 300

      Would change the scan time to every 5 minutes.

      change share command (G)

      Samba 2.2.0 introduced the ability to dynamically - add and delete shares via the Windows NT 4.0 Server Manager. The - change share command is used to define an - external program or script which will modify an existing service definition - in smb.conf. In order to successfully - execute the change share command, smbd - requires that the administrator be connected using a root account (i.e. - uid == 0). -

      When executed, smbd will automatically invoke the - change share command with four parameters. -

      • configFile - the location - of the global smb.conf file. -

      • shareName - the name of the new - share. -

      • pathName - path to an **existing** - directory on disk. -

      • comment - comment string to associate - with the new share. -

      This parameter is only used modify existing file shares definitions. To modify - printer shares, use the "Printers..." folder as seen when browsing the Samba host. -

      See also add share - command, delete - share command. -

      Default: none

      Example: change share command = /usr/local/bin/addshare

      comment (S)

      This is a text field that is seen next to a share - when a client does a queries the server, either via the network - neighborhood or via net view to list what shares - are available.

      If you want to set the string that is displayed next to the - machine name then see the server string parameter.

      Default: No comment string

      Example: comment = Fred's Files

      config file (G)

      This allows you to override the config file - to use, instead of the default (usually smb.conf). - There is a chicken and egg problem here as this option is set - in the config file!

      For this reason, if the name of the config file has changed - when the parameters are loaded then it will reload them from - the new config file.

      This option takes the usual substitutions, which can - be very useful.

      If the config file doesn't exist then it won't be loaded - (allowing you to special case the config files of just a few - clients).

      Example: config file = /usr/local/samba/lib/smb.conf.%m -

      copy (S)

      This parameter allows you to "clone" service - entries. The specified service is simply duplicated under the - current service's name. Any parameters specified in the current - section will override those in the section being copied.

      This feature lets you set up a 'template' service and - create similar services easily. Note that the service being - copied must occur earlier in the configuration file than the - service doing the copying.

      Default: no value

      Example: copy = otherservice

      create mask (S)

      A synonym for this parameter is - create mode - .

      When a file is created, the necessary permissions are - calculated according to the mapping from DOS modes to UNIX - permissions, and the resulting UNIX mode is then bit-wise 'AND'ed - with this parameter. This parameter may be thought of as a bit-wise - MASK for the UNIX modes of a file. Any bit not - set here will be removed from the modes set on a file when it is - created.

      The default value of this parameter removes the - 'group' and 'other' write and execute bits from the UNIX modes.

      Following this Samba will bit-wise 'OR' the UNIX mode created - from this parameter with the value of the force create mode - parameter which is set to 000 by default.

      This parameter does not affect directory modes. See the - parameter directory mode - for details.

      See also the force - create mode parameter for forcing particular mode - bits to be set on created files. See also the directory mode parameter for masking - mode bits on created directories. See also the inherit permissions parameter.

      Note that this parameter does not apply to permissions - set by Windows NT/2000 ACL editors. If the administrator wishes to enforce - a mask on access control lists also, they need to set the security mask.

      Default: create mask = 0744

      Example: create mask = 0775

      create mode (S)

      This is a synonym for create mask.

      csc policy (S)

      This stands for client-side caching - policy, and specifies how clients capable of offline - caching will cache the files in the share. The valid values - are: manual, documents, programs, disable.

      These values correspond to those used on Windows - servers.

      For example, shares containing roaming profiles can have - offline caching disabled using csc policy = disable - .

      Default: csc policy = manual

      Example: csc policy = programs

      deadtime (G)

      The value of the parameter (a decimal integer) - represents the number of minutes of inactivity before a connection - is considered dead, and it is disconnected. The deadtime only takes - effect if the number of open files is zero.

      This is useful to stop a server's resources being - exhausted by a large number of inactive connections.

      Most clients have an auto-reconnect feature when a - connection is broken so in most cases this parameter should be - transparent to users.

      Using this parameter with a timeout of a few minutes - is recommended for most systems.

      A deadtime of zero indicates that no auto-disconnection - should be performed.

      Default: deadtime = 0

      Example: deadtime = 15

      debug hires timestamp (G)

      Sometimes the timestamps in the log messages - are needed with a resolution of higher that seconds, this - boolean parameter adds microsecond resolution to the timestamp - message header when turned on.

      Note that the parameter debug timestamp must be on for this to have an - effect.

      Default: debug hires timestamp = no

      debug pid (G)

      When using only one log file for more then one - forked smbd-process there may be hard to follow which process - outputs which message. This boolean parameter is adds the process-id - to the timestamp message headers in the logfile when turned on.

      Note that the parameter debug timestamp must be on for this to have an - effect.

      Default: debug pid = no

      debug timestamp (G)

      Samba debug log messages are timestamped - by default. If you are running at a high debug level these timestamps - can be distracting. This boolean parameter allows timestamping - to be turned off.

      Default: debug timestamp = yes

      debug uid (G)

      Samba is sometimes run as root and sometime - run as the connected user, this boolean parameter inserts the - current euid, egid, uid and gid to the timestamp message headers - in the log file if turned on.

      Note that the parameter debug timestamp must be on for this to have an - effect.

      Default: debug uid = no

      debuglevel (G)

      Synonym for log level.

      default (G)

      A synonym for default service.

      default case (S)

      See the section on NAME MANGLING. Also note the short preserve case parameter.

      Default: default case = lower

      default devmode (S)

      This parameter is only applicable to printable services. When smbd is serving - Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba - server has a Device Mode which defines things such as paper size and - orientation and duplex settings. The device mode can only correctly be - generated by the printer driver itself (which can only be executed on a - Win32 platform). Because smbd is unable to execute the driver code - to generate the device mode, the default behavior is to set this field - to NULL. -

      Most problems with serving printer drivers to Windows NT/2k/XP clients - can be traced to a problem with the generated device mode. Certain drivers - will do things such as crashing the client's Explorer.exe with a NULL devmode. - However, other printer drivers can cause the client's spooler service - (spoolsv.exe) to die if the devmode was not created by the driver itself - (i.e. smbd generates a default devmode). -

      This parameter should be used with care and tested with the printer - driver in question. It is better to leave the device mode to NULL - and let the Windows client set the correct values. Because drivers do not - do this all the time, setting default devmode = yes - will instruct smbd to generate a default one. -

      For more information on Windows NT/2k printing and Device Modes, - see the MSDN documentation. -

      Default: default devmode = no

      default service (G)

      This parameter specifies the name of a service - which will be connected to if the service actually requested cannot - be found. Note that the square brackets are NOT - given in the parameter value (see example below).

      There is no default value for this parameter. If this - parameter is not given, attempting to connect to a nonexistent - service results in an error.

      Typically the default service would be a guest ok, read-only service.

      Also note that the apparent service name will be changed - to equal that of the requested service, this is very useful as it - allows you to use macros like %S to make - a wildcard service.

      Note also that any "_" characters in the name of the service - used in the default service will get mapped to a "/". This allows for - interesting things.

      Example:

      [global]
-	default service = pub
-        
-[pub]
-	path = /%S
-

      delete group script (G)

      This is the full pathname to a script that will - be run AS ROOT by smbd(8) when a group is requested to be deleted. It will expand any %g to the group name passed. This script is only useful for installations using the Windows NT domain administration tools. -

      deleteprinter command (G)

      With the introduction of MS-RPC based printer - support for Windows NT/2000 clients in Samba 2.2, it is now - possible to delete printer at run time by issuing the - DeletePrinter() RPC call.

      For a Samba host this means that the printer must be - physically deleted from underlying printing system. The deleteprinter command defines a script to be run which - will perform the necessary operations for removing the printer - from the print system and from smb.conf. -

      The deleteprinter command is - automatically called with only one parameter: "printer name".

      Once the deleteprinter command has - been executed, smbd will reparse the smb.conf to associated printer no longer exists. - If the sharename is still valid, then smbd - will return an ACCESS_DENIED error to the client.

      See also addprinter command, printing, - show add - printer wizard

      Default: none

      Example: deleteprinter command = /usr/bin/removeprinter -

      delete readonly (S)

      This parameter allows readonly files to be deleted. - This is not normal DOS semantics, but is allowed by UNIX.

      This option may be useful for running applications such - as rcs, where UNIX file ownership prevents changing file - permissions, and DOS semantics prevent deletion of a read only file.

      Default: delete readonly = no

      delete share command (G)

      Samba 2.2.0 introduced the ability to dynamically - add and delete shares via the Windows NT 4.0 Server Manager. The - delete share command is used to define an - external program or script which will remove an existing service - definition from smb.conf. In order to successfully - execute the delete share command, smbd - requires that the administrator be connected using a root account (i.e. - uid == 0). -

      When executed, smbd will automatically invoke the - delete share command with two parameters. -

      • configFile - the location - of the global smb.conf file. -

      • shareName - the name of - the existing service. -

      This parameter is only used to remove file shares. To delete printer shares, - see the deleteprinter - command. -

      See also add share - command, change - share command. -

      Default: none

      Example: delete share command = /usr/local/bin/delshare

      delete user script (G)

      This is the full pathname to a script that will - be run by smbd(8) - when managing user's with remote RPC (NT) tools. -

      This script is called when a remote client removes a user - from the server, normally using 'User Manager for Domains' or - rpcclient. -

      This script should delete the given UNIX username. -

      Default: delete user script = <empty string> -

      Example: delete user script = /usr/local/samba/bin/del_user - %u

      delete user from group script (G)

      Full path to the script that will be called when - a user is removed from a group using the Windows NT domain administration - tools. It will be run by smbd(8) - AS ROOT. Any %g will be - replaced with the group name and any %u will - be replaced with the user name. -

      Default: delete user from group script =

      Example: delete user from group script = /usr/sbin/deluser %u %g

      delete veto files (S)

      This option is used when Samba is attempting to - delete a directory that contains one or more vetoed directories - (see the veto files - option). If this option is set to no (the default) then if a vetoed - directory contains any non-vetoed files or directories then the - directory delete will fail. This is usually what you want.

      If this option is set to yes, then Samba - will attempt to recursively delete any files and directories within - the vetoed directory. This can be useful for integration with file - serving systems such as NetAtalk which create meta-files within - directories you might normally veto DOS/Windows users from seeing - (e.g. .AppleDouble)

      Setting delete veto files = yes allows these - directories to be transparently deleted when the parent directory - is deleted (so long as the user has permissions to do so).

      See also the veto - files parameter.

      Default: delete veto files = no

      deny hosts (S)

      Synonym for hosts - deny.

      dfree command (G)

      The dfree command setting should - only be used on systems where a problem occurs with the internal - disk space calculations. This has been known to happen with Ultrix, - but may occur with other operating systems. The symptom that was - seen was an error of "Abort Retry Ignore" at the end of each - directory listing.

      This setting allows the replacement of the internal routines to - calculate the total disk space and amount available with an external - routine. The example below gives a possible script that might fulfill - this function.

      The external program will be passed a single parameter indicating - a directory in the filesystem being queried. This will typically consist - of the string ./. The script should return two - integers in ASCII. The first should be the total disk space in blocks, - and the second should be the number of available blocks. An optional - third return value can give the block size in bytes. The default - blocksize is 1024 bytes.

      Note: Your script should NOT be setuid or - setgid and should be owned by (and writeable only by) root!

      Default: By default internal routines for - determining the disk capacity and remaining space will be used. -

      Example: dfree command = /usr/local/samba/bin/dfree -

      Where the script dfree (which must be made executable) could be:

       
-		#!/bin/sh
-		df $1 | tail -1 | awk '{print $2" "$4}'
-

      or perhaps (on Sys V based systems):

       
-		#!/bin/sh
-		/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
-

      Note that you may have to replace the command names - with full path names on some systems.

      directory (S)

      Synonym for path - .

      directory mask (S)

      This parameter is the octal modes which are - used when converting DOS modes to UNIX modes when creating UNIX - directories.

      When a directory is created, the necessary permissions are - calculated according to the mapping from DOS modes to UNIX permissions, - and the resulting UNIX mode is then bit-wise 'AND'ed with this - parameter. This parameter may be thought of as a bit-wise MASK for - the UNIX modes of a directory. Any bit not set - here will be removed from the modes set on a directory when it is - created.

      The default value of this parameter removes the 'group' - and 'other' write bits from the UNIX mode, allowing only the - user who owns the directory to modify it.

      Following this Samba will bit-wise 'OR' the UNIX mode - created from this parameter with the value of the force directory mode - parameter. This parameter is set to 000 by - default (i.e. no extra mode bits are added).

      Note that this parameter does not apply to permissions - set by Windows NT/2000 ACL editors. If the administrator wishes to enforce - a mask on access control lists also, they need to set the directory security mask.

      See the force - directory mode parameter to cause particular mode - bits to always be set on created directories.

      See also the create mode - parameter for masking mode bits on created files, - and the directory - security mask parameter.

      Also refer to the inherit permissions parameter.

      Default: directory mask = 0755

      Example: directory mask = 0775

      directory mode (S)

      Synonym for directory mask

      directory security mask (S)

      This parameter controls what UNIX permission bits - can be modified when a Windows NT client is manipulating the UNIX - permission on a directory using the native NT security dialog - box.

      This parameter is applied as a mask (AND'ed with) to - the changed permission bits, thus preventing any bits not in - this mask from being modified. Essentially, zero bits in this - mask may be treated as a set of bits the user is not allowed - to change.

      If not set explicitly this parameter is set to 0777 - meaning a user is allowed to modify all the user/group/world - permissions on a directory.

      Note that users who can access the - Samba server through other means can easily bypass this restriction, - so it is primarily useful for standalone "appliance" systems. - Administrators of most normal systems will probably want to leave - it as the default of 0777.

      See also the force directory security mode, security mask, - force security mode - parameters.

      Default: directory security mask = 0777

      Example: directory security mask = 0700

      disable netbios (G)

      Enabling this parameter will disable netbios support - in Samba. Netbios is the only available form of browsing in - all windows versions except for 2000 and XP.

      Note that clients that only support netbios won't be able to - see your samba server when netbios support is disabled. -

      Default: disable netbios = no

      Example: disable netbios = yes

      disable spoolss (G)

      Enabling this parameter will disable Samba's support - for the SPOOLSS set of MS-RPC's and will yield identical behavior - as Samba 2.0.x. Windows NT/2000 clients will downgrade to using - Lanman style printing commands. Windows 9x/ME will be uneffected by - the parameter. However, this will also disable the ability to upload - printer drivers to a Samba server via the Windows NT Add Printer - Wizard or by using the NT printer properties dialog window. It will - also disable the capability of Windows NT/2000 clients to download - print drivers from the Samba host upon demand. - Be very careful about enabling this parameter. -

      See also use client driver -

      Default : disable spoolss = no

      display charset (G)

      Specifies the charset that samba will use - to print messages to stdout and stderr and SWAT will use. - Should generally be the same as the unix charset. -

      Default: display charset = ASCII

      Example: display charset = UTF8

      dns proxy (G)

      Specifies that nmbd(8) - when acting as a WINS server and finding that a NetBIOS name has not - been registered, should treat the NetBIOS name word-for-word as a DNS - name and do a lookup with the DNS server for that name on behalf of - the name-querying client.

      Note that the maximum length for a NetBIOS name is 15 - characters, so the DNS name (or DNS alias) can likewise only be - 15 characters, maximum.

      nmbd spawns a second copy of itself to do the - DNS name lookup requests, as doing a name lookup is a blocking - action.

      See also the parameter wins support.

      Default: dns proxy = yes

      domain logons (G)

      If set to yes, the Samba server will serve - Windows 95/98 Domain logons for the workgroup it is in. Samba 2.2 - has limited capability to act as a domain controller for Windows - NT 4 Domains. For more details on setting up this feature see - the Samba-PDC-HOWTO included in the htmldocs/ - directory shipped with the source code.

      Default: domain logons = no

      domain master (G)

      Tell nmbd(8) to enable WAN-wide browse list - collation. Setting this option causes nmbd to - claim a special domain specific NetBIOS name that identifies - it as a domain master browser for its given workgroup. Local master browsers - in the same workgroup on broadcast-isolated - subnets will give this nmbd their local browse lists, - and then ask smbd(8) - for a complete copy of the browse list for the whole wide area - network. Browser clients will then contact their local master browser, - and will receive the domain-wide browse list, instead of just the list - for their broadcast-isolated subnet.

      Note that Windows NT Primary Domain Controllers expect to be - able to claim this workgroup specific special - NetBIOS name that identifies them as domain master browsers for - that workgroup by default (i.e. there is no - way to prevent a Windows NT PDC from attempting to do this). This - means that if this parameter is set and nmbd claims - the special name for a workgroup before a Windows - NT PDC is able to do so then cross subnet browsing will behave - strangely and may fail.

      If domain logons = yes - , then the default behavior is to enable the domain - master parameter. If domain logons is - not enabled (the default setting), then neither will domain - master be enabled by default.

      Default: domain master = auto

      dont descend (S)

      There are certain directories on some systems - (e.g., the /proc tree under Linux) that are either not - of interest to clients or are infinitely deep (recursive). This - parameter allows you to specify a comma-delimited list of directories - that the server should always show as empty.

      Note that Samba can be very fussy about the exact format - of the "dont descend" entries. For example you may need ./proc instead of just /proc. - Experimentation is the best policy :-)

      Default: none (i.e., all directories are OK - to descend)

      Example: dont descend = /proc,/dev

      dos charset (G)

      DOS SMB clients assume the server has - the same charset as they do. This option specifies which - charset Samba should talk to DOS clients. -

      The default depends on which charsets you have instaled. - Samba tries to use charset 850 but falls back to ASCII in - case it is not available. Run testparm(1) - to check the default on your system. -

      dos filemode (S)

      The default behavior in Samba is to provide - UNIX-like behavior where only the owner of a file/directory is - able to change the permissions on it. However, this behavior - is often confusing to DOS/Windows users. Enabling this parameter - allows a user who has write access to the file (by whatever - means) to modify the permissions on it. Note that a user - belonging to the group owning the file will not be allowed to - change permissions if the group is only granted read access. - Ownership of the file/directory is not changed, only the permissions - are modified.

      Default: dos filemode = no

      dos filetime resolution (S)

      Under the DOS and Windows FAT filesystem, the finest - granularity on time resolution is two seconds. Setting this parameter - for a share causes Samba to round the reported time down to the - nearest two second boundary when a query call that requires one second - resolution is made to smbd(8) - .

      This option is mainly used as a compatibility option for Visual - C++ when used against Samba shares. If oplocks are enabled on a - share, Visual C++ uses two different time reading calls to check if a - file has changed since it was last read. One of these calls uses a - one-second granularity, the other uses a two second granularity. As - the two second call rounds any odd second down, then if the file has a - timestamp of an odd number of seconds then the two timestamps will not - match and Visual C++ will keep reporting the file has changed. Setting - this option causes the two timestamps to match, and Visual C++ is - happy.

      Default: dos filetime resolution = no

      dos filetimes (S)

      Under DOS and Windows, if a user can write to a - file they can change the timestamp on it. Under POSIX semantics, - only the owner of the file or root may change the timestamp. By - default, Samba runs with POSIX semantics and refuses to change the - timestamp on a file if the user smbd is acting - on behalf of is not the file owner. Setting this option to yes allows DOS semantics and smbd will change the file - timestamp as DOS requires.

      Default: dos filetimes = no

      encrypt passwords (G)

      This boolean controls whether encrypted passwords - will be negotiated with the client. Note that Windows NT 4.0 SP3 and - above and also Windows 98 will by default expect encrypted passwords - unless a registry entry is changed. To use encrypted passwords in - Samba see the file ENCRYPTION.txt in the Samba documentation - directory docs/ shipped with the source code.

      In order for encrypted passwords to work correctly - smbd(8) must either - have access to a local smbpasswd(5) - file (see the smbpasswd(8) program for information on how to set up - and maintain this file), or set the security = [server|domain|ads] parameter which - causes smbd to authenticate against another - server.

      Default: encrypt passwords = yes

      enhanced browsing (G)

      This option enables a couple of enhancements to - cross-subnet browse propagation that have been added in Samba - but which are not standard in Microsoft implementations. -

      The first enhancement to browse propagation consists of a regular - wildcard query to a Samba WINS server for all Domain Master Browsers, - followed by a browse synchronization with each of the returned - DMBs. The second enhancement consists of a regular randomised browse - synchronization with all currently known DMBs.

      You may wish to disable this option if you have a problem with empty - workgroups not disappearing from browse lists. Due to the restrictions - of the browse protocols these enhancements can cause a empty workgroup - to stay around forever which can be annoying.

      In general you should leave this option enabled as it makes - cross-subnet browse propagation much more reliable.

      Default: enhanced browsing = yes

      enumports command (G)

      The concept of a "port" is fairly foreign - to UNIX hosts. Under Windows NT/2000 print servers, a port - is associated with a port monitor and generally takes the form of - a local port (i.e. LPT1:, COM1:, FILE:) or a remote port - (i.e. LPD Port Monitor, etc...). By default, Samba has only one - port defined--"Samba Printer Port". Under - Windows NT/2000, all printers must have a valid port name. - If you wish to have a list of ports displayed (smbd - does not use a port name for anything) other than - the default "Samba Printer Port", you - can define enumports command to point to - a program which should generate a list of ports, one per line, - to standard output. This listing will then be used in response - to the level 1 and 2 EnumPorts() RPC.

      Default: no enumports command

      Example: enumports command = /usr/bin/listports -

      exec (S)

      This is a synonym for preexec.

      fake directory create times (S)

      NTFS and Windows VFAT file systems keep a create - time for all files and directories. This is not the same as the - ctime - status change time - that Unix keeps, so Samba by default - reports the earliest of the various times Unix does keep. Setting - this parameter for a share causes Samba to always report midnight - 1-1-1980 as the create time for directories.

      This option is mainly used as a compatibility option for - Visual C++ when used against Samba shares. Visual C++ generated - makefiles have the object directory as a dependency for each object - file, and a make rule to create the directory. Also, when NMAKE - compares timestamps it uses the creation time when examining a - directory. Thus the object directory will be created if it does not - exist, but once it does exist it will always have an earlier - timestamp than the object files it contains.

      However, Unix time semantics mean that the create time - reported by Samba will be updated whenever a file is created or - or deleted in the directory. NMAKE finds all object files in - the object directory. The timestamp of the last one built is then - compared to the timestamp of the object directory. If the - directory's timestamp if newer, then all object files - will be rebuilt. Enabling this option - ensures directories always predate their contents and an NMAKE build - will proceed as expected.

      Default: fake directory create times = no

      fake oplocks (S)

      Oplocks are the way that SMB clients get permission - from a server to locally cache file operations. If a server grants - an oplock (opportunistic lock) then the client is free to assume - that it is the only one accessing the file and it will aggressively - cache file data. With some oplock types the client may even cache - file open/close operations. This can give enormous performance benefits. -

      When you set fake oplocks = yes, smbd(8) will - always grant oplock requests no matter how many clients are using - the file.

      It is generally much better to use the real oplocks support rather - than this parameter.

      If you enable this option on all read-only shares or - shares that you know will only be accessed from one client at a - time such as physically read-only media like CDROMs, you will see - a big performance improvement on many operations. If you enable - this option on shares where multiple clients may be accessing the - files read-write at the same time you can get data corruption. Use - this option carefully!

      Default: fake oplocks = no

      follow symlinks (S)

      This parameter allows the Samba administrator - to stop smbd(8) - from following symbolic links in a particular share. Setting this - parameter to no prevents any file or directory - that is a symbolic link from being followed (the user will get an - error). This option is very useful to stop users from adding a - symbolic link to /etc/passwd in their home - directory for instance. However it will slow filename lookups - down slightly.

      This option is enabled (i.e. smbd will - follow symbolic links) by default.

      Default: follow symlinks = yes

      force create mode (S)

      This parameter specifies a set of UNIX mode bit - permissions that will always be set on a - file created by Samba. This is done by bitwise 'OR'ing these bits onto - the mode bits of a file that is being created or having its - permissions changed. The default for this parameter is (in octal) - 000. The modes in this parameter are bitwise 'OR'ed onto the file - mode after the mask set in the create mask - parameter is applied.

      See also the parameter create - mask for details on masking mode bits on files.

      See also the inherit - permissions parameter.

      Default: force create mode = 000

      Example: force create mode = 0755

      would force all created files to have read and execute - permissions set for 'group' and 'other' as well as the - read/write/execute bits set for the 'user'.

      force directory mode (S)

      This parameter specifies a set of UNIX mode bit - permissions that will always be set on a directory - created by Samba. This is done by bitwise 'OR'ing these bits onto the - mode bits of a directory that is being created. The default for this - parameter is (in octal) 0000 which will not add any extra permission - bits to a created directory. This operation is done after the mode - mask in the parameter directory mask is - applied.

      See also the parameter directory mask for details on masking mode bits - on created directories.

      See also the inherit permissions parameter.

      Default: force directory mode = 000

      Example: force directory mode = 0755

      would force all created directories to have read and execute - permissions set for 'group' and 'other' as well as the - read/write/execute bits set for the 'user'.

      force directory security mode (S)

      This parameter controls what UNIX permission bits - can be modified when a Windows NT client is manipulating the UNIX - permission on a directory using the native NT security dialog box.

      This parameter is applied as a mask (OR'ed with) to the - changed permission bits, thus forcing any bits in this mask that - the user may have modified to be on. Essentially, one bits in this - mask may be treated as a set of bits that, when modifying security - on a directory, the user has always set to be 'on'.

      If not set explicitly this parameter is 000, which - allows a user to modify all the user/group/world permissions on a - directory without restrictions.

      Note that users who can access the - Samba server through other means can easily bypass this restriction, - so it is primarily useful for standalone "appliance" systems. - Administrators of most normal systems will probably want to leave - it set as 0000.

      See also the directory security mask, security mask, - force security mode - parameters.

      Default: force directory security mode = 0

      Example: force directory security mode = 700

      force group (S)

      This specifies a UNIX group name that will be - assigned as the default primary group for all users connecting - to this service. This is useful for sharing files by ensuring - that all access to files on service will use the named group for - their permissions checking. Thus, by assigning permissions for this - group to the files and directories within this service the Samba - administrator can restrict or allow sharing of these files.

      In Samba 2.0.5 and above this parameter has extended - functionality in the following way. If the group name listed here - has a '+' character prepended to it then the current user accessing - the share only has the primary group default assigned to this group - if they are already assigned as a member of that group. This allows - an administrator to decide that only users who are already in a - particular group will create files with group ownership set to that - group. This gives a finer granularity of ownership assignment. For - example, the setting force group = +sys means - that only users who are already in group sys will have their default - primary group assigned to sys when accessing this Samba share. All - other users will retain their ordinary primary group.

      If the force user - parameter is also set the group specified in - force group will override the primary group - set in force user.

      See also force - user.

      Default: no forced group

      Example: force group = agroup

      force security mode (S)

      This parameter controls what UNIX permission - bits can be modified when a Windows NT client is manipulating - the UNIX permission on a file using the native NT security dialog - box.

      This parameter is applied as a mask (OR'ed with) to the - changed permission bits, thus forcing any bits in this mask that - the user may have modified to be on. Essentially, one bits in this - mask may be treated as a set of bits that, when modifying security - on a file, the user has always set to be 'on'.

      If not set explicitly this parameter is set to 0, - and allows a user to modify all the user/group/world permissions on a file, - with no restrictions.

      Note that users who can access - the Samba server through other means can easily bypass this restriction, - so it is primarily useful for standalone "appliance" systems. - Administrators of most normal systems will probably want to leave - this set to 0000.

      See also the force directory security mode, - directory security - mask, security mask parameters.

      Default: force security mode = 0

      Example: force security mode = 700

      force user (S)

      This specifies a UNIX user name that will be - assigned as the default user for all users connecting to this service. - This is useful for sharing files. You should also use it carefully - as using it incorrectly can cause security problems.

      This user name only gets used once a connection is established. - Thus clients still need to connect as a valid user and supply a - valid password. Once connected, all file operations will be performed - as the "forced user", no matter what username the client connected - as. This can be very useful.

      In Samba 2.0.5 and above this parameter also causes the - primary group of the forced user to be used as the primary group - for all file activity. Prior to 2.0.5 the primary group was left - as the primary group of the connecting user (this was a bug).

      See also force group -

      Default: no forced user

      Example: force user = auser

      fstype (S)

      This parameter allows the administrator to - configure the string that specifies the type of filesystem a share - is using that is reported by smbd(8) - when a client queries the filesystem type - for a share. The default type is NTFS for - compatibility with Windows NT but this can be changed to other - strings such as Samba or FAT - if required.

      Default: fstype = NTFS

      Example: fstype = Samba

      getwd cache (G)

      This is a tuning option. When this is enabled a - caching algorithm will be used to reduce the time taken for getwd() - calls. This can have a significant impact on performance, especially - when the wide links - parameter is set to no.

      Default: getwd cache = yes

      group (S)

      Synonym for force - group.

      guest account (S)

      This is a username which will be used for access - to services which are specified as guest ok (see below). Whatever privileges this - user has will be available to any client connecting to the guest service. - Typically this user will exist in the password file, but will not - have a valid login. The user account "ftp" is often a good choice - for this parameter. If a username is specified in a given service, - the specified username overrides this one.

      One some systems the default guest account "nobody" may not - be able to print. Use another account in this case. You should test - this by trying to log in as your guest user (perhaps by using the - su - command) and trying to print using the - system print command such as lpr(1) or lp(1).

      This parameter does not accept % macros, because - many parts of the system require this value to be - constant for correct operation.

      Default: specified at compile time, usually - "nobody"

      Example: guest account = ftp

      guest ok (S)

      If this parameter is yes for - a service, then no password is required to connect to the service. - Privileges will be those of the guest account.

      See the section below on security for more information about this option. -

      Default: guest ok = no

      guest only (S)

      If this parameter is yes for - a service, then only guest connections to the service are permitted. - This parameter will have no effect if guest ok is not set for the service.

      See the section below on security for more information about this option. -

      Default: guest only = no

      hide dot files (S)

      This is a boolean parameter that controls whether - files starting with a dot appear as hidden files.

      Default: hide dot files = yes

      hide files(S)

      This is a list of files or directories that are not - visible but are accessible. The DOS 'hidden' attribute is applied - to any files or directories that match.

      Each entry in the list must be separated by a '/', - which allows spaces to be included in the entry. '*' - and '?' can be used to specify multiple files or directories - as in DOS wildcards.

      Each entry must be a Unix path, not a DOS path and must - not include the Unix directory separator '/'.

      Note that the case sensitivity option is applicable - in hiding files.

      Setting this parameter will affect the performance of Samba, - as it will be forced to check all files and directories for a match - as they are scanned.

      See also hide - dot files, veto files and case sensitive.

      Default: no file are hidden

      Example: hide files = - /.*/DesktopFolderDB/TrashFor%m/resource.frk/

      The above example is based on files that the Macintosh - SMB client (DAVE) available from - Thursby creates for internal use, and also still hides - all files beginning with a dot.

      hide local users(G)

      This parameter toggles the hiding of local UNIX - users (root, wheel, floppy, etc) from remote clients.

      Default: hide local users = no

      hide unreadable (G)

      This parameter prevents clients from seeing the - existance of files that cannot be read. Defaults to off.

      Default: hide unreadable = no

      hide unwriteable files (G)

      This parameter prevents clients from seeing - the existance of files that cannot be written to. Defaults to off. - Note that unwriteable directories are shown as usual. -

      Default: hide unwriteable = no

      hide special files (G)

      This parameter prevents clients from seeing - special files such as sockets, devices and fifo's in directory - listings. -

      Default: hide special files = no

      homedir map (G)

      Ifnis homedir - is yes, and smbd(8) is also acting - as a Win95/98 logon server then this parameter - specifies the NIS (or YP) map from which the server for the user's - home directory should be extracted. At present, only the Sun - auto.home map format is understood. The form of the map is:

      username server:/some/file/system

      and the program will extract the servername from before - the first ':'. There should probably be a better parsing system - that copes with different map formats and also Amd (another - automounter) maps.

      NOTE :A working NIS client is required on - the system for this option to work.

      See also nis homedir - , domain logons - .

      Default: homedir map = <empty string>

      Example: homedir map = amd.homedir

      host msdfs (G)

      This boolean parameter is only available - if Samba has been configured and compiled with the --with-msdfs option. If set to yes, - Samba will act as a Dfs server, and allow Dfs-aware clients - to browse Dfs trees hosted on the server.

      See also the msdfs root share level parameter. For - more information on setting up a Dfs tree on Samba, - refer to msdfs_setup.html. -

      Default: host msdfs = no

      hostname lookups (G)

      Specifies whether samba should use (expensive) - hostname lookups or use the ip addresses instead. An example place - where hostname lookups are currently used is when checking - the hosts deny and hosts allow. -

      Default: hostname lookups = yes

      Example: hostname lookups = no

      hosts allow (S)

      A synonym for this parameter is allow - hosts.

      This parameter is a comma, space, or tab delimited - set of hosts which are permitted to access a service.

      If specified in the [global] section then it will - apply to all services, regardless of whether the individual - service has a different setting.

      You can specify the hosts by name or IP number. For - example, you could restrict access to only the hosts on a - Class C subnet with something like allow hosts = 150.203.5. - . The full syntax of the list is described in the man - page hosts_access(5). Note that this man - page may not be present on your system, so a brief description will - be given here also.

      Note that the localhost address 127.0.0.1 will always - be allowed access unless specifically denied by a hosts deny option.

      You can also specify hosts by network/netmask pairs and - by netgroup names if your system supports netgroups. The - EXCEPT keyword can also be used to limit a - wildcard list. The following examples may provide some help:

      Example 1: allow all IPs in 150.203.*.*; except one

      hosts allow = 150.203. EXCEPT 150.203.6.66

      Example 2: allow hosts that match the given network/netmask

      hosts allow = 150.203.15.0/255.255.255.0

      Example 3: allow a couple of hosts

      hosts allow = lapland, arvidsjaur

      Example 4: allow only hosts in NIS netgroup "foonet", but - deny access from one particular host

      hosts allow = @foonet

      hosts deny = pirate

      Note that access still requires suitable user-level passwords.

      See testparm(1) - for a way of testing your host access to see if it does - what you expect.

      Default: none (i.e., all hosts permitted access) -

      Example: allow hosts = 150.203.5. myhost.mynet.edu.au -

      hosts deny (S)

      The opposite of hosts allow - - hosts listed here are NOT permitted access to - services unless the specific services have their own lists to override - this one. Where the lists conflict, the allow - list takes precedence.

      Default: none (i.e., no hosts specifically excluded) -

      Example: hosts deny = 150.203.4. badhost.mynet.edu.au -

      hosts equiv (G)

      If this global parameter is a non-null string, - it specifies the name of a file to read for the names of hosts - and users who will be allowed access without specifying a password. -

      This is not be confused with hosts allow which is about hosts - access to services and is more useful for guest services. hosts equiv may be useful for NT clients which will - not supply passwords to Samba.

      NOTE : The use of hosts equiv - can be a major security hole. This is because you are - trusting the PC to supply the correct username. It is very easy to - get a PC to supply a false username. I recommend that the - hosts equiv option be only used if you really - know what you are doing, or perhaps on a home network where you trust - your spouse and kids. And only if you really trust - them :-).

      Default: no host equivalences

      Example: hosts equiv = /etc/hosts.equiv

      include (G)

      This allows you to include one config file - inside another. The file is included literally, as though typed - in place.

      It takes the standard substitutions, except %u - , %P and %S. -

      Default: no file included

      Example: include = /usr/local/samba/lib/admin_smb.conf -

      inherit acls (S)

      This parameter can be used to ensure - that if default acls exist on parent directories, - they are always honored when creating a subdirectory. - The default behavior is to use the mode specified - when creating the directory. Enabling this option - sets the mode to 0777, thus guaranteeing that - default directory acls are propagated. -

      Default: inherit acls = no -

      inherit permissions (S)

      The permissions on new files and directories - are normally governed by create mask, directory mask, force create mode - and force - directory mode but the boolean inherit - permissions parameter overrides this.

      New directories inherit the mode of the parent directory, - including bits such as setgid.

      New files inherit their read/write bits from the parent - directory. Their execute bits continue to be determined by - map archive - , map hidden - and map system - as usual.

      Note that the setuid bit is never set via - inheritance (the code explicitly prohibits this).

      This can be particularly useful on large systems with - many users, perhaps several thousand, to allow a single [homes] - share to be used flexibly by each user.

      See also create mask - , directory mask, force create mode and force directory mode - .

      Default: inherit permissions = no

      interfaces (G)

      This option allows you to override the default - network interfaces list that Samba will use for browsing, name - registration and other NBT traffic. By default Samba will query - the kernel for the list of all active interfaces and use any - interfaces except 127.0.0.1 that are broadcast capable.

      The option takes a list of interface strings. Each string - can be in any of the following forms:

      • a network interface name (such as eth0). - This may include shell-like wildcards so eth* will match - any interface starting with the substring "eth"

      • an IP address. In this case the netmask is - determined from the list of interfaces obtained from the - kernel

      • an IP/mask pair.

      • a broadcast/mask pair.

      The "mask" parameters can either be a bit length (such - as 24 for a C class network) or a full netmask in dotted - decimal form.

      The "IP" parameters above can either be a full dotted - decimal IP address or a hostname which will be looked up via - the OS's normal hostname resolution mechanisms.

      For example, the following line:

      interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 -

      would configure three network interfaces corresponding - to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. - The netmasks of the latter two interfaces would be set to 255.255.255.0.

      See also bind - interfaces only.

      Default: all active interfaces except 127.0.0.1 - that are broadcast capable

      invalid users (S)

      This is a list of users that should not be allowed - to login to this service. This is really a paranoid - check to absolutely ensure an improper setting does not breach - your security.

      A name starting with a '@' is interpreted as an NIS - netgroup first (if your system supports NIS), and then as a UNIX - group if the name was not found in the NIS netgroup database.

      A name starting with '+' is interpreted only - by looking in the UNIX group database. A name starting with - '&' is interpreted only by looking in the NIS netgroup database - (this requires NIS to be working on your system). The characters - '+' and '&' may be used at the start of the name in either order - so the value +&group means check the - UNIX group database, followed by the NIS netgroup database, and - the value &+group means check the NIS - netgroup database, followed by the UNIX group database (the - same as the '@' prefix).

      The current servicename is substituted for %S. - This is useful in the [homes] section.

      See also valid users - .

      Default: no invalid users

      Example: invalid users = root fred admin @wheel -

      keepalive (G)

      The value of the parameter (an integer) represents - the number of seconds between keepalive - packets. If this parameter is zero, no keepalive packets will be - sent. Keepalive packets, if sent, allow the server to tell whether - a client is still present and responding.

      Keepalives should, in general, not be needed if the socket - being used has the SO_KEEPALIVE attribute set on it (see socket options). - Basically you should only use this option if you strike difficulties.

      Default: keepalive = 300

      Example: keepalive = 600

      kernel oplocks (G)

      For UNIXes that support kernel based oplocks - (currently only IRIX and the Linux 2.4 kernel), this parameter - allows the use of them to be turned on or off.

      Kernel oplocks support allows Samba oplocks - to be broken whenever a local UNIX process or NFS operation - accesses a file that smbd(8) - has oplocked. This allows complete data consistency between - SMB/CIFS, NFS and local file access (and is a very - cool feature :-).

      This parameter defaults to on, but is translated - to a no-op on systems that no not have the necessary kernel support. - You should never need to touch this parameter.

      See also the oplocks - and level2 oplocks - parameters.

      Default: kernel oplocks = yes

      lanman auth (G)

      This parameter determines whether or not smbd will - attempt to authenticate users using the LANMAN password hash. - If disabled, only clients which support NT password hashes (e.g. Windows - NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS - network client) will be able to connect to the Samba host.

      Default : lanman auth = yes

      large readwrite (G)

      This parameter determines whether or not smbd - supports the new 64k streaming read and write varient SMB requests introduced - with Windows 2000. Note that due to Windows 2000 client redirector bugs - this requires Samba to be running on a 64-bit capable operating system such - as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with - Windows 2000 clients. Defaults to on. Not as tested as some other Samba - code paths. -

      Default : large readwrite = yes

      ldap admin dn (G)

      The ldap admin dn defines the Distinguished - Name (DN) name used by Samba to contact the ldap server when retreiving - user account information. The ldap - admin dn is used in conjunction with the admin dn password - stored in the private/secrets.tdb file. See the - smbpasswd(8) man - page for more information on how to accomplish this. -

      >ldap del only sam attr (G)

      This parameter specifies whether a delete - operation in the ldapsam deletes the complete entry or only the attributes - specific to Samba. -

      Default : ldap delete dn = no

      >ldap del only sam attr (G)

      Inverted synonym for ldap delete dn. -

      ldap filter (G)

      This parameter specifies the RFC 2254 compliant LDAP search filter. - The default is to match the login name with the uid - attribute for all entries matching the sambaAccount - objectclass. Note that this filter should only return one entry. -

      Default : ldap filter = (&(uid=%u)(objectclass=sambaAccount))

      ldap port (G)

      This parameter is only available if Samba has been - configure to include the --with-ldapsam option - at compile time. -

      This option is used to control the tcp port number used to contact - the ldap server. - The default is to use the stand LDAPS port 636. -

      See Also: ldap ssl -

      Default : ldap port = 636 ; if ldap ssl = on

      Default : ldap port = 389 ; if ldap ssl = off

      ldap server (G)

      This parameter is only available if Samba has been - configure to include the --with-ldapsam option - at compile time. -

      This parameter should contain the FQDN of the ldap directory - server which should be queried to locate user account information. -

      Default : ldap server = localhost

      ldap ssl (G)

      This option is used to define whether or not Samba should - use SSL when connecting to the ldap server - This is NOT related to - Samba's previous SSL support which was enabled by specifying the - --with-ssl option to the configure - script. -

      The ldap ssl can be set to one of three values: -

      • Off = Never use SSL when querying the directory.

      • Start_tls = Use the LDAPv3 StartTLS extended operation - (RFC2830) for communicating with the directory server.

      • On = - Use SSL on the ldaps port when contacting the - ldap server. Only - available when the backwards-compatiblity --with-ldapsam option is specified - to configure. See passdb backend

      Default : ldap ssl = start_tls

      ldap suffix (G)

      Specifies where user and machine accounts are added to the tree. Can be overriden by ldap user suffix and ldap machine suffix. It also used as the base dn for all ldap searches.

      Default : none

      ldap user suffix (G)

      It specifies where users are added to the tree. -

      Default : none

      ldap machine suffix (G)

      It specifies where machines should be - added to the ldap tree. -

      Default : none

      ldap passwd sync (G)

      This option is used to define whether - or not Samba should sync the LDAP password with the NT - and LM hashes for normal accounts (NOT for - workstation, server or domain trusts) on a password - change via SAMBA. -

      The ldap passwd sync can be set to one of three values: -

      • Yes = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time.

      • No = Update NT and LM passwords and update the pwdLastSet time.

      • Only = Only update the LDAP password and let the LDAP server do the rest.

      Default : ldap passwd sync = no

      ldap trust ids (G)

      Normally, Samba validates each entry - in the LDAP server against getpwnam(). This allows - LDAP to be used for Samba with the unix system using - NIS (for example) and also ensures that Samba does not - present accounts that do not otherwise exist.

      This option is used to disable this functionality, and - instead to rely on the presence of the appropriate - attributes in LDAP directly, which can result in a - significant performance boost in some situations. - Setting this option to yes effectivly assumes - that the local machine is running nss_ldap against the - same LDAP server.

      Default: ldap trust ids = No

      level2 oplocks (S)

      This parameter controls whether Samba supports - level2 (read-only) oplocks on a share.

      Level2, or read-only oplocks allow Windows NT clients - that have an oplock on a file to downgrade from a read-write oplock - to a read-only oplock once a second client opens the file (instead - of releasing all oplocks on a second open, as in traditional, - exclusive oplocks). This allows all openers of the file that - support level2 oplocks to cache the file for read-ahead only (ie. - they may not cache writes or lock requests) and increases performance - for many accesses of files that are not commonly written (such as - application .EXE files).

      Once one of the clients which have a read-only oplock - writes to the file all clients are notified (no reply is needed - or waited for) and told to break their oplocks to "none" and - delete any read-ahead caches.

      It is recommended that this parameter be turned on - to speed access to shared executables.

      For more discussions on level2 oplocks see the CIFS spec.

      Currently, if kernel - oplocks are supported then level2 oplocks are - not granted (even if this parameter is set to yes). - Note also, the oplocks - parameter must be set to yes on this share in order for - this parameter to have any effect.

      See also the oplocks - and kernel oplocks - parameters.

      Default: level2 oplocks = yes

      lm announce (G)

      This parameter determines if nmbd(8) will produce Lanman announce - broadcasts that are needed by OS/2 clients in order for them to see - the Samba server in their browse list. This parameter can have three - values, yes, no, or - auto. The default is auto. - If set to no Samba will never produce these - broadcasts. If set to yes Samba will produce - Lanman announce broadcasts at a frequency set by the parameter - lm interval. If set to auto - Samba will not send Lanman announce broadcasts by default but will - listen for them. If it hears such a broadcast on the wire it will - then start sending them at a frequency set by the parameter - lm interval.

      See also lm interval - .

      Default: lm announce = auto

      Example: lm announce = yes

      lm interval (G)

      If Samba is set to produce Lanman announce - broadcasts needed by OS/2 clients (see the lm announce parameter) then this - parameter defines the frequency in seconds with which they will be - made. If this is set to zero then no Lanman announcements will be - made despite the setting of the lm announce - parameter.

      See also lm - announce.

      Default: lm interval = 60

      Example: lm interval = 120

      load printers (G)

      A boolean variable that controls whether all - printers in the printcap will be loaded for browsing by default. - See the printers section for - more details.

      Default: load printers = yes

      local master (G)

      This option allows nmbd(8) to try and become a local master browser - on a subnet. If set to no then nmbd will not attempt to become a local master browser - on a subnet and will also lose in all browsing elections. By - default this value is set to yes. Setting this value to yes doesn't - mean that Samba will become the local master - browser on a subnet, just that nmbd will participate in elections for local master browser.

      Setting this value to no will cause nmbd - never to become a local master browser.

      Default: local master = yes

      lock dir (G)

      Synonym for lock directory.

      lock directory (G)

      This option specifies the directory where lock - files will be placed. The lock files are used to implement the - max connections - option.

      Default: lock directory = ${prefix}/var/locks

      Example: lock directory = /var/run/samba/locks -

      lock spin count (G)

      This parameter controls the number of times - that smbd should attempt to gain a byte range lock on the - behalf of a client request. Experiments have shown that - Windows 2k servers do not reply with a failure if the lock - could not be immediately granted, but try a few more times - in case the lock could later be aquired. This behavior - is used to support PC database formats such as MS Access - and FoxPro. -

      Default: lock spin count = 2 -

      lock spin time (G)

      The time in microseconds that smbd should - pause before attempting to gain a failed lock. See - lock spin - count for more details. -

      Default: lock spin time = 10 -

      locking (S)

      This controls whether or not locking will be - performed by the server in response to lock requests from the - client.

      If locking = no, all lock and unlock - requests will appear to succeed and all lock queries will report - that the file in question is available for locking.

      If locking = yes, real locking will be performed - by the server.

      This option may be useful for read-only - filesystems which may not need locking (such as - CDROM drives), although setting this parameter of no - is not really recommended even in this case.

      Be careful about disabling locking either globally or in a - specific service, as lack of locking may result in data corruption. - You should never need to set this parameter.

      Default: locking = yes

      log file (G)

      This option allows you to override the name - of the Samba log file (also known as the debug file).

      This option takes the standard substitutions, allowing - you to have separate log files for each user or machine.

      Example: log file = /usr/local/samba/var/log.%m -

      log level (G)

      The value of the parameter (a astring) allows - the debug level (logging level) to be specified in the - smb.conf file. This parameter has been - extended since the 2.2.x series, now it allow to specify the debug - level for multiple debug classes. This is to give greater - flexibility in the configuration of the system.

      The default will be the log level specified on - the command line or level zero if none was specified.

      Example: log level = 3 passdb:5 auth:10 winbind:2 -

      logon drive (G)

      This parameter specifies the local path to - which the home directory will be connected (see logon home) - and is only used by NT Workstations.

      Note that this option is only useful if Samba is set up as a - logon server.

      Default: logon drive = z:

      Example: logon drive = h:

      logon home (G)

      This parameter specifies the home directory - location when a Win95/98 or NT Workstation logs into a Samba PDC. - It allows you to do

      C:\> NET USE H: /HOME -

      from a command prompt, for example.

      This option takes the standard substitutions, allowing - you to have separate logon scripts for each user or machine.

      This parameter can be used with Win9X workstations to ensure - that roaming profiles are stored in a subdirectory of the user's - home directory. This is done in the following way:

      logon home = \\%N\%U\profile

      This tells Samba to return the above string, with - substitutions made when a client requests the info, generally - in a NetUserGetInfo request. Win9X clients truncate the info to - \\server\share when a user does net use /home - but use the whole string when dealing with profiles.

      Note that in prior versions of Samba, the logon path was returned rather than - logon home. This broke net use - /home but allowed profiles outside the home directory. - The current implementation is correct, and can be used for - profiles if you use the above trick.

      This option is only useful if Samba is set up as a logon - server.

      Default: logon home = "\\%N\%U"

      Example: logon home = "\\remote_smb_server\%U" -

      logon path (G)

      This parameter specifies the home directory - where roaming profiles (NTuser.dat etc files for Windows NT) are - stored. Contrary to previous versions of these manual pages, it has - nothing to do with Win 9X roaming profiles. To find out how to - handle roaming profiles for Win 9X system, see the logon home parameter.

      This option takes the standard substitutions, allowing you - to have separate logon scripts for each user or machine. It also - specifies the directory from which the "Application Data", - (desktop, start menu, - network neighborhood, programs - and other folders, and their contents, are loaded and displayed on - your Windows NT client.

      The share and the path must be readable by the user for - the preferences and directories to be loaded onto the Windows NT - client. The share must be writeable when the user logs in for the first - time, in order that the Windows NT client can create the NTuser.dat - and other directories.

      Thereafter, the directories and any of the contents can, - if required, be made read-only. It is not advisable that the - NTuser.dat file be made read-only - rename it to NTuser.man to - achieve the desired effect (a MANdatory - profile).

      Windows clients can sometimes maintain a connection to - the [homes] share, even though there is no user logged in. - Therefore, it is vital that the logon path does not include a - reference to the homes share (i.e. setting this parameter to - \%N\%U\profile_path will cause problems).

      This option takes the standard substitutions, allowing - you to have separate logon scripts for each user or machine.

      Note that this option is only useful if Samba is set up - as a logon server.

      Default: logon path = \\%N\%U\profile

      Example: logon path = \\PROFILESERVER\PROFILE\%U

      logon script (G)

      This parameter specifies the batch file (.bat) or - NT command file (.cmd) to be downloaded and run on a machine when - a user successfully logs in. The file must contain the DOS - style CR/LF line endings. Using a DOS-style editor to create the - file is recommended.

      The script must be a relative path to the [netlogon] - service. If the [netlogon] service specifies a path of /usr/local/samba/netlogon - , and logon script = STARTUP.BAT, then - the file that will be downloaded is:

      /usr/local/samba/netlogon/STARTUP.BAT

      The contents of the batch file are entirely your choice. A - suggested command would be to add NET TIME \\SERVER /SET - /YES, to force every machine to synchronize clocks with - the same time server. Another use would be to add NET USE - U: \\SERVER\UTILS for commonly used utilities, or NET USE Q: \\SERVER\ISO9001_QA for example.

      Note that it is particularly important not to allow write - access to the [netlogon] share, or to grant users write permission - on the batch files in a secure environment, as this would allow - the batch files to be arbitrarily modified and security to be - breached.

      This option takes the standard substitutions, allowing you - to have separate logon scripts for each user or machine.

      This option is only useful if Samba is set up as a logon - server.

      Default: no logon script defined

      Example: logon script = scripts\%U.bat

      lppause command (S)

      This parameter specifies the command to be - executed on the server host in order to stop printing or spooling - a specific print job.

      This command should be a program or script which takes - a printer name and job number to pause the print job. One way - of implementing this is by using job priorities, where jobs - having a too low priority won't be sent to the printer.

      If a %p is given then the printer name - is put in its place. A %j is replaced with - the job number (an integer). On HPUX (see printing=hpux - ), if the -p%p option is added - to the lpq command, the job will show up with the correct status, i.e. - if the job priority is lower than the set fence priority it will - have the PAUSED status, whereas if the priority is equal or higher it - will have the SPOOLED or PRINTING status.

      Note that it is good practice to include the absolute path - in the lppause command as the PATH may not be available to the server.

      See also the printing - parameter.

      Default: Currently no default value is given to - this string, unless the value of the printing - parameter is SYSV, in which case the default is :

      lp -i %p-%j -H hold

      or if the value of the printing parameter - is SOFTQ, then the default is:

      qstat -s -j%j -h

      Example for HPUX: lppause command = /usr/bin/lpalt - %p-%j -p0

      lpq cache time (G)

      This controls how long lpq info will be cached - for to prevent the lpq command being called too - often. A separate cache is kept for each variation of the lpq command used by the system, so if you use different - lpq commands for different users then they won't - share cache information.

      The cache files are stored in /tmp/lpq.xxxx - where xxxx is a hash of the lpq command in use.

      The default is 10 seconds, meaning that the cached results - of a previous identical lpq command will be used - if the cached data is less than 10 seconds old. A large value may - be advisable if your lpq command is very slow.

      A value of 0 will disable caching completely.

      See also the printing - parameter.

      Default: lpq cache time = 10

      Example: lpq cache time = 30

      lpq command (S)

      This parameter specifies the command to be - executed on the server host in order to obtain lpq - -style printer status information.

      This command should be a program or script which - takes a printer name as its only parameter and outputs printer - status information.

      Currently nine styles of printer status information - are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. - This covers most UNIX systems. You control which type is expected - using the printing = option.

      Some clients (notably Windows for Workgroups) may not - correctly send the connection number for the printer they are - requesting status information about. To get around this, the - server reports on the first printer service connected to by the - client. This only happens if the connection number sent is invalid.

      If a %p is given then the printer name - is put in its place. Otherwise it is placed at the end of the - command.

      Note that it is good practice to include the absolute path - in the lpq command as the $PATH - may not be available to the server. When compiled with - the CUPS libraries, no lpq command is - needed because smbd will make a library call to obtain the - print queue listing.

      See also the printing - parameter.

      Default: depends on the setting of printing

      Example: lpq command = /usr/bin/lpq -P%p

      lpresume command (S)

      This parameter specifies the command to be - executed on the server host in order to restart or continue - printing or spooling a specific print job.

      This command should be a program or script which takes - a printer name and job number to resume the print job. See - also the lppause command - parameter.

      If a %p is given then the printer name - is put in its place. A %j is replaced with - the job number (an integer).

      Note that it is good practice to include the absolute path - in the lpresume command as the PATH may not - be available to the server.

      See also the printing - parameter.

      Default: Currently no default value is given - to this string, unless the value of the printing - parameter is SYSV, in which case the default is :

      lp -i %p-%j -H resume

      or if the value of the printing parameter - is SOFTQ, then the default is:

      qstat -s -j%j -r

      Example for HPUX: lpresume command = /usr/bin/lpalt - %p-%j -p2

      lprm command (S)

      This parameter specifies the command to be - executed on the server host in order to delete a print job.

      This command should be a program or script which takes - a printer name and job number, and deletes the print job.

      If a %p is given then the printer name - is put in its place. A %j is replaced with - the job number (an integer).

      Note that it is good practice to include the absolute - path in the lprm command as the PATH may not be - available to the server.

      See also the printing - parameter.

      Default: depends on the setting of printing -

      Example 1: lprm command = /usr/bin/lprm -P%p %j -

      Example 2: lprm command = /usr/bin/cancel %p-%j -

      machine password timeout (G)

      If a Samba server is a member of a Windows - NT Domain (see the security = domain) - parameter) then periodically a running smbd(8) process will try and change the MACHINE ACCOUNT - PASSWORD stored in the TDB called private/secrets.tdb - . This parameter specifies how often this password - will be changed, in seconds. The default is one week (expressed in - seconds), the same as a Windows NT Domain member server.

      See also smbpasswd(8) - , and the security = domain) parameter.

      Default: machine password timeout = 604800

      magic output (S)

      This parameter specifies the name of a file - which will contain output created by a magic script (see the - magic script - parameter below).

      Warning: If two clients use the same magic script - in the same directory the output file content - is undefined.

      Default: magic output = <magic script name>.out -

      Example: magic output = myfile.txt

      magic script (S)

      This parameter specifies the name of a file which, - if opened, will be executed by the server when the file is closed. - This allows a UNIX script to be sent to the Samba host and - executed on behalf of the connected user.

      Scripts executed in this way will be deleted upon - completion assuming that the user has the appropriate level - of privilege and the file permissions allow the deletion.

      If the script generates output, output will be sent to - the file specified by the magic output parameter (see above).

      Note that some shells are unable to interpret scripts - containing CR/LF instead of CR as - the end-of-line marker. Magic scripts must be executable - as is on the host, which for some hosts and - some shells will require filtering at the DOS end.

      Magic scripts are EXPERIMENTAL and - should NOT be relied upon.

      Default: None. Magic scripts disabled.

      Example: magic script = user.csh

      mangle case (S)

      See the section on NAME MANGLING

      Default: mangle case = no

      mangled map (S)

      This is for those who want to directly map UNIX - file names which cannot be represented on Windows/DOS. The mangling - of names is not always what is needed. In particular you may have - documents with file extensions that differ between DOS and UNIX. - For example, under UNIX it is common to use .html - for HTML files, whereas under Windows/DOS .htm - is more commonly used.

      So to map html to htm - you would use:

      mangled map = (*.html *.htm)

      One very useful case is to remove the annoying ;1 - off the ends of filenames on some CDROMs (only visible - under some UNIXes). To do this use a map of (*;1 *;).

      Default: no mangled map

      Example: mangled map = (*;1 *;)

      mangled names (S)

      This controls whether non-DOS names under UNIX - should be mapped to DOS-compatible names ("mangled") and made visible, - or whether non-DOS names should simply be ignored.

      See the section on NAME MANGLING for details on how to control the mangling process.

      If mangling is used then the mangling algorithm is as follows:

      • The first (up to) five alphanumeric characters - before the rightmost dot of the filename are preserved, forced - to upper case, and appear as the first (up to) five characters - of the mangled name.

      • A tilde "~" is appended to the first part of the mangled - name, followed by a two-character unique sequence, based on the - original root name (i.e., the original filename minus its final - extension). The final extension is included in the hash calculation - only if it contains any upper case characters or is longer than three - characters.

        Note that the character to use may be specified using - the mangling char - option, if you don't like '~'.

      • The first three alphanumeric characters of the final - extension are preserved, forced to upper case and appear as the - extension of the mangled name. The final extension is defined as that - part of the original filename after the rightmost dot. If there are no - dots in the filename, the mangled name will have no extension (except - in the case of "hidden files" - see below).

      • Files whose UNIX name begins with a dot will be - presented as DOS hidden files. The mangled name will be created as - for other filenames, but with the leading dot removed and "___" as - its extension regardless of actual original extension (that's three - underscores).

      The two-digit hash value consists of upper case - alphanumeric characters.

      This algorithm can cause name collisions only if files - in a directory share the same first five alphanumeric characters. - The probability of such a clash is 1/1300.

      The name mangling (if enabled) allows a file to be - copied between UNIX directories from Windows/DOS while retaining - the long UNIX filename. UNIX files can be renamed to a new extension - from Windows/DOS and will retain the same basename. Mangled names - do not change between sessions.

      Default: mangled names = yes

      mangling method (G)

      controls the algorithm used for the generating - the mangled names. Can take two different values, "hash" and - "hash2". "hash" is the default and is the algorithm that has been - used in Samba for many years. "hash2" is a newer and considered - a better algorithm (generates less collisions) in the names. - However, many Win32 applications store the mangled names and so - changing to the new algorithm must not be done - lightly as these applications may break unless reinstalled.

      Default: mangling method = hash2

      Example: mangling method = hash

      mangle prefix (G)

      controls the number of prefix - characters from the original name used when generating - the mangled names. A larger value will give a weaker - hash and therefore more name collisions. The minimum - value is 1 and the maximum value is 6.

      Default: mangle prefix = 1

      Example: mangle prefix = 4

      mangled stack (G)

      This parameter controls the number of mangled names - that should be cached in the Samba server smbd(8).

      This stack is a list of recently mangled base names - (extensions are only maintained if they are longer than 3 characters - or contains upper case characters).

      The larger this value, the more likely it is that mangled - names can be successfully converted to correct long UNIX names. - However, large stack sizes will slow most directory accesses. Smaller - stacks save memory in the server (each stack element costs 256 bytes). -

      It is not possible to absolutely guarantee correct long - filenames, so be prepared for some surprises!

      Default: mangled stack = 50

      Example: mangled stack = 100

      mangling char (S)

      This controls what character is used as - the magic character in name mangling. The default is a '~' - but this may interfere with some software. Use this option to set - it to whatever you prefer.

      Default: mangling char = ~

      Example: mangling char = ^

      map archive (S)

      This controls whether the DOS archive attribute - should be mapped to the UNIX owner execute bit. The DOS archive bit - is set when a file has been modified since its last backup. One - motivation for this option it to keep Samba/your PC from making - any file it touches from becoming executable under UNIX. This can - be quite annoying for shared source code, documents, etc...

      Note that this requires the create mask - parameter to be set such that owner execute bit is not masked out - (i.e. it must include 100). See the parameter create mask for details.

      Default: map archive = yes

      map hidden (S)

      This controls whether DOS style hidden files - should be mapped to the UNIX world execute bit.

      Note that this requires the create mask - to be set such that the world execute bit is not masked out (i.e. - it must include 001). See the parameter create mask for details.

      Default: map hidden = no

      map system (S)

      This controls whether DOS style system files - should be mapped to the UNIX group execute bit.

      Note that this requires the create mask - to be set such that the group execute bit is not masked out (i.e. - it must include 010). See the parameter create mask for details.

      Default: map system = no

      map to guest (G)

      This parameter is only useful in security modes other than security = share - - i.e. user, server, - and domain.

      This parameter can take three different values, which tell - smbd(8) what to do with user - login requests that don't match a valid UNIX user in some way.

      The three settings are :

      • Never - Means user login - requests with an invalid password are rejected. This is the - default.

      • Bad User - Means user - logins with an invalid password are rejected, unless the username - does not exist, in which case it is treated as a guest login and - mapped into the guest account.

      • Bad Password - Means user logins - with an invalid password are treated as a guest login and mapped - into the guest account. Note that - this can cause problems as it means that any user incorrectly typing - their password will be silently logged on as "guest" - and - will not know the reason they cannot access files they think - they should - there will have been no message given to them - that they got their password wrong. Helpdesk services will - hate you if you set the map to - guest parameter this way :-).

      Note that this parameter is needed to set up "Guest" - share services when using security modes other than - share. This is because in these modes the name of the resource being - requested is not sent to the server until after - the server has successfully authenticated the client so the server - cannot make authentication decisions at the correct time (connection - to the share) for "Guest" shares.

      For people familiar with the older Samba releases, this - parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.

      Default: map to guest = Never

      Example: map to guest = Bad User

      max connections (S)

      This option allows the number of simultaneous - connections to a service to be limited. If max connections - is greater than 0 then connections will be refused if - this number of connections to the service are already open. A value - of zero mean an unlimited number of connections may be made.

      Record lock files are used to implement this feature. The - lock files will be stored in the directory specified by the lock directory - option.

      Default: max connections = 0

      Example: max connections = 10

      max disk size (G)

      This option allows you to put an upper limit - on the apparent size of disks. If you set this option to 100 - then all shares will appear to be not larger than 100 MB in - size.

      Note that this option does not limit the amount of - data you can put on the disk. In the above case you could still - store much more than 100 MB on the disk, but if a client ever asks - for the amount of free disk space or the total disk size then the - result will be bounded by the amount specified in max - disk size.

      This option is primarily useful to work around bugs - in some pieces of software that can't handle very large disks, - particularly disks over 1GB in size.

      A max disk size of 0 means no limit.

      Default: max disk size = 0

      Example: max disk size = 1000

      max log size (G)

      This option (an integer in kilobytes) specifies - the max size the log file should grow to. Samba periodically checks - the size and if it is exceeded it will rename the file, adding - a .old extension.

      A size of 0 means no limit.

      Default: max log size = 5000

      Example: max log size = 1000

      max mux (G)

      This option controls the maximum number of - outstanding simultaneous SMB operations that Samba tells the client - it will allow. You should never need to set this parameter.

      Default: max mux = 50

      max open files (G)

      This parameter limits the maximum number of - open files that one smbd(8) file - serving process may have open for a client at any one time. The - default for this parameter is set very high (10,000) as Samba uses - only one bit per unopened file.

      The limit of the number of open files is usually set - by the UNIX per-process file descriptor limit rather than - this parameter so you should never need to touch this parameter.

      Default: max open files = 10000

      max print jobs (S)

      This parameter limits the maximum number of - jobs allowable in a Samba printer queue at any given moment. - If this number is exceeded, smbd(8) will remote "Out of Space" to the client. - See all total - print jobs. -

      Default: max print jobs = 1000

      Example: max print jobs = 5000

      max protocol (G)

      The value of the parameter (a string) is the highest - protocol level that will be supported by the server.

      Possible values are :

      • CORE: Earliest version. No - concept of user names.

      • COREPLUS: Slight improvements on - CORE for efficiency.

      • LANMAN1: First modern version of the protocol. Long filename - support.

      • LANMAN2: Updates to Lanman1 protocol. -

      • NT1: Current up to date version of - the protocol. Used by Windows NT. Known as CIFS.

      Normally this option should not be set as the automatic - negotiation phase in the SMB protocol takes care of choosing - the appropriate protocol.

      See also min - protocol

      Default: max protocol = NT1

      Example: max protocol = LANMAN1

      max smbd processes (G)

      This parameter limits the maximum number of - smbd(8) - processes concurrently running on a system and is intended - as a stopgap to prevent degrading service to clients in the event - that the server has insufficient resources to handle more than this - number of connections. Remember that under normal operating - conditions, each user will have an smbd associated with him or her - to handle connections to all shares from a given host. -

      Default: max smbd processes = 0 ## no limit

      Example: max smbd processes = 1000

      max ttl (G)

      This option tells nmbd(8) - what the default 'time to live' of NetBIOS names should be (in seconds) - when nmbd is requesting a name using either a - broadcast packet or from a WINS server. You should never need to - change this parameter. The default is 3 days.

      Default: max ttl = 259200

      max wins ttl (G)

      This option tells nmbd(8) - when acting as a WINS server ( wins support = yes) what the maximum - 'time to live' of NetBIOS names that nmbd - will grant will be (in seconds). You should never need to change this - parameter. The default is 6 days (518400 seconds).

      See also the min - wins ttl parameter.

      Default: max wins ttl = 518400

      max xmit (G)

      This option controls the maximum packet size - that will be negotiated by Samba. The default is 65535, which - is the maximum. In some cases you may find you get better performance - with a smaller value. A value below 2048 is likely to cause problems. -

      Default: max xmit = 65535

      Example: max xmit = 8192

      message command (G)

      This specifies what command to run when the - server receives a WinPopup style message.

      This would normally be a command that would - deliver the message somehow. How this is to be done is - up to your imagination.

      An example is:

      message command = csh -c 'xedit %s;rm %s' & -

      This delivers the message using xedit, then - removes it afterwards. NOTE THAT IT IS VERY IMPORTANT - THAT THIS COMMAND RETURN IMMEDIATELY. That's why I - have the '&' on the end. If it doesn't return immediately then - your PCs may freeze when sending messages (they should recover - after 30 seconds, hopefully).

      All messages are delivered as the global guest user. - The command takes the standard substitutions, although %u won't work (%U may be better - in this case).

      Apart from the standard substitutions, some additional - ones apply. In particular:

      • %s = the filename containing - the message.

      • %t = the destination that - the message was sent to (probably the server name).

      • %f = who the message - is from.

      You could make this command send mail, or whatever else - takes your fancy. Please let us know of any really interesting - ideas you have.

      Here's a way of sending the messages as mail to root:

      message command = /bin/mail -s 'message from %f on - %m' root < %s; rm %s

      If you don't have a message command then the message - won't be delivered and Samba will tell the sender there was - an error. Unfortunately WfWg totally ignores the error code - and carries on regardless, saying that the message was delivered. -

      If you want to silently delete it then try:

      message command = rm %s

      Default: no message command

      Example: message command = csh -c 'xedit %s; - rm %s' &

      min passwd length (G)

      Synonym for min password length.

      min password length (G)

      This option sets the minimum length in characters - of a plaintext password that smbd will accept when performing - UNIX password changing.

      See also unix - password sync, passwd program and passwd chat debug - .

      Default: min password length = 5

      min print space (S)

      This sets the minimum amount of free disk - space that must be available before a user will be able to spool - a print job. It is specified in kilobytes. The default is 0, which - means a user can always spool a print job.

      See also the printing - parameter.

      Default: min print space = 0

      Example: min print space = 2000

      min protocol (G)

      The value of the parameter (a string) is the - lowest SMB protocol dialect than Samba will support. Please refer - to the max protocol - parameter for a list of valid protocol names and a brief description - of each. You may also wish to refer to the C source code in - source/smbd/negprot.c for a listing of known protocol - dialects supported by clients.

      If you are viewing this parameter as a security measure, you should - also refer to the lanman - auth parameter. Otherwise, you should never need - to change this parameter.

      Default : min protocol = CORE

      Example : min protocol = NT1 # disable DOS - clients

      min wins ttl (G)

      This option tells nmbd(8) - when acting as a WINS server ( wins support = yes) what the minimum 'time to live' - of NetBIOS names that nmbd will grant will be (in - seconds). You should never need to change this parameter. The default - is 6 hours (21600 seconds).

      Default: min wins ttl = 21600

      msdfs proxy (S)

      This parameter indicates that the share is a - stand-in for another CIFS share whose location is specified by - the value of the parameter. When clients attempt to connect to - this share, they are redirected to the proxied share using - the SMB-Dfs protocol.

      Only Dfs roots can act as proxy shares. Take a look at the - msdfs root - and - host msdfs - options to find out how to set up a Dfs root share.

      Example: msdfs proxy = \otherserver\someshare

      msdfs root (S)

      This boolean parameter is only available if - Samba is configured and compiled with the --with-msdfs option. If set to yes, - Samba treats the share as a Dfs root and allows clients to browse - the distributed file system tree rooted at the share directory. - Dfs links are specified in the share directory by symbolic - links of the form msdfs:serverA\shareA,serverB\shareB - and so on. For more information on setting up a Dfs tree - on Samba, refer to msdfs_setup.html - .

      See also host msdfs -

      Default: msdfs root = no

      name cache timeout (G)

      Specifies the number of seconds it takes before - entries in samba's hostname resolve cache time out. If - the timeout is set to 0. the caching is disabled. -

      Default: name cache timeout = 660

      Example: name cache timeout = 0

      name resolve order (G)

      This option is used by the programs in the Samba - suite to determine what naming services to use and in what order - to resolve host names to IP addresses. The option takes a space - separated string of name resolution options.

      The options are :"lmhosts", "host", "wins" and "bcast". They - cause names to be resolved as follows :

      • lmhosts : Lookup an IP - address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see the lmhosts(5) for details) then - any name type matches for lookup.

      • host : Do a standard host - name to IP address resolution, using the system /etc/hosts - , NIS, or DNS lookups. This method of name resolution - is operating system depended for instance on IRIX or Solaris this - may be controlled by the /etc/nsswitch.conf - file. Note that this method is only used if the NetBIOS name - type being queried is the 0x20 (server) name type, otherwise - it is ignored.

      • wins : Query a name with - the IP address listed in the wins server parameter. If no WINS server has - been specified this method will be ignored.

      • bcast : Do a broadcast on - each of the known local interfaces listed in the interfaces - parameter. This is the least reliable of the name resolution - methods as it depends on the target host being on a locally - connected subnet.

      Default: name resolve order = lmhosts host wins bcast -

      Example: name resolve order = lmhosts bcast host -

      This will cause the local lmhosts file to be examined - first, followed by a broadcast attempt, followed by a normal - system hostname lookup.

      netbios aliases (G)

      This is a list of NetBIOS names that nmbd(8) will advertise as additional - names by which the Samba server is known. This allows one machine - to appear in browse lists under multiple names. If a machine is - acting as a browse server or logon server none - of these names will be advertised as either browse server or logon - servers, only the primary name of the machine will be advertised - with these capabilities.

      See also netbios - name.

      Default: empty string (no additional names)

      Example: netbios aliases = TEST TEST1 TEST2

      netbios name (G)

      This sets the NetBIOS name by which a Samba - server is known. By default it is the same as the first component - of the host's DNS name. If a machine is a browse server or - logon server this name (or the first component - of the hosts DNS name) will be the name that these services are - advertised under.

      See also netbios - aliases.

      Default: machine DNS name

      Example: netbios name = MYNAME

      netbios scope (G)

      This sets the NetBIOS scope that Samba will - operate under. This should not be set unless every machine - on your LAN also sets this value.

      nis homedir (G)

      Get the home share server from a NIS map. For - UNIX systems that use an automounter, the user's home directory - will often be mounted on a workstation on demand from a remote - server.

      When the Samba logon server is not the actual home directory - server, but is mounting the home directories via NFS then two - network hops would be required to access the users home directory - if the logon server told the client to use itself as the SMB server - for home directories (one over SMB and one over NFS). This can - be very slow.

      This option allows Samba to return the home share as - being on a different server to the logon server and as - long as a Samba daemon is running on the home directory server, - it will be mounted on the Samba client directly from the directory - server. When Samba is returning the home share to the client, it - will consult the NIS map specified in homedir map and return the server - listed there.

      Note that for this option to work there must be a working - NIS system and the Samba server with this option must also - be a logon server.

      Default: nis homedir = no

      non unix account range (G)

      The non unix account range parameter specifies - the range of 'user ids' that are allocated by the various 'non unix - account' passdb backends. These backends allow - the storage of passwords for users who don't exist in /etc/passwd. - This is most often used for machine account creation. - This range of ids should have no existing local or NIS users within - it as strange conflicts can occur otherwise.

      NOTE: These userids never appear on the system and Samba will never - 'become' these users. They are used only to ensure that the algorithmic - RID mapping does not conflict with normal users. -

      Default: non unix account range = <empty string> -

      Example: non unix account range = 10000-20000

      nt acl support (S)

      This boolean parameter controls whether - smbd(8) will attempt to map - UNIX permissions into Windows NT access control lists. - This parameter was formally a global parameter in releases - prior to 2.2.2.

      Default: nt acl support = yes

      nt pipe support (G)

      This boolean parameter controls whether - smbd(8) will allow Windows NT - clients to connect to the NT SMB specific IPC$ - pipes. This is a developer debugging option and can be left - alone.

      Default: nt pipe support = yes

      nt status support (G)

      This boolean parameter controls whether smbd(8) will negotiate NT specific status - support with Windows NT/2k/XP clients. This is a developer - debugging option and should be left alone. - If this option is set to no then Samba offers - exactly the same DOS error codes that versions prior to Samba 2.2.3 - reported.

      You should not need to ever disable this parameter.

      Default: nt status support = yes

      null passwords (G)

      Allow or disallow client access to accounts - that have null passwords.

      See also smbpasswd (5).

      Default: null passwords = no

      obey pam restrictions (G)

      When Samba 2.2 is configured to enable PAM support - (i.e. --with-pam), this parameter will control whether or not Samba - should obey PAM's account and session management directives. The - default behavior is to use PAM for clear text authentication only - and to ignore any account or session management. Note that Samba - always ignores PAM for authentication in the case of encrypt passwords = yes - . The reason is that PAM modules cannot support the challenge/response - authentication mechanism needed in the presence of SMB password encryption. -

      Default: obey pam restrictions = no

      only user (S)

      This is a boolean option that controls whether - connections with usernames not in the user - list will be allowed. By default this option is disabled so that a - client can supply a username to be used by the server. Enabling - this parameter will force the server to only use the login - names from the user list and is only really - useful in share level - security.

      Note that this also means Samba won't try to deduce - usernames from the service name. This can be annoying for - the [homes] section. To get around this you could use user = - %S which means your user list - will be just the service name, which for home directories is the - name of the user.

      See also the user - parameter.

      Default: only user = no

      only guest (S)

      A synonym for guest only.

      oplock break wait time (G)

      This is a tuning parameter added due to bugs in - both Windows 9x and WinNT. If Samba responds to a client too - quickly when that client issues an SMB that can cause an oplock - break request, then the network client can fail and not respond - to the break request. This tuning parameter (which is set in milliseconds) - is the amount of time Samba will wait before sending an oplock break - request to such (broken) clients.

      DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ - AND UNDERSTOOD THE SAMBA OPLOCK CODE.

      Default: oplock break wait time = 0

      oplock contention limit (S)

      This is a very advanced - smbd(8) tuning option to - improve the efficiency of the granting of oplocks under multiple - client contention for the same file.

      In brief it specifies a number, which causes smbd not to - grant an oplock even when requested if the approximate number of - clients contending for an oplock on the same file goes over this - limit. This causes smbd to behave in a similar - way to Windows NT.

      DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ - AND UNDERSTOOD THE SAMBA OPLOCK CODE.

      Default: oplock contention limit = 2

      oplocks (S)

      This boolean option tells smbd whether to - issue oplocks (opportunistic locks) to file open requests on this - share. The oplock code can dramatically (approx. 30% or more) improve - the speed of access to files on Samba servers. It allows the clients - to aggressively cache files locally and you may want to disable this - option for unreliable network environments (it is turned on by - default in Windows NT Servers). For more information see the file - Speed.txt in the Samba docs/ - directory.

      Oplocks may be selectively turned off on certain files with a - share. See the veto oplock files parameter. On some systems - oplocks are recognized by the underlying operating system. This - allows data synchronization between all access to oplocked files, - whether it be via Samba or NFS or a local UNIX process. See the - kernel oplocks parameter for details.

      See also the kernel - oplocks and level2 oplocks parameters.

      Default: oplocks = yes

      ntlm auth (G)

      This parameter determines whether or not smbd will - attempt to authenticate users using the NTLM password hash. - If disabled, only the lanman password hashes will be used. -

      Please note that at least this option or lanman auth should be enabled in order to be able to log in. -

      Default : ntlm auth = yes

      os level (G)

      This integer value controls what level Samba - advertises itself as for browse elections. The value of this - parameter determines whether nmbd(8) - has a chance of becoming a local master browser for the WORKGROUP in the local broadcast area.

      Note :By default, Samba will win - a local master browsing election over all Microsoft operating - systems except a Windows NT 4.0/2000 Domain Controller. This - means that a misconfigured Samba host can effectively isolate - a subnet for browsing purposes. See BROWSING.txt - in the Samba docs/ directory - for details.

      Default: os level = 20

      Example: os level = 65

      os2 driver map (G)

      The parameter is used to define the absolute - path to a file containing a mapping of Windows NT printer driver - names to OS/2 printer driver names. The format is:

      <nt driver name> = <os2 driver - name>.<device name>

      For example, a valid entry using the HP LaserJet 5 - printer driver would appear as HP LaserJet 5L = LASERJET.HP - LaserJet 5L.

      The need for the file is due to the printer driver namespace - problem described in the Samba - Printing HOWTO. For more details on OS/2 clients, please - refer to the OS2-Client-HOWTO - containing in the Samba documentation.

      Default: os2 driver map = <empty string> -

      pam password change (G)

      With the addition of better PAM support in Samba 2.2, - this parameter, it is possible to use PAM's password change control - flag for Samba. If enabled, then PAM will be used for password - changes when requested by an SMB client instead of the program listed in - passwd program. - It should be possible to enable this without changing your - passwd chat - parameter for most setups. -

      Default: pam password change = no

      panic action (G)

      This is a Samba developer option that allows a - system command to be called when either smbd(8) or nmbd(8) - crashes. This is usually used to draw attention to the fact that - a problem occurred.

      Default: panic action = <empty string>

      Example: panic action = "/bin/sleep 90000"

      paranoid server security (G)

      Some version of NT 4.x allow non-guest - users with a bad passowrd. When this option is enabled, samba will not - use a broken NT 4.x server as password server, but instead complain - to the logs and exit. -

      Default: paranoid server security = yes

      passdb backend (G)

      This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both - smbpasswd and tdbsam to be used without a recompile. - Multiple backends can be specified, separated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified. - Experimental backends must still be selected - (eg --with-tdbsam) at configure time. -

      This parameter is in two parts, the backend's name, and a 'location' - string that has meaning only to that particular backed. These are separated - by a : character.

      Available backends can include: -

      • smbpasswd - The default smbpasswd - backend. Takes a path to the smbpasswd file as an optional argument.

      • smbpasswd_nua - The smbpasswd - backend, but with support for 'not unix accounts'. - Takes a path to the smbpasswd file as an optional argument.

        See also non unix account range

      • tdbsam - The TDB based password storage - backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb - in the private dir directory.

      • tdbsam_nua - The TDB based password storage - backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb - in the private dir directory.

        See also non unix account range

      • ldapsam - The LDAP based passdb - backend. Takes an LDAP URL as an optional argument (defaults to - ldap://localhost)

      • ldapsam_nua - The LDAP based passdb - backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to - ldap://localhost)

        Note: In this module, any account without a matching POSIX account is regarded - as 'non unix'.

        See also non unix account - range

        LDAP connections should be secured where - possible. This may be done using either - Start-TLS (see ldap ssl) or by - specifying ldaps:// in - the URL argument. -

      • nisplussam - The NIS+ based passdb backend. Takes name NIS domain as an optional argument. Only works with sun NIS+ servers.

      • plugin - Allows Samba to load an - arbitary passdb backend from the .so specified as a compulsary argument. -

        Any characters after the (optional) second : are passed to the plugin - for its own processing

      • unixsam - (EXPERIMENTAL) Allows samba to map all (other) available unix users

        This backend uses the standard unix database for retrieving users. Users included - in this pdb are NOT listed in samba user listings and users included in this pdb won't be - able to login. The use of this backend is to always be able to display the owner of a file - on the samba server - even when the user doesn't have a 'real' samba account in one of the - other passdb backends. -

        This backend should always be the last backend listed, since it contains all users in - the unix passdb and might 'override' mappings if specified earlier. It's meant to only return - accounts for users that aren't covered by the previous backends.

      -

      Default: passdb backend = smbpasswd guest

      Example: passdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd

      Example: passdb backend = ldapsam_nua:ldaps://ldap.example.com

      Example: passdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb

      passwd chat (G)

      This string controls the "chat" - conversation that takes places between smbd and the local password changing - program to change the user's password. The string describes a - sequence of response-receive pairs that smbd(8) uses to determine what to send to the - passwd program - and what to expect back. If the expected output is not - received then the password is not changed.

      This chat sequence is often quite site specific, depending - on what local methods are used for password control (such as NIS - etc).

      Note that this parameter only is only used if the unix - password sync parameter is set to yes. This - sequence is then called AS ROOT when the SMB password - in the smbpasswd file is being changed, without access to the old - password cleartext. This means that root must be able to reset the user's password - without knowing the text of the previous password. In the presence of NIS/YP, - this means that the passwd program must be - executed on the NIS master. -

      The string can contain the macro %n which is substituted - for the new password. The chat sequence can also contain the standard - macros \n, \r, \t and \s to give line-feed, - carriage-return, tab and space. The chat sequence string can also contain - a '*' which matches any sequence of characters. - Double quotes can be used to collect strings with spaces - in them into a single string.

      If the send string in any part of the chat sequence - is a full stop ".", then no string is sent. Similarly, - if the expect string is a full stop then no string is expected.

      If the pam - password change parameter is set to yes, the chat pairs - may be matched in any order, and success is determined by the PAM result, - not any particular output. The \n macro is ignored for PAM conversions. -

      See also unix password - sync, passwd program , passwd chat debug and pam password change.

      Default: passwd chat = *new*password* %n\n - *new*password* %n\n *changed*

      Example: passwd chat = "*Enter OLD password*" %o\n - "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password - changed*"

      passwd chat debug (G)

      This boolean specifies if the passwd chat script - parameter is run in debug mode. In this mode the - strings passed to and received from the passwd chat are printed - in the smbd(8) log with a - debug level - of 100. This is a dangerous option as it will allow plaintext passwords - to be seen in the smbd log. It is available to help - Samba admins debug their passwd chat scripts - when calling the passwd program and should - be turned off after this has been done. This option has no effect if the - pam password change - paramter is set. This parameter is off by default.

      See also passwd chat - , pam password change - , passwd program - .

      Default: passwd chat debug = no

      passwd program (G)

      The name of a program that can be used to set - UNIX user passwords. Any occurrences of %u - will be replaced with the user name. The user name is checked for - existence before calling the password changing program.

      Also note that many passwd programs insist in reasonable - passwords, such as a minimum length, or the inclusion - of mixed case chars and digits. This can pose a problem as some clients - (such as Windows for Workgroups) uppercase the password before sending - it.

      Note that if the unix - password sync parameter is set to yes - then this program is called AS ROOT - before the SMB password in the smbpasswd(5) - file is changed. If this UNIX password change fails, then - smbd will fail to change the SMB password also - (this is by design).

      If the unix password sync parameter - is set this parameter MUST USE ABSOLUTE PATHS - for ALL programs called, and must be examined - for security implications. Note that by default unix - password sync is set to no.

      See also unix - password sync.

      Default: passwd program = /bin/passwd

      Example: passwd program = /sbin/npasswd %u -

      password level (G)

      Some client/server combinations have difficulty - with mixed-case passwords. One offending client is Windows for - Workgroups, which for some reason forces passwords to upper - case when using the LANMAN1 protocol, but leaves them alone when - using COREPLUS! Another problem child is the Windows 95/98 - family of operating systems. These clients upper case clear - text passwords even when NT LM 0.12 selected by the protocol - negotiation request/response.

      This parameter defines the maximum number of characters - that may be upper case in passwords.

      For example, say the password given was "FRED". If password level is set to 1, the following combinations - would be tried if "FRED" failed:

      "Fred", "fred", "fRed", "frEd","freD"

      If password level was set to 2, - the following combinations would also be tried:

      "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..

      And so on.

      The higher value this parameter is set to the more likely - it is that a mixed case password will be matched against a single - case password. However, you should be aware that use of this - parameter reduces security and increases the time taken to - process a new connection.

      A value of zero will cause only two attempts to be - made - the password as is and the password in all-lower case.

      Default: password level = 0

      Example: password level = 4

      password server (G)

      By specifying the name of another SMB server (such - as a WinNT box) with this option, and using security = domain - or security = server you can get Samba - to do all its username/password validation via a remote server.

      This option sets the name of the password server to use. - It must be a NetBIOS name, so if the machine's NetBIOS name is - different from its Internet name then you may have to add its NetBIOS - name to the lmhosts file which is stored in the same directory - as the smb.conf file.

      The name of the password server is looked up using the - parameter name - resolve order and so may resolved - by any method and order described in that parameter.

      The password server must be a machine capable of using - the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in - user level security mode.

      NOTE: Using a password server - means your UNIX box (running Samba) is only as secure as your - password server. DO NOT CHOOSE A PASSWORD SERVER THAT - YOU DON'T COMPLETELY TRUST.

      Never point a Samba server at itself for password - serving. This will cause a loop and could lock up your Samba - server!

      The name of the password server takes the standard - substitutions, but probably the only useful one is %m - , which means the Samba server will use the incoming - client as the password server. If you use this then you better - trust your clients, and you had better restrict them with hosts allow!

      If the security parameter is set to - domain, then the list of machines in this - option must be a list of Primary or Backup Domain controllers for the - Domain or the character '*', as the Samba server is effectively - in that domain, and will use cryptographically authenticated RPC calls - to authenticate the user logging on. The advantage of using security = domain is that if you list several hosts in the - password server option then smbd - will try each in turn till it finds one that responds. This - is useful in case your primary server goes down.

      If the password server option is set - to the character '*', then Samba will attempt to auto-locate the - Primary or Backup Domain controllers to authenticate against by - doing a query for the name WORKGROUP<1C> - and then contacting each server returned in the list of IP - addresses from the name resolution source.

      If the list of servers contains both names and the '*' - character, the list is treated as a list of preferred - domain controllers, but an auto lookup of all remaining DC's - will be added to the list as well. Samba will not attempt to optimize - this list by locating the closest DC.

      If the security parameter is - set to server, then there are different - restrictions that security = domain doesn't - suffer from:

      • You may list several password servers in - the password server parameter, however if an - smbd makes a connection to a password server, - and then the password server fails, no more users will be able - to be authenticated from this smbd. This is a - restriction of the SMB/CIFS protocol when in security = server - mode and cannot be fixed in Samba.

      • If you are using a Windows NT server as your - password server then you will have to ensure that your users - are able to login from the Samba server, as when in security = server mode the network logon will appear to - come from there rather than from the users workstation.

      See also the security - parameter.

      Default: password server = <empty string> -

      Example: password server = NT-PDC, NT-BDC1, NT-BDC2, * -

      Example: password server = *

      path (S)

      This parameter specifies a directory to which - the user of the service is to be given access. In the case of - printable services, this is where print data will spool prior to - being submitted to the host for printing.

      For a printable service offering guest access, the service - should be readonly and the path should be world-writeable and - have the sticky bit set. This is not mandatory of course, but - you probably won't get the results you expect if you do - otherwise.

      Any occurrences of %u in the path - will be replaced with the UNIX username that the client is using - on this connection. Any occurrences of %m - will be replaced by the NetBIOS name of the machine they are - connecting from. These replacements are very useful for setting - up pseudo home directories for users.

      Note that this path will be based on root dir if one was specified.

      Default: none

      Example: path = /home/fred

      pid directory (G)

      This option specifies the directory where pid - files will be placed.

      Default: pid directory = ${prefix}/var/locks

      Example: pid directory = /var/run/ -

      posix locking (S)

      The smbd(8) - daemon maintains an database of file locks obtained by SMB clients. - The default behavior is to map this internal database to POSIX - locks. This means that file locks obtained by SMB clients are - consistent with those seen by POSIX compliant applications accessing - the files via a non-SMB method (e.g. NFS or local file access). - You should never need to disable this parameter.

      Default: posix locking = yes

      postexec (S)

      This option specifies a command to be run - whenever the service is disconnected. It takes the usual - substitutions. The command may be run as the root on some - systems.

      An interesting example may be to unmount server - resources:

      postexec = /etc/umount /cdrom

      See also preexec - .

      Default: none (no command executed) -

      Example: postexec = echo \"%u disconnected from %S - from %m (%I)\" >> /tmp/log

      postscript (S)

      This parameter forces a printer to interpret - the print files as PostScript. This is done by adding a %! - to the start of print output.

      This is most useful when you have lots of PCs that persist - in putting a control-D at the start of print jobs, which then - confuses your printer.

      Default: postscript = no

      preexec (S)

      This option specifies a command to be run whenever - the service is connected to. It takes the usual substitutions.

      An interesting example is to send the users a welcome - message every time they log in. Maybe a message of the day? Here - is an example:

      preexec = csh -c 'echo \"Welcome to %S!\" | - /usr/local/samba/bin/smbclient -M %m -I %I' &

      Of course, this could get annoying after a while :-)

      See also preexec close - and postexec - .

      Default: none (no command executed)

      Example: preexec = echo \"%u connected to %S from %m - (%I)\" >> /tmp/log

      preexec close (S)

      This boolean option controls whether a non-zero - return code from preexec - should close the service being connected to.

      Default: preexec close = no

      preferred master (G)

      This boolean parameter controls if nmbd(8) is a preferred master browser - for its workgroup.

      If this is set to yes, on startup, nmbd - will force an election, and it will have a slight advantage in - winning the election. It is recommended that this parameter is - used in conjunction with domain master = yes, so that nmbd can guarantee becoming a domain master.

      Use this option with caution, because if there are several - hosts (whether Samba servers, Windows 95 or NT) that are preferred - master browsers on the same subnet, they will each periodically - and continuously attempt to become the local master browser. - This will result in unnecessary broadcast traffic and reduced browsing - capabilities.

      See also os level - .

      Default: preferred master = auto

      prefered master (G)

      Synonym for preferred master for people who cannot spell :-).

      preload (G)

      This is a list of services that you want to be - automatically added to the browse lists. This is most useful - for homes and printers services that would otherwise not be - visible.

      Note that if you just want all printers in your - printcap file loaded then the load printers option is easier.

      Default: no preloaded services

      Example: preload = fred lp colorlp

      preserve case (S)

      This controls if new filenames are created - with the case that the client passes, or if they are forced to - be the default case - .

      Default: preserve case = yes

      See the section on NAME - MANGLING for a fuller discussion.

      print command (S)

      After a print job has finished spooling to - a service, this command will be used via a system() - call to process the spool file. Typically the command specified will - submit the spool file to the host's printing subsystem, but there - is no requirement that this be the case. The server will not remove - the spool file, so whatever command you specify should remove the - spool file when it has been processed, otherwise you will need to - manually remove old spool files.

      The print command is simply a text string. It will be used - verbatim after macro substitutions have been made:

      s, %p - the path to the spool - file name

      %p - the appropriate printer - name

      %J - the job - name as transmitted by the client.

      %c - The number of printed pages - of the spooled job (if known).

      %z - the size of the spooled - print job (in bytes)

      The print command MUST contain at least - one occurrence of %s or %f - - the %p is optional. At the time - a job is submitted, if no printer name is supplied the %p - will be silently removed from the printer command.

      If specified in the [global] section, the print command given - will be used for any printable service that does not have its own - print command specified.

      If there is neither a specified print command for a - printable service nor a global print command, spool files will - be created but not processed and (most importantly) not removed.

      Note that printing may fail on some UNIXes from the - nobody account. If this happens then create - an alternative guest account that can print and set the guest account - in the [global] section.

      You can form quite complex print commands by realizing - that they are just passed to a shell. For example the following - will log a print job, print the file, then remove it. Note that - ';' is the usual separator for command in shell scripts.

      print command = echo Printing %s >> - /tmp/print.log; lpr -P %p %s; rm %s

      You may have to vary this command considerably depending - on how you normally print files on your system. The default for - the parameter varies depending on the setting of the printing parameter.

      Default: For printing = BSD, AIX, QNX, LPRNG - or PLP :

      print command = lpr -r -P%p %s

      For printing = SYSV or HPUX :

      print command = lp -c -d%p %s; rm %s

      For printing = SOFTQ :

      print command = lp -d%p -s %s; rm %s

      For printing = CUPS : If SAMBA is compiled against - libcups, then printcap = cups - uses the CUPS API to - submit jobs, etc. Otherwise it maps to the System V - commands with the -oraw option for printing, i.e. it - uses lp -c -d%p -oraw; rm %s. - With printing = cups, - and if SAMBA is compiled against libcups, any manually - set print command will be ignored.

      Example: print command = /usr/local/samba/bin/myprintscript - %p %s

      print ok (S)

      Synonym for printable.

      printable (S)

      If this parameter is yes, then - clients may open, write to and submit spool files on the directory - specified for the service.

      Note that a printable service will ALWAYS allow writing - to the service path (user privileges permitting) via the spooling - of print data. The read only - parameter controls only non-printing access to - the resource.

      Default: printable = no

      printcap (G)

      Synonym for printcap name.

      printcap name (G)

      This parameter may be used to override the - compiled-in default printcap name used by the server (usually /etc/printcap). See the discussion of the [printers] section above for reasons - why you might want to do this.

      To use the CUPS printing interface set printcap name = cups - . This should be supplemented by an addtional setting - printing = cups in the [global] - section. printcap name = cups will use the - "dummy" printcap created by CUPS, as specified in your CUPS - configuration file. -

      On System V systems that use lpstat to - list available printers you can use printcap name = lpstat - to automatically obtain lists of available printers. This - is the default for systems that define SYSV at configure time in - Samba (this includes most System V based systems). If printcap name is set to lpstat on - these systems then Samba will launch lpstat -v and - attempt to parse the output to obtain a printer list.

      A minimal printcap file would look something like this:

      		print1|My Printer 1
-		print2|My Printer 2
-		print3|My Printer 3
-		print4|My Printer 4
-		print5|My Printer 5
-

      where the '|' separates aliases of a printer. The fact - that the second alias has a space in it gives a hint to Samba - that it's a comment.

      NOTE: Under AIX the default printcap - name is /etc/qconfig. Samba will assume the - file is in AIX qconfig format if the string - qconfig appears in the printcap filename.

      Default: printcap name = /etc/printcap

      Example: printcap name = /etc/myprintcap

      printer admin (S)

      This is a list of users that can do anything to - printers via the remote administration interfaces offered by MS-RPC - (usually using a NT workstation). Note that the root user always - has admin rights.

      Default: printer admin = <empty string> -

      Example: printer admin = admin, @staff

      printer driver (S)

      Note :This is a deprecated - parameter and will be removed in the next major release - following version 2.2. Please see the instructions in - the Samba 2.2. Printing - HOWTO for more information - on the new method of loading printer drivers onto a Samba server. -

      This option allows you to control the string - that clients receive when they ask the server for the printer driver - associated with a printer. If you are using Windows95 or Windows NT - then you can use this to automate the setup of printers on your - system.

      You need to set this parameter to the exact string (case - sensitive) that describes the appropriate printer driver for your - system. If you don't know the exact string to use then you should - first try with no printer driver option set and the client will - give you a list of printer drivers. The appropriate strings are - shown in a scroll box after you have chosen the printer manufacturer.

      See also printer - driver file.

      Example: printer driver = HP LaserJet 4L

      printer driver file (G)

      Note :This is a deprecated - parameter and will be removed in the next major release - following version 2.2. Please see the instructions in - the Samba 2.2. Printing - HOWTO for more information - on the new method of loading printer drivers onto a Samba server. -

      This parameter tells Samba where the printer driver - definition file, used when serving drivers to Windows 95 clients, is - to be found. If this is not set, the default is :

      SAMBA_INSTALL_DIRECTORY - /lib/printers.def

      This file is created from Windows 95 msprint.inf - files found on the Windows 95 client system. For more - details on setting up serving of printer drivers to Windows 95 - clients, see the outdated documentation file in the docs/ - directory, PRINTER_DRIVER.txt.

      See also printer driver location.

      Default: None (set in compile).

      Example: printer driver file = - /usr/local/samba/printers/drivers.def

      printer driver location (S)

      Note :This is a deprecated - parameter and will be removed in the next major release - following version 2.2. Please see the instructions in - the Samba 2.2. Printing - HOWTO for more information - on the new method of loading printer drivers onto a Samba server. -

      This parameter tells clients of a particular printer - share where to find the printer driver files for the automatic - installation of drivers for Windows 95 machines. If Samba is set up - to serve printer drivers to Windows 95 machines, this should be set to

      \\MACHINE\PRINTER$

      Where MACHINE is the NetBIOS name of your Samba server, - and PRINTER$ is a share you set up for serving printer driver - files. For more details on setting this up see the outdated documentation - file in the docs/ directory, PRINTER_DRIVER.txt.

      See also printer driver file.

      Default: none

      Example: printer driver location = \\MACHINE\PRINTER$ -

      printer name (S)

      This parameter specifies the name of the printer - to which print jobs spooled through a printable service will be sent.

      If specified in the [global] section, the printer - name given will be used for any printable service that does - not have its own printer name specified.

      Default: none (but may be lp - on many systems)

      Example: printer name = laserwriter

      printer (S)

      Synonym for printer name.

      printing (S)

      This parameters controls how printer status - information is interpreted on your system. It also affects the - default values for the print command, - lpq command, lppause command - , lpresume command, and - lprm command if specified in the - [global] section.

      Currently nine printing styles are supported. They are - BSD, AIX, - LPRNG, PLP, - SYSV, HPUX, - QNX, SOFTQ, - and CUPS.

      To see what the defaults are for the other print - commands when using the various options use the testparm(1) program.

      This option can be set on a per printer basis

      See also the discussion in the [printers] section.

      private dir (G)

      This parameters defines the directory - smbd will use for storing such files as smbpasswd - and secrets.tdb. -

      Default :private dir = ${prefix}/private

      protocol (G)

      Synonym for max protocol.

      public (S)

      Synonym for guest - ok.

      queuepause command (S)

      This parameter specifies the command to be - executed on the server host in order to pause the printer queue.

      This command should be a program or script which takes - a printer name as its only parameter and stops the printer queue, - such that no longer jobs are submitted to the printer.

      This command is not supported by Windows for Workgroups, - but can be issued from the Printers window under Windows 95 - and NT.

      If a %p is given then the printer name - is put in its place. Otherwise it is placed at the end of the command. -

      Note that it is good practice to include the absolute - path in the command as the PATH may not be available to the - server.

      Default: depends on the setting of printing -

      Example: queuepause command = disable %p

      queueresume command (S)

      This parameter specifies the command to be - executed on the server host in order to resume the printer queue. It - is the command to undo the behavior that is caused by the - previous parameter ( queuepause command).

      This command should be a program or script which takes - a printer name as its only parameter and resumes the printer queue, - such that queued jobs are resubmitted to the printer.

      This command is not supported by Windows for Workgroups, - but can be issued from the Printers window under Windows 95 - and NT.

      If a %p is given then the printer name - is put in its place. Otherwise it is placed at the end of the - command.

      Note that it is good practice to include the absolute - path in the command as the PATH may not be available to the - server.

      Default: depends on the setting of printing -

      Example: queuepause command = enable %p -

      read bmpx (G)

      This boolean parameter controls whether smbd(8) will support the "Read - Block Multiplex" SMB. This is now rarely used and defaults to - no. You should never need to set this - parameter.

      Default: read bmpx = no

      read list (S)

      This is a list of users that are given read-only - access to a service. If the connecting user is in this list then - they will not be given write access, no matter what the read only - option is set to. The list can include group names using the - syntax described in the invalid users parameter.

      See also the write list parameter and the invalid users - parameter.

      Default: read list = <empty string>

      Example: read list = mary, @students

      read only (S)

      An inverted synonym is writeable.

      If this parameter is yes, then users - of a service may not create or modify files in the service's - directory.

      Note that a printable service (printable = yes) - will ALWAYS allow writing to the directory - (user privileges permitting), but only via spooling operations.

      Default: read only = yes

      read raw (G)

      This parameter controls whether or not the server - will support the raw read SMB requests when transferring data - to clients.

      If enabled, raw reads allow reads of 65535 bytes in - one packet. This typically provides a major performance benefit. -

      However, some clients either negotiate the allowable - block size incorrectly or are incapable of supporting larger block - sizes, and for these clients you may need to disable raw reads.

      In general this parameter should be viewed as a system tuning - tool and left severely alone. See also write raw.

      Default: read raw = yes

      read size (G)

      The option read size - affects the overlap of disk reads/writes with network reads/writes. - If the amount of data being transferred in several of the SMB - commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger - than this value then the server begins writing the data before it - has received the whole packet from the network, or in the case of - SMBreadbraw, it begins writing to the network before all the data - has been read from disk.

      This overlapping works best when the speeds of disk and - network access are similar, having very little effect when the - speed of one is much greater than the other.

      The default value is 16384, but very little experimentation - has been done yet to determine the optimal value, and it is likely - that the best value will vary greatly between systems anyway. - A value over 65536 is pointless and will cause you to allocate - memory unnecessarily.

      Default: read size = 16384

      Example: read size = 8192

      realm (G)

      This option specifies the kerberos realm to use. The realm is - used as the ADS equivalent of the NT4domain. It - is usually set to the DNS name of the kerberos server. -

      Default: realm =

      Example: realm = mysambabox.mycompany.com

      remote announce (G)

      This option allows you to setup nmbd(8) to periodically announce itself - to arbitrary IP addresses with an arbitrary workgroup name.

      This is useful if you want your Samba server to appear - in a remote workgroup for which the normal browse propagation - rules don't work. The remote workgroup can be anywhere that you - can send IP packets to.

      For example:

      remote announce = 192.168.2.255/SERVERS - 192.168.4.255/STAFF

      the above line would cause nmbd to announce itself - to the two given IP addresses using the given workgroup names. - If you leave out the workgroup name then the one given in - the workgroup - parameter is used instead.

      The IP addresses you choose would normally be the broadcast - addresses of the remote networks, but can also be the IP addresses - of known browse masters if your network config is that stable.

      See the documentation file BROWSING.txt - in the docs/ directory.

      Default: remote announce = <empty string> -

      remote browse sync (G)

      This option allows you to setup nmbd(8) to periodically request - synchronization of browse lists with the master browser of a Samba - server that is on a remote segment. This option will allow you to - gain browse lists for multiple workgroups across routed networks. This - is done in a manner that does not work with any non-Samba servers.

      This is useful if you want your Samba server and all local - clients to appear in a remote workgroup for which the normal browse - propagation rules don't work. The remote workgroup can be anywhere - that you can send IP packets to.

      For example:

      remote browse sync = 192.168.2.255 192.168.4.255 -

      the above line would cause nmbd to request - the master browser on the specified subnets or addresses to - synchronize their browse lists with the local server.

      The IP addresses you choose would normally be the broadcast - addresses of the remote networks, but can also be the IP addresses - of known browse masters if your network config is that stable. If - a machine IP address is given Samba makes NO attempt to validate - that the remote machine is available, is listening, nor that it - is in fact the browse master on its segment.

      Default: remote browse sync = <empty string> -

      restrict anonymous (G)

      This is a integer parameter, and - mirrors as much as possible the functinality the - RestrictAnonymous - registry key does on NT/Win2k.

      Default: restrict anonymous = 0

      root (G)

      Synonym for root directory".

      root dir (G)

      Synonym for root directory".

      root directory (G)

      The server will chroot() (i.e. - Change its root directory) to this directory on startup. This is - not strictly necessary for secure operation. Even without it the - server will deny access to files not in one of the service entries. - It may also check for, and deny access to, soft links to other - parts of the filesystem, or attempts to use ".." in file names - to access other directories (depending on the setting of the wide links - parameter).

      Adding a root directory entry other - than "/" adds an extra level of security, but at a price. It - absolutely ensures that no access is given to files not in the - sub-tree specified in the root directory - option, including some files needed for - complete operation of the server. To maintain full operability - of the server you will need to mirror some system files - into the root directory tree. In particular - you will need to mirror /etc/passwd (or a - subset of it), and any binaries or configuration files needed for - printing (if required). The set of files that must be mirrored is - operating system dependent.

      Default: root directory = /

      Example: root directory = /homes/smb

      root postexec (S)

      This is the same as the postexec - parameter except that the command is run as root. This - is useful for unmounting filesystems - (such as CDROMs) after a connection is closed.

      See also postexec.

      Default: root postexec = <empty string> -

      root preexec (S)

      This is the same as the preexec - parameter except that the command is run as root. This - is useful for mounting filesystems (such as CDROMs) when a - connection is opened.

      See also preexec and preexec close.

      Default: root preexec = <empty string> -

      root preexec close (S)

      This is the same as the preexec close - parameter except that the command is run as root.

      See also preexec and preexec close.

      Default: root preexec close = no

      security (G)

      This option affects how clients respond to - Samba and is one of the most important settings in the smb.conf file.

      The option sets the "security mode bit" in replies to - protocol negotiations with smbd(8) - to turn share level security on or off. Clients decide - based on this bit whether (and how) to transfer user and password - information to the server.

      The default is security = user, as this is - the most common setting needed when talking to Windows 98 and - Windows NT.

      The alternatives are security = share, - security = server or security = domain - .

      In versions of Samba prior to 2.0.0, the default was - security = share mainly because that was - the only option at one stage.

      There is a bug in WfWg that has relevance to this - setting. When in user or server level security a WfWg client - will totally ignore the password you type in the "connect - drive" dialog box. This makes it very difficult (if not impossible) - to connect to a Samba service as anyone except the user that - you are logged into WfWg as.

      If your PCs use usernames that are the same as their - usernames on the UNIX machine then you will want to use - security = user. If you mostly use usernames - that don't exist on the UNIX box then use security = - share.

      You should also use security = share if you - want to mainly setup shares without a password (guest shares). This - is commonly used for a shared printer server. It is more difficult - to setup guest shares with security = user, see - the map to guest - parameter for details.

      It is possible to use smbd in a hybrid mode where it is offers both user and share - level security under different NetBIOS aliases.

      The different settings will now be explained.

      SECURITY = SHARE -

      When clients connect to a share level security server they - need not log onto the server with a valid username and password before - attempting to connect to a shared resource (although modern clients - such as Windows 95/98 and Windows NT will send a logon request with - a username but no password when talking to a security = share - server). Instead, the clients send authentication information - (passwords) on a per-share basis, at the time they attempt to connect - to that share.

      Note that smbd ALWAYS - uses a valid UNIX user to act on behalf of the client, even in - security = share level security.

      As clients are not required to send a username to the server - in share level security, smbd uses several - techniques to determine the correct UNIX user to use on behalf - of the client.

      A list of possible UNIX usernames to match with the given - client password is constructed using the following methods :

      • If the guest - only parameter is set, then all the other - stages are missed and only the guest account username is checked. -

      • Is a username is sent with the share connection - request, then this username (after mapping - see username map), - is added as a potential username.

      • If the client did a previous logon - request (the SessionSetup SMB call) then the - username sent in this SMB will be added as a potential username. -

      • The name of the service the client requested is - added as a potential username.

      • The NetBIOS name of the client is added to - the list as a potential username.

      • Any users on the user list are added as potential usernames. -

      If the guest only parameter is - not set, then this list is then tried with the supplied password. - The first user for whom the password matches will be used as the - UNIX user.

      If the guest only parameter is - set, or no username can be determined then if the share is marked - as available to the guest account, then this - guest user will be used, otherwise access is denied.

      Note that it can be very confusing - in share-level security as to which UNIX username will eventually - be used in granting access.

      See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.

      SECURITY = USER -

      This is the default security setting in Samba 2.2. - With user-level security a client must first "log-on" with a - valid username and password (which can be mapped using the username map - parameter). Encrypted passwords (see the encrypted passwords parameter) can also - be used in this security mode. Parameters such as user and guest only if set are then applied and - may change the UNIX user to use on this connection, but only after - the user has been successfully authenticated.

      Note that the name of the resource being - requested is not sent to the server until after - the server has successfully authenticated the client. This is why - guest shares don't work in user level security without allowing - the server to automatically map unknown users into the guest account. - See the map to guest - parameter for details on doing this.

      See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.

      SECURITY = SERVER -

      In this mode Samba will try to validate the username/password - by passing it to another SMB server, such as an NT box. If this - fails it will revert to security = user, but note - that if encrypted passwords have been negotiated then Samba cannot - revert back to checking the UNIX password file, it must have a valid - smbpasswd file to check users against. See the - documentation file in the docs/ directory - ENCRYPTION.txt for details on how to set this - up.

      Note that from the client's point of - view security = server is the same as security = user. It only affects how the server deals - with the authentication, it does not in any way affect what the - client sees.

      Note that the name of the resource being - requested is not sent to the server until after - the server has successfully authenticated the client. This is why - guest shares don't work in user level security without allowing - the server to automatically map unknown users into the guest account. - See the map to guest - parameter for details on doing this.

      See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.

      See also the password - server parameter and the encrypted passwords - parameter.

      SECURITY = DOMAIN -

      This mode will only work correctly if smbpasswd(8) has been used to add this - machine into a Windows NT Domain. It expects the encrypted passwords - parameter to be set to yes. In this - mode Samba will try to validate the username/password by passing - it to a Windows NT Primary or Backup Domain Controller, in exactly - the same way that a Windows NT Server would do.

      Note that a valid UNIX user must still - exist as well as the account on the Domain Controller to allow - Samba to have a valid UNIX account to map file access to.

      Note that from the client's point - of view security = domain is the same as security = user - . It only affects how the server deals with the authentication, - it does not in any way affect what the client sees.

      Note that the name of the resource being - requested is not sent to the server until after - the server has successfully authenticated the client. This is why - guest shares don't work in user level security without allowing - the server to automatically map unknown users into the guest account. - See the map to guest - parameter for details on doing this.

      BUG: There is currently a bug in the - implementation of security = domain with respect - to multi-byte character set usernames. The communication with a - Domain Controller must be done in UNICODE and Samba currently - does not widen multi-byte user names to UNICODE correctly, thus - a multi-byte username will not be recognized correctly at the - Domain Controller. This issue will be addressed in a future release.

      See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.

      See also the password - server parameter and the encrypted passwords - parameter.

      Default: security = USER

      Example: security = DOMAIN

      security mask (S)

      This parameter controls what UNIX permission - bits can be modified when a Windows NT client is manipulating - the UNIX permission on a file using the native NT security - dialog box.

      This parameter is applied as a mask (AND'ed with) to - the changed permission bits, thus preventing any bits not in - this mask from being modified. Essentially, zero bits in this - mask may be treated as a set of bits the user is not allowed - to change.

      If not set explicitly this parameter is 0777, allowing - a user to modify all the user/group/world permissions on a file. -

      Note that users who can access the - Samba server through other means can easily bypass this - restriction, so it is primarily useful for standalone - "appliance" systems. Administrators of most normal systems will - probably want to leave it set to 0777.

      See also the force directory security mode, - directory - security mask, force security mode parameters.

      Default: security mask = 0777

      Example: security mask = 0770

      server string (G)

      This controls what string will show up in the - printer comment box in print manager and next to the IPC connection - in net view. It can be any string that you wish - to show to your users.

      It also sets what will appear in browse lists next - to the machine name.

      A %v will be replaced with the Samba - version number.

      A %h will be replaced with the - hostname.

      Default: server string = Samba %v

      Example: server string = University of GNUs Samba - Server

      set directory (S)

      If set directory = no, then - users of the service may not use the setdir command to change - directory.

      The setdir command is only implemented - in the Digital Pathworks client. See the Pathworks documentation - for details.

      Default: set directory = no

      share modes (S)

      This enables or disables the honoring of - the share modes during a file open. These - modes are used by clients to gain exclusive read or write access - to a file.

      These open modes are not directly supported by UNIX, so - they are simulated using shared memory, or lock files if your - UNIX doesn't support shared memory (almost all do).

      The share modes that are enabled by this option are - DENY_DOS, DENY_ALL, - DENY_READ, DENY_WRITE, - DENY_NONE and DENY_FCB. -

      This option gives full share compatibility and enabled - by default.

      You should NEVER turn this parameter - off as many Windows applications will break if you do so.

      Default: share modes = yes

      short preserve case (S)

      This boolean parameter controls if new files - which conform to 8.3 syntax, that is all in upper case and of - suitable length, are created upper case, or if they are forced - to be the default case - . This option can be use with preserve case = yes - to permit long filenames to retain their case, while short - names are lowered.

      See the section on NAME MANGLING.

      Default: short preserve case = yes

      show add printer wizard (G)

      With the introduction of MS-RPC based printing support - for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will - appear on Samba hosts in the share listing. Normally this folder will - contain an icon for the MS Add Printer Wizard (APW). However, it is - possible to disable this feature regardless of the level of privilege - of the connected user.

      Under normal circumstances, the Windows NT/2000 client will - open a handle on the printer server with OpenPrinterEx() asking for - Administrator privileges. If the user does not have administrative - access on the print server (i.e is not root or a member of the - printer admin group), the OpenPrinterEx() - call fails and the client makes another open call with a request for - a lower privilege level. This should succeed, however the APW - icon will not be displayed.

      Disabling the show add printer wizard - parameter will always cause the OpenPrinterEx() on the server - to fail. Thus the APW icon will never be displayed. Note :This does not prevent the same user from having - administrative privilege on an individual printer.

      See also addprinter - command, deleteprinter command, printer admin

      Default :show add printer wizard = yes

      shutdown script (G)

      This parameter only exists in the HEAD cvs branch - This a full path name to a script called by - smbd(8) that - should start a shutdown procedure.

      This command will be run as the user connected to the - server.

      %m %t %r %f parameters are expanded

      %m will be substituted with the - shutdown message sent to the server.

      %t will be substituted with the - number of seconds to wait before effectively starting the - shutdown procedure.

      %r will be substituted with the - switch -r. It means reboot after shutdown - for NT. -

      %f will be substituted with the - switch -f. It means force the shutdown - even if applications do not respond for NT.

      Default: None.

      Example: abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f

      Shutdown script example: - 
      		#!/bin/bash
-		
-		$time=0
-		let "time/60"
-		let "time++"
-
-		/sbin/shutdown $3 $4 +$time $1 &
-
      - Shutdown does not return so we need to launch it in background. -

      See also abort shutdown script.

      smb passwd file (G)

      This option sets the path to the encrypted - smbpasswd file. By default the path to the smbpasswd file - is compiled into Samba.

      Default: smb passwd file = ${prefix}/private/smbpasswd -

      Example: smb passwd file = /etc/samba/smbpasswd -

      smb ports (G)

      Specifies which ports the server should listen on - for SMB traffic. -

      Default: smb ports = 445 139

      socket address (G)

      This option allows you to control what - address Samba will listen for connections on. This is used to - support multiple virtual interfaces on the one server, each - with a different configuration.

      By default Samba will accept connections on any - address.

      Example: socket address = 192.168.2.20 -

      socket options (G)

      This option allows you to set socket options - to be used when talking with the client.

      Socket options are controls on the networking layer - of the operating systems which allow the connection to be - tuned.

      This option will typically be used to tune your Samba - server for optimal performance for your local network. There is - no way that Samba can know what the optimal parameters are for - your net, so you must experiment and choose them yourself. We - strongly suggest you read the appropriate documentation for your - operating system first (perhaps man setsockopt - will help).

      You may find that on some systems Samba will say - "Unknown socket option" when you supply an option. This means you - either incorrectly typed it or you need to add an include file - to includes.h for your OS. If the latter is the case please - send the patch to samba@samba.org.

      Any of the supported socket options may be combined - in any way you like, as long as your OS allows it.

      This is the list of socket options currently settable - using this option:

      • SO_KEEPALIVE

      • SO_REUSEADDR

      • SO_BROADCAST

      • TCP_NODELAY

      • IPTOS_LOWDELAY

      • IPTOS_THROUGHPUT

      • SO_SNDBUF *

      • SO_RCVBUF *

      • SO_SNDLOWAT *

      • SO_RCVLOWAT *

      Those marked with a '*' take an integer - argument. The others can optionally take a 1 or 0 argument to enable - or disable the option, by default they will be enabled if you - don't specify 1 or 0.

      To specify an argument use the syntax SOME_OPTION = VALUE - for example SO_SNDBUF = 8192. Note that you must - not have any spaces before or after the = sign.

      If you are on a local network then a sensible option - might be

      socket options = IPTOS_LOWDELAY

      If you have a local network then you could try:

      socket options = IPTOS_LOWDELAY TCP_NODELAY

      If you are on a wide area network then perhaps try - setting IPTOS_THROUGHPUT.

      Note that several of the options may cause your Samba - server to fail completely. Use these options with caution!

      Default: socket options = TCP_NODELAY

      Example: socket options = IPTOS_LOWDELAY

      source environment (G)

      This parameter causes Samba to set environment - variables as per the content of the file named.

      If the value of this parameter starts with a "|" character - then Samba will treat that value as a pipe command to open and - will set the environment variables from the output of the pipe.

      The contents of the file or the output of the pipe should - be formatted as the output of the standard Unix env(1) - command. This is of the form :

      Example environment entry:

      SAMBA_NETBIOS_NAME = myhostname

      Default: No default value

      Examples: source environment = |/etc/smb.conf.sh -

      Example: source environment = - /usr/local/smb_env_vars

      use spnego (G)

      This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. As of samba 3.0alpha it must be set to "no" for these clients to join a samba domain controller. It can be set to "yes" to allow samba to participate in an AD domain controlled by a Windows2000 domain controller.

      Default: use spnego = yes

      stat cache (G)

      This parameter determines if smbd(8) will use a cache in order to - speed up case insensitive name mappings. You should never need - to change this parameter.

      Default: stat cache = yes

      stat cache size (G)

      This parameter determines the number of - entries in the stat cache. You should - never need to change this parameter.

      Default: stat cache size = 50

      strict allocate (S)

      This is a boolean that controls the handling of - disk space allocation in the server. When this is set to yes - the server will change from UNIX behaviour of not committing real - disk storage blocks when a file is extended to the Windows behaviour - of actually forcing the disk system to allocate real storage blocks - when a file is created or extended to be a given size. In UNIX - terminology this means that Samba will stop creating sparse files. - This can be slow on some systems.

      When strict allocate is no the server does sparse - disk block allocation when a file is extended.

      Setting this to yes can help Samba return - out of quota messages on systems that are restricting the disk quota - of users.

      Default: strict allocate = no

      strict locking (S)

      This is a boolean that controls the handling of - file locking in the server. When this is set to yes - the server will check every read and write access for file locks, and - deny access if locks exist. This can be slow on some systems.

      When strict locking is no the server does file - lock checks only when the client explicitly asks for them.

      Well-behaved clients always ask for lock checks when it - is important, so in the vast majority of cases strict - locking = no is preferable.

      Default: strict locking = no

      strict sync (S)

      Many Windows applications (including the Windows - 98 explorer shell) seem to confuse flushing buffer contents to - disk with doing a sync to disk. Under UNIX, a sync call forces - the process to be suspended until the kernel has ensured that - all outstanding data in kernel disk buffers has been safely stored - onto stable storage. This is very slow and should only be done - rarely. Setting this parameter to no (the - default) means that smbd ignores the Windows applications requests for - a sync call. There is only a possibility of losing data if the - operating system itself that Samba is running on crashes, so there is - little danger in this default setting. In addition, this fixes many - performance problems that people have reported with the new Windows98 - explorer shell file copies.

      See also the sync - always> parameter.

      Default: strict sync = no

      strip dot (G)

      This is a boolean that controls whether to - strip trailing dots off UNIX filenames. This helps with some - CDROMs that have filenames ending in a single dot.

      Default: strip dot = no

      sync always (S)

      This is a boolean parameter that controls - whether writes will always be written to stable storage before - the write call returns. If this is no then the server will be - guided by the client's request in each write call (clients can - set a bit indicating that a particular write should be synchronous). - If this is yes then every write will be followed by a fsync() - call to ensure the data is written to disk. Note that - the strict sync parameter must be set to - yes in order for this parameter to have - any affect.

      See also the strict - sync parameter.

      Default: sync always = no

      syslog (G)

      This parameter maps how Samba debug messages - are logged onto the system syslog logging levels. Samba debug - level zero maps onto syslog LOG_ERR, debug - level one maps onto LOG_WARNING, debug level - two maps onto LOG_NOTICE, debug level three - maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG.

      This parameter sets the threshold for sending messages - to syslog. Only messages with debug level less than this value - will be sent to syslog.

      Default: syslog = 1

      syslog only (G)

      If this parameter is set then Samba debug - messages are logged into the system syslog only, and not to - the debug log files.

      Default: syslog only = no

      template homedir (G)

      When filling out the user information for a Windows NT - user, the winbindd(8) daemon - uses this parameter to fill in the home directory for that user. - If the string %D is present it is substituted - with the user's Windows NT domain name. If the string %U - is present it is substituted with the user's Windows - NT user name.

      Default: template homedir = /home/%D/%U

      template shell (G)

      When filling out the user information for a Windows NT - user, the winbindd(8) daemon - uses this parameter to fill in the login shell for that user.

      Default: template shell = /bin/false

      time offset (G)

      This parameter is a setting in minutes to add - to the normal GMT to local time conversion. This is useful if - you are serving a lot of PCs that have incorrect daylight - saving time handling.

      Default: time offset = 0

      Example: time offset = 60

      time server (G)

      This parameter determines if - nmbd(8) advertises itself as a time server to Windows - clients.

      Default: time server = no

      timestamp logs (G)

      Synonym for debug timestamp.

      total print jobs (G)

      This parameter accepts an integer value which defines - a limit on the maximum number of print jobs that will be accepted - system wide at any given time. If a print job is submitted - by a client which will exceed this number, then smbd will return an - error indicating that no space is available on the server. The - default value of 0 means that no such limit exists. This parameter - can be used to prevent a server from exceeding its capacity and is - designed as a printing throttle. See also - max print jobs. -

      Default: total print jobs = 0

      Example: total print jobs = 5000

      unicode (G)

      Specifies whether Samba should try - to use unicode on the wire by default. Note: This does NOT - mean that samba will assume that the unix machine uses unicode! -

      Default: unicode = yes

      unix charset (G)

      Specifies the charset the unix machine - Samba runs on uses. Samba needs to know this in order to be able to - convert text to the charsets other SMB clients use. -

      Default: unix charset = ASCII

      Example: unix charset = UTF8

      unix extensions(G)

      This boolean parameter controls whether Samba - implments the CIFS UNIX extensions, as defined by HP. - These extensions enable Samba to better serve UNIX CIFS clients - by supporting features such as symbolic links, hard links, etc... - These extensions require a similarly enabled client, and are of - no current use to Windows clients.

      Default: unix extensions = no

      unix password sync (G)

      This boolean parameter controls whether Samba - attempts to synchronize the UNIX password with the SMB password - when the encrypted SMB password in the smbpasswd file is changed. - If this is set to yes the program specified in the passwd - programparameter is called AS ROOT - - to allow the new UNIX password to be set without access to the - old UNIX password (as the SMB password change code has no - access to the old password cleartext, only the new).

      See also passwd - program, passwd chat.

      Default: unix password sync = no

      update encrypted (G)

      This boolean parameter allows a user logging - on with a plaintext password to have their encrypted (hashed) - password in the smbpasswd file to be updated automatically as - they log on. This option allows a site to migrate from plaintext - password authentication (users authenticate with plaintext - password over the wire, and are checked against a UNIX account - database) to encrypted password authentication (the SMB - challenge/response authentication mechanism) without forcing - all users to re-enter their passwords via smbpasswd at the time the - change is made. This is a convenience option to allow the change over - to encrypted passwords to be made over a longer period. Once all users - have encrypted representations of their passwords in the smbpasswd - file this parameter should be set to no.

      In order for this parameter to work correctly the encrypt passwords - parameter must be set to no when - this parameter is set to yes.

      Note that even when this parameter is set a user - authenticating to smbd must still enter a valid - password in order to connect correctly, and to update their hashed - (smbpasswd) passwords.

      Default: update encrypted = no

      use client driver (S)

      This parameter applies only to Windows NT/2000 - clients. It has no affect on Windows 95/98/ME clients. When - serving a printer to Windows NT/2000 clients without first installing - a valid printer driver on the Samba host, the client will be required - to install a local printer driver. From this point on, the client - will treat the print as a local printer and not a network printer - connection. This is much the same behavior that will occur - when disable spoolss = yes.

      The differentiating - factor is that under normal circumstances, the NT/2000 client will - attempt to open the network printer using MS-RPC. The problem is that - because the client considers the printer to be local, it will attempt - to issue the OpenPrinterEx() call requesting access rights associated - with the logged on user. If the user possesses local administator rights - but not root privilegde on the Samba host (often the case), the OpenPrinterEx() - call will fail. The result is that the client will now display an "Access - Denied; Unable to connect" message in the printer queue window (even though - jobs may successfully be printed).

      If this parameter is enabled for a printer, then any attempt - to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped - to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() - call to succeed. This parameter MUST not be able enabled - on a print share which has valid print driver installed on the Samba - server.

      See also disable spoolss -

      Default: use client driver = no

      use mmap (G)

      This global parameter determines if the tdb internals of Samba can - depend on mmap working correctly on the running system. Samba requires a coherent - mmap/read-write system memory cache. Currently only HPUX does not have such a - coherent cache, and so this parameter is set to no by - default on HPUX. On all other systems this parameter should be left alone. This - parameter is provided to help the Samba developers track down problems with - the tdb internal code. -

      Default: use mmap = yes

      use rhosts (G)

      If this global parameter is yes, it specifies - that the UNIX user's .rhosts file in their home directory - will be read to find the names of hosts and users who will be allowed - access without specifying a password.

      NOTE: The use of use rhosts - can be a major security hole. This is because you are - trusting the PC to supply the correct username. It is very easy to - get a PC to supply a false username. I recommend that the use rhosts option be only used if you really know what - you are doing.

      Default: use rhosts = no

      user (S)

      Synonym for username.

      users (S)

      Synonym for username.

      username (S)

      Multiple users may be specified in a comma-delimited - list, in which case the supplied password will be tested against - each username in turn (left to right).

      The username line is needed only when - the PC is unable to supply its own username. This is the case - for the COREPLUS protocol or where your users have different WfWg - usernames to UNIX usernames. In both these cases you may also be - better using the \\server\share%user syntax instead.

      The username line is not a great - solution in many cases as it means Samba will try to validate - the supplied password against each of the usernames in the - username line in turn. This is slow and - a bad idea for lots of users in case of duplicate passwords. - You may get timeouts or security breaches using this parameter - unwisely.

      Samba relies on the underlying UNIX security. This - parameter does not restrict who can login, it just offers hints - to the Samba server as to what usernames might correspond to the - supplied password. Users can login as whoever they please and - they will be able to do no more damage than if they started a - telnet session. The daemon runs as the user that they log in as, - so they cannot do anything that user cannot do.

      To restrict a service to a particular set of users you - can use the valid users - parameter.

      If any of the usernames begin with a '@' then the name - will be looked up first in the NIS netgroups list (if Samba - is compiled with netgroup support), followed by a lookup in - the UNIX groups database and will expand to a list of all users - in the group of that name.

      If any of the usernames begin with a '+' then the name - will be looked up only in the UNIX groups database and will - expand to a list of all users in the group of that name.

      If any of the usernames begin with a '&'then the name - will be looked up only in the NIS netgroups database (if Samba - is compiled with netgroup support) and will expand to a list - of all users in the netgroup group of that name.

      Note that searching though a groups database can take - quite some time, and some clients may time out during the - search.

      See the section NOTE ABOUT - USERNAME/PASSWORD VALIDATION for more information on how - this parameter determines access to the services.

      Default: The guest account if a guest service, - else <empty string>.

      Examples:username = fred, mary, jack, jane, - @users, @pcgroup

      username level (G)

      This option helps Samba to try and 'guess' at - the real UNIX username, as many DOS clients send an all-uppercase - username. By default Samba tries all lowercase, followed by the - username with the first letter capitalized, and fails if the - username is not found on the UNIX machine.

      If this parameter is set to non-zero the behavior changes. - This parameter is a number that specifies the number of uppercase - combinations to try while trying to determine the UNIX user name. The - higher the number the more combinations will be tried, but the slower - the discovery of usernames will be. Use this parameter when you have - strange usernames on your UNIX machine, such as AstrangeUser - .

      Default: username level = 0

      Example: username level = 5

      username map (G)

      This option allows you to specify a file containing - a mapping of usernames from the clients to the server. This can be - used for several purposes. The most common is to map usernames - that users use on DOS or Windows machines to those that the UNIX - box uses. The other is to map multiple users to a single username - so that they can more easily share files.

      The map file is parsed line by line. Each line should - contain a single UNIX username on the left then a '=' followed - by a list of usernames on the right. The list of usernames on the - right may contain names of the form @group in which case they - will match any UNIX username in that group. The special client - name '*' is a wildcard and matches any name. Each line of the - map file may be up to 1023 characters long.

      The file is processed on each line by taking the - supplied username and comparing it with each username on the right - hand side of the '=' signs. If the supplied name matches any of - the names on the right hand side then it is replaced with the name - on the left. Processing then continues with the next line.

      If any line begins with a '#' or a ';' then it is - ignored

      If any line begins with an '!' then the processing - will stop after that line if a mapping was done by the line. - Otherwise mapping continues with every line being processed. - Using '!' is most useful when you have a wildcard mapping line - later in the file.

      For example to map from the name admin - or administrator to the UNIX name root you would use:

      root = admin administrator

      Or to map anyone in the UNIX group system - to the UNIX name sys you would use:

      sys = @system

      You can have as many mappings as you like in a username - map file.

      If your system supports the NIS NETGROUP option then - the netgroup database is checked before the /etc/group - database for matching groups.

      You can map Windows usernames that have spaces in them - by using double quotes around the name. For example:

      tridge = "Andrew Tridgell"

      would map the windows username "Andrew Tridgell" to the - unix username "tridge".

      The following example would map mary and fred to the - unix user sys, and map the rest to guest. Note the use of the - '!' to tell Samba to stop processing if it gets a match on - that line.

      		!sys = mary fred
-		guest = *
-

      Note that the remapping is applied to all occurrences - of usernames. Thus if you connect to \\server\fred and fred is remapped to mary then you - will actually be connecting to \\server\mary and will need to - supply a password suitable for mary not - fred. The only exception to this is the - username passed to the password server (if you have one). The password - server will receive whatever username the client supplies without - modification.

      Also note that no reverse mapping is done. The main effect - this has is with printing. Users who have been mapped may have - trouble deleting print jobs as PrintManager under WfWg will think - they don't own the print job.

      Default: no username map

      Example: username map = /usr/local/samba/lib/users.map -

      use sendfile (S)

      If this parameter is yes, and Samba - was built with the --with-sendfile-support option, and the underlying operating - system supports sendfile system call, then some SMB read calls (mainly ReadAndX - and ReadRaw) will use the more efficient sendfile system call for files that - are exclusively oplocked. This may make more efficient use of the system CPU's - and cause Samba to be faster. This is off by default as it's effects are unknown - as yet. -

      Default: use sendfile = no

      utmp (G)

      This boolean parameter is only available if - Samba has been configured and compiled with the option --with-utmp. If set to yes then Samba will attempt - to add utmp or utmpx records (depending on the UNIX system) whenever a - connection is made to a Samba server. Sites may use this to record the - user connecting to a Samba share.

      Due to the requirements of the utmp record, we - are required to create a unique identifier for the - incoming user. Enabling this option creates an n^2 - algorithm to find this number. This may impede - performance on large installations.

      See also the utmp directory parameter.

      Default: utmp = no

      utmp directory(G)

      This parameter is only available if Samba has - been configured and compiled with the option --with-utmp. It specifies a directory pathname that is - used to store the utmp or utmpx files (depending on the UNIX system) that - record user connections to a Samba server. See also the utmp parameter. By default this is - not set, meaning the system will use whatever utmp file the - native system is set to use (usually - /var/run/utmp on Linux).

      Default: no utmp directory

      Example: utmp directory = /var/run/utmp

      wtmp directory(G)

      This parameter is only available if Samba has - been configured and compiled with the option --with-utmp. It specifies a directory pathname that is - used to store the wtmp or wtmpx files (depending on the UNIX system) that - record user connections to a Samba server. The difference with - the utmp directory is the fact that user info is kept after a user - has logged out. - - See also the utmp parameter. By default this is - not set, meaning the system will use whatever utmp file the - native system is set to use (usually - /var/run/wtmp on Linux).

      Default: no wtmp directory

      Example: wtmp directory = /var/log/wtmp

      valid users (S)

      This is a list of users that should be allowed - to login to this service. Names starting with '@', '+' and '&' - are interpreted using the same rules as described in the - invalid users parameter.

      If this is empty (the default) then any user can login. - If a username is in both this list and the invalid - users list then access is denied for that user.

      The current servicename is substituted for %S - . This is useful in the [homes] section.

      See also invalid users -

      Default: No valid users list (anyone can login) -

      Example: valid users = greg, @pcusers

      veto files(S)

      This is a list of files and directories that - are neither visible nor accessible. Each entry in the list must - be separated by a '/', which allows spaces to be included - in the entry. '*' and '?' can be used to specify multiple files - or directories as in DOS wildcards.

      Each entry must be a unix path, not a DOS path and - must not include the unix directory - separator '/'.

      Note that the case sensitive option - is applicable in vetoing files.

      One feature of the veto files parameter that it - is important to be aware of is Samba's behaviour when - trying to delete a directory. If a directory that is - to be deleted contains nothing but veto files this - deletion will fail unless you also set - the delete veto files parameter to - yes.

      Setting this parameter will affect the performance - of Samba, as it will be forced to check all files and directories - for a match as they are scanned.

      See also hide files - and case sensitive.

      Default: No files or directories are vetoed. -

      Examples:
      ; Veto any files containing the word Security, 
-; any ending in .tmp, and any directory containing the
-; word root.
-veto files = /*Security*/*.tmp/*root*/
-
-; Veto the Apple specific files that a NetAtalk server
-; creates.
-veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/

      veto oplock files (S)

      This parameter is only valid when the oplocks - parameter is turned on for a share. It allows the Samba administrator - to selectively turn off the granting of oplocks on selected files that - match a wildcarded list, similar to the wildcarded list used in the - veto files - parameter.

      Default: No files are vetoed for oplock - grants

      You might want to do this on files that you know will - be heavily contended for by clients. A good example of this - is in the NetBench SMB benchmark program, which causes heavy - client contention for files ending in .SEM. - To cause Samba not to grant oplocks on these files you would use - the line (either in the [global] section or in the section for - the particular NetBench share :

      Example: veto oplock files = /*.SEM/ -

      vfs path (S)

      This parameter specifies the directory - to look in for vfs modules. The name of every vfs object - will be prepended by this directory -

      Default: vfs path =

      Example: vfs path = /usr/lib/samba/vfs

      vfs object (S)

      This parameter specifies a shared object files that - are used for Samba VFS I/O operations. By default, normal - disk I/O operations are used but these can be overloaded - with one or more VFS objects.

      Default : no value

      vfs options (S)

      This parameter allows parameters to be passed - to the vfs layer at initialization time. - See also vfs object.

      Default : no value

      volume (S)

      This allows you to override the volume label - returned for a share. Useful for CDROMs with installation programs - that insist on a particular volume label.

      Default: the name of the share

      wide links (S)

      This parameter controls whether or not links - in the UNIX file system may be followed by the server. Links - that point to areas within the directory tree exported by the - server are always allowed; this parameter controls access only - to areas that are outside the directory tree being exported.

      Note that setting this parameter can have a negative - effect on your server performance due to the extra system calls - that Samba has to do in order to perform the link checks.

      Default: wide links = yes

      winbind cache time (G)

      This parameter specifies the number of seconds the - winbindd(8) daemon will cache - user and group information before querying a Windows NT server - again.

      Default: winbind cache type = 15

      winbind enum users (G)

      On large installations using - winbindd(8) it may be - necessary to suppress the enumeration of users through the - setpwent(), - getpwent() and - endpwent() group of system calls. If - the winbind enum users parameter is - no, calls to the getpwent system call - will not return any data.

      Warning: Turning off user - enumeration may cause some programs to behave oddly. For - example, the finger program relies on having access to the - full user list when searching for matching - usernames.

      Default: winbind enum users = yes

      winbind enum groups (G)

      On large installations using - winbindd(8) it may be - necessary to suppress the enumeration of groups through the - setgrent(), - getgrent() and - endgrent() group of system calls. If - the winbind enum groups parameter is - no, calls to the getgrent() system - call will not return any data.

      Warning: Turning off group - enumeration may cause some programs to behave oddly. -

      Default: winbind enum groups = yes -

      winbind gid (G)

      The winbind gid parameter specifies the range of group - ids that are allocated by the winbindd(8) daemon. This range of group ids should have no - existing local or NIS groups within it as strange conflicts can - occur otherwise.

      Default: winbind gid = <empty string> -

      Example: winbind gid = 10000-20000

      winbind separator (G)

      This parameter allows an admin to define the character - used when listing a username of the form of DOMAIN - \user. This parameter - is only applicable when using the pam_winbind.so - and nss_winbind.so modules for UNIX services. -

      Please note that setting this parameter to + causes problems - with group membership at least on glibc systems, as the character + - is used as a special character for NIS in /etc/group.

      Default: winbind separator = '\'

      Example: winbind separator = +

      winbind uid (G)

      The winbind gid parameter specifies the range of group - ids that are allocated by the winbindd(8) daemon. This range of ids should have no - existing local or NIS users within it as strange conflicts can - occur otherwise.

      Default: winbind uid = <empty string> -

      Example: winbind uid = 10000-20000

      winbind use default domain, winbind use default domain (G)

      This parameter specifies whether the winbindd(8) - daemon should operate on users without domain component in their username. - Users without a domain component are treated as is part of the winbindd server's - own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail - function in a way much closer to the way they would in a native unix system.

      Default: winbind use default domain = <no> -

      Example: winbind use default domain = yes

      wins hook (G)

      When Samba is running as a WINS server this - allows you to call an external program for all changes to the - WINS database. The primary use for this option is to allow the - dynamic update of external name resolution databases such as - dynamic DNS.

      The wins hook parameter specifies the name of a script - or executable that will be called as follows:

      wins_hook operation name nametype ttl IP_list -

      • The first argument is the operation and is one - of "add", "delete", or "refresh". In most cases the operation can - be ignored as the rest of the parameters provide sufficient - information. Note that "refresh" may sometimes be called when the - name has not previously been added, in that case it should be treated - as an add.

      • The second argument is the NetBIOS name. If the - name is not a legal name then the wins hook is not called. - Legal names contain only letters, digits, hyphens, underscores - and periods.

      • The third argument is the NetBIOS name - type as a 2 digit hexadecimal number.

      • The fourth argument is the TTL (time to live) - for the name in seconds.

      • The fifth and subsequent arguments are the IP - addresses currently registered for that name. If this list is - empty then the name should be deleted.

      An example script that calls the BIND dynamic DNS update - program nsupdate is provided in the examples - directory of the Samba source code.

      wins proxy (G)

      This is a boolean that controls if nmbd(8) will respond to broadcast name - queries on behalf of other hosts. You may need to set this - to yes for some older clients.

      Default: wins proxy = no

      wins server (G)

      This specifies the IP address (or DNS name: IP - address for preference) of the WINS server that nmbd(8) should register with. If you have a WINS server on - your network then you should set this to the WINS server's IP.

      You should point this at your WINS server if you have a - multi-subnetted network.

      NOTE. You need to set up Samba to point - to a WINS server if you have multiple subnets and wish cross-subnet - browsing to work correctly.

      See the documentation file BROWSING.txt - in the docs/ directory of your Samba source distribution.

      Default: not enabled

      Example: wins server = 192.9.200.1

      wins support (G)

      This boolean controls if the - nmbd(8) process in Samba will act as a WINS server. You should - not set this to yes unless you have a multi-subnetted network and - you wish a particular nmbd to be your WINS server. - Note that you should NEVER set this to yes - on more than one machine in your network.

      Default: wins support = no

      workgroup (G)

      This controls what workgroup your server will - appear to be in when queried by clients. Note that this parameter - also controls the Domain name used with the security = domain - setting.

      Default: set at compile time to WORKGROUP

      Example: workgroup = MYGROUP

      writable (S)

      Synonym for writeable for people who can't spell :-).

      write cache size (S)

      If this integer parameter is set to non-zero value, - Samba will create an in-memory cache for each oplocked file - (it does not do this for - non-oplocked files). All writes that the client does not request - to be flushed directly to disk will be stored in this cache if possible. - The cache is flushed onto disk when a write comes in whose offset - would not fit into the cache or when the file is closed by the client. - Reads for the file are also served from this cache if the data is stored - within it.

      This cache allows Samba to batch client writes into a more - efficient write size for RAID disks (i.e. writes may be tuned to - be the RAID stripe size) and can improve performance on systems - where the disk subsystem is a bottleneck but there is free - memory for userspace programs.

      The integer parameter specifies the size of this cache - (per oplocked file) in bytes.

      Default: write cache size = 0

      Example: write cache size = 262144

      for a 256k cache size per file.

      write list (S)

      This is a list of users that are given read-write - access to a service. If the connecting user is in this list then - they will be given write access, no matter what the read only - option is set to. The list can include group names using the - @group syntax.

      Note that if a user is in both the read list and the - write list then they will be given write access.

      See also the read list - option.

      Default: write list = <empty string> -

      Example: write list = admin, root, @staff -

      wins partners (G)

      A space separated list of partners' IP addresses for - WINS replication. WINS partners are always defined as push/pull - partners as defining only one way WINS replication is unreliable. - WINS replication is currently experimental and unreliable between - samba servers. -

      Default: wins partners =

      Example: wins partners = 192.168.0.1 172.16.1.2

      write ok (S)

      Inverted synonym for read only.

      write raw (G)

      This parameter controls whether or not the server - will support raw write SMB's when transferring data from clients. - You should never need to change this parameter.

      Default: write raw = yes

      writeable (S)

      Inverted synonym for read only.

      WARNINGS

      Although the configuration file permits service names + the group of the same name.

    2. If the service is a guest service then a + connection is made as the username given in the "guest + account =" for the service, irrespective of the + supplied password.

    COMPLETE LIST OF GLOBAL PARAMETERS

    Here is a list of all global parameters. See the section of + each parameter for details. Note that some are synonyms.

      COMPLETE LIST OF SERVICE PARAMETERS

      Here is a list of all service parameters. See the section on + each parameter for details. Note that some are synonyms.

        EXPLANATION OF EACH PARAMETER

        WARNINGS

        Although the configuration file permits service names to contain spaces, your client software may not. Spaces will be ignored in comparisons anyway, so it shouldn't be a - problem - but be aware of the possibility.

        On a similar note, many clients - especially DOS clients - - limit service names to eight characters. smbd(8) - has no such limitation, but attempts to connect from such + problem - but be aware of the possibility.

        On a similar note, many clients - especially DOS clients - + limit service names to eight characters. smbd(8) has no such limitation, but attempts to connect from such clients will fail if they truncate the service names. For this reason you should probably keep your service names down to eight characters - in length.

        Use of the [homes] and [printers] special sections make life + in length.

        Use of the [homes] and [printers] special sections make life for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme care when designing these sections. In particular, ensure that the permissions on spool - directories are correct.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        SEE ALSO

        samba(7), - smbpasswd(8), - swat(8), - smbd(8), - nmbd(8), - smbclient(1), - nmblookup(1), - testparm(1), - testprns(1) -

        AUTHOR

        The original Samba software and related utilities + directories are correct.

        VERSION

        This man page is correct for version 3.0 of the Samba suite.

        SEE ALSO

        + samba(7), smbpasswd(8), swat(8), smbd(8), nmbd(8), smbclient(1), nmblookup(1), testparm(1), testprns(1).

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbcacls.1.html b/docs/htmldocs/smbcacls.1.html index e0425d481d..d7c5fed1b5 100644 --- a/docs/htmldocs/smbcacls.1.html +++ b/docs/htmldocs/smbcacls.1.html @@ -1,415 +1,95 @@ - -smbcacls

        smbcacls

        Name

        smbcacls -- Set or get ACLs on an NT file or directory names

        Synopsis

        smbcacls {//server/share} {filename} [-U username] [-A acls] [-M acls] [-D acls] [-S acls] [-C name] [-G name] [-n] [-h]

        DESCRIPTION

        This tool is part of the Samba suite.

        The smbcacls program manipulates NT Access Control - Lists (ACLs) on SMB file shares.

        OPTIONS

        The following options are available to the smbcacls program. - The format of ACLs is described in the section ACL FORMAT

        -A acls

        Add the ACLs specified to the ACL list. Existing - access control entries are unchanged.

        -M acls

        Modify the mask value (permissions) for the ACLs +smbcacls

        Name

        smbcacls — Set or get ACLs on an NT file or directory names

        Synopsis

        smbcacls {//server/share} {filename} [-D acls] [-M acls] [-A acls] [-S acls] [-C name] [-G name] [-n] [-t] [-U username] [-h] [-d]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        The smbcacls program manipulates NT Access Control + Lists (ACLs) on SMB file shares.

        OPTIONS

        The following options are available to the smbcacls program. + The format of ACLs is described in the section ACL FORMAT

        -A acls

        Add the ACLs specified to the ACL list. Existing + access control entries are unchanged.

        -M acls

        Modify the mask value (permissions) for the ACLs specified on the command line. An error will be printed for each ACL specified that was not already present in the ACL list -

        -D acls

        Delete any ACLs specified on the command line. +

        -D acls

        Delete any ACLs specified on the command line. An error will be printed for each ACL specified that was not - already present in the ACL list.

        -S acls

        This command sets the ACLs on the file with + already present in the ACL list.

        -S acls

        This command sets the ACLs on the file with only the ones specified on the command line. All other ACLs are erased. Note that the ACL specified must contain at least a revision, - type, owner and group for the call to succeed.

        -U username

        Specifies a username used to connect to the - specified service. The username may be of the form "username" in + type, owner and group for the call to succeed.

        -U username

        Specifies a username used to connect to the + specified service. The username may be of the form "username" in which case the user is prompted to enter in a password and the - workgroup specified in the smb.conf file is - used, or "username%password" or "DOMAIN\username%password" and the - password and workgroup names are used as provided.

        -C name

        The owner of a file or directory can be changed - to the name given using the -C option. + workgroup specified in the smb.conf(5) file is + used, or "username%password" or "DOMAIN\username%password" and the + password and workgroup names are used as provided.

        -C name

        The owner of a file or directory can be changed + to the name given using the -C option. The name can be a sid in the form S-1-x-y-z or a name resolved - against the server specified in the first argument.

        This command is a shortcut for -M OWNER:name. -

        -G name

        The group owner of a file or directory can - be changed to the name given using the -G + against the server specified in the first argument.

        This command is a shortcut for -M OWNER:name. +

        -G name

        The group owner of a file or directory can + be changed to the name given using the -G option. The name can be a sid in the form S-1-x-y-z or a name resolved against the server specified n the first argument. -

        This command is a shortcut for -M GROUP:name.

        -n

        This option displays all ACL information in numeric +

        This command is a shortcut for -M GROUP:name.

        -n

        This option displays all ACL information in numeric format. The default is to convert SIDs to names and ACE types - and masks to a readable string format.

        -h

        Print usage information on the smbcacls - program.

        ACL FORMAT

        The format of an ACL is one or more ACL entries separated by - either commas or newlines. An ACL entry is one of the following: 

         
+		and masks to a readable string format.
        -t

        + Don't actually do anything, only validate the correctness of + the arguments. +

        -h|--help

        Print a summary of command line options. +

        -V

        Prints the version number for +smbd.

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

        The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

        Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -l|--logfile=logbasename

        File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

        ACL FORMAT

        The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following: 

         
 REVISION:<revision number>
 OWNER:<sid or name>
 GROUP:<sid or name>
 ACL:<sid or name>:<type>/<flags>/<mask>
-

        The revision of the ACL specifies the internal Windows +

        The revision of the ACL specifies the internal Windows NT ACL revision for the security descriptor. If not specified it defaults to 1. Using values other than 1 may - cause strange behaviour.

        The owner and group specify the owner and group sids for the + cause strange behaviour.

        The owner and group specify the owner and group sids for the object. If a SID in the format CWS-1-x-y-z is specified this is used, otherwise the name specified is resolved using the server on which - the file or directory resides.

        ACLs specify permissions granted to the SID. This SID again - can be specified in CWS-1-x-y-z format or as a name in which case - it is resolved against the server on which the file or directory - resides. The type, flags and mask values determine the type of - access granted to the SID.

        The type can be either 0 or 1 corresponding to ALLOWED or - DENIED access to the SID. The flags values are generally - zero for file ACLs and either 9 or 2 for directory ACLs. Some - common flags are:

        At present flags can only be specified as decimal or - hexadecimal values.

        The mask is a value which expresses the access right + the file or directory resides.

        ACLs specify permissions granted to the SID. This SID again + can be specified in CWS-1-x-y-z format or as a name in which case + it is resolved against the server on which the file or directory + resides. The type, flags and mask values determine the type of + access granted to the SID.

        The type can be either 0 or 1 corresponding to ALLOWED or + DENIED access to the SID. The flags values are generally + zero for file ACLs and either 9 or 2 for directory ACLs. Some + common flags are:

        • #define SEC_ACE_FLAG_OBJECT_INHERIT 0x1

        • #define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2

        • #define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4

        • #define SEC_ACE_FLAG_INHERIT_ONLY 0x8

        At present flags can only be specified as decimal or + hexadecimal values.

        The mask is a value which expresses the access right granted to the SID. It can be given as a decimal or hexadecimal value, or by using one of the following text strings which map to the NT - file permissions of the same name.

        The following combined permissions can be specified:

        EXIT STATUS

        The smbcacls program sets the exit status + file permissions of the same name.

        • R - Allow read access

        • W - Allow write access

        • X - Execute permission on the object

        • D - Delete the object

        • P - Change permissions

        • O - Take ownership

        The following combined permissions can be specified:

        • READ - Equivalent to 'RX' + permissions

        • CHANGE - Equivalent to 'RXWD' permissions +

        • FULL - Equivalent to 'RWXDPO' + permissions

        EXIT STATUS

        The smbcacls program sets the exit status depending on the success or otherwise of the operations performed. - The exit status may be one of the following values.

        If the operation succeeded, smbcacls returns and exit - status of 0. If smbcacls couldn't connect to the specified server, + The exit status may be one of the following values.

        If the operation succeeded, smbcacls returns and exit + status of 0. If smbcacls couldn't connect to the specified server, or there was an error getting or setting the ACLs, an exit status of 1 is returned. If there was an error parsing any command line - arguments, an exit status of 2 is returned.

        VERSION

        This man page is correct for version 2.2 of - the Samba suite.

        AUTHOR

        The original Samba software and related utilities + arguments, an exit status of 2 is returned.

        VERSION

        This man page is correct for version 3.0 of the Samba suite.

        AUTHOR

        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.

        smbcacls was written by Andrew Tridgell - and Tim Potter.

        The conversion to DocBook for Samba 2.2 was done - by Gerald Carter

        \ No newline at end of file + to the way the Linux kernel is developed.

        smbcacls was written by Andrew Tridgell + and Tim Potter.

        The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done + by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbclient.1.html b/docs/htmldocs/smbclient.1.html index ca8cafd312..ecb85d6e85 100644 --- a/docs/htmldocs/smbclient.1.html +++ b/docs/htmldocs/smbclient.1.html @@ -1,1645 +1,424 @@ - -smbclient

        smbclient

        Name

        smbclient -- ftp-like client to access SMB/CIFS resources - on servers

        Synopsis

        smbclient {servicename} [password] [-b <buffer size>] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logfile] [-L <netbios name>] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan]

        DESCRIPTION

        This tool is part of the Samba suite.

        smbclient is a client that can +smbclient

        Name

        smbclient — ftp-like client to access SMB/CIFS resources + on servers

        Synopsis

        smbclient {servicename} [password] [-b <buffer size>] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logfile] [-L <netbios name>] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        smbclient is a client that can 'talk' to an SMB/CIFS server. It offers an interface - similar to that of the ftp program (see ftp(1)). + similar to that of the ftp program (see ftp(1)). Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server - and so on.

        OPTIONS

        servicename

        servicename is the name of the service + and so on.

        OPTIONS

        servicename

        servicename is the name of the service you want to use on the server. A service name takes the form - //server/service where server - is the NetBIOS name of the SMB/CIFS server - offering the desired service and service + //server/service where server + is the NetBIOS name of the SMB/CIFS server + offering the desired service and service is the name of the service offered. Thus to connect to - the service "printer" on the SMB/CIFS server "smbserver", - you would use the servicename //smbserver/printer -

        Note that the server name required is NOT necessarily + the service "printer" on the SMB/CIFS server "smbserver", + you would use the servicename //smbserver/printer +

        Note that the server name required is NOT necessarily the IP (DNS) host name of the server ! The name required is a NetBIOS server name, which may or may not be the same as the IP hostname of the machine running the server. -

        The server name is looked up according to either - the -R parameter to smbclient or - using the name resolve order parameter in the smb.conf file, +

        The server name is looked up according to either + the -R parameter to smbclient or + using the name resolve order parameter in + the smb.conf(5) file, allowing an administrator to change the order and methods - by which server names are looked up.

        password

        The password required to access the specified + by which server names are looked up.

        password

        The password required to access the specified service on the specified server. If this parameter is - supplied, the -N option (suppress - password prompt) is assumed.

        There is no default password. If no password is supplied + supplied, the -N option (suppress + password prompt) is assumed.

        There is no default password. If no password is supplied on the command line (either by using this parameter or adding - a password to the -U option (see - below)) and the -N option is not + a password to the -U option (see + below)) and the -N option is not specified, the client will prompt for a password, even if the desired service does not require one. (If no password is required, simply press ENTER to provide a null password.) -

        Note: Some servers (including OS/2 and Windows for +

        Note: Some servers (including OS/2 and Windows for Workgroups) insist on an uppercase password. Lowercase or mixed case passwords may be rejected by these servers. -

        Be cautious about including passwords in scripts. -

        -s smb.conf

        Specifies the location of the all important - smb.conf file.

        -O socket options

        TCP socket options to set on the client - socket. See the socket options parameter in the smb.conf (5) manpage for the list of valid - options.

        -R <name resolve order>

        This option is used by the programs in the Samba +

        Be cautious about including passwords in scripts. +

        -R <name resolve order>

        This option is used by the programs in the Samba suite to determine what naming services and in what order to resolve host names to IP addresses. The option takes a space-separated - string of different name resolution options.

        The options are :"lmhosts", "host", "wins" and "bcast". They - cause names to be resolved as follows :

        • lmhosts : Lookup an IP + string of different name resolution options.

          The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows:

          • lmhosts: Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see the lmhosts(5) for details) then - any name type matches for lookup.

          • host : Do a standard host - name to IP address resolution, using the system /etc/hosts - , NIS, or DNS lookups. This method of name resolution + no name type attached to the NetBIOS name (see + the lmhosts(5) for details) then + any name type matches for lookup.

          • host: Do a standard host + name to IP address resolution, using the system /etc/hosts + , NIS, or DNS lookups. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this - may be controlled by the /etc/nsswitch.conf + may be controlled by the /etc/nsswitch.conf file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise - it is ignored.

          • wins : Query a name with - the IP address listed in the wins server + it is ignored.

          • wins: Query a name with + the IP address listed in the wins server parameter. If no WINS server has - been specified this method will be ignored.

          • bcast : Do a broadcast on + been specified this method will be ignored.

          • bcast: Do a broadcast on each of the known local interfaces listed in the - interfaces + interfaces parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally - connected subnet.

          If this parameter is not set then the name resolve order - defined in the smb.conf file parameter - (name resolve order) will be used.

          The default order is lmhosts, host, wins, bcast and without - this parameter or any entry in the name resolve order - parameter of the smb.conf file the name resolution - methods will be attempted in this order.

        -M NetBIOS name

        This options allows you to send messages, using - the "WinPopup" protocol, to another computer. Once a connection is + connected subnet.

        If this parameter is not set then the name resolve order + defined in the smb.conf(5) file parameter + (name resolve order) will be used.

        The default order is lmhosts, host, wins, bcast and without + this parameter or any entry in the name resolve order + parameter of the smb.conf(5) file the name resolution + methods will be attempted in this order.

        -M NetBIOS name

        This options allows you to send messages, using + the "WinPopup" protocol, to another computer. Once a connection is established you then type your message, pressing ^D (control-D) to - end.

        If the receiving computer is running WinPopup the user will + end.

        If the receiving computer is running WinPopup the user will receive the message and probably a beep. If they are not running WinPopup the message will be lost, and no error message will - occur.

        The message is also automatically truncated if the message + occur.

        The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol. -

        One useful trick is to cat the message through - smbclient. For example: cat mymessage.txt | smbclient -M FRED will - send the message in the file mymessage.txt - to the machine FRED.

        You may also find the -U and - -I options useful, as they allow you to - control the FROM and TO parts of the message.

        See the message command parameter in the smb.conf(5) for a description of how to handle incoming - WinPopup messages in Samba.

        Note: Copy WinPopup into the startup group +

        One useful trick is to cat the message through + smbclient. For example: + cat mymessage.txt | smbclient -M FRED will + send the message in the file mymessage.txt + to the machine FRED.

        You may also find the -U and + -I options useful, as they allow you to + control the FROM and TO parts of the message.

        See the message command parameter in the smb.conf(5) for a description of how to handle incoming + WinPopup messages in Samba.

        Note: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive - messages.

        -i scope

        This specifies a NetBIOS scope that smbclient will - use to communicate with when generating NetBIOS names. For details - on the use of NetBIOS scopes, see rfc1001.txt - and rfc1002.txt. - NetBIOS scopes are very rarely used, only set - this parameter if you are the system administrator in charge of all - the NetBIOS systems you communicate with.

        -N

        If specified, this parameter suppresses the normal - password prompt from the client to the user. This is useful when - accessing a service that does not require a password.

        Unless a password is specified on the command line or - this parameter is specified, the client will request a - password.

        -n NetBIOS name

        By default, the client will use the local - machine's hostname (in uppercase) as its NetBIOS name. This parameter - allows you to override the host name and use whatever NetBIOS - name you wish.

        -d debuglevel

        debuglevel is an integer from 0 to 10, or - the letter 'A'.

        The default value if this parameter is not specified - is zero.

        The higher this value, the more detail will be logged to - the log files about the activities of the - client. At level 0, only critical errors and serious warnings will - be logged. Level 1 is a reasonable level for day to day running - - it generates a small amount of information about operations - carried out.

        Levels above 1 will generate considerable amounts of log - data, and should only be used when investigating a problem. - Levels above 3 are designed for use only by developers and - generate HUGE amounts of log data, most of which is extremely - cryptic. If debuglevel is set to the letter 'A', then all - debug messages will be printed. This setting - is for developers only (and people who really want - to know how the code works internally).

        Note that specifying this parameter here will override - the log level parameter in the smb.conf (5) - file.

        -p port

        This number is the TCP port number that will be used + messages.

        -p port

        This number is the TCP port number that will be used when making connections to the server. The standard (well-known) TCP port number for an SMB/CIFS server is 139, which is the - default.

        -l logfilename

        If specified, logfilename specifies a base filename + default.

        -l logfilename

        If specified, logfilename specifies a base filename into which operational data from the running client will be - logged.

        The default base name is specified at compile time.

        The base name is used to generate actual log file names. - For example, if the name specified was "log", the debug file - would be log.client.

        The log file generated is never removed by the client. -

        -h

        Print the usage message for the client.

        -I IP-address

        IP address is the address of the server to connect to. - It should be specified in standard "a.b.c.d" notation.

        Normally the client would attempt to locate a named + logged.

        The default base name is specified at compile time.

        The base name is used to generate actual log file names. + For example, if the name specified was "log", the debug file + would be log.client.

        The log file generated is never removed by the client. +

        -h|--help

        Print a summary of command line options. +

        -I IP-address

        IP address is the address of the server to connect to. + It should be specified in standard "a.b.c.d" notation.

        Normally the client would attempt to locate a named SMB/CIFS server by looking it up via the NetBIOS name resolution - mechanism described above in the name resolve order + mechanism described above in the name resolve order parameter above. Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being - connected to will be ignored.

        There is no default for this parameter. If not supplied, + connected to will be ignored.

        There is no default for this parameter. If not supplied, it will be determined automatically by the client as described - above.

        -E

        This parameter causes the client to write messages + above.

        -E

        This parameter causes the client to write messages to the standard error stream (stderr) rather than to the standard - output stream.

        By default, the client writes messages to standard output - - typically the user's tty.

        -U username[%pass]

        Sets the SMB username or username and password. - If %pass is not specified, The user will be prompted. The client - will first check the USER environment variable, then the - LOGNAME variable and if either exists, the - string is uppercased. Anything in these variables following a '%' - sign will be treated as the password. If these environment - variables are not found, the username GUEST - is used.

        If the password is not included in these environment - variables (using the %pass syntax), smbclient will look for - a PASSWD environment variable from which - to read the password.

        A third option is to use a credentials file which - contains the plaintext of the domain name, username and password. This - option is mainly provided for scripts where the admin doesn't - wish to pass the credentials on the command line or via environment - variables. If this method is used, make certain that the permissions - on the file restrict access from unwanted users. See the - -A for more details.

        Be cautious about including passwords in scripts or in - the PASSWD environment variable. Also, on - many systems the command line of a running process may be seen - via the ps command to be safe always allow - smbclient to prompt for a password and type - it in directly.

        -A filename

        This option allows - you to specify a file from which to read the username, domain name, and - password used in the connection. The format of the file is - 

        username = <value> 
-password = <value>
-domain = <value>
-

        If the domain parameter is missing the current workgroup name - is used instead. Make certain that the permissions on the file restrict - access from unwanted users.

        -L

        This option allows you to look at what services - are available on a server. You use it as smbclient -L - host and a list should appear. The -I - option may be useful if your NetBIOS names don't + output stream.

        By default, the client writes messages to standard output + - typically the user's tty.

        -L

        This option allows you to look at what services + are available on a server. You use it as smbclient -L + host and a list should appear. The -I + option may be useful if your NetBIOS names don't match your TCP/IP DNS host names or if you are trying to reach a - host on another network.

        -t terminal code

        This option tells smbclient how to interpret + host on another network.

        -t terminal code

        This option tells smbclient how to interpret filenames coming from the remote server. Usually Asian language multibyte UNIX implementations use different character sets than - SMB/CIFS servers (EUC instead of SJIS for example). Setting this parameter will let - smbclient convert between the UNIX filenames and + SMB/CIFS servers (EUC instead of + SJIS for example). Setting this parameter will let + smbclient convert between the UNIX filenames and the SMB filenames correctly. This option has not been seriously tested - and may have some problems.

        The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, + and may have some problems.

        The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, CWjunet, CWhex, CWcap. This is not a complete list, check the Samba - source code for the complete list.

        -b buffersize

        This option changes the transmit/send buffer + source code for the complete list.

        -b buffersize

        This option changes the transmit/send buffer size when getting or putting a file from/to the server. The default is 65520 bytes. Setting this value smaller (to 1200 bytes) has been observed to speed up file transfers to and from a Win9x server. -

        -W WORKGROUP

        Override the default workgroup (domain) specified - in the workgroup parameter of the smb.conf - file for this connection. This may be needed to connect to some - servers.

        -T tar options

        smbclient may be used to create tar(1) - compatible backups of all the files on an SMB/CIFS +

        -V

        Prints the version number for +smbd.

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

        The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

        Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -l|--logfile=logbasename

        File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

        -N

        If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password.

        Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.

        -k

        +Try to authenticate with kerberos. Only useful in +an Active Directory environment. +

        -A|--authfile=filename

        This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +

        +username = <value>
+password = <value>
+domain   = <value>
+

        Make certain that the permissions on the file restrict +access from unwanted users.

        -U|--user=username[%password]

        Sets the SMB username or username and password.

        If %password is not specified, the user will be prompted. The +client will first check the USER environment variable, then the +LOGNAME variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username GUEST is used.

        A third option is to use a credentials file which +contains the plaintext of the username and password. This +option is mainly provided for scripts where the admin does not +wish to pass the credentials on the command line or via environment +variables. If this method is used, make certain that the permissions +on the file restrict access from unwanted users. See the +-A for more details.

        Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the ps command. To be safe always allow +rpcclient to prompt for a password and type +it in directly.

        -n <primary NetBIOS name>

        This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the NetBIOS +name parameter in the smb.conf(5) file. However, a command +line setting will take precedence over settings in +smb.conf(5).

        -i <scope>

        This specifies a NetBIOS scope that +nmblookup will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +very rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.

        -W|--workgroup=domain

        Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM).

        -O socket options

        TCP socket options to set on the client +socket. See the socket options parameter in +the smb.conf(5) manual page for the list of valid +options.

        -T tar options

        smbclient may be used to create tar(1) + compatible backups of all the files on an SMB/CIFS share. The secondary tar flags that can be given to this option - are :

        • c - Create a tar file on UNIX. + are :

          • c - Create a tar file on UNIX. Must be followed by the name of a tar file, tape device - or "-" for standard output. If using standard output you must + or "-" for standard output. If using standard output you must turn the log level to its lowest value -d0 to avoid corrupting your tar file. This flag is mutually exclusive with the - x flag.

          • x - Extract (restore) a local + x flag.

          • x - Extract (restore) a local tar file back to a share. Unless the -D option is given, the tar files will be restored from the top level of the share. Must be - followed by the name of the tar file, device or "-" for standard - input. Mutually exclusive with the c flag. + followed by the name of the tar file, device or "-" for standard + input. Mutually exclusive with the c flag. Restored files have their creation times (mtime) set to the date saved in the tar file. Directories currently do not get - their creation dates restored properly.

          • I - Include files and directories. + their creation dates restored properly.

          • I - Include files and directories. Is the default behavior when filenames are specified above. Causes tar files to be included in an extract or create (and therefore everything else to be excluded). See example below. Filename globbing - works in one of two ways. See r below.

          • X - Exclude files and directories. + works in one of two ways. See r below.

          • X - Exclude files and directories. Causes tar files to be excluded from an extract or create. See example below. Filename globbing works in one of two ways now. - See r below.

          • b - Blocksize. Must be followed + See r below.

          • b - Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte) blocks. -

          • g - Incremental. Only back up +

          • g - Incremental. Only back up files that have the archive bit set. Useful only with the - c flag.

          • q - Quiet. Keeps tar from printing + c flag.

          • q - Quiet. Keeps tar from printing diagnostics as it works. This is the same as tarmode quiet. -

          • r - Regular expression include +

          • r - Regular expression include or exclude. Uses regular expression matching for excluding or excluding files if compiled with HAVE_REGEX_H. However this mode can be very slow. If not compiled with HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. -

          • N - Newer than. Must be followed +

          • N - Newer than. Must be followed by the name of a file whose date is compared against files found on the share during a create. Only files newer than the file specified are backed up to the tar file. Useful only with the - c flag.

          • a - Set archive bit. Causes the + c flag.

          • a - Set archive bit. Causes the archive bit to be reset when a file is backed up. Useful with the - g and c flags. -

          Tar Long File Names

          smbclient's tar option now supports long + g and c flags. +

        Tar Long File Names

        smbclient's tar option now supports long file names both on backup and restore. However, the full path name of the file must be less than 1024 bytes. Also, when - a tar archive is created, smbclient's tar option places all + a tar archive is created, smbclient's tar option places all files in the archive with relative names, not absolute names. -

        Tar Filenames

        All file names can be given as DOS path names (with '\' +

        Tar Filenames

        All file names can be given as DOS path names (with '\\' as the component separator) or as UNIX path names (with '/' as - the component separator).

        Examples

        Restore from tar file backup.tar into myshare on mypc - (no password on share).

        smbclient //mypc/yshare "" -N -Tx backup.tar -

        Restore everything except users/docs -

        smbclient //mypc/myshare "" -N -TXx backup.tar - users/docs

        Create a tar file of the files beneath users/docs.

        smbclient //mypc/myshare "" -N -Tc - backup.tar users/docs

        Create the same tar file as above, but now use - a DOS path name.

        smbclient //mypc/myshare "" -N -tc backup.tar - users\edocs

        Create a tar file of all the files and directories in - the share.

        smbclient //mypc/myshare "" -N -Tc backup.tar * -

        -D initial directory

        Change to initial directory before starting. Probably - only of any use with the tar -T option.

        -c command string

        command string is a semicolon-separated list of - commands to be executed instead of prompting from stdin. -N is implied by -c.

        This is particularly useful in scripts and for printing stdin - to the server, e.g. -c 'print -'.

        OPERATIONS

        Once the client is running, the user is presented with - a prompt :

        smb:\>

        The backslash ("\") indicates the current working directory + the component separator).

        Examples

        Restore from tar file backup.tar into myshare on mypc + (no password on share).

        smbclient //mypc/yshare "" -N -Tx backup.tar +

        Restore everything except users/docs +

        smbclient //mypc/myshare "" -N -TXx backup.tar + users/docs

        Create a tar file of the files beneath + users/docs.

        smbclient //mypc/myshare "" -N -Tc + backup.tar users/docs

        Create the same tar file as above, but now use + a DOS path name.

        smbclient //mypc/myshare "" -N -tc backup.tar + users\edocs

        Create a tar file of all the files and directories in + the share.

        smbclient //mypc/myshare "" -N -Tc backup.tar * +

        -D initial directory

        Change to initial directory before starting. Probably + only of any use with the tar -T option.

        -c command string

        command string is a semicolon-separated list of + commands to be executed instead of prompting from stdin. + -N is implied by -c.

        This is particularly useful in scripts and for printing stdin + to the server, e.g. -c 'print -'.

        OPERATIONS

        Once the client is running, the user is presented with + a prompt :

        smb:\>

        The backslash ("\\") indicates the current working directory on the server, and will change if the current working directory - is changed.

        The prompt indicates that the client is ready and waiting to + is changed.

        The prompt indicates that the client is ready and waiting to carry out a user command. Each command is a single word, optionally followed by parameters specific to that command. Command and parameters are space-delimited unless these notes specifically state otherwise. All commands are case-insensitive. Parameters to commands may or may not be case sensitive, depending on the command. -

        You can specify file names which have spaces in them by quoting - the name with double quotes, for example "a long file name".

        Parameters shown in square brackets (e.g., "[parameter]") are +

        You can specify file names which have spaces in them by quoting + the name with double quotes, for example "a long file name".

        Parameters shown in square brackets (e.g., "[parameter]") are optional. If not given, the command will use suitable defaults. Parameters - shown in angle brackets (e.g., "<parameter>") are required. -

        Note that all commands operating on the server are actually + shown in angle brackets (e.g., "<parameter>") are required. +

        Note that all commands operating on the server are actually performed by issuing a request to the server. Thus the behavior may vary from server to server, depending on how the server was implemented. -

        The commands available are given here in alphabetical order.

        ? [command]

        If command is specified, the ? command will display +

        The commands available are given here in alphabetical order.

        ? [command]

        If command is specified, the ? command will display a brief informative message about the specified command. If no command is specified, a list of available commands will - be displayed.

        ! [shell command]

        If shell command is specified, the ! + be displayed.

        ! [shell command]

        If shell command is specified, the ! command will execute a shell locally and run the specified shell command. If no command is specified, a local shell will be run. -

        altname file

        The client will request that the server return - the "alternate" name (the 8.3 name) for a file or directory. -

        cancel jobid0 [jobid1] ... [jobidN]

        The client will request that the server cancel +

        altname file

        The client will request that the server return + the "alternate" name (the 8.3 name) for a file or directory. +

        cancel jobid0 [jobid1] ... [jobidN]

        The client will request that the server cancel the printjobs identified by the given numeric print job ids. -

        chmod file mode in octal

        This command depends on the server supporting the CIFS +

        chmod file mode in octal

        This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server change the UNIX permissions to the given octal mode, in standard UNIX format. -

        chown file uid gid

        This command depends on the server supporting the CIFS +

        chown file uid gid

        This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server change the UNIX user and group ownership to the given decimal values. Note there is currently no way to remotely look up the UNIX uid and gid values for a given name. This may be addressed in future versions of the CIFS UNIX extensions. -

        cd [directory name]

        If "directory name" is specified, the current +

        cd [directory name]

        If "directory name" is specified, the current working directory on the server will be changed to the directory specified. This operation will fail if for any reason the specified - directory is inaccessible.

        If no directory name is specified, the current working - directory on the server will be reported.

        del <mask>

        The client will request that the server attempt - to delete all files matching mask from the current working - directory on the server.

        dir <mask>

        A list of the files matching mask in the current + directory is inaccessible.

        If no directory name is specified, the current working + directory on the server will be reported.

        del <mask>

        The client will request that the server attempt + to delete all files matching mask from the current working + directory on the server.

        dir <mask>

        A list of the files matching mask in the current working directory on the server will be retrieved from the server - and displayed.

        exit

        Terminate the connection with the server and exit - from the program.

        get <remote file name> [local file name]

        Copy the file called remote file name from + and displayed.

        exit

        Terminate the connection with the server and exit + from the program.

        get <remote file name> [local file name]

        Copy the file called remote file name from the server to the machine running the client. If specified, name - the local copy local file name. Note that all transfers in - smbclient are binary. See also the - lowercase command.

        help [command]

        See the ? command above.

        lcd [directory name]

        If directory name is specified, the current + the local copy local file name. Note that all transfers in + smbclient are binary. See also the + lowercase command.

        help [command]

        See the ? command above.

        lcd [directory name]

        If directory name is specified, the current working directory on the local machine will be changed to the directory specified. This operation will fail if for any - reason the specified directory is inaccessible.

        If no directory name is specified, the name of the + reason the specified directory is inaccessible.

        If no directory name is specified, the name of the current working directory on the local machine will be reported. -

        link source destination

        This command depends on the server supporting the CIFS +

        link source destination

        This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server create a hard link between the source and destination files. The source file must not exist. -

        lowercase

        Toggle lowercasing of filenames for the get and - mget commands.

        When lowercasing is toggled ON, local filenames are converted +

        lowercase

        Toggle lowercasing of filenames for the get and + mget commands.

        When lowercasing is toggled ON, local filenames are converted to lowercase when using the get and mget commands. This is often useful when copying (say) MSDOS files from a server, because - lowercase filenames are the norm on UNIX systems.

        ls <mask>

        See the dir command above.

        mask <mask>

        This command allows the user to set up a mask + lowercase filenames are the norm on UNIX systems.

        ls <mask>

        See the dir command above.

        mask <mask>

        This command allows the user to set up a mask which will be used during recursive operation of the mget and - mput commands.

        The masks specified to the mget and mput commands act as + mput commands.

        The masks specified to the mget and mput commands act as filters for directories rather than files when recursion is - toggled ON.

        The mask specified with the mask command is necessary + toggled ON.

        The mask specified with the mask command is necessary to filter files within those directories. For example, if the - mask specified in an mget command is "source*" and the mask - specified with the mask command is "*.c" and recursion is + mask specified in an mget command is "source*" and the mask + specified with the mask command is "*.c" and recursion is toggled ON, the mget command will retrieve all files matching - "*.c" in all directories below and including all directories - matching "source*" in the current working directory.

        Note that the value for mask defaults to blank (equivalent - to "*") and remains so until the mask command is used to change it. + "*.c" in all directories below and including all directories + matching "source*" in the current working directory.

        Note that the value for mask defaults to blank (equivalent + to "*") and remains so until the mask command is used to change it. It retains the most recently specified value indefinitely. To avoid unexpected results it would be wise to change the value of - mask back to "*" after using the mget or mput commands.

        md <directory name>

        See the mkdir command.

        mget <mask>

        Copy all files matching mask from the server to - the machine running the client.

        Note that mask is interpreted differently during recursive + mask back to "*" after using the mget or mput commands.

        md <directory name>

        See the mkdir command.

        mget <mask>

        Copy all files matching mask from the server to + the machine running the client.

        Note that mask is interpreted differently during recursive operation and non-recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in - smbclient are binary. See also the lowercase command.

        mkdir <directory name>

        Create a new directory on the server (user access - privileges permitting) with the specified name.

        mput <mask>

        Copy all files matching mask in the current working + smbclient are binary. See also the lowercase command.

        mkdir <directory name>

        Create a new directory on the server (user access + privileges permitting) with the specified name.

        mput <mask>

        Copy all files matching mask in the current working directory on the local machine to the current working directory on - the server.

        Note that mask is interpreted differently during recursive + the server.

        Note that mask is interpreted differently during recursive operation and non-recursive operation - refer to the recurse and mask - commands for more information. Note that all transfers in smbclient - are binary.

        print <file name>

        Print the specified file from the local machine - through a printable service on the server.

        See also the printmode command.

        printmode <graphics or text>

        Set the print mode to suit either binary data + commands for more information. Note that all transfers in smbclient + are binary.

        print <file name>

        Print the specified file from the local machine + through a printable service on the server.

        See also the printmode command.

        printmode <graphics or text>

        Set the print mode to suit either binary data (such as graphical information) or text. Subsequent print - commands will use the currently set print mode.

        prompt

        Toggle prompting for filenames during operation - of the mget and mput commands.

        When toggled ON, the user will be prompted to confirm + commands will use the currently set print mode.

        prompt

        Toggle prompting for filenames during operation + of the mget and mput commands.

        When toggled ON, the user will be prompted to confirm the transfer of each file during these commands. When toggled OFF, all specified files will be transferred without prompting. -

        put <local file name> [remote file name]

        Copy the file called local file name from the +

        put <local file name> [remote file name]

        Copy the file called local file name from the machine running the client to the server. If specified, - name the remote copy remote file name. Note that all transfers - in smbclient are binary. See also the lowercase command. -

        queue

        Displays the print queue, showing the job id, - name, size and current status.

        quit

        See the exit command.

        rd <directory name>

        See the rmdir command.

        recurse

        Toggle directory recursion for the commands mget - and mput.

        When toggled ON, these commands will process all directories + name the remote copy remote file name. Note that all transfers + in smbclient are binary. See also the lowercase command. +

        queue

        Displays the print queue, showing the job id, + name, size and current status.

        quit

        See the exit command.

        rd <directory name>

        See the rmdir command.

        recurse

        Toggle directory recursion for the commands mget + and mput.

        When toggled ON, these commands will process all directories in the source directory (i.e., the directory they are copying from ) and will recurse into any that match the mask specified to the command. Only files that match the mask specified using the mask command will be retrieved. See also the mask command. -

        When recursion is toggled OFF, only files from the current +

        When recursion is toggled OFF, only files from the current working directory on the source machine that match the mask specified to the mget or mput commands will be copied, and any mask specified - using the mask command will be ignored.

        rm <mask>

        Remove all files matching mask from the current - working directory on the server.

        rmdir <directory name>

        Remove the specified directory (user access - privileges permitting) from the server.

        setmode <filename> <perm=[+|\-]rsha>

        A version of the DOS attrib command to set - file permissions. For example:

        setmode myfile +r

        would make myfile read only.

        symlink source destination

        This command depends on the server supporting the CIFS + using the mask command will be ignored.

        rm <mask>

        Remove all files matching mask from the current + working directory on the server.

        rmdir <directory name>

        Remove the specified directory (user access + privileges permitting) from the server.

        setmode <filename> <perm=[+|\-]rsha>

        A version of the DOS attrib command to set + file permissions. For example:

        setmode myfile +r

        would make myfile read only.

        symlink source destination

        This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server create a symbolic hard link between the source and destination files. The source file must not exist. Note that the server will not create a link to any path that lies outside the currently connected share. This is enforced by the Samba server. -

        tar <c|x>[IXbgNa]

        Performs a tar operation - see the -T - command line option above. Behavior may be affected +

        tar <c|x>[IXbgNa]

        Performs a tar operation - see the -T + command line option above. Behavior may be affected by the tarmode command (see below). Using g (incremental) and N - (newer) will affect tarmode settings. Note that using the "-" option + (newer) will affect tarmode settings. Note that using the "-" option with tar x may not work - use the command line option instead. -

        blocksize <blocksize>

        Blocksize. Must be followed by a valid (greater +

        blocksize <blocksize>

        Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in - blocksize*TBLOCK (usually 512 byte) blocks.

        tarmode <full|inc|reset|noreset>

        Changes tar's behavior with regard to archive + blocksize*TBLOCK (usually 512 byte) blocks.

        tarmode <full|inc|reset|noreset>

        Changes tar's behavior with regard to archive bits. In full mode, tar will back up everything regardless of the archive bit setting (this is the default mode). In incremental mode, tar will only back up files with the archive bit set. In reset mode, tar will reset the archive bit on all files it backs up (implies - read/write share).

        NOTES

        Some servers are fussy about the case of supplied usernames, + read/write share).

        NOTES

        Some servers are fussy about the case of supplied usernames, passwords, share names (AKA service names) and machine names. If you fail to connect try giving all parameters in uppercase. -

        It is often necessary to use the -n option when connecting +

        It is often necessary to use the -n option when connecting to some types of servers. For example OS/2 LanManager insists on a valid NetBIOS name being used, so you need to supply a valid - name that would be known to the server.

        smbclient supports long file names where the server - supports the LANMAN2 protocol or above.

        ENVIRONMENT VARIABLES

        The variable USER may contain the + name that would be known to the server.

        smbclient supports long file names where the server + supports the LANMAN2 protocol or above.

        ENVIRONMENT VARIABLES

        The variable USER may contain the username of the person using the client. This information is used only if the protocol level is high enough to support - session-level passwords.

        The variable PASSWD may contain + session-level passwords.

        The variable PASSWD may contain the password of the person using the client. This information is used only if the protocol level is high enough to support - session-level passwords.

        The variable LIBSMB_PROG may contain + session-level passwords.

        The variable LIBSMB_PROG may contain the path, executed with system(), which the client should connect to instead of connecting to a server. This functionality is primarily intended as a development aid, and works best when using a LMHOSTS - file

        INSTALLATION

        The location of the client program is a matter for + file

        INSTALLATION

        The location of the client program is a matter for individual system administrators. The following are thus - suggestions only.

        It is recommended that the smbclient software be installed - in the /usr/local/samba/bin/ or /usr/samba/bin/ directory, this directory readable + suggestions only.

        It is recommended that the smbclient software be installed + in the /usr/local/samba/bin/ or + /usr/samba/bin/ directory, this directory readable by all, writeable only by root. The client program itself should - be executable by all. The client should NOT be - setuid or setgid!

        The client log files should be put in a directory readable - and writeable only by the user.

        To test the client, you will need to know the name of a - running SMB/CIFS server. It is possible to run smbd(8) - as an ordinary user - running that server as a daemon + be executable by all. The client should NOT be + setuid or setgid!

        The client log files should be put in a directory readable + and writeable only by the user.

        To test the client, you will need to know the name of a + running SMB/CIFS server. It is possible to run smbd(8) as an ordinary user - running that server as a daemon on a user-accessible port (typically any port number over 1024) - would provide a suitable test server.

        DIAGNOSTICS

        Most diagnostics issued by the client are logged in a + would provide a suitable test server.

        DIAGNOSTICS

        Most diagnostics issued by the client are logged in a specified log file. The log file name is specified at compile time, - but may be overridden on the command line.

        The number and nature of diagnostics available depends + but may be overridden on the command line.

        The number and nature of diagnostics available depends on the debug level used by the client. If you have problems, - set the debug level to 3 and peruse the log files.

        VERSION

        This man page is correct for version 2.2 of - the Samba suite.

        AUTHOR

        The original Samba software and related utilities + set the debug level to 3 and peruse the log files.

        VERSION

        This man page is correct for version 2.2 of the Samba suite.

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbcontrol.1.html b/docs/htmldocs/smbcontrol.1.html index 12662dcc04..21344b9ade 100644 --- a/docs/htmldocs/smbcontrol.1.html +++ b/docs/htmldocs/smbcontrol.1.html @@ -1,385 +1,71 @@ - -smbcontrol

        smbcontrol

        Name

        smbcontrol -- send messages to smbd, nmbd or winbindd processes

        Synopsis

        smbcontrol [-i]

        smbcontrol [destination] [message-type] [parameter]

        DESCRIPTION

        This tool is part of the Samba suite.

        smbcontrol is a very small program, which - sends messages to an smbd(8), - an nmbd(8) - or a winbindd(8) - daemon running on the system.

        OPTIONS

        -i

        Run interactively. Individual commands +smbcontrol

        Name

        smbcontrol — send messages to smbd, nmbd or winbindd processes

        Synopsis

        smbcontrol [-i] [-s]

        smbcontrol [destination] [message-type] [parameter]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        smbcontrol is a very small program, which + sends messages to a smbd(8), a nmbd(8), or a winbindd(8) daemon running on the system.

        OPTIONS

        -h|--help

        Print a summary of command line options. +

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -i

        Run interactively. Individual commands of the form destination message-type parameters can be entered - on STDIN. An empty command line or a "q" will quit the - program.

        destination

        One of nmbd - smbd or a process ID.

        The smbd destination causes the - message to "broadcast" to all smbd daemons.

        The nmbd destination causes the + on STDIN. An empty command line or a "q" will quit the + program.

        destination

        One of nmbd, smbd or a process ID.

        The smbd destination causes the + message to "broadcast" to all smbd daemons.

        The nmbd destination causes the message to be sent to the nmbd daemon specified in the - nmbd.pid file.

        If a single process ID is given, the message is sent - to only that process.

        message-type

        One of: close-share, - debug, - force-election, ping - , profile, debuglevel, profilelevel, - or printnotify.

        The close-share message-type sends a - message to smbd which will then close the client connections to - the named share. Note that this doesn't affect client connections - to any other shares. This message-type takes an argument of the - share name for which client connections will be closed, or the - "*" character which will close all currently open shares. - This may be useful if you made changes to the access controls on the share. - This message can only be sent to smbd.

        The debug message-type allows - the debug level to be set to the value specified by the - parameter. This can be sent to any of the destinations.

        The force-election message-type can only be - sent to the nmbd destination. This message - causes the nmbd daemon to force a new browse - master election.

        The ping message-type sends the - number of "ping" messages specified by the parameter and waits - for the same number of reply "pong" messages. This can be sent to - any of the destinations.

        The profile message-type sends a - message to an smbd to change the profile settings based on the - parameter. The parameter can be "on" to turn on profile stats - collection, "off" to turn off profile stats collection, "count" - to enable only collection of count stats (time stats are - disabled), and "flush" to zero the current profile stats. This can - be sent to any smbd or nmbd destinations.

        The debuglevel message-type sends - a "request debug level" message. The current debug level setting - is returned by a "debuglevel" message. This can be - sent to any of the destinations.

        The profilelevel message-type sends - a "request profile level" message. The current profile level - setting is returned by a "profilelevel" message. This can be sent - to any smbd or nmbd destinations.

        The printnotify message-type sends a - message to smbd which in turn sends a printer notify message to - any Windows NT clients connected to a printer. This message-type - takes the following arguments: - -

        queuepause printername

        Send a queue pause change notify - message to the printer specified.

        queueresume printername

        Send a queue resume change notify - message for the printer specified.

        jobpause printername unixjobid

        Send a job pause change notify - message for the printer and unix jobid - specified.

        jobresume printername unixjobid

        Send a job resume change notify - message for the printer and unix jobid - specified.

        jobdelete printername unixjobid

        Send a job delete change notify - message for the printer and unix jobid - specified.

        - - Note that this message only sends notification that an - event has occured. It doesn't actually cause the - event to happen. - - This message can only be sent to smbd. -

        parameters

        any parameters required for the message-type

        VERSION

        This man page is correct for version 2.2 of - the Samba suite.

        SEE ALSO

        nmbd(8), - and smbd(8). -

        AUTHOR

        The original Samba software and related utilities + nmbd.pid file.

        If a single process ID is given, the message is sent + to only that process.

        message-type

        Type of message to send. See + the section MESSAGE-TYPES for details. +

        parameters

        any parameters required for the message-type

        MESSAGE-TYPES

        Available message types are:

        close-share

        Order smbd to close the client + connections to the named share. Note that this doesn't affect client + connections to any other shares. This message-type takes an argument of the + share name for which client connections will be closed, or the + "*" character which will close all currently open shares. + This may be useful if you made changes to the access controls on the share. + This message can only be sent to smbd.

        debug

        Set debug level to the value specified by the + parameter. This can be sent to any of the destinations.

        force-election

        This message causes the nmbd daemon to + force a new browse master election.

        ping

        + Send specified number of "ping" messages and + wait for the same number of reply "pong" messages. This can be sent to + any of the destinations.

        profile

        Change profile settings of a daemon, based on the + parameter. The parameter can be "on" to turn on profile stats + collection, "off" to turn off profile stats collection, "count" + to enable only collection of count stats (time stats are + disabled), and "flush" to zero the current profile stats. This can + be sent to any smbd or nmbd destinations.

        debuglevel

        + Request debuglevel of a certain daemon and write it to stdout. This + can be sent to any of the destinations.

        profilelevel

        + Request profilelevel of a certain daemon and write it to stdout. + This can be sent to any smbd or nmbd destinations.

        printnotify

        + Order smbd to send a printer notify message to any Windows NT clients + connected to a printer. This message-type takes the following arguments: +

        queuepause printername

        Send a queue pause change notify + message to the printer specified.

        queueresume printername

        Send a queue resume change notify + message for the printer specified.

        jobpause printername unixjobid

        Send a job pause change notify + message for the printer and unix jobid + specified.

        jobresume printername unixjobid

        Send a job resume change notify + message for the printer and unix jobid + specified.

        jobdelete printername unixjobid

        Send a job delete change notify + message for the printer and unix jobid + specified.

        + Note that this message only sends notification that an + event has occured. It doesn't actually cause the + event to happen. +

        This message can only be sent to smbd.

        samsync

        Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to smbd.

        Note

        Not working at the moment

        samrepl

        Send sam replication message, with specified serial. Can only be sent to smbd. Should not be used manually.

        dmalloc-mark

        Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.

        dmalloc-log-changed

        + Dump the pointers that have changed since the mark set by dmalloc-mark. + Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.

        shutdown

        Shut down specified daemon. Can be sent to both smbd and nmbd.

        pool-usage

        Print a human-readable description of all + talloc(pool) memory usage by the specified daemon/process. Available + for both smbd and nmbd.

        drvupgrade

        Force clients of printers using specified driver + to update their local version of the driver. Can only be + sent to smbd.

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        nmbd(8) and smbd(8).

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbd.8.html b/docs/htmldocs/smbd.8.html index 65f5f95b8d..5b71bd7196 100644 --- a/docs/htmldocs/smbd.8.html +++ b/docs/htmldocs/smbd.8.html @@ -1,780 +1,183 @@ - -smbd

        smbd

        Name

        smbd -- server to provide SMB/CIFS services to clients

        Synopsis

        smbd [-D] [-F] [-S] [-i] [-h] [-V] [-b] [-d <debug level>] [-l <log directory>] [-p <port number>] [-O <socket option>] [-s <configuration file>]

        DESCRIPTION

        This program is part of the Samba suite.

        smbd is the server daemon that +smbd

        Name

        smbd — server to provide SMB/CIFS services to clients

        Synopsis

        smbd [-D] [-F] [-S] [-i] [-h] [-V] [-b] [-d <debug level>] [-l <log directory>] [-p <port number>] [-O <socket option>] [-s <configuration file>]

        DESCRIPTION

        This program is part of the Samba(7) suite.

        smbd is the server daemon that provides filesharing and printing services to Windows clients. The server provides filespace and printer services to clients using the SMB (or CIFS) protocol. This is compatible with the LanManager protocol, and can service LanManager clients. These include MSCLIENT 3.0 for DOS, Windows for Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, - OS/2, DAVE for Macintosh, and smbfs for Linux.

        An extensive description of the services that the + OS/2, DAVE for Macintosh, and smbfs for Linux.

        An extensive description of the services that the server can provide is given in the man page for the configuration file controlling the attributes of those - services (see smb.conf(5) - . This man page will not describe the + services (see smb.conf(5). This man page will not describe the services, but will concentrate on the administrative aspects - of running the server.

        Please note that there are significant security - implications to running this server, and the smb.conf(5) - manpage should be regarded as mandatory reading before - proceeding with installation.

        A session is created whenever a client requests one. + of running the server.

        Please note that there are significant security + implications to running this server, and the smb.conf(5) manual page should be regarded as mandatory reading before + proceeding with installation.

        A session is created whenever a client requests one. Each client gets a copy of the server for each session. This copy then services all connections made by the client during that session. When all connections from its client are closed, - the copy of the server for that client terminates.

        The configuration file, and any files that it includes, + the copy of the server for that client terminates.

        The configuration file, and any files that it includes, are automatically reloaded every minute, if they change. You can force a reload by sending a SIGHUP to the server. Reloading the configuration file will not affect connections to any service that is already established. Either the user will have to - disconnect from the service, or smbd killed and restarted.

        OPTIONS

        -D

        If specified, this parameter causes + disconnect from the service, or smbd killed and restarted.

        OPTIONS

        -D

        If specified, this parameter causes the server to operate as a daemon. That is, it detaches itself and runs in the background, fielding requests on the appropriate port. Operating the server as a - daemon is the recommended way of running smbd for + daemon is the recommended way of running smbd for servers that provide more than casual use file and - print services. This switch is assumed if smbd - is executed on the command line of a shell. -

        -F

        If specified, this parameter causes - the main smbd process to not daemonize, + print services. This switch is assumed if smbd + is executed on the command line of a shell. +

        -F

        If specified, this parameter causes + the main smbd process to not daemonize, i.e. double-fork and disassociate with the terminal. Child processes are still created as normal to service each connection request, but the main process does not exit. This operation mode is suitable for running - smbd under process supervisors such - as supervise and svscan - from Daniel J. Bernstein's daemontools + smbd under process supervisors such + as supervise and svscan + from Daniel J. Bernstein's daemontools package, or the AIX process monitor. -

        -S

        If specified, this parameter causes - smbd to log to standard output rather - than a file.

        -i

        If this parameter is specified it causes the - server to run "interactively", not as a daemon, even if the +

        -S

        If specified, this parameter causes + smbd to log to standard output rather + than a file.

        -i

        If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell. Setting this parameter negates the implicit deamon mode when run from the - command line. smbd also logs to standard - output, as if the -S parameter had been + command line. smbd also logs to standard + output, as if the -S parameter had been given. -

        -h

        Prints the help information (usage) - for smbd.

        -V

        Prints the version number for - smbd.

        -b

        Prints information about how - Samba was built.

        -d <debug level>

        debuglevel is an integer - from 0 to 10. The default value if this parameter is - not specified is zero.

        The higher this value, the more detail will be - logged to the log files about the activities of the - server. At level 0, only critical errors and serious - warnings will be logged. Level 1 is a reasonable level for - day to day running - it generates a small amount of - information about operations carried out.

        Levels above 1 will generate considerable - amounts of log data, and should only be used when - investigating a problem. Levels above 3 are designed for - use only by developers and generate HUGE amounts of log - data, most of which is extremely cryptic.

        Note that specifying this parameter here will - override the log - level parameter in the smb.conf(5) file.

        -l <log directory>

        If specified, - log directory - specifies a log directory into which the "log.smbd" log +

        -V

        Prints the version number for +smbd.

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

        The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

        Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -l|--logfile=logbasename

        File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

        -h|--help

        Print a summary of command line options. +

        -b

        Prints information about how + Samba was built.

        -l <log directory>

        If specified, + log directory + specifies a log directory into which the "log.smbd" log file will be created for informational and debug messages from the running server. The log file generated is never removed by the server although - its size may be controlled by the max log size - option in the smb.conf(5) file. Beware: - If the directory specified does not exist, smbd + its size may be controlled by the max log size + option in the smb.conf(5) file. Beware: + If the directory specified does not exist, smbd will log to the default debug log location defined at compile time. -

        The default log directory is specified at - compile time.

        -O <socket options>

        See the socket options - parameter in the smb.conf(5) - file for details.

        -p <port number>

        port number is a positive integer +

        The default log directory is specified at + compile time.

        -p <port number>

        port number is a positive integer value. The default value if this parameter is not - specified is 139.

        This number is the port number that will be + specified is 139.

        This number is the port number that will be used when making connections to the server from client software. The standard (well-known) port number for the SMB over TCP is 139, hence the default. If you wish to run the server as an ordinary user rather than as root, most systems will require you to use a port number greater than 1024 - ask your system administrator - for help if you are in this situation.

        In order for the server to be useful by most + for help if you are in this situation.

        In order for the server to be useful by most clients, should you configure it on a port other than 139, you will require port redirection services on port 139, details of which are outlined in rfc1002.txt - section 4.3.5.

        This parameter is not normally specified except - in the above situation.

        -s <configuration file>

        The file specified contains the - configuration details required by the server. The - information in this file includes server-specific - information such as what printcap file to use, as well - as descriptions of all the services that the server is - to provide. See smb.conf(5) for more information. - The default configuration file name is determined at - compile time.

        FILES

        /etc/inetd.conf

        If the server is to be run by the - inetd meta-daemon, this file + section 4.3.5.

        This parameter is not normally specified except + in the above situation.

        FILES

        /etc/inetd.conf

        If the server is to be run by the + inetd meta-daemon, this file must contain suitable startup information for the - meta-daemon. See the UNIX_INSTALL.html + meta-daemon. See the "How to Install and Test SAMBA" document for details. -

        /etc/rc

        or whatever initialization script your - system uses).

        If running the server as a daemon at startup, +

        /etc/rc

        or whatever initialization script your + system uses).

        If running the server as a daemon at startup, this file will need to contain an appropriate startup - sequence for the server. See the UNIX_INSTALL.html - document for details.

        /etc/services

        If running the server via the - meta-daemon inetd, this file + sequence for the server. See the "How to Install and Test SAMBA" + document for details.

        /etc/services

        If running the server via the + meta-daemon inetd, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). - See the UNIX_INSTALL.html - document for details.

        /usr/local/samba/lib/smb.conf

        This is the default location of the - smb.conf - server configuration file. Other common places that systems - install this file are /usr/samba/lib/smb.conf - and /etc/smb.conf.

        This file describes all the services the server - is to make available to clients. See smb.conf(5) for more information.

        LIMITATIONS

        On some systems smbd cannot change uid back + See the "How to Install and Test SAMBA" + document for details.

        /usr/local/samba/lib/smb.conf

        This is the default location of the smb.conf(5) server configuration file. Other common places that systems + install this file are /usr/samba/lib/smb.conf + and /etc/samba/smb.conf.

        This file describes all the services the server + is to make available to clients. See smb.conf(5) for more information.

        LIMITATIONS

        On some systems smbd cannot change uid back to root after a setuid() call. Such systems are called trapdoor uid systems. If you have such a system, you will be unable to connect from a client (such as a PC) as two different users at once. Attempts to connect the second user will result in access denied or - similar.

        ENVIRONMENT VARIABLES

        PRINTER

        If no printer name is specified to + similar.

        ENVIRONMENT VARIABLES

        PRINTER

        If no printer name is specified to printable services, most systems will use the value of - this variable (or lp if this variable is + this variable (or lp if this variable is not defined) as the name of the printer to use. This - is not specific to the server, however.

        PAM INTERACTION

        Samba uses PAM for authentication (when presented with a plaintext + is not specific to the server, however.

        PAM INTERACTION

        Samba uses PAM for authentication (when presented with a plaintext password), for account checking (is this account disabled?) and for session management. The degree too which samba supports PAM is restricted - by the limitations of the SMB protocol and the - obey pam restricions - smb.conf paramater. When this is set, the following restrictions apply: -

        • Account Validation: All accesses to a + by the limitations of the SMB protocol and the obey + pam restricions smb.conf(5) paramater. When this is set, the following restrictions apply: +

          • Account Validation: All accesses to a samba server are checked against PAM to see if the account is vaild, not disabled and is permitted to login at this time. This also applies to encrypted logins. -

          • Session Management: When not using share +

          • Session Management: When not using share level secuirty, users must pass PAM's session checks before access is granted. Note however, that this is bypassed in share level secuirty. Note also that some older pam configuration files may need a line added for session support. -

          VERSION

          This man page is correct for version 3.0 of - the Samba suite.

          DIAGNOSTICS

          Most diagnostics issued by the server are logged +

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        DIAGNOSTICS

        Most diagnostics issued by the server are logged in a specified log file. The log file name is specified - at compile time, but may be overridden on the command line.

        The number and nature of diagnostics available depends + at compile time, but may be overridden on the command line.

        The number and nature of diagnostics available depends on the debug level used by the server. If you have problems, set - the debug level to 3 and peruse the log files.

        Most messages are reasonably self-explanatory. Unfortunately, + the debug level to 3 and peruse the log files.

        Most messages are reasonably self-explanatory. Unfortunately, at the time this man page was created, there are too many diagnostics available in the source code to warrant describing each and every diagnostic. At this stage your best bet is still to grep the source code and inspect the conditions that gave rise to the - diagnostics you are seeing.

        SIGNALS

        Sending the smbd a SIGHUP will cause it to - reload its smb.conf configuration - file within a short period of time.

        To shut down a user's smbd process it is recommended - that SIGKILL (-9) NOT + diagnostics you are seeing.

        SIGNALS

        Sending the smbd a SIGHUP will cause it to + reload its smb.conf configuration + file within a short period of time.

        To shut down a user's smbd process it is recommended + that SIGKILL (-9) NOT be used, except as a last resort, as this may leave the shared memory area in an inconsistent state. The safe way to terminate - an smbd is to send it a SIGTERM (-15) signal and wait for - it to die on its own.

        The debug log level of smbd may be raised - or lowered using smbcontrol(1) - program (SIGUSR[1|2] signals are no longer used in - Samba 2.2). This is to allow transient problems to be diagnosed, - whilst still running at a normally low log level.

        Note that as the signal handlers send a debug write, - they are not re-entrant in smbd. This you should wait until - smbd is in a state of waiting for an incoming SMB before + an smbd is to send it a SIGTERM (-15) signal and wait for + it to die on its own.

        The debug log level of smbd may be raised + or lowered using smbcontrol(1) program (SIGUSR[1|2] signals are no longer + used since Samba 2.2). This is to allow transient problems to be diagnosed, + whilst still running at a normally low log level.

        Note that as the signal handlers send a debug write, + they are not re-entrant in smbd. This you should wait until + smbd is in a state of waiting for an incoming SMB before issuing them. It is possible to make the signal handlers safe by un-blocking the signals before the select call and re-blocking - them after, however this would affect performance.

        SEE ALSO

        hosts_access(5), inetd(8), - nmbd(8), - smb.conf(5) - , smbclient(1) - , testparm(1), testprns(1), and the Internet RFC's - rfc1001.txt, rfc1002.txt. + them after, however this would affect performance.

        SEE ALSO

        hosts_access(5), inetd(8), nmbd(8), smb.conf(5), smbclient(1), testparm(1), testprns(1), and the + Internet RFC's rfc1001.txt, rfc1002.txt. In addition the CIFS (formerly SMB) specification is available - as a link from the Web page - http://samba.org/cifs/.

        AUTHOR

        The original Samba software and related utilities + as a link from the Web page + http://samba.org/cifs/.

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbmnt.8.html b/docs/htmldocs/smbmnt.8.html index 06b9fb1fd3..8caedac3f5 100644 --- a/docs/htmldocs/smbmnt.8.html +++ b/docs/htmldocs/smbmnt.8.html @@ -1,179 +1,24 @@ - -smbmnt

        smbmnt

        Name

        smbmnt -- helper utility for mounting SMB filesystems

        Synopsis

        smbmnt {mount-point} [-s <share>] [-r] [-u <uid>] [-g <gid>] [-f <mask>] [-d <mask>] [-o <options>]

        DESCRIPTION

        smbmnt is a helper application used +smbmnt

        Name

        smbmnt — helper utility for mounting SMB filesystems

        Synopsis

        smbmnt {mount-point} [-s <share>] [-r] [-u <uid>] [-g <gid>] [-f <mask>] [-d <mask>] [-o <options>] [-h]

        DESCRIPTION

        smbmnt is a helper application used by the smbmount program to do the actual mounting of SMB shares. - smbmnt can be installed setuid root if you want - normal users to be able to mount their SMB shares.

        A setuid smbmnt will only allow mounts on directories owned - by the user, and that the user has write permission on.

        The smbmnt program is normally invoked - by smbmount(8) - . It should not be invoked directly by users.

        smbmount searches the normal PATH for smbmnt. You must ensure - that the smbmnt version in your path matches the smbmount used.

        OPTIONS

        -r

        mount the filesystem read-only -

        -u uid

        specify the uid that the files will - be owned by

        -g gid

        specify the gid that the files will be - owned by

        -f mask

        specify the octal file mask applied -

        -d mask

        specify the octal directory mask - applied

        -o options

        list of options that are passed as-is to smbfs, if this + smbmnt can be installed setuid root if you want + normal users to be able to mount their SMB shares.

        A setuid smbmnt will only allow mounts on directories owned + by the user, and that the user has write permission on.

        The smbmnt program is normally invoked + by smbmount(8). It should not be invoked directly by users.

        smbmount searches the normal PATH for smbmnt. You must ensure + that the smbmnt version in your path matches the smbmount used.

        OPTIONS

        -r

        mount the filesystem read-only +

        -u uid

        specify the uid that the files will + be owned by

        -g gid

        specify the gid that the files will be + owned by

        -f mask

        specify the octal file mask applied +

        -d mask

        specify the octal directory mask + applied

        -o options

        + list of options that are passed as-is to smbfs, if this command is run on a 2.4 or higher Linux kernel. -

        AUTHOR

        Volker Lendecke, Andrew Tridgell, Michael H. Warfield - and others.

        The current maintainer of smbfs and the userspace - tools smbmount, smbumount, - and smbmnt is Urban Widmark. - The SAMBA Mailing list +

        -h|--help

        Print a summary of command line options. +

        AUTHOR

        Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.

        The current maintainer of smbfs and the userspace + tools smbmount, smbumount, + and smbmnt is Urban Widmark. + The SAMBA Mailing list is the preferred place to ask questions regarding these programs. -

        The conversion of this manpage for Samba 2.2 was performed - by Gerald Carter

        \ No newline at end of file +

        The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbmount.8.html b/docs/htmldocs/smbmount.8.html index 81a3ac04b2..233dee51d7 100644 --- a/docs/htmldocs/smbmount.8.html +++ b/docs/htmldocs/smbmount.8.html @@ -1,321 +1,72 @@ - -smbmount

        smbmount

        Name

        smbmount -- mount an smbfs filesystem

        Synopsis

        smbmount {service} {mount-point} [-o options]

        DESCRIPTION

        smbmount mounts a Linux SMB filesystem. It - is usually invoked as mount.smbfs by - the mount(8) command when using the - "-t smbfs" option. This command only works in Linux, and the kernel must - support the smbfs filesystem.

        Options to smbmount are specified as a comma-separated +smbmount

        Name

        smbmount — mount an smbfs filesystem

        Synopsis

        smbmount {service} {mount-point} [-o options]

        DESCRIPTION

        smbmount mounts a Linux SMB filesystem. It + is usually invoked as mount.smbfs by + the mount(8) command when using the + "-t smbfs" option. This command only works in Linux, and the kernel must + support the smbfs filesystem.

        Options to smbmount are specified as a comma-separated list of key=value pairs. It is possible to send options other than those listed here, assuming that smbfs supports them. If you get mount failures, check your kernel log for errors on - unknown options.

        smbmount is a daemon. After mounting it keeps running until + unknown options.

        smbmount is a daemon. After mounting it keeps running until the mounted smbfs is umounted. It will log things that happen - when in daemon mode using the "machine name" smbmount, so - typically this output will end up in log.smbmount. The - smbmount process may also be called mount.smbfs.

        NOTE: smbmount - calls smbmnt(8) to do the actual mount. You - must make sure that smbmnt is in the path so - that it can be found.

        OPTIONS

        username=<arg>

        specifies the username to connect as. If - this is not given, then the environment variable USER is used. This option can also take the - form "user%password" or "user/workgroup" or - "user/workgroup%password" to allow the password and workgroup - to be specified as part of the username.

        password=<arg>

        specifies the SMB password. If this + when in daemon mode using the "machine name" smbmount, so + typically this output will end up in log.smbmount. The + smbmount process may also be called mount.smbfs.

        Note

        smbmount + calls smbmnt(8) to do the actual mount. You + must make sure that smbmnt is in the path so + that it can be found.

        OPTIONS

        username=<arg>

        specifies the username to connect as. If + this is not given, then the environment variable + USER is used. This option can also take the + form "user%password" or "user/workgroup" or + "user/workgroup%password" to allow the password and workgroup + to be specified as part of the username.

        password=<arg>

        specifies the SMB password. If this option is not given then the environment variable - PASSWD is used. If it can find - no password smbmount will prompt + PASSWD is used. If it can find + no password smbmount will prompt for a passeword, unless the guest option is - given.

        Note that passwords which contain the argument delimiter + given.

        + Note that passwords which contain the argument delimiter character (i.e. a comma ',') will failed to be parsed correctly on the command line. However, the same password defined in the PASSWD environment variable or a credentials file (see below) will be read correctly. -

        credentials=<filename>

        specifies a file that contains a username - and/or password. The format of the file is:

        		username = <value>
-		password = <value>
-
        -

        This is preferred over having passwords in plaintext in a - shared file, such as /etc/fstab. Be sure to protect any +

        credentials=<filename>

        specifies a file that contains a username and/or password. +The format of the file is: +

        +username = <value>
+password = <value>
+

        This is preferred over having passwords in plaintext in a + shared file, such as /etc/fstab. Be sure to protect any credentials file properly. -

        netbiosname=<arg>

        sets the source NetBIOS name. It defaults - to the local hostname.

        uid=<arg>

        sets the uid that will own all files on +

        krb

        Use kerberos (Active Directory).

        netbiosname=<arg>

        sets the source NetBIOS name. It defaults + to the local hostname.

        uid=<arg>

        sets the uid that will own all files on the mounted filesystem. It may be specified as either a username or a numeric uid. -

        gid=<arg>

        sets the gid that will own all files on +

        gid=<arg>

        sets the gid that will own all files on the mounted filesystem. It may be specified as either a groupname or a numeric - gid.

        port=<arg>

        sets the remote SMB port number. The default - is 139.

        fmask=<arg>

        sets the file mask. This determines the + gid.

        port=<arg>

        sets the remote SMB port number. The default + is 139.

        fmask=<arg>

        sets the file mask. This determines the permissions that remote files have in the local filesystem. - The default is based on the current umask.

        dmask=<arg>

        sets the directory mask. This determines the + This is not a umask, but the actual permissions for the files. + The default is based on the current umask.

        dmask=<arg>

        Sets the directory mask. This determines the permissions that remote directories have in the local filesystem. - The default is based on the current umask.

        debug=<arg>

        sets the debug level. This is useful for + This is not a umask, but the actual permissions for the directories. + The default is based on the current umask.

        debug=<arg>

        Sets the debug level. This is useful for tracking down SMB connection problems. A suggested value to start with is 4. If set too high there will be a lot of - output, possibly hiding the useful output.

        ip=<arg>

        sets the destination host or IP address. -

        workgroup=<arg>

        sets the workgroup on the destination

        sockopt=<arg>

        sets the TCP socket options. See the smb.conf - socket options option. -

        scope=<arg>

        sets the NetBIOS scope

        guest

        don't prompt for a password

        ro

        mount read-only

        rw

        mount read-write

        iocharset=<arg>

        sets the charset used by the Linux side for codepage + output, possibly hiding the useful output.

        ip=<arg>

        Sets the destination host or IP address. +

        workgroup=<arg>

        Sets the workgroup on the destination

        sockopt=<arg>

        Sets the TCP socket options. See the smb.conf(5) socket options option. +

        scope=<arg>

        Sets the NetBIOS scope

        guest

        Don't prompt for a password

        ro

        mount read-only

        rw

        mount read-write

        iocharset=<arg>

        + sets the charset used by the Linux side for codepage to charset translations (NLS). Argument should be the name of a charset, like iso8859-1. (Note: only kernel 2.4.0 or later) -

        codepage=<arg>

        sets the codepage the server uses. See the iocharset +

        codepage=<arg>

        + sets the codepage the server uses. See the iocharset option. Example value cp850. (Note: only kernel 2.4.0 or later) -

        ttl=<arg>

        sets how long a directory listing is cached in milliseconds +

        ttl=<arg>

        + sets how long a directory listing is cached in milliseconds (also affects visibility of file size and date changes). A higher value means that changes on the server take longer to be noticed but it can give @@ -324,141 +75,34 @@ CLASS="PARAMETER" like 10000ms (10 seconds) is probably more reasonable in many cases. (Note: only kernel 2.4.2 or later) -

        ENVIRONMENT VARIABLES

        The variable USER may contain the username of the +

        ENVIRONMENT VARIABLES

        The variable USER may contain the username of the person using the client. This information is used only if the protocol level is high enough to support session-level passwords. The variable can be used to set both username and - password by using the format username%password.

        The variable PASSWD may contain the password of the + password by using the format username%password.

        The variable PASSWD may contain the password of the person using the client. This information is used only if the protocol level is high enough to support session-level - passwords.

        The variable PASSWD_FILE may contain the pathname + passwords.

        The variable PASSWD_FILE may contain the pathname of a file to read the password from. A single line of input is - read and used as the password.

        BUGS

        Passwords and other options containing , can not be handled. + read and used as the password.

        BUGS

        Passwords and other options containing , can not be handled. For passwords an alternative way of passing them is in a credentials - file or in the PASSWD environment.

        The credentials file does not handle usernames or passwords with - leading space.

        One smbfs bug is important enough to mention here, even if it - is a bit misplaced:

        • Mounts sometimes stop working. This is usually + file or in the PASSWD environment.

          The credentials file does not handle usernames or passwords with + leading space.

          One smbfs bug is important enough to mention here, even if it + is a bit misplaced:

          • Mounts sometimes stop working. This is usually caused by smbmount terminating. Since smbfs needs smbmount to reconnect when the server disconnects, the mount will eventually go dead. An umount/mount normally fixes this. At least 2 ways to - trigger this bug are known.

          Note that the typical response to a bug report is suggestion + trigger this bug are known.

        Note that the typical response to a bug report is suggestion to try the latest version first. So please try doing that first, and always include which versions you use of relevant software - when reporting bugs (minimum: samba, kernel, distribution)

        SEE ALSO

        Documentation/filesystems/smbfs.txt in the linux kernel - source tree may contain additional options and information.

        FreeBSD also has a smbfs, but it is not related to smbmount

        For Solaris, HP-UX and others you may want to look at - smbsh(1) or at other - solutions, such as sharity or perhaps replacing the SMB server with - a NFS server.

        AUTHOR

        Volker Lendecke, Andrew Tridgell, Michael H. Warfield - and others.

        The current maintainer of smbfs and the userspace - tools smbmount, smbumount, - and smbmnt is Urban Widmark. - The SAMBA Mailing list + when reporting bugs (minimum: samba, kernel, distribution)

        SEE ALSO

        Documentation/filesystems/smbfs.txt in the linux kernel + source tree may contain additional options and information.

        FreeBSD also has a smbfs, but it is not related to smbmount

        For Solaris, HP-UX and others you may want to look at smbsh(1) or at other solutions, such as + Sharity or perhaps replacing the SMB server with a NFS server.

        AUTHOR

        Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.

        The current maintainer of smbfs and the userspace + tools smbmount, smbumount, + and smbmnt is Urban Widmark. + The SAMBA Mailing list is the preferred place to ask questions regarding these programs. -

        The conversion of this manpage for Samba 2.2 was performed - by Gerald Carter

        \ No newline at end of file +

        The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbpasswd.5.html b/docs/htmldocs/smbpasswd.5.html index ac3ab94691..556b637f4f 100644 --- a/docs/htmldocs/smbpasswd.5.html +++ b/docs/htmldocs/smbpasswd.5.html @@ -1,357 +1,89 @@ - -smbpasswd

        smbpasswd

        Name

        smbpasswd -- The Samba encrypted password file

        Synopsis

        smbpasswd

        DESCRIPTION

        This tool is part of the Samba suite.

        smbpasswd is the Samba encrypted password file. It contains +smbpasswd

        Name

        smbpasswd — The Samba encrypted password file

        Synopsis

        smbpasswd

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        smbpasswd is the Samba encrypted password file. It contains the username, Unix user id and the SMB hashed passwords of the user, as well as account flag information and the time the password was last changed. This file format has been evolving with - Samba and has had several different formats in the past.

        FILE FORMAT

        The format of the smbpasswd file used by Samba 2.2 - is very similar to the familiar Unix passwd(5) + Samba and has had several different formats in the past.

        FILE FORMAT

        The format of the smbpasswd file used by Samba 2.2 + is very similar to the familiar Unix passwd(5) file. It is an ASCII file containing one line for each user. Each field ithin each line is separated from the next by a colon. Any entry beginning with '#' is ignored. The smbpasswd file contains the - following information for each user:

        name

        This is the user name. It must be a name that - already exists in the standard UNIX passwd file.

        uid

        This is the UNIX uid. It must match the uid + following information for each user:

        name

        This is the user name. It must be a name that + already exists in the standard UNIX passwd file.

        uid

        This is the UNIX uid. It must match the uid field for the same user entry in the standard UNIX passwd file. If this does not match then Samba will refuse to recognize this smbpasswd file entry as being valid for a user. -

        Lanman Password Hash

        This is the LANMAN hash of the user's password, +

        Lanman Password Hash

        This is the LANMAN hash of the user's password, encoded as 32 hex digits. The LANMAN hash is created by DES encrypting a well known string with the user's password as the DES key. This is the same password used by Windows 95/98 machines. Note that this password hash is regarded as weak as it is vulnerable to dictionary attacks and if two users choose the same password this entry will be identical (i.e. the password - is not "salted" as the UNIX password is). If the user has a - null password this field will contain the characters "NO PASSWORD" + is not "salted" as the UNIX password is). If the user has a + null password this field will contain the characters "NO PASSWORD" as the start of the hex string. If the hex string is equal to 32 'X' characters then the user's account is marked as - disabled and the user will not be able to - log onto the Samba server.

        WARNING !! Note that, due to + disabled and the user will not be able to + log onto the Samba server.

        WARNING !! Note that, due to the challenge-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network. For this - reason these hashes are known as plain text - equivalents and must NOT be made + reason these hashes are known as plain text + equivalents and must NOT be made available to anyone but the root user. To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no - other access.

        NT Password Hash

        This is the Windows NT hash of the user's + other access.

        NT Password Hash

        This is the Windows NT hash of the user's password, encoded as 32 hex digits. The Windows NT hash is created by taking the user's password as represented in 16-bit, little-endian UNICODE and then applying the MD4 - (internet rfc1321) hashing algorithm to it.

        This password hash is considered more secure than + (internet rfc1321) hashing algorithm to it.

        This password hash is considered more secure than the LANMAN Password Hash as it preserves the case of the password and uses a much higher quality hashing algorithm. However, it is still the case that if two users choose the same password this entry will be identical (i.e. the password is - not "salted" as the UNIX password is).

        WARNING !!. Note that, due to + not "salted" as the UNIX password is).

        WARNING !!. Note that, due to the challenge-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this password hash will be able to impersonate the user on the network. For this - reason these hashes are known as plain text - equivalents and must NOT be made + reason these hashes are known as plain text + equivalents and must NOT be made available to anyone but the root user. To protect these passwords the smbpasswd file is placed in a directory with read and traverse access only to the root user and the smbpasswd file itself must be set to be read/write only by root, with no - other access.

        Account Flags

        This section contains flags that describe + other access.

        Account Flags

        This section contains flags that describe the attributes of the users account. In the Samba 2.2 release this field is bracketed by '[' and ']' characters and is always 13 characters in length (including the '[' and ']' characters). - The contents of this field may be any of the characters. -

        • U - This means - this is a "User" account, i.e. an ordinary user. Only User + The contents of this field may be any of the following characters: +

          • U - This means + this is a "User" account, i.e. an ordinary user. Only User and Workstation Trust accounts are currently supported - in the smbpasswd file.

          • N - This means the + in the smbpasswd file.

          • N - This means the account has no password (the passwords in the fields LANMAN Password Hash and NT Password Hash are ignored). Note that this - will only allow users to log on with no password if the null passwords parameter is set in the smb.conf(5) - config file.

          • D - This means the account - is disabled and no SMB/CIFS logins will be allowed for - this user.

          • W - This means this account - is a "Workstation Trust" account. This kind of account is used + will only allow users to log on with no password if the + null passwords parameter is set in the smb.conf(5) config file.

          • D - This means the account + is disabled and no SMB/CIFS logins will be allowed for this user.

          • W - This means this account + is a "Workstation Trust" account. This kind of account is used in the Samba PDC code stream to allow Windows NT Workstations - and Servers to join a Domain hosted by a Samba PDC.

          Other flags may be added as the code is extended in future. - The rest of this field space is filled in with spaces.

        Last Change Time

        This field consists of the time the account was + and Servers to join a Domain hosted by a Samba PDC.

        Other flags may be added as the code is extended in future. + The rest of this field space is filled in with spaces.

        Last Change Time

        This field consists of the time the account was last modified. It consists of the characters 'LCT-' (standing for - "Last Change Time") followed by a numeric encoding of the UNIX time + "Last Change Time") followed by a numeric encoding of the UNIX time in seconds since the epoch (1970) that the last change was made. -

        All other colon separated fields are ignored at this time.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        SEE ALSO

        smbpasswd(8), - samba(7), and +

        All other colon separated fields are ignored at this time.

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        smbpasswd(8), Samba(7), and the Internet RFC1321 for details on the MD4 algorithm. -

        AUTHOR

        The original Samba software and related utilities +

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbpasswd.8.html b/docs/htmldocs/smbpasswd.8.html index da3cb9f601..7612fdd775 100644 --- a/docs/htmldocs/smbpasswd.8.html +++ b/docs/htmldocs/smbpasswd.8.html @@ -1,626 +1,163 @@ - -smbpasswd

        smbpasswd

        Name

        smbpasswd -- change a user's SMB password

        Synopsis

        smbpasswd [-a] [-x] [-d] [-e] [-D debuglevel] [-n] [-r <remote machine>] [-R <name resolve order>] [-m] [-U username[%password]] [-h] [-s] [-w pass] [-i] [-L] [username]

        DESCRIPTION

        This tool is part of the Samba suite.

        The smbpasswd program has several different - functions, depending on whether it is run by the root - user or not. When run as a normal user it allows the user to change +smbpasswd

        Name

        smbpasswd — change a user's SMB password

        Synopsis

        smbpasswd [-a] [-x] [-d] [-e] [-D debuglevel] [-n] [-r <remote machine>] [-R <name resolve order>] [-m] [-U username[%password]] [-h] [-s] [-w pass] [-i] [-L] [username]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        The smbpasswd program has several different + functions, depending on whether it is run by the root user + or not. When run as a normal user it allows the user to change the password used for their SMB sessions on any machines that store - SMB passwords.

        By default (when run with no arguments) it will attempt to + SMB passwords.

        By default (when run with no arguments) it will attempt to change the current user's SMB password on the local machine. This is - similar to the way the passwd(1) program works. - smbpasswd differs from how the passwd program works - however in that it is not setuid root but works in - a client-server mode and communicates with a locally running - smbd(8). As a consequence in order for this to + similar to the way the passwd(1) program works. + smbpasswd differs from how the passwd program works + however in that it is not setuid root but works in + a client-server mode and communicates with a + locally running smbd(8). As a consequence in order for this to succeed the smbd daemon must be running on the local machine. On a UNIX machine the encrypted SMB passwords are usually stored in - the smbpasswd(5) file.

        When run by an ordinary user with no options, smbpasswd + the smbpasswd(5) file.

        When run by an ordinary user with no options, smbpasswd will prompt them for their old SMB password and then ask them for their new password twice, to ensure that the new password was typed correctly. No passwords will be echoed on the screen whilst being typed. If you have a blank SMB password (specified by - the string "NO PASSWORD" in the smbpasswd file) then just press - the <Enter> key when asked for your old password.

        smbpasswd can also be used by a normal user to change their + the string "NO PASSWORD" in the smbpasswd file) then just press + the <Enter> key when asked for your old password.

        smbpasswd can also be used by a normal user to change their SMB password on remote machines, such as Windows NT Primary Domain - Controllers. See the (-r) and -U options below.

        When run by root, smbpasswd allows new users to be added + Controllers. See the (-r) and -U options + below.

        When run by root, smbpasswd allows new users to be added and deleted in the smbpasswd file, as well as allows changes to - the attributes of the user in this file to be made. When run by root, - smbpasswd accesses the local smbpasswd file + the attributes of the user in this file to be made. When run by root, + smbpasswd accesses the local smbpasswd file directly, thus enabling changes to be made even if smbd is not - running.

        OPTIONS

        -a

        This option specifies that the username + running.

        OPTIONS

        -a

        This option specifies that the username following should be added to the local smbpasswd file, with the - new password typed (type <Enter> for the old password). This + new password typed (type <Enter> for the old password). This option is ignored if the username following already exists in the smbpasswd file and it is treated like a regular change password command. Note that the default passdb backends require the user to already exist in the system password file (usually - /etc/passwd), else the request to add the - user will fail.

        This option is only available when running smbpasswd - as root.

        -x

        This option specifies that the username + /etc/passwd), else the request to add the + user will fail.

        This option is only available when running smbpasswd + as root.

        -x

        This option specifies that the username following should be deleted from the local smbpasswd file. -

        This option is only available when running smbpasswd as - root.

        -d

        This option specifies that the username following - should be disabled in the local smbpasswd - file. This is done by writing a 'D' flag +

        This option is only available when running smbpasswd as + root.

        -d

        This option specifies that the username following + should be disabled in the local smbpasswd + file. This is done by writing a 'D' flag into the account control space in the smbpasswd file. Once this is done all attempts to authenticate via SMB using this username - will fail.

        If the smbpasswd file is in the 'old' format (pre-Samba 2.0 + will fail.

        If the smbpasswd file is in the 'old' format (pre-Samba 2.0 format) there is no space in the user's password entry to write - this information and the command will FAIL. See smbpasswd(5) - for details on the 'old' and new password file formats. -

        This option is only available when running smbpasswd as - root.

        -e

        This option specifies that the username following - should be enabled in the local smbpasswd file, + this information and the command will FAIL. See smbpasswd(5) for details on the 'old' and new password file formats. +

        This option is only available when running smbpasswd as + root.

        -e

        This option specifies that the username following + should be enabled in the local smbpasswd file, if the account was previously disabled. If the account was not disabled this option has no effect. Once the account is enabled then - the user will be able to authenticate via SMB once again.

        If the smbpasswd file is in the 'old' format, then smbpasswd will FAIL to enable the account. - See smbpasswd (5) for - details on the 'old' and new password file formats.

        This option is only available when running smbpasswd as root. -

        -D debuglevel

        debuglevel is an integer + the user will be able to authenticate via SMB once again.

        If the smbpasswd file is in the 'old' format, then + smbpasswd will FAIL to enable the account. + See smbpasswd(5) for + details on the 'old' and new password file formats.

        This option is only available when running smbpasswd as root. +

        -D debuglevel

        debuglevel is an integer from 0 to 10. The default value if this parameter is not specified - is zero.

        The higher this value, the more detail will be logged to the + is zero.

        The higher this value, the more detail will be logged to the log files about the activities of smbpasswd. At level 0, only - critical errors and serious warnings will be logged.

        Levels above 1 will generate considerable amounts of log + critical errors and serious warnings will be logged.

        Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. -

        -n

        This option specifies that the username following +

        -n

        This option specifies that the username following should have their password set to null (i.e. a blank password) in - the local smbpasswd file. This is done by writing the string "NO - PASSWORD" as the first part of the first password stored in the - smbpasswd file.

        Note that to allow users to logon to a Samba server once - the password has been set to "NO PASSWORD" in the smbpasswd + the local smbpasswd file. This is done by writing the string "NO + PASSWORD" as the first part of the first password stored in the + smbpasswd file.

        Note that to allow users to logon to a Samba server once + the password has been set to "NO PASSWORD" in the smbpasswd file the administrator must set the following parameter in the [global] - section of the smb.conf file :

        null passwords = yes

        This option is only available when running smbpasswd as - root.

        -r remote machine name

        This option allows a user to specify what machine + section of the smb.conf file :

        null passwords = yes

        This option is only available when running smbpasswd as + root.

        -r remote machine name

        This option allows a user to specify what machine they wish to change their password on. Without this parameter - smbpasswd defaults to the local host. The remote - machine name is the NetBIOS name of the SMB/CIFS + smbpasswd defaults to the local host. The remote + machine name is the NetBIOS name of the SMB/CIFS server to contact to attempt the password change. This name is resolved into an IP address using the standard name resolution - mechanism in all programs of the Samba suite. See the -R - name resolve order parameter for details on changing - this resolving mechanism.

        The username whose password is changed is that of the - current UNIX logged on user. See the -U username + mechanism in all programs of the Samba suite. See the -R + name resolve order parameter for details on changing + this resolving mechanism.

        The username whose password is changed is that of the + current UNIX logged on user. See the -U username parameter for details on changing the password for a different - username.

        Note that if changing a Windows NT Domain password the + username.

        Note that if changing a Windows NT Domain password the remote machine specified must be the Primary Domain Controller for the domain (Backup Domain Controllers only have a read-only copy of the user account database and will not allow the password - change).

        Note that Windows 95/98 do not have + change).

        Note that Windows 95/98 do not have a real password database so it is not possible to change passwords - specifying a Win95/98 machine as remote machine target.

        -R name resolve order

        This option allows the user of smbpasswd to determine + specifying a Win95/98 machine as remote machine target.

        -R name resolve order

        This option allows the user of smbpasswd to determine what name resolution services to use when looking up the NetBIOS - name of the host being connected to.

        The options are :"lmhosts", "host", "wins" and "bcast". They - cause names to be resolved as follows :

        • lmhosts : Lookup an IP + name of the host being connected to.

          The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows:

          • lmhosts: Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see the lmhosts(5) for details) then - any name type matches for lookup.

          • host : Do a standard host - name to IP address resolution, using the system /etc/hosts - , NIS, or DNS lookups. This method of name resolution + no name type attached to the NetBIOS name (see the lmhosts(5) for details) then + any name type matches for lookup.

          • host: Do a standard host + name to IP address resolution, using the system /etc/hosts + , NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this - may be controlled by the /etc/nsswitch.conf + may be controlled by the /etc/nsswitch.conf file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise - it is ignored.

          • wins : Query a name with - the IP address listed in the wins server + it is ignored.

          • wins: Query a name with + the IP address listed in the wins server parameter. If no WINS server has been specified this method - will be ignored.

          • bcast : Do a broadcast on + will be ignored.

          • bcast: Do a broadcast on each of the known local interfaces listed in the - interfaces parameter. This is the least + interfaces parameter. This is the least reliable of the name resolution methods as it depends on the - target host being on a locally connected subnet.

          The default order is lmhosts, host, wins, bcast - and without this parameter or any entry in the - smb.conf file the name resolution methods will - be attempted in this order.

        -m

        This option tells smbpasswd that the account + target host being on a locally connected subnet.

        The default order is lmhosts, host, wins, bcast + and without this parameter or any entry in the smb.conf(5) file the name resolution methods will + be attempted in this order.

        -m

        This option tells smbpasswd that the account being changed is a MACHINE account. Currently this is used - when Samba is being used as an NT Primary Domain Controller.

        This option is only available when running smbpasswd as root. -

        -U username

        This option may only be used in conjunction - with the -r option. When changing + when Samba is being used as an NT Primary Domain Controller.

        This option is only available when running smbpasswd as root. +

        -U username

        This option may only be used in conjunction + with the -r option. When changing a password on a remote machine it allows the user to specify the user name on that machine whose password will be changed. It is present to allow users who have different user names on - different systems to change these passwords.

        -h

        This option prints the help string for smbpasswd, selecting the correct one for running as root - or as an ordinary user.

        -s

        This option causes smbpasswd to be silent (i.e. + different systems to change these passwords.

        -h

        This option prints the help string for + smbpasswd, selecting the correct one for running as root + or as an ordinary user.

        -s

        This option causes smbpasswd to be silent (i.e. not issue prompts) and to read its old and new passwords from - standard input, rather than from /dev/tty - (like the passwd(1) program does). This option - is to aid people writing scripts to drive smbpasswd

        -w password

        This parameter is only available if Samba + standard input, rather than from /dev/tty + (like the passwd(1) program does). This option + is to aid people writing scripts to drive smbpasswd

        -w password

        This parameter is only available if Samba has been configured to use the experimental - --with-ldapsam option. The -w + --with-ldapsam option. The -w switch is used to specify the password to be used with the - ldap admin - dn. Note that the password is stored in - the private/secrets.tdb and is keyed off - of the admin's DN. This means that if the value of ldap - admin dn ever changes, the password will need to be + ldap admin + dn. Note that the password is stored in + the secrets.tdb and is keyed off + of the admin's DN. This means that if the value of ldap + admin dn ever changes, the password will need to be manually updated as well. -

        -i

        This option tells smbpasswd that the account +

        -i

        This option tells smbpasswd that the account being changed is an interdomain trust account. Currently this is used when Samba is being used as an NT Primary Domain Controller. - The account contains the info about another trusted domain.

        This option is only available when running smbpasswd as root. -

        -L

        Run in local mode.

        username

        This specifies the username for all of the - root only options to operate on. Only root + The account contains the info about another trusted domain.

        This option is only available when running smbpasswd as root. +

        -L

        Run in local mode.

        username

        This specifies the username for all of the + root only options to operate on. Only root can specify this parameter as only root has the permission needed to modify attributes directly in the local smbpasswd file. -

        NOTES

        Since smbpasswd works in client-server +

        NOTES

        Since smbpasswd works in client-server mode communicating with a local smbd for a non-root user then the smbd daemon must be running for this to work. A common problem - is to add a restriction to the hosts that may access the smbd running on the local machine by specifying a - allow hosts or deny hosts - entry in the smb.conf file and neglecting to - allow "localhost" access to the smbd.

        In addition, the smbpasswd command is only useful if Samba - has been set up to use encrypted passwords. See the file - ENCRYPTION.txt in the docs directory for details - on how to do this.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        SEE ALSO

        smbpasswd(5), - samba(7) -

        AUTHOR

        The original Samba software and related utilities + is to add a restriction to the hosts that may access the + smbd running on the local machine by specifying either allow + hosts or deny hosts entry in + the smb.conf(5) file and neglecting to + allow "localhost" access to the smbd.

        In addition, the smbpasswd command is only useful if Samba + has been set up to use encrypted passwords. See the document + "LanMan and NT Password Encryption in Samba" in the docs directory for details + on how to do this.

        VERSION

        This man page is correct for version 3.0 of the Samba suite.

        SEE ALSO

        smbpasswd(5), Samba(7).

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbsh.1.html b/docs/htmldocs/smbsh.1.html index bab2b45cdd..935576af6b 100644 --- a/docs/htmldocs/smbsh.1.html +++ b/docs/htmldocs/smbsh.1.html @@ -1,467 +1,110 @@ - -smbsh

        smbsh

        Name

        smbsh -- Allows access to Windows NT filesystem - using UNIX commands

        Synopsis

        smbsh [-W workgroup] [-U username] [-P prefix] [-R <name resolve order>] [-d <debug level>] [-l logfile] [-L libdir]

        DESCRIPTION

        This tool is part of the Samba suite.

        smbsh allows you to access an NT filesystem - using UNIX commands such as ls, egrep, and rcp. You must use a - shell that is dynamically linked in order for smbsh - to work correctly.

        OPTIONS

        -W WORKGROUP

        Override the default workgroup specified in the - workgroup parameter of the smb.conf file +smbsh

        Name

        smbsh — Allows access to Windows NT filesystem + using UNIX commands

        Synopsis

        smbsh [-W workgroup] [-U username] [-P prefix] [-R <name resolve order>] [-d <debug level>] [-l logfile] [-L libdir]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        smbsh allows you to access an NT filesystem + using UNIX commands such as ls, + egrep, and rcp. You must use a + shell that is dynamically linked in order for smbsh + to work correctly.

        OPTIONS

        -W WORKGROUP

        Override the default workgroup specified in the + workgroup parameter of the smb.conf(5) file for this session. This may be needed to connect to some - servers.

        -U username[%pass]

        Sets the SMB username or username and password. + servers.

        -U username[%pass]

        Sets the SMB username or username and password. If this option is not specified, the user will be prompted for both the username and the password. If %pass is not specified, the user will be prompted for the password. -

        -P prefix

        This option allows +

        -P prefix

        This option allows the user to set the directory prefix for SMB access. The default value if this option is not specified is - smb. -

        -R <name resolve order>

        This option is used to determine what naming - services and in what order to resolve - host names to IP addresses. The option takes a space-separated - string of different name resolution options.

        The options are :"lmhosts", "host", "wins" and "bcast". - They cause names to be resolved as follows :

        • lmhosts : - Lookup an IP address in the Samba lmhosts file. If the - line in lmhosts has no name type attached to the - NetBIOS name - (see the lmhosts(5) - for details) then any name type matches for lookup. -

        • host : - Do a standard host name to IP address resolution, using - the system /etc/hosts, NIS, or DNS - lookups. This method of name resolution is operating - system dependent, for instance on IRIX or Solaris this - may be controlled by the /etc/nsswitch.conf - file). Note that this method is only used - if the NetBIOS name type being queried is the 0x20 - (server) name type, otherwise it is ignored. -

        • wins : - Query a name with the IP address listed in the - wins server parameter. If no - WINS server has been specified this method will be - ignored. -

        • bcast : - Do a broadcast on each of the known local interfaces - listed in the interfaces - parameter. This is the least reliable of the name - resolution methods as it depends on the target host - being on a locally connected subnet. -

        If this parameter is not set then the name resolve order - defined in the smb.conf file parameter - (name resolve order) will be used.

        The default order is lmhosts, host, wins, bcast. Without - this parameter or any entry in the name resolve order - parameter of the smb.conf - file, the name resolution methods will be attempted in this - order.

        -d <debug level>

        debug level is an integer from 0 to 10.

        The default value if this parameter is not specified - is zero.

        The higher this value, the more detail will be logged - about the activities of nmblookup. At level - 0, only critical errors and serious warnings will be logged. -

        -l logfilename

        If specified causes all debug messages to be - written to the file specified by logfilename - . If not specified then all messages will be - written tostderr. -

        -L libdir

        This parameter specifies the location of the - shared libraries used by smbsh. The default + smb. +

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

        The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

        Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -R <name resolve order>

        This option is used to determine what naming +services and in what order to resolve +host names to IP addresses. The option takes a space-separated +string of different name resolution options.

        The options are: "lmhosts", "host", "wins" and "bcast". +They cause names to be resolved as follows :

        • lmhosts: +Lookup an IP address in the Samba lmhosts file. If the +line in lmhosts has no name type attached to the +NetBIOS name +(see the lmhosts(5) for details) +then any name type matches for lookup. +

        • host: +Do a standard host name to IP address resolution, using +the system /etc/hosts, NIS, or DNS +lookups. This method of name resolution is operating +system dependent, for instance on IRIX or Solaris this +may be controlled by the /etc/nsswitch.conf + file). Note that this method is only used +if the NetBIOS name type being queried is the 0x20 +(server) name type, otherwise it is ignored. +

        • wins: +Query a name with the IP address listed in the +wins server parameter. If no +WINS server has been specified this method will be +ignored. +

        • bcast: +Do a broadcast on each of the known local interfaces +listed in the interfaces +parameter. This is the least reliable of the name +resolution methods as it depends on the target host +being on a locally connected subnet. +

        If this parameter is not set then the name resolve order +defined in the smb.conf(5) file parameter +(name resolve order) will be used.

        The default order is lmhosts, host, wins, bcast. Without +this parameter or any entry in the name resolve order + parameter of the smb.conf(5) file, the name resolution methods +will be attempted in this order.

        -L libdir

        This parameter specifies the location of the + shared libraries used by smbsh. The default value is specified at compile time. -

        EXAMPLES

        To use the smbsh command, execute smbsh from the prompt and enter the username and password +

        EXAMPLES

        To use the smbsh command, execute + smbsh from the prompt and enter the username and password that authenticates you to the machine running the Windows NT - operating system.

        	system% smbsh
-	Username: user
-	Password: XXXXXXX
-

        Any dynamically linked command you execute from - this shell will access the /smb directory - using the smb protocol. For example, the command ls /smb - will show a list of workgroups. The command - ls /smb/MYGROUP will show all the machines in + operating system. +

        +system% smbsh
+Username: user
+Password: XXXXXXX
+

        Any dynamically linked command you execute from + this shell will access the /smb directory + using the smb protocol. For example, the command ls /smb + will show a list of workgroups. The command + ls /smb/MYGROUP will show all the machines in the workgroup MYGROUP. The command - ls /smb/MYGROUP/<machine-name> will show the share - names for that machine. You could then, for example, use the cd command to change directories, vi to - edit files, and rcp to copy files.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        BUGS

        smbsh works by intercepting the standard - libc calls with the dynamically loaded versions in smbwrapper.o. Not all calls have been "wrapped", so - some programs may not function correctly under smbsh - .

        Programs which are not dynamically linked cannot make - use of smbsh's functionality. Most versions - of UNIX have a file command that will - describe how a program was linked.

        SEE ALSO

        smbd(8), - smb.conf(5) -

        AUTHOR

        The original Samba software and related utilities + ls /smb/MYGROUP/<machine-name> will show the share + names for that machine. You could then, for example, use the + cd command to change directories, vi to + edit files, and rcp to copy files.

        VERSION

        This man page is correct for version 3.0 of the Samba suite.

        BUGS

        smbsh works by intercepting the standard + libc calls with the dynamically loaded versions in + smbwrapper.o. Not all calls have been "wrapped", so + some programs may not function correctly under smbsh + .

        Programs which are not dynamically linked cannot make + use of smbsh's functionality. Most versions + of UNIX have a file command that will + describe how a program was linked.

        SEE ALSO

        smbd(8), smb.conf(5)

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbspool.8.html b/docs/htmldocs/smbspool.8.html index 8dc2fbbd63..186f30ebcf 100644 --- a/docs/htmldocs/smbspool.8.html +++ b/docs/htmldocs/smbspool.8.html @@ -1,227 +1,35 @@ - -smbspool

        smbspool

        Name

        smbspool -- send a print file to an SMB printer

        Synopsis

        smbspool [job] [user] [title] [copies] [options] [filename]

        DESCRIPTION

        This tool is part of the Samba suite.

        smbspool is a very small print spooling program that +smbspool

        Name

        smbspool — send a print file to an SMB printer

        Synopsis

        smbspool {job} {user} {title} {copies} {options} [filename]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        smbspool is a very small print spooling program that sends a print file to an SMB printer. The command-line arguments are position-dependent for compatibility with the Common UNIX Printing System, but you can use smbspool with any printing system - or from a program or script.

        DEVICE URI

        smbspool specifies the destination using a Uniform Resource - Identifier ("URI") with a method of "smb". This string can take - a number of forms:

        • smb://server/printer

        • smb://workgroup/server/printer

        • smb://username:password@server/printer

        • smb://username:password@workgroup/server/printer -

        smbspool tries to get the URI from argv[0]. If argv[0] - contains the name of the program then it looks in the DEVICE_URI environment variable.

        Programs using the exec(2) functions can + or from a program or script.

        DEVICE URI

        smbspool specifies the destination using a Uniform Resource + Identifier ("URI") with a method of "smb". This string can take + a number of forms:

        • smb://server/printer

        • smb://workgroup/server/printer

        • smb://username:password@server/printer

        • smb://username:password@workgroup/server/printer

        smbspool tries to get the URI from argv[0]. If argv[0] + contains the name of the program then it looks in the + DEVICE_URI environment variable.

        Programs using the exec(2) functions can pass the URI in argv[0], while shell scripts must set the - DEVICE_URI environment variable prior to - running smbspool.

        OPTIONS

        • The job argument (argv[1]) contains the + DEVICE_URI environment variable prior to + running smbspool.

        OPTIONS

        • The job argument (argv[1]) contains the job ID number and is presently not used by smbspool. -

        • The user argument (argv[2]) contains the +

        • The user argument (argv[2]) contains the print user's name and is presently not used by smbspool. -

        • The title argument (argv[3]) contains the +

        • The title argument (argv[3]) contains the job title string and is passed as the remote file name - when sending the print job.

        • The copies argument (argv[4]) contains + when sending the print job.

        • The copies argument (argv[4]) contains the number of copies to be printed of the named file. If no filename is provided then this argument is not used by - smbspool.

        • The options argument (argv[5]) contains + smbspool.

        • The options argument (argv[5]) contains the print options in a single string and is currently - not used by smbspool.

        • The filename argument (argv[6]) contains the + not used by smbspool.

        • The filename argument (argv[6]) contains the name of the file to print. If this argument is not specified - then the print file is read from the standard input.

        VERSION

        This man page is correct for version 2.2 of - the Samba suite.

        SEE ALSO

        smbd(8), - and samba(7). -

        AUTHOR

        smbspool was written by Michael Sweet - at Easy Software Products.

        The original Samba software and related utilities + then the print file is read from the standard input.

        VERSION

        This man page is correct for version 3.0 of the Samba suite.

        SEE ALSO

        smbd(8) and Samba(7).

        AUTHOR

        smbspool was written by Michael Sweet + at Easy Software Products.

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbstatus.1.html b/docs/htmldocs/smbstatus.1.html index fb7e14fadd..c1be6234c3 100644 --- a/docs/htmldocs/smbstatus.1.html +++ b/docs/htmldocs/smbstatus.1.html @@ -1,223 +1,44 @@ - -smbstatus

        smbstatus

        Name

        smbstatus -- report on current Samba connections

        Synopsis

        smbstatus [-P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration file>] [-u <username>]

        DESCRIPTION

        This tool is part of the Samba suite.

        smbstatus is a very simple program to - list the current Samba connections.

        OPTIONS

        -P|--profile

        If samba has been compiled with the +smbstatus

        Name

        smbstatus — report on current Samba connections

        Synopsis

        smbstatus [-P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration file>] [-u <username>]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        smbstatus is a very simple program to + list the current Samba connections.

        OPTIONS

        -P|--profile

        If samba has been compiled with the profiling option, print only the contents of the profiling - shared memory area.

        -b|--brief

        gives brief output.

        -d|--debug=<debuglevel>

        sets debugging to specified level

        -v|--verbose

        gives verbose output.

        -L|--locks

        causes smbstatus to only list locks.

        -B|--byterange

        causes smbstatus to include byte range locks. -

        -p|--processes

        print a list of smbd(8) processes and exit. - Useful for scripting.

        -S|--shares

        causes smbstatus to only list shares.

        -s|--conf=<configuration file>

        The default configuration file name is - determined at compile time. The file specified contains the - configuration details required by the server. See smb.conf(5) - for more information.

        -u|--user=<username>

        selects information relevant to - username only.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        SEE ALSO

        smbd(8) and - smb.conf(5).

        AUTHOR

        The original Samba software and related utilities + shared memory area.

        -b|--brief

        gives brief output.

        -V

        Prints the version number for +smbd.

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

        The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

        Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -l|--logfile=logbasename

        File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

        -v|--verbose

        gives verbose output.

        -L|--locks

        causes smbstatus to only list locks.

        -B|--byterange

        causes smbstatus to include byte range locks. +

        -p|--processes

        print a list of smbd(8) processes and exit. + Useful for scripting.

        -S|--shares

        causes smbstatus to only list shares.

        -h|--help

        Print a summary of command line options. +

        -u|--user=<username>

        selects information relevant to + username only.

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        smbd(8) and smb.conf(5).

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbtar.1.html b/docs/htmldocs/smbtar.1.html index d3215c6901..30058d1860 100644 --- a/docs/htmldocs/smbtar.1.html +++ b/docs/htmldocs/smbtar.1.html @@ -1,356 +1,39 @@ - -smbtar

        smbtar

        Name

        smbtar -- shell script for backing up SMB/CIFS shares - directly to UNIX tape drives

        Synopsis

        smbtar {-s server} [-p password] [-x services] [-X] [-d directory] [-u user] [-t tape] [-t tape] [-b blocksize] [-N filename] [-i] [-r] [-l loglevel] [-v] {filenames}

        DESCRIPTION

        This tool is part of the Samba suite.

        smbtar is a very small shell script on top - of smbclient(1) - which dumps SMB shares directly to tape.

        OPTIONS

        -s server

        The SMB/CIFS server that the share resides - upon.

        -x service

        The share name on the server to connect to. - The default is "backup".

        -X

        Exclude mode. Exclude filenames... from tar - create or restore.

        -d directory

        Change to initial directory - before restoring / backing up files.

        -v

        Verbose mode.

        -p password

        The password to use to access a share. - Default: none

        -u user

        The user id to connect as. Default: - UNIX login name.

        -t tape

        Tape device. May be regular file or tape - device. Default: $TAPE environmental - variable; if not set, a file called tar.out - .

        -b blocksize

        Blocking factor. Defaults to 20. See - tar(1) for a fuller explanation.

        -N filename

        Backup only files newer than filename. Could +smbtar

        Name

        smbtar — shell script for backing up SMB/CIFS shares + directly to UNIX tape drives

        Synopsis

        smbtar [-r] [-i] [-a] [-v] {-s server} [-p password] [-x services] [-X] [-N filename] [-b blocksize] [-d directory] [-l loglevel] [-u user] [-t tape] {filenames}

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        smbtar is a very small shell script on top + of smbclient(1) which dumps SMB shares directly to tape.

        OPTIONS

        -s server

        The SMB/CIFS server that the share resides + upon.

        -x service

        The share name on the server to connect to. + The default is "backup".

        -X

        Exclude mode. Exclude filenames... from tar + create or restore.

        -d directory

        Change to initial directory + before restoring / backing up files.

        -v

        Verbose mode.

        -p password

        The password to use to access a share. + Default: none

        -u user

        The user id to connect as. Default: + UNIX login name.

        -a

        Reset DOS archive bit mode to + indicate file has been archived.

        -t tape

        Tape device. May be regular file or tape + device. Default: $TAPE environmental + variable; if not set, a file called tar.out + .

        -b blocksize

        Blocking factor. Defaults to 20. See + tar(1) for a fuller explanation.

        -N filename

        Backup only files newer than filename. Could be used (for example) on a log file to implement incremental - backups.

        -i

        Incremental mode; tar files are only backed + backups.

        -i

        Incremental mode; tar files are only backed up if they have the archive bit set. The archive bit is reset - after each file is read.

        -r

        Restore. Files are restored to the share - from the tar file.

        -l log level

        Log (debug) level. Corresponds to the - -d flag of smbclient(1) - .

        ENVIRONMENT VARIABLES

        The $TAPE variable specifies the + after each file is read.

        -r

        Restore. Files are restored to the share + from the tar file.

        -l log level

        Log (debug) level. Corresponds to the + -d flag of smbclient(1).

        ENVIRONMENT VARIABLES

        The $TAPE variable specifies the default tape device to write to. May be overridden - with the -t option.

        BUGS

        The smbtar script has different - options from ordinary tar and from smbclient's tar command.

        CAVEATS

        Sites that are more careful about security may not like + with the -t option.

        BUGS

        The smbtar script has different + options from ordinary tar and from smbclient's tar command.

        CAVEATS

        Sites that are more careful about security may not like the way the script handles PC passwords. Backup and restore work on entire shares; should work on file lists. smbtar works best - with GNU tar and may not work well with other versions.

        DIAGNOSTICS

        See the DIAGNOSTICS section for the - smbclient(1) - command.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        SEE ALSO

        smbd(8), - smbclient(1), - smb.conf(5), -

        AUTHOR

        The original Samba software and related utilities + with GNU tar and may not work well with other versions.

        DIAGNOSTICS

        See the DIAGNOSTICS section for the smbclient(1) command.

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        smbd(8), smbclient(1), smb.conf(5).

        AUTHOR

        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.

        Ricky Poulten - wrote the tar extension and this man page. The smbtar - script was heavily rewritten and improved by Martin Kraemer. Many + to the way the Linux kernel is developed.

        Ricky Poulten + wrote the tar extension and this man page. The smbtar + script was heavily rewritten and improved by Martin Kraemer. Many thanks to everyone who suggested extensions, improvements, bug fixes, etc. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter.

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/smbumount.8.html b/docs/htmldocs/smbumount.8.html index 993436f0c6..f0aa0f974d 100644 --- a/docs/htmldocs/smbumount.8.html +++ b/docs/htmldocs/smbumount.8.html @@ -1,141 +1,16 @@ - -smbumount

        smbumount

        Name

        smbumount -- smbfs umount for normal users

        Synopsis

        smbumount {mount-point}

        DESCRIPTION

        With this program, normal users can unmount smb-filesystems, - provided that it is suid root. smbumount has +smbumount

        Name

        smbumount — smbfs umount for normal users

        Synopsis

        smbumount {mount-point}

        DESCRIPTION

        With this program, normal users can unmount smb-filesystems, + provided that it is suid root. smbumount has been written to give normal Linux users more control over their resources. It is safe to install this program suid root, because only the user who has mounted a filesystem is allowed to unmount it again. For root it is not necessary to use smbumount. The normal umount program works perfectly well, but it would certainly be problematic - to make umount setuid root.

        OPTIONS

        mount-point

        The directory to unmount.

        SEE ALSO

        smbmount(8) -

        AUTHOR

        Volker Lendecke, Andrew Tridgell, Michael H. Warfield - and others.

        The current maintainer of smbfs and the userspace - tools smbmount, smbumount, - and smbmnt is Urban Widmark. - The SAMBA Mailing list + to make umount setuid root.

        OPTIONS

        mount-point

        The directory to unmount.

        SEE ALSO

        smbmount(8)

        AUTHOR

        Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.

        The current maintainer of smbfs and the userspace + tools smbmount, smbumount, + and smbmnt is Urban Widmark. + The SAMBA Mailing list is the preferred place to ask questions regarding these programs. -

        The conversion of this manpage for Samba 2.2 was performed - by Gerald Carter

        \ No newline at end of file +

        The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/speed.html b/docs/htmldocs/speed.html index 1a05706f92..c7ae9dda2d 100644 --- a/docs/htmldocs/speed.html +++ b/docs/htmldocs/speed.html @@ -1,419 +1,143 @@ - -Samba performance issues
        SAMBA Project Documentation
        PrevNext

        Chapter 22. Samba performance issues

        22.1. Comparisons

        The Samba server uses TCP to talk to the client. Thus if you are +Chapter 39. Samba Performance Tuning

        Chapter 39. Samba Performance Tuning
        Prev Part VI. Appendixes Next

        Chapter 39. Samba Performance Tuning

        Paul Cochrane

        Dundee Limb Fitting Centre

        Jelmer R. Vernooij

        The Samba Team

        John H. Terpstra

        Samba Team

        Table of Contents

        Comparisons
        Socket options
        Read size
        Max xmit
        Log level
        Read raw
        Write raw
        Slow Logins
        LDAP
        Client tuning
        Samba performance problem due changing kernel
        Corrupt tdb Files

        Comparisons

        +The Samba server uses TCP to talk to the client. Thus if you are trying to see if it performs well you should really compare it to programs that use the same protocol. The most readily available programs for file transfer that use TCP are ftp or another TCP based -SMB server.

        If you want to test against something like a NT or WfWg server then +SMB server. +

        +If you want to test against something like a NT or WfWg server then you will have to disable all but TCP on either the client or server. Otherwise you may well be using a totally different protocol -(such as Netbeui) and comparisons may not be valid.

        Generally you should find that Samba performs similarly to ftp at raw +(such as Netbeui) and comparisons may not be valid. +

        +Generally you should find that Samba performs similarly to ftp at raw transfer speed. It should perform quite a bit faster than NFS, -although this very much depends on your system.

        Several people have done comparisons between Samba and Novell, NFS or +although this very much depends on your system. +

        +Several people have done comparisons between Samba and Novell, NFS or WinNT. In some cases Samba performed the best, in others the worst. I suspect the biggest factor is not Samba vs some other system but the hardware and drivers used on the various systems. Given similar hardware Samba should certainly be competitive in speed with other -systems.

        22.2. Socket options

        There are a number of socket options that can greatly affect the -performance of a TCP based server like Samba.

        The socket options that Samba uses are settable both on the command -line with the -O option, or in the smb.conf file.

        The "socket options" section of the smb.conf manual page describes how -to set these and gives recommendations.

        Getting the socket options right can make a big difference to your +systems. +

        Socket options

        +There are a number of socket options that can greatly affect the +performance of a TCP based server like Samba. +

        +The socket options that Samba uses are settable both on the command +line with the -O option, or in the smb.conf file. +

        +The socket options section of the smb.conf manual page describes how +to set these and gives recommendations. +

        +Getting the socket options right can make a big difference to your performance, but getting them wrong can degrade it by just as -much. The correct settings are very dependent on your local network.

        The socket option TCP_NODELAY is the one that seems to make the +much. The correct settings are very dependent on your local network. +

        +The socket option TCP_NODELAY is the one that seems to make the biggest single difference for most networks. Many people report that -adding "socket options = TCP_NODELAY" doubles the read performance of -a Samba drive. The best explanation I have seen for this is that the -Microsoft TCP/IP stack is slow in sending tcp ACKs.

        22.3. Read size

        The option "read size" affects the overlap of disk reads/writes with -network reads/writes. If the amount of data being transferred in -several of the SMB commands (currently SMBwrite, SMBwriteX and +adding socket options = TCP_NODELAY doubles the read +performance of a Samba drive. The best explanation I have seen for this is +that the Microsoft TCP/IP stack is slow in sending tcp ACKs. +

        Read size

        +The option read size affects the overlap of disk +reads/writes with network reads/writes. If the amount of data being +transferred in several of the SMB commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger than this value then the server begins writing the data before it has received the whole packet from the network, or in the case of SMBreadbraw, it begins writing to the network before -all the data has been read from disk.

        This overlapping works best when the speeds of disk and network access +all the data has been read from disk. +

        +This overlapping works best when the speeds of disk and network access are similar, having very little effect when the speed of one is much -greater than the other.

        The default value is 16384, but very little experimentation has been +greater than the other. +

        +The default value is 16384, but very little experimentation has been done yet to determine the optimal value, and it is likely that the best value will vary greatly between systems anyway. A value over 65536 is -pointless and will cause you to allocate memory unnecessarily.

        22.4. Max xmit

        At startup the client and server negotiate a "maximum transmit" size, +pointless and will cause you to allocate memory unnecessarily. +

        Max xmit

        +At startup the client and server negotiate a maximum transmit size, which limits the size of nearly all SMB commands. You can set the -maximum size that Samba will negotiate using the "max xmit = " option -in smb.conf. Note that this is the maximum size of SMB request that +maximum size that Samba will negotiate using the max xmit = option +in smb.conf. Note that this is the maximum size of SMB requests that Samba will accept, but not the maximum size that the *client* will accept. The client maximum receive size is sent to Samba by the client and Samba -honours this limit.

        It defaults to 65536 bytes (the maximum), but it is possible that some +honours this limit. +

        +It defaults to 65536 bytes (the maximum), but it is possible that some clients may perform better with a smaller transmit unit. Trying values -of less than 2048 is likely to cause severe problems.

        In most cases the default is the best option.

        22.5. Log level

        If you set the log level (also known as "debug level") higher than 2 +of less than 2048 is likely to cause severe problems. +

        +In most cases the default is the best option. +

        Log level

        +If you set the log level (also known as debug level) higher than 2 then you may suffer a large drop in performance. This is because the server flushes the log file after each operation, which can be very -expensive.

        22.6. Read raw

        The "read raw" operation is designed to be an optimised, low-latency +expensive. +

        Read raw

        +The read raw operation is designed to be an optimised, low-latency file read operation. A server may choose to not support it, -however. and Samba makes support for "read raw" optional, with it -being enabled by default.

        In some cases clients don't handle "read raw" very well and actually +however. and Samba makes support for read raw optional, with it +being enabled by default. +

        +In some cases clients don't handle read raw very well and actually get lower performance using it than they get using the conventional -read operations.

        So you might like to try "read raw = no" and see what happens on your +read operations. +

        +So you might like to try read raw = no and see what happens on your network. It might lower, raise or not affect your performance. Only -testing can really tell.

        22.7. Write raw

        The "write raw" operation is designed to be an optimised, low-latency +testing can really tell. +

        Write raw

        +The write raw operation is designed to be an optimised, low-latency file write operation. A server may choose to not support it, -however. and Samba makes support for "write raw" optional, with it -being enabled by default.

        Some machines may find "write raw" slower than normal write, in which -case you may wish to change this option.

        22.8. Slow Clients

        One person has reported that setting the protocol to COREPLUS rather -than LANMAN2 gave a dramatic speed improvement (from 10k/s to 150k/s).

        I suspect that his PC's (386sx16 based) were asking for more data than -they could chew. I suspect a similar speed could be had by setting -"read raw = no" and "max xmit = 2048", instead of changing the -protocol. Lowering the "read size" might also help.

        22.9. Slow Logins

        Slow logins are almost always due to the password checking time. Using -the lowest practical "password level" will improve things a lot. You -could also enable the "UFC crypt" option in the Makefile.

        22.10. Client tuning

        Often a speed problem can be traced to the client. The client (for +however. and Samba makes support for write raw optional, with it +being enabled by default. +

        +Some machines may find write raw slower than normal write, in which +case you may wish to change this option. +

        Slow Logins

        +Slow logins are almost always due to the password checking time. Using +the lowest practical password level will improve things. +

        LDAP

        +LDAP can be vastly improved by using the +ldap trust ids parameter. +

        Client tuning

        +Often a speed problem can be traced to the client. The client (for example Windows for Workgroups) can often be tuned for better TCP -performance.

        See your client docs for details. In particular, I have heard rumours -that the WfWg options TCPWINDOWSIZE and TCPSEGMENTSIZE can have a -large impact on performance.

        Also note that some people have found that setting DefaultRcvWindow in -the [MSTCP] section of the SYSTEM.INI file under WfWg to 3072 gives a -big improvement. I don't know why.

        My own experience wth DefaultRcvWindow is that I get much better -performance with a large value (16384 or larger). Other people have -reported that anything over 3072 slows things down enourmously. One -person even reported a speed drop of a factor of 30 when he went from -3072 to 8192. I don't know why.

        It probably depends a lot on your hardware, and the type of unix box -you have at the other end of the link.

        Paul Cochrane has done some testing on client side tuning and come -to the following conclusions:

        Install the W2setup.exe file from www.microsoft.com. This is an -update for the winsock stack and utilities which improve performance.

        Configure the win95 TCPIP registry settings to give better -perfomance. I use a program called MTUSPEED.exe which I got off the -net. There are various other utilities of this type freely available. -The setting which give the best performance for me are:

        1. MaxMTU Remove

        2. RWIN Remove

        3. MTUAutoDiscover Disable

        4. MTUBlackHoleDetect Disable

        5. Time To Live Enabled

        6. Time To Live - HOPS 32

        7. NDI Cache Size 0

        I tried virtually all of the items mentioned in the document and -the only one which made a difference to me was the socket options. It -turned out I was better off without any!!!!!

        In terms of overall speed of transfer, between various win95 clients -and a DX2-66 20MB server with a crappy NE2000 compatible and old IDE -drive (Kernel 2.0.30). The transfer rate was reasonable for 10 baseT.

        The figures are:          Put              Get 
-P166 client 3Com card:    420-440kB/s      500-520kB/s
-P100 client 3Com card:    390-410kB/s      490-510kB/s
-DX4-75 client NE2000:     370-380kB/s      330-350kB/s

        I based these test on transfer two files a 4.5MB text file and a 15MB -textfile. The results arn't bad considering the hardware Samba is -running on. It's a crap machine!!!!

        The updates mentioned in 1 and 2 brought up the transfer rates from -just over 100kB/s in some clients.

        A new client is a P333 connected via a 100MB/s card and hub. The -transfer rates from this were good: 450-500kB/s on put and 600+kB/s -on get.

        Looking at standard FTP throughput, Samba is a bit slower (100kB/s -upwards). I suppose there is more going on in the samba protocol, but -if it could get up to the rate of FTP the perfomance would be quite -staggering.

        PrevHomeNext
        Group mapping HOWTOUpAppendixes
        \ No newline at end of file +performance. Check the sections on the various clients in +Samba and Other Clients. +

        Samba performance problem due changing kernel

        +Hi everyone. I am running Gentoo on my server and samba 2.2.8a. Recently +I changed kernel version from linux-2.4.19-gentoo-r10 to +linux-2.4.20-wolk4.0s. And now I have performance issue with samba. Ok +many of you will probably say that move to vanilla sources...well I ried +it too and it didn't work. I have 100mb LAN and two computers (linux + +Windows2000). Linux server shares directory with DivX files, client +(windows2000) plays them via LAN. Before when I was running 2.4.19 kernel +everything was fine, but now movies freezes and stops...I tried moving +files between server and Windows and it's trerribly slow. +

        +Grab mii-tool and check the duplex settings on the NIC. +My guess is that it is a link layer issue, not an application +layer problem. Also run ifconfig and verify that the framing +error, collisions, etc... look normal for ethernet. +

        Corrupt tdb Files

        +Well today it happend, our first major problem using samba. +Our samba PDC server has been hosting 3 TB of data to our 500+ users +[Windows NT/XP] for the last 3 years using samba, no problem. +But today all shares went SLOW; very slow. Also the main smbd kept +spawning new processes so we had 1600+ running smbd's (normally we avg. 250). +It crashed the SUN E3500 cluster twice. After alot of searching I +decided to rm /var/locks/*.tbl. Happy again. +

        +Q1) Is there any method of keeping the *.tbl files in top condition or +how to early detect corruption? +

        +A1) Yes, run tdbbackup each time after stoping nmbd and before starting nmbd. +

        +Q2) What I also would like to mention is that the service latency seems +alot lower then before the locks cleanup, any ideas on keeping it top notch? +

        +A2) Yes! Samba answer as for Q1! +

        Prev Up Next
        Chapter 38. Samba and other CIFS clients Home Chapter 40. DNS and DHCP Configuration Guide
        diff --git a/docs/htmldocs/swat.8.html b/docs/htmldocs/swat.8.html index f101a7bc26..e0719dce3d 100644 --- a/docs/htmldocs/swat.8.html +++ b/docs/htmldocs/swat.8.html @@ -1,425 +1,87 @@ - -swat

        swat

        Name

        swat -- Samba Web Administration Tool

        Synopsis

        swat [-s <smb config file>] [-a]

        DESCRIPTION

        This tool is part of the Samba suite.

        swat allows a Samba administrator to - configure the complex smb.conf(5) file via a Web browser. In addition, - a swat configuration page has help links - to all the configurable options in the smb.conf file allowing an - administrator to easily look up the effects of any change.

        swat is run from inetd

        OPTIONS

        -s smb configuration file

        The default configuration file path is +swat

        Name

        swat — Samba Web Administration Tool

        Synopsis

        swat [-s <smb config file>] [-a]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        swat allows a Samba administrator to + configure the complex smb.conf(5) file via a Web browser. In addition, + a swat configuration page has help links + to all the configurable options in the smb.conf file allowing an + administrator to easily look up the effects of any change.

        swat is run from inetd

        OPTIONS

        -s smb configuration file

        The default configuration file path is determined at compile time. The file specified contains - the configuration details required by the smbd - server. This is the file that swat will modify. + the configuration details required by the smbd(8) server. This is the file + that swat will modify. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. - See smb.conf for more information. -

        -a

        This option disables authentication and puts - swat in demo mode. In that mode anyone will be able to modify - the smb.conf file.

        WARNING: Do NOT enable this option on a production - server.

        INSTALLATION

        After you compile SWAT you need to run make install - to install the swat binary + See smb.conf for more information. +

        -a

        This option disables authentication and puts + swat in demo mode. In that mode anyone will be able to modify + the smb.conf file.

        WARNING: Do NOT enable this option on a production + server.

        -V

        Prints the version number for +smbd.

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

        The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

        Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -l|--logfile=logbasename

        File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

        -h|--help

        Print a summary of command line options. +

        INSTALLATION

        Swat is included as binary package with most distributions. The + package manager in this case takes care of the installation and + configuration. This section is only for those who have compiled + swat from scratch. +

        After you compile SWAT you need to run make install + to install the swat binary and the various help files and images. A default install would put - these in:

        Inetd Installation

        You need to edit your /etc/inetd.conf - and /etc/services - to enable SWAT to be launched via inetd.

        In /etc/services you need to - add a line like this:

        swat 901/tcp

        Note for NIS/YP users - you may need to rebuild the - NIS service maps rather than alter your local /etc/services file.

        the choice of port number isn't really important + these in:

        • /usr/local/samba/bin/swat

        • /usr/local/samba/swat/images/*

        • /usr/local/samba/swat/help/*

        Inetd Installation

        You need to edit your /etc/inetd.conf + and /etc/services + to enable SWAT to be launched via inetd.

        In /etc/services you need to + add a line like this:

        swat 901/tcp

        Note for NIS/YP and LDAP users - you may need to rebuild the + NIS service maps rather than alter your local + /etc/services file.

        the choice of port number isn't really important except that it should be less than 1024 and not currently used (using a number above 1024 presents an obscure security hole depending on the implementation details of your - inetd daemon).

        In /etc/inetd.conf you should - add a line like this:

        swat stream tcp nowait.400 root - /usr/local/samba/bin/swat swat

        One you have edited /etc/services - and /etc/inetd.conf you need to send a - HUP signal to inetd. To do this use kill -1 PID - where PID is the process ID of the inetd daemon.

        Launching

        To launch SWAT just run your favorite web browser and - point it at "http://localhost:901/".

        Note that you can attach to SWAT from any IP connected - machine but connecting from a remote machine leaves your - connection open to password sniffing as passwords will be sent - in the clear over the wire.

        FILES

        /etc/inetd.conf

        This file must contain suitable startup - information for the meta-daemon.

        /etc/services

        This file must contain a mapping of service name + inetd daemon).

        In /etc/inetd.conf you should + add a line like this:

        swat stream tcp nowait.400 root + /usr/local/samba/bin/swat swat

        One you have edited /etc/services + and /etc/inetd.conf you need to send a + HUP signal to inetd. To do this use kill -1 PID + where PID is the process ID of the inetd daemon.

        LAUNCHING

        To launch SWAT just run your favorite web browser and + point it at "http://localhost:901/".

        Note that you can attach to SWAT from any IP connected + machine but connecting from a remote machine leaves your + connection open to password sniffing as passwords will be sent + in the clear over the wire.

        FILES

        /etc/inetd.conf

        This file must contain suitable startup + information for the meta-daemon.

        /etc/services

        This file must contain a mapping of service name (e.g., swat) to service port (e.g., 901) and protocol type - (e.g., tcp).

        /usr/local/samba/lib/smb.conf

        This is the default location of the smb.conf(5) - server configuration file that swat edits. Other - common places that systems install this file are /usr/samba/lib/smb.conf and /etc/smb.conf - . This file describes all the services the server - is to make available to clients.

        WARNINGS

        swat will rewrite your smb.conf - file. It will rearrange the entries and delete all - comments, include= and copy= - options. If you have a carefully crafted smb.conf then back it up or don't use swat!

        VERSION

        This man page is correct for version 2.2 of - the Samba suite.

        SEE ALSO

        inetd(5), - smbd(8), - smb.conf(5) -

        AUTHOR

        The original Samba software and related utilities + (e.g., tcp).

        /usr/local/samba/lib/smb.conf

        This is the default location of the smb.conf(5) server configuration file that swat edits. Other + common places that systems install this file are + /usr/samba/lib/smb.conf and /etc/smb.conf + . This file describes all the services the server + is to make available to clients.

        WARNINGS

        swat will rewrite your smb.conf(5) file. It will rearrange the entries and delete all + comments, include= and copy= + options. If you have a carefully crafted + smb.conf then back it up or don't use swat!

        VERSION

        This man page is correct for version 3.0 of the Samba suite.

        SEE ALSO

        inetd(5), smbd(8), smb.conf(5)

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/testparm.1.html b/docs/htmldocs/testparm.1.html index baf11bacac..3732b53f4c 100644 --- a/docs/htmldocs/testparm.1.html +++ b/docs/htmldocs/testparm.1.html @@ -1,316 +1,51 @@ - -testparm

        testparm

        Name

        testparm -- check an smb.conf configuration file for - internal correctness

        Synopsis

        testparm [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]

        DESCRIPTION

        This tool is part of the Samba suite.

        testparm is a very simple test program - to check an smbd configuration file for +testparm

        Name

        testparm — check an smb.conf configuration file for + internal correctness

        Synopsis

        testparm [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        testparm is a very simple test program + to check an smbd(8) configuration file for internal correctness. If this program reports no problems, you - can use the configuration file with confidence that smbd - will successfully load the configuration file.

        Note that this is NOT a guarantee that + can use the configuration file with confidence that smbd + will successfully load the configuration file.

        Note that this is NOT a guarantee that the services specified in the configuration file will be - available or will operate as expected.

        If the optional host name and host IP address are + available or will operate as expected.

        If the optional host name and host IP address are specified on the command line, this test program will run through the service entries reporting whether the specified host - has access to each service.

        If testparm finds an error in the smb.conf file it returns an exit code of 1 to the calling + has access to each service.

        If testparm finds an error in the + smb.conf file it returns an exit code of 1 to the calling program, else it returns an exit code of 0. This allows shell scripts - to test the output from testparm.

        OPTIONS

        -s

        Without this option, testparm + to test the output from testparm.

        OPTIONS

        -s

        Without this option, testparm will prompt for a carriage return after printing the service - names and before dumping the service definitions.

        -h

        Print usage message

        -L servername

        Sets the value of the %L macro to servername. + names and before dumping the service definitions.

        -h|--help

        Print a summary of command line options. +

        -V

        Prints the version number for +smbd.

        -L servername

        Sets the value of the %L macro to servername. This is useful for testing include files specified with the - %L macro.

        -v

        If this option is specified, testparm - will also output all options that were not used in - smb.conf and are thus set to - their defaults.

        -t encoding

        Output data in specified encoding. -

        configfilename

        This is the name of the configuration file + %L macro.

        -v

        If this option is specified, testparm + will also output all options that were not used in smb.conf(5) and are thus set to their defaults.

        -t encoding

        + Output data in specified encoding. +

        configfilename

        This is the name of the configuration file to check. If this parameter is not present then the - default smb.conf file will be checked. -

        hostname

        If this parameter and the following are - specified, then testparm will examine the hosts - allow and hosts deny - parameters in the smb.conf file to + default smb.conf(5) file will be checked. +

        hostname

        If this parameter and the following are + specified, then testparm will examine the hosts + allow and hosts deny + parameters in the smb.conf(5) file to determine if the hostname with this IP address would be - allowed access to the smbd server. If + allowed access to the smbd server. If this parameter is supplied, the hostIP parameter must also - be supplied.

        hostIP

        This is the IP address of the host specified + be supplied.

        hostIP

        This is the IP address of the host specified in the previous parameter. This address must be supplied - if the hostname parameter is supplied.

        FILES

        smb.conf

        This is usually the name of the configuration - file used by smbd. -

        DIAGNOSTICS

        The program will issue a message saying whether the + if the hostname parameter is supplied.

        FILES

        smb.conf(5)

        This is usually the name of the configuration + file used by smbd(8). +

        DIAGNOSTICS

        The program will issue a message saying whether the configuration file loaded OK or not. This message may be preceded by errors and warnings if the file did not load. If the file was loaded OK, the program then dumps all known service details - to stdout.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        SEE ALSO

        smb.conf(5), - smbd(8) -

        AUTHOR

        The original Samba software and related utilities + to stdout.

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        smb.conf(5), smbd(8)

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/testprns.1.html b/docs/htmldocs/testprns.1.html index 0225aad9d5..ff7d4efd33 100644 --- a/docs/htmldocs/testprns.1.html +++ b/docs/htmldocs/testprns.1.html @@ -1,253 +1,38 @@ - -testprns

        testprns

        Name

        testprns -- check printer name for validity with smbd

        Synopsis

        testprns {printername} [printcapname]

        DESCRIPTION

        This tool is part of the Samba suite.

        testprns is a very simple test program +testprns

        Name

        testprns — check printer name for validity with smbd

        Synopsis

        testprns {printername} [printcapname]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        testprns is a very simple test program to determine whether a given printer name is valid for use in - a service to be provided by smbd(8).

        "Valid" in this context means "can be found in the - printcap specified". This program is very stupid - so stupid in + a service to be provided by smbd(8).

        "Valid" in this context means "can be found in the + printcap specified". This program is very stupid - so stupid in fact that it would be wisest to always specify the printcap file - to use.

        OPTIONS

        printername

        The printer name to validate.

        Printer names are taken from the first field in each + to use.

        OPTIONS

        printername

        The printer name to validate.

        Printer names are taken from the first field in each record in the printcap file, single printer names and sets - of aliases separated by vertical bars ("|") are recognized. + of aliases separated by vertical bars ("|") are recognized. Note that no validation or checking of the printcap syntax is done beyond that required to extract the printer name. It may be that the print spooling system is more forgiving or less - forgiving than testprns. However, if - testprns finds the printer then - smbd should do so as well.

        printcapname

        This is the name of the printcap file within - which to search for the given printer name.

        If no printcap name is specified testprns - will attempt to scan the printcap file name - specified at compile time.

        FILES

        /etc/printcap

        This is usually the default printcap - file to scan. See printcap (5). -

        DIAGNOSTICS

        If a printer is found to be valid, the message - "Printer name <printername> is valid" will be - displayed.

        If a printer is found to be invalid, the message - "Printer name <printername> is not valid" will be - displayed.

        All messages that would normally be logged during + forgiving than testprns. However, if + testprns finds the printer then smbd(8) should do so as well.

        printcapname

        This is the name of the printcap file within + which to search for the given printer name.

        If no printcap name is specified testprns + will attempt to scan the printcap file name + specified at compile time.

        FILES

        /etc/printcap

        This is usually the default printcap + file to scan. See printcap (5). +

        DIAGNOSTICS

        If a printer is found to be valid, the message + "Printer name <printername> is valid" will be + displayed.

        If a printer is found to be invalid, the message + "Printer name <printername> is not valid" will be + displayed.

        All messages that would normally be logged during operation of the Samba daemons are logged by this program to the - file test.log in the current directory. The + file test.log in the current directory. The program runs at debuglevel 3, so quite extensive logging information is written. The log should be checked carefully - for errors and warnings.

        Other messages are self-explanatory.

        VERSION

        This man page is correct for version 2.2 of - the Samba suite.

        SEE ALSO

        printcap(5), - smbd(8), - smbclient(1) -

        AUTHOR

        The original Samba software and related utilities + for errors and warnings.

        Other messages are self-explanatory.

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        printcap(5), + smbd(8), smbclient(1)

        AUTHOR

        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.

        The original Samba man pages were written by Karl Auer. + to the way the Linux kernel is developed.

        The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter

        \ No newline at end of file + Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 + for Samba 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/type.html b/docs/htmldocs/type.html index e3f09acc18..0e0f6b7d2a 100644 --- a/docs/htmldocs/type.html +++ b/docs/htmldocs/type.html @@ -1,389 +1,9 @@ - -Type of installation
        SAMBA Project Documentation
        PrevNext

        II. Type of installation

        Introduction

        Samba can operate in various SMB networks. This part contains information on configuring samba -for various environments.

        Table of Contents
        5. User and Share security level (for servers not in a domain)
        6. How to Configure Samba as a NT4 Primary Domain Controller
        6.1. Prerequisite Reading
        6.2. Background
        6.3. Configuring the Samba Domain Controller
        6.4. Creating Machine Trust Accounts and Joining Clients to the -Domain
        6.4.1. Manual Creation of Machine Trust Accounts
        6.4.2. "On-the-Fly" Creation of Machine Trust Accounts
        6.4.3. Joining the Client to the Domain
        6.5. Common Problems and Errors
        6.6. System Policies and Profiles
        6.7. What other help can I get?
        6.8. Domain Control for Windows 9x/ME
        6.8.1. Configuration Instructions: Network Logons
        6.8.2. Configuration Instructions: Setting up Roaming User Profiles
        6.9. DOMAIN_CONTROL.txt : Windows NT Domain Control & Samba
        7. How to Act as a Backup Domain Controller in a Purely Samba Controlled Domain
        7.1. Prerequisite Reading
        7.2. Background
        7.3. What qualifies a Domain Controller on the network?
        7.3.1. How does a Workstation find its domain controller?
        7.3.2. When is the PDC needed?
        7.4. Can Samba be a Backup Domain Controller?
        7.5. How do I set up a Samba BDC?
        7.5.1. How do I replicate the smbpasswd file?
        8. Samba as a ADS domain member
        8.1. Installing the required packages for Debian
        8.2. Installing the required packages for RedHat
        8.3. Compile Samba
        8.4. Setup your /etc/krb5.conf
        8.5. Create the computer account
        8.5.1. Possible errors
        8.6. Test your server setup
        8.7. Testing with smbclient
        8.8. Notes
        9. Samba as a NT4 domain member
        9.1. Joining an NT Domain with Samba 2.2
        9.2. Samba and Windows 2000 Domains
        9.3. Why is this better than security = server?
        PrevHomeNext
        LanMan and NT Password Encryption in Samba User and Share security level (for servers not in a domain)
        \ No newline at end of file +Part II. Server Configuration Basics
        Part II. Server Configuration Basics
        Prev   Next

        Server Configuration Basics

        First Steps in Server Configuration

        +Samba can operate in various modes within SMB networks. This HOWTO section contains information on +configuring samba to function as the type of server your network requires. Please read this +section carefully. +

        Table of Contents

        4. Server Types and Security Modes
        Features and Benefits
        Server Types
        Samba Security Modes
        User Level Security
        Share Level Security
        Domain Security Mode (User Level Security)
        ADS Security Mode (User Level Security)
        Server Security (User Level Security)
        Seamless Windows Network Integration
        Common Errors
        What makes Samba a SERVER?
        What makes Samba a Domain Controller?
        What makes Samba a Domain Member?
        Constantly Losing Connections to Password Server
        5. Domain Control
        Features and Benefits
        Basics of Domain Control
        Domain Controller Types
        Preparing for Domain Control
        Domain Control - Example Configuration
        Samba ADS Domain Control
        Domain and Network Logon Configuration
        Domain Network Logon Service
        Security Mode and Master Browsers
        Common Problems and Errors
        I cannot include a '$' in a machine name
        I get told "You already have a connection to the Domain...." +or "Cannot join domain, the credentials supplied conflict with an +existing set.." when creating a machine trust account.
        The system can not log you on (C000019B)....
        The machine trust account for this computer either does not +exist or is not accessible.
        When I attempt to login to a Samba Domain from a NT4/W2K workstation, +I get a message about my account being disabled.
        Until a few minutes after Samba has started, clients get the error "Domain Controller Unavailable"
        6. Backup Domain Control
        Features And Benefits
        Essential Background Information
        MS Windows NT4 Style Domain Control
        Active Directory Domain Control
        What qualifies a Domain Controller on the network?
        How does a Workstation find its domain controller?
        Backup Domain Controller Configuration
        Example Configuration
        Common Errors
        Machine Accounts keep expiring, what can I do?
        Can Samba be a Backup Domain Controller to an NT4 PDC?
        How do I replicate the smbpasswd file?
        Can I do this all with LDAP?
        7. Domain Membership
        Features and Benefits
        MS Windows Workstation/Server Machine Trust Accounts
        Manual Creation of Machine Trust Accounts
        Using NT4 Server Manager to Add Machine Accounts to the Domain
        "On-the-Fly" Creation of Machine Trust Accounts
        Making an MS Windows Workstation or Server a Domain Member
        Domain Member Server
        Joining an NT4 type Domain with Samba-3
        Why is this better than security = server?
        Samba ADS Domain Membership
        Setup your smb.conf
        Setup your /etc/krb5.conf
        Create the computer account
        Test your server setup
        Testing with smbclient
        Notes
        Common Errors
        Can Not Add Machine Back to Domain
        Adding Machine to Domain Fails
        8. Stand-Alone Servers
        Features and Benefits
        Background
        Example Configuration
        Reference Documentation Server
        Central Print Serving
        Common Errors
        9. MS Windows Network Configuration Guide
        Note
        Prev Up Next
        Chapter 3. FastStart for the Impatient Home Chapter 4. Server Types and Security Modes
        diff --git a/docs/htmldocs/vfstest.1.html b/docs/htmldocs/vfstest.1.html index 1fd7880805..7b124c070f 100644 --- a/docs/htmldocs/vfstest.1.html +++ b/docs/htmldocs/vfstest.1.html @@ -1,487 +1,43 @@ - -vfstest

        vfstest

        Name

        vfstest -- tool for testing samba VFS modules

        Synopsis

        vfstest [-d debuglevel] [-c command] [-l logfile] [-h]

        DESCRIPTION

        This tool is part of the Samba suite.

        vfstest is a small command line +vfstest

        Name

        vfstest — tool for testing samba VFS modules

        Synopsis

        vfstest [-d debuglevel] [-c command] [-l logfile] [-h]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        vfstest 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. -

        OPTIONS

        -c|--command=command

        Execute the specified (colon-separated) commands. +

        OPTIONS

        -c|--command=command

        Execute the specified (colon-separated) commands. See below for the commands that are available. -

        -d|--debug=debuglevel

        debuglevel is an integer +

        -h|--help

        Print a summary of command line options. +

        -l|--logfile=logbasename

        File name for log/debug files. The extension + '.client' will be appended. The log file is never removed + by the client. +

        -V

        Prints the version number for +smbd.

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer from 0 to 10. The default value if this parameter is -not specified is zero.

        The higher this value, the more detail will be +not specified is zero.

        The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day to day running - it generates a small amount of -information about operations carried out.

        Levels above 1 will generate considerable +information about operations carried out.

        Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.

        Note that specifying this parameter here will -override the log -level parameter in the smb.conf(5) file.

        -h|--help

        Print a summary of command line options.

        -l|--logfile=logbasename

        File name for log/debug files. The extension - '.client' will be appended. The log file is never removed - by the client. -

        COMMANDS

        VFS COMMANDS

        • load <module.so> - Load specified VFS module

        • populate <char> <size> - Populate a data buffer with the specified data -

        • showdata [<offset> <len>] - Show data currently in data buffer -

        • connect - VFS connect()

        • disconnect - VFS disconnect()

        • disk_free - VFS disk_free()

        • opendir - VFS opendir()

        • readdir - VFS readdir()

        • mkdir - VFS mkdir()

        • rmdir - VFS rmdir()

        • closedir - VFS closedir()

        • open - VFS open()

        • close - VFS close()

        • read - VFS read()

        • write - VFS write()

        • lseek - VFS lseek()

        • rename - VFS rename()

        • fsync - VFS fsync()

        • stat - VFS stat()

        • fstat - VFS fstat()

        • lstat - VFS lstat()

        • unlink - VFS unlink()

        • chmod - VFS chmod()

        • fchmod - VFS fchmod()

        • chown - VFS chown()

        • fchown - VFS fchown()

        • chdir - VFS chdir()

        • getwd - VFS getwd()

        • utime - VFS utime()

        • ftruncate - VFS ftruncate()

        • lock - VFS lock()

        • symlink - VFS symlink()

        • readlink - VFS readlink()

        • link - VFS link()

        • mknod - VFS mknod()

        • realpath - VFS realpath()

        GENERAL COMMANDS

        • conf <smb.conf> - Load a different configuration file

        • help [<command>] - Get list of commands or info about specified command

        • debuglevel <level> - Set debug level

        • freemem - Free memory currently in use

        • exit - Exit vfstest

        VERSION

        This man page is correct for version 3.0 of the Samba - suite.

        AUTHOR

        The original Samba software and related utilities +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -l|--logfile=logbasename

        File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

        COMMANDS

        VFS COMMANDS

        • load <module.so> - Load specified VFS module

        • populate <char> <size> - Populate a data buffer with the specified data +

        • showdata [<offset> <len>] - Show data currently in data buffer +

        • connect - VFS connect()

        • disconnect - VFS disconnect()

        • disk_free - VFS disk_free()

        • opendir - VFS opendir()

        • readdir - VFS readdir()

        • mkdir - VFS mkdir()

        • rmdir - VFS rmdir()

        • closedir - VFS closedir()

        • open - VFS open()

        • close - VFS close()

        • read - VFS read()

        • write - VFS write()

        • lseek - VFS lseek()

        • rename - VFS rename()

        • fsync - VFS fsync()

        • stat - VFS stat()

        • fstat - VFS fstat()

        • lstat - VFS lstat()

        • unlink - VFS unlink()

        • chmod - VFS chmod()

        • fchmod - VFS fchmod()

        • chown - VFS chown()

        • fchown - VFS fchown()

        • chdir - VFS chdir()

        • getwd - VFS getwd()

        • utime - VFS utime()

        • ftruncate - VFS ftruncate()

        • lock - VFS lock()

        • symlink - VFS symlink()

        • readlink - VFS readlink()

        • link - VFS link()

        • mknod - VFS mknod()

        • realpath - VFS realpath()

        GENERAL COMMANDS

        • conf <smb.conf> - Load a different configuration file

        • help [<command>] - Get list of commands or info about specified command

        • debuglevel <level> - Set debug level

        • freemem - Free memory currently in use

        • exit - Exit vfstest

        VERSION

        This man page is correct for version 3.0 of the Samba + suite.

        AUTHOR

        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.

        The vfstest man page was written by Jelmer Vernooij.

        \ No newline at end of file + to the way the Linux kernel is developed.

        The vfstest man page was written by Jelmer Vernooij.

        diff --git a/docs/htmldocs/wbinfo.1.html b/docs/htmldocs/wbinfo.1.html index a8aa065eed..13967b3e61 100644 --- a/docs/htmldocs/wbinfo.1.html +++ b/docs/htmldocs/wbinfo.1.html @@ -1,383 +1,71 @@ - -wbinfo

        wbinfo

        Name

        wbinfo -- Query information from winbind daemon

        Synopsis

        wbinfo [-u] [-g] [-i ip] [-N netbios-name] [-n name] [-s sid] [-U uid] [-G gid] [-S sid] [-Y sid] [-t] [-m] [-r user] [-a user%password] [-A user%password] [-p]

        DESCRIPTION

        This tool is part of the Samba suite.

        The wbinfo program queries and returns information - created and used by the winbindd(8) daemon.

        The winbindd(8) daemon must be configured - and running for the wbinfo program to be able - to return information.

        OPTIONS

        -u

        This option will list all users available - in the Windows NT domain for which the winbindd(8) - daemon is operating in. Users in all trusted domains +wbinfo

        Name

        wbinfo — Query information from winbind daemon

        Synopsis

        wbinfo [-u] [-g] [-N netbios-name] [-I ip] [-n name] [-s sid] [-U uid] [-G gid] [-S sid] [-Y sid] [-t] [-m] [--sequence] [-r user] [-a user%password] [-A user%password] [--get-auth-user] [-p]

        DESCRIPTION

        This tool is part of the Samba(7) suite.

        The wbinfo program queries and returns information + created and used by the winbindd(8) daemon.

        The winbindd(8) daemon must be configured + and running for the wbinfo program to be able + to return information.

        OPTIONS

        -u

        This option will list all users available + in the Windows NT domain for which the winbindd(8) daemon is operating in. Users in all trusted domains will also be listed. Note that this operation does not assign - user ids to any users that have not already been seen by - winbindd(8).

        -g

        This option will list all groups available - in the Windows NT domain for which the winbindd(8) - daemon is operating in. Groups in all trusted domains + user ids to any users that have not already been seen by winbindd(8) + .

        -g

        This option will list all groups available + in the Windows NT domain for which the Samba(7) daemon is operating in. Groups in all trusted domains will also be listed. Note that this operation does not assign - group ids to any groups that have not already been seen by - winbindd(8).

        -N name

        The -N option - queries winbindd(8) to query the WINS + group ids to any groups that have not already been + seen by winbindd(8).

        -N name

        The -N option + queries winbindd(8) to query the WINS server for the IP address associated with the NetBIOS name - specified by the name parameter. -

        -I ip

        The -I option - queries winbindd(8) to send a node status + specified by the name parameter. +

        -I ip

        The -I option + queries winbindd(8) to send a node status request to get the NetBIOS name associated with the IP address - specified by the ip parameter. -

        -n name

        The -n option - queries winbindd(8) for the SID + specified by the ip parameter. +

        -n name

        The -n option + queries winbindd(8) for the SID associated with the name specified. Domain names can be specified before the user name by using the winbind separator character. For example CWDOM1/Administrator refers to the Administrator user in the domain CWDOM1. If no domain is specified then the - domain used is the one specified in the smb.conf - workgroup parameter.

        -s sid

        Use -s to resolve - a SID to a name. This is the inverse of the -n - option above. SIDs must be specified as ASCII strings + domain used is the one specified in the smb.conf(5) workgroup + parameter.

        -s sid

        Use -s to resolve + a SID to a name. This is the inverse of the -n + option above. SIDs must be specified as ASCII strings in the traditional Microsoft format. For example, - S-1-5-21-1455342024-3071081365-2475485837-500.

        -U uid

        Try to convert a UNIX user id to a Windows NT + S-1-5-21-1455342024-3071081365-2475485837-500.

        -U uid

        Try to convert a UNIX user id to a Windows NT SID. If the uid specified does not refer to one within - the winbind uid range then the operation will fail.

        -G gid

        Try to convert a UNIX group id to a Windows + the winbind uid range then the operation will fail.

        -G gid

        Try to convert a UNIX group id to a Windows NT SID. If the gid specified does not refer to one within - the winbind gid range then the operation will fail.

        -S sid

        Convert a SID to a UNIX user id. If the SID - does not correspond to a UNIX user mapped by winbindd(8) then the operation will fail.

        -Y sid

        Convert a SID to a UNIX group id. If the SID - does not correspond to a UNIX group mapped by winbindd(8) then the operation will fail.

        -t

        Verify that the workstation trust account + the winbind gid range then the operation will fail.

        -S sid

        Convert a SID to a UNIX user id. If the SID + does not correspond to a UNIX user mapped by winbindd(8) then the operation will fail.

        -Y sid

        Convert a SID to a UNIX group id. If the SID + does not correspond to a UNIX group mapped by winbindd(8) then + the operation will fail.

        -t

        Verify that the workstation trust account created when the Samba server is added to the Windows NT - domain is working.

        -m

        Produce a list of domains trusted by the - Windows NT server winbindd(8) contacts + domain is working.

        -m

        Produce a list of domains trusted by the + Windows NT server winbindd(8) contacts when resolving names. This list does not include the Windows NT domain the server is a Primary Domain Controller for. -

        -r username

        Try to obtain the list of UNIX group ids +

        --sequence

        Show sequence numbers of + all known domains

        -r username

        Try to obtain the list of UNIX group ids to which the user belongs. This only works for users defined on a Domain Controller. -

        -a username%password

        Attempt to authenticate a user via winbindd. +

        -a username%password

        Attempt to authenticate a user via winbindd. This checks both authenticaion methods and reports its results. -

        -A username%password

        Store username and password used by winbindd +

        -A username%password

        Store username and password used by winbindd during session setup to a domain controller. This enables winbindd to operate in a Windows 2000 domain with Restrict Anonymous turned on (a.k.a. Permissions compatiable with Windows 2000 servers only). -

        EXIT STATUS

        The wbinfo program returns 0 if the operation - succeeded, or 1 if the operation failed. If the winbindd(8) - daemon is not working wbinfo will always return - failure.

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        AUTHOR

        The original Samba software and related utilities +

        --get-auth-user

        Print username and password used by winbindd + during session setup to a domain controller. Username + and password can be set using '-A'. Only available for + root.

        -p

        Check whether winbindd is still alive. + Prints out either 'succeeded' or 'failed'. +

        -V

        Prints the version number for +smbd.

        -h|--help

        Print a summary of command line options. +

        EXIT STATUS

        The wbinfo program returns 0 if the operation + succeeded, or 1 if the operation failed. If the winbindd(8) daemon is not working wbinfo will always return + failure.

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        winbindd(8)

        AUTHOR

        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.

        wbinfo and winbindd - were written by Tim Potter.

        The conversion to DocBook for Samba 2.2 was done - by Gerald Carter

        \ No newline at end of file + to the way the Linux kernel is developed.

        wbinfo and winbindd + were written by Tim Potter.

        The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba + 3.0 was done by Alexander Bokovoy.

        diff --git a/docs/htmldocs/winbind.html b/docs/htmldocs/winbind.html index 1558512a61..8ba0047742 100644 --- a/docs/htmldocs/winbind.html +++ b/docs/htmldocs/winbind.html @@ -1,244 +1,74 @@ - -Unified Logons between Windows NT and UNIX using Winbind
        SAMBA Project Documentation
        PrevNext

        Chapter 15. Unified Logons between Windows NT and UNIX using Winbind

        15.1. Abstract

        Integration of UNIX and Microsoft Windows NT through - a unified logon has been considered a "holy grail" in heterogeneous +Chapter 21. Integrated Logon Support using Winbind

        Chapter 21. Integrated Logon Support using Winbind
        Prev Part III. Advanced Configuration Next

        Chapter 21. Integrated Logon Support using Winbind

        Tim Potter

        Samba Team

        Andrew Tridgell

        Samba Team

        Naag Mummaneni

        Jelmer R. Vernooij

        The Samba Team

        John H. Terpstra

        Samba Team

        27 June 2002

        Table of Contents

        Features and Benefits
        Introduction
        What Winbind Provides
        Target Uses
        How Winbind Works
        Microsoft Remote Procedure Calls
        Microsoft Active Directory Services
        Name Service Switch
        Pluggable Authentication Modules
        User and Group ID Allocation
        Result Caching
        Installation and Configuration
        Introduction
        Requirements
        Testing Things Out
        Conclusion
        Common Errors

        Features and Benefits

        Integration of UNIX and Microsoft Windows NT through + a unified logon has been considered a "holy grail" in heterogeneous computing environments for a long time. We present - winbind, a component of the Samba suite + winbind, a component of the Samba suite of programs as a solution to the unified logon problem. Winbind uses a UNIX implementation of Microsoft RPC calls, Pluggable Authentication Modules, and the Name Service Switch to allow Windows NT domain users to appear and operate as UNIX users on a UNIX machine. This paper describes the winbind system, explaining the functionality it provides, how it is configured, - and how it works internally.

        15.2. Introduction

        It is well known that UNIX and Microsoft Windows NT have + and how it works internally.

        Introduction

        It is well known that UNIX and Microsoft Windows NT have different models for representing user and group information and use different technologies for implementing them. This fact has made it difficult to integrate the two systems in a satisfactory - manner.

        One common solution in use today has been to create + manner.

        One common solution in use today has been to create identically named user accounts on both the UNIX and Windows systems and use the Samba suite of programs to provide file and print services between the two. This solution is far from perfect however, as adding and deleting users on both sets of machines becomes a chore and two sets of passwords are required both of which can lead to synchronization problems between the UNIX and Windows - systems and confusion for users.

        We divide the unified logon problem for UNIX machines into - three smaller problems:

        • Obtaining Windows NT user and group information -

        • Authenticating Windows NT users -

        • Password changing for Windows NT users -

        Ideally, a prospective solution to the unified logon problem + systems and confusion for users.

        We divide the unified logon problem for UNIX machines into + three smaller problems:

        • Obtaining Windows NT user and group information +

        • Authenticating Windows NT users +

        • Password changing for Windows NT users +

        Ideally, a prospective solution to the unified logon problem would satisfy all the above components without duplication of information on the UNIX machines and without creating additional tasks for the system administrator when maintaining users and groups on either system. The winbind system provides a simple and elegant solution to all three components of the unified logon - problem.

        15.3. What Winbind Provides

        Winbind unifies UNIX and Windows NT account management by + problem.

        What Winbind Provides

        Winbind unifies UNIX and Windows NT account management by allowing a UNIX box to become a full member of a NT domain. Once this is done the UNIX box will see NT users and groups as if they were native UNIX users and groups, allowing the NT domain to be used in much the same manner that NIS+ is used within - UNIX-only environments.

        The end result is that whenever any + UNIX-only environments.

        The end result is that whenever any program on the UNIX machine asks the operating system to lookup a user or group name, the query will be resolved by asking the NT domain controller for the specified domain to do the lookup. Because Winbind hooks into the operating system at a low level (via the NSS name resolution modules in the C library) this redirection to the NT domain controller is completely - transparent.

        Users on the UNIX machine can then use NT user and group - names as they would use "native" UNIX names. They can chown files + transparent.

        Users on the UNIX machine can then use NT user and group + names as they would use "native" UNIX names. They can chown files so that they are owned by NT domain users or even login to the - UNIX machine and run a UNIX X-Window session as a domain user.

        The only obvious indication that Winbind is being used is + UNIX machine and run a UNIX X-Window session as a domain user.

        The only obvious indication that Winbind is being used is that user and group names take the form DOMAIN\user and DOMAIN\group. This is necessary as it allows Winbind to determine that redirection to a domain controller is wanted for a particular - lookup and which trusted domain is being referenced.

        Additionally, Winbind provides an authentication service + lookup and which trusted domain is being referenced.

        Additionally, Winbind provides an authentication service that hooks into the Pluggable Authentication Modules (PAM) system to provide authentication via a NT domain to any PAM enabled applications. This capability solves the problem of synchronizing passwords between systems since all passwords are stored in a single - location (on the domain controller).

        15.3.1. Target Uses

        Winbind is targeted at organizations that have an + location (on the domain controller).

        Target Uses

        Winbind is targeted at organizations that have an existing NT based domain infrastructure into which they wish to put UNIX workstations or servers. Winbind will allow these organizations to deploy UNIX workstations without having to maintain a separate account infrastructure. This greatly simplifies the administrative overhead of deploying UNIX - workstations into a NT based organization.

        Another interesting way in which we expect Winbind to + workstations into a NT based organization.

        Another interesting way in which we expect Winbind to be used is as a central part of UNIX based appliances. Appliances that provide file and print services to Microsoft based networks will be able to use Winbind to provide seamless integration of - the appliance into the domain.

        How Winbind Works

        The winbind system is designed around a client/server + architecture. A long running winbindd daemon listens on a UNIX domain socket waiting for requests to arrive. These requests are generated by the NSS and PAM - clients and processed sequentially.

        The technologies used to implement winbind are described - in detail below.

        15.4.1. Microsoft Remote Procedure Calls

        Over the last two years, efforts have been underway + clients and processed sequentially.

        The technologies used to implement winbind are described + in detail below.

        Microsoft Remote Procedure Calls

        Over the last few years, efforts have been underway by various Samba Team members to decode various aspects of the Microsoft Remote Procedure Call (MSRPC) system. This system is used for most network related operations between @@ -246,23 +76,21 @@ NAME="AEN2258">15.4.1. Microsoft Remote Procedure Calls

        Winbind uses various MSRPC calls to enumerate domain users + can be used for other purposes.

        Winbind uses various MSRPC calls to enumerate domain users and groups and to obtain detailed information about individual users or groups. Other MSRPC calls can be used to authenticate NT domain users and to change user passwords. By directly querying a Windows PDC for user and group information, winbind maps the - NT account information onto UNIX user and group names.

        Microsoft Active Directory Services

        + Since late 2001, Samba has gained the ability to + interact with Microsoft Windows 2000 using its 'Native + Mode' protocols, rather than the NT4 RPC services. + Using LDAP and Kerberos, a domain member running + winbind can enumerate users and groups in exactly the + same way as a Win2k client would, and in so doing + provide a much more efficient and + effective winbind implementation. +

        Name Service Switch

        The Name Service Switch, or NSS, is a feature that is present in many UNIX operating systems. It allows system information such as hostnames, mail aliases and user information to be resolved from different sources. For example, a standalone @@ -270,9 +98,7 @@ NAME="AEN2262">15.4.2. Name Service Switch

        The NSS application programming interface allows winbind + for hostname information.

        The NSS application programming interface allows winbind to present itself as a source of system information when resolving UNIX usernames and groups. Winbind uses this interface, and information obtained from a Windows NT server using MSRPC @@ -280,67 +106,28 @@ NAME="AEN2262">15.4.2. Name Service Switch

        The primary control file for NSS is - /etc/nsswitch.conf. + users and groups.

        The primary control file for NSS is + /etc/nsswitch.conf. When a UNIX application makes a request to do a lookup - the C library looks in /etc/nsswitch.conf + the C library looks in /etc/nsswitch.conf for a line which matches the service type being requested, for - example the "passwd" service type is used when user or group names + example the "passwd" service type is used when user or group names are looked up. This config line species which implementations of that service should be tried and in what order. If the passwd - config line is:

        passwd: files example

        then the C library will first load a module called - /lib/libnss_files.so followed by - the module /lib/libnss_example.so. The + config line is:

        +passwd: files example
+

        then the C library will first load a module called + /lib/libnss_files.so followed by + the module /lib/libnss_example.so. The C library will dynamically load each of these modules in turn and call resolver functions within the modules to try to resolve the request. Once the request is resolved the C library returns the - result to the application.

        This NSS interface provides a very easy way for Winbind + result to the application.

        This NSS interface provides a very easy way for Winbind to hook into the operating system. All that needs to be done - is to put libnss_winbind.so in /lib/ - then add "winbind" into /etc/nsswitch.conf at + is to put libnss_winbind.so in /lib/ + then add "winbind" into /etc/nsswitch.conf at the appropriate place. The C library will then call Winbind to - resolve user and group names.

        Pluggable Authentication Modules

        Pluggable Authentication Modules, also known as PAM, is a system for abstracting authentication and authorization technologies. With a PAM module it is possible to specify different authentication methods for different system applications without @@ -348,46 +135,24 @@ NAME="AEN2278">15.4.3. Pluggable Authentication Modules

        Winbind uses the authentication management and password + a NIS database to log in over the network.

        Winbind uses the authentication management and password management PAM interface to integrate Windows NT users into a UNIX system. This allows Windows NT users to log in to a UNIX machine and be authenticated against a suitable Primary Domain Controller. These users can also change their passwords and have this change take effect directly on the Primary Domain Controller. -

        PAM is configured by providing control files in the directory - /etc/pam.d/ for each of the services that +

        PAM is configured by providing control files in the directory + /etc/pam.d/ for each of the services that require authentication. When an authentication request is made by an application the PAM code in the C library looks up this control file to determine what modules to load to do the authentication check and in what order. This interface makes adding a new authentication service for Winbind very easy, all that needs - to be done is that the pam_winbind.so module - is copied to /lib/security/ and the PAM + to be done is that the pam_winbind.so module + is copied to /lib/security/ and the PAM control files for relevant services are updated to allow authentication via winbind. See the PAM documentation - for more details.

        User and Group ID Allocation

        When a user or group is created under Windows NT is it allocated a numerical relative identifier (RID). This is slightly different to UNIX which has a range of numbers that are used to identify users, and the same range in which to identify @@ -398,20 +163,9 @@ NAME="AEN2286">15.4.4. User and Group ID Allocation

        The results of this mapping are stored persistently in + to UNIX user ids and group ids.

        The results of this mapping are stored persistently in an ID mapping database held in a tdb database). This ensures that - RIDs are mapped to UNIX IDs in a consistent way.

        Result Caching

        An active system can generate a lot of user and group name lookups. To reduce the network cost of these lookups winbind uses a caching scheme based on the SAM sequence number supplied by NT domain controllers. User or group information returned @@ -422,1182 +176,557 @@ NAME="AEN2290">15.4.5. Result Caching

        15.5. Installation and Configuration

        Many thanks to John Trostel jtrostel@snapserver.com -for providing the HOWTO for this section.

        This HOWTO describes how to get winbind services up and running + from the PDC.

        Installation and Configuration

        +Many thanks to John Trostel jtrostel@snapserver.com +for providing the HOWTO for this section. +

        +This HOWTO describes how to get winbind services up and running to control access and authenticate users on your Linux box using -the winbind services which come with SAMBA 2.2.2.

        There is also some Solaris specific information in -docs/textdocs/Solaris-Winbind-HOWTO.txt. -Future revisions of this document will incorporate that -information.

        15.5.1. Introduction

        This HOWTO describes the procedures used to get winbind up and -running on my RedHat 7.1 system. Winbind is capable of providing access +the winbind services which come with SAMBA 3.0. +

        Introduction

        +This section describes the procedures used to get winbind up and +running on a RedHat 7.1 system. Winbind is capable of providing access and authentication control for Windows Domain users through an NT or Win2K PDC for 'regular' services, such as telnet a nd ftp, as -well for SAMBA services.

        This HOWTO has been written from a 'RedHat-centric' perspective, so if +well for SAMBA services. +

        +This HOWTO has been written from a 'RedHat-centric' perspective, so if you are using another distribution, you may have to modify the instructions -somewhat to fit the way your distribution works.

        Requirements

        +If you have a samba configuration file that you are currently +using... BACK IT UP! If your system already uses PAM, +back up the /etc/pam.d directory +contents! If you haven't already made a boot disk, +MAKE ONE NOW! +

        +Messing with the pam configuration files can make it nearly impossible to log in to yourmachine. That's why you want to be able to boot back into your machine in single user mode and restore your -/etc/pam.d back to the original state they were in if -you get frustrated with the way things are going. ;-)

        The latest version of SAMBA (version 3.0 as of this writing), now +/etc/pam.d back to the original state they were in if +you get frustrated with the way things are going. ;-) +

        +The latest version of SAMBA (version 3.0 as of this writing), now includes a functioning winbindd daemon. Please refer to the -main SAMBA web page or, +main SAMBA web page or, better yet, your closest SAMBA mirror site for instructions on -downloading the source code.

        To allow Domain users the ability to access SAMBA shares and +downloading the source code. +

        +To allow Domain users the ability to access SAMBA shares and files, as well as potentially other services provided by your SAMBA machine, PAM (pluggable authentication modules) must be setup properly on your machine. In order to compile the winbind modules, you should have at least the pam libraries resident on your system. For recent RedHat systems (7.1, for instance), that -means pam-0.74-22. For best results, it is helpful to also -install the development packages in pam-devel-0.74-22.

        Testing Things Out

        +Before starting, it is probably best to kill off all the SAMBA +related daemons running on your server. Kill off all smbd, +nmbd, and winbindd processes that may be running. To use PAM, you will want to make sure that you have the -standard PAM package (for RedHat) which supplies the /etc/pam.d +standard PAM package (for RedHat) which supplies the /etc/pam.d directory structure, including the pam modules are used by pam-aware -services, several pam libraries, and the /usr/doc -and /usr/man entries for pam. Winbind built better +services, several pam libraries, and the /usr/doc +and /usr/man entries for pam. Winbind built better in SAMBA if the pam-devel package was also installed. This package includes -the header files needed to compile pam-aware applications. For instance, -my RedHat system has both pam-0.74-22 and -pam-devel-0.74-22 RPMs installed.

        15.5.3.1. Configure and compile SAMBA

        The configuration and compilation of SAMBA is pretty straightforward. +the header files needed to compile pam-aware applications. +

        Configure and compile SAMBA

        +The configuration and compilation of SAMBA is pretty straightforward. The first three steps may not be necessary depending upon -whether or not you have previously built the Samba binaries.

        root# autoconf
-root# make clean
-root# rm config.cache
-root# ./configure --with-winbind
-root# make
-root# make install

        This will, by default, install SAMBA in /usr/local/samba. +whether or not you have previously built the Samba binaries. +

        +root# autoconf
+root# make clean
+root# rm config.cache
+root# ./configure
+root# make
+root# make install
+

        +This will, by default, install SAMBA in /usr/local/samba. See the main SAMBA documentation if you want to install SAMBA somewhere else. -It will also build the winbindd executable and libraries.

        15.5.3.2. Configure nsswitch.conf and the -winbind libraries

        The libraries needed to run the winbindd daemon -through nsswitch need to be copied to their proper locations, so

        root# cp ../samba/source/nsswitch/libnss_winbind.so /lib

        I also found it necessary to make the following symbolic link:

        root# ln -s /lib/libnss_winbind.so /lib/libnss_winbind.so.2

        And, in the case of Sun solaris:

        root# ln -s /usr/lib/libnss_winbind.so /usr/lib/libnss_winbind.so.1 -root# ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.1 -root# ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.2

        Now, as root you need to edit /etc/nsswitch.conf to -allow user and group entries to be visible from the winbindd -daemon. My /etc/nsswitch.conf file look like -this after editing:

        	passwd:     files winbind
+It will also build the winbindd executable and libraries. 
+

        Configure nsswitch.conf and the +winbind libraries on Linux and Solaris

        +The libraries needed to run the winbindd daemon +through nsswitch need to be copied to their proper locations, so +

        +

        +root# cp ../samba/source/nsswitch/libnss_winbind.so /lib
+

        +

        +I also found it necessary to make the following symbolic link: +

        +root# ln -s /lib/libnss_winbind.so /lib/libnss_winbind.so.2 +

        And, in the case of Sun solaris:

        +root# ln -s /usr/lib/libnss_winbind.so /usr/lib/libnss_winbind.so.1
+root# ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.1
+root# ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.2
+

        +Now, as root you need to edit /etc/nsswitch.conf to +allow user and group entries to be visible from the winbindd +daemon. My /etc/nsswitch.conf file look like +this after editing: +

        +	passwd:     files winbind
 	shadow:     files 
-	group:      files winbind

        + group: files winbind +

        The libraries needed by the winbind daemon will be automatically -entered into the ldconfig cache the next time +entered into the ldconfig cache the next time your system reboots, but it -is faster (and you don't need to reboot) if you do it manually:

        root# /sbin/ldconfig -v | grep winbind

        This makes libnss_winbind available to winbindd -and echos back a check to you.

        15.5.3.3. Configure smb.conf

        Several parameters are needed in the smb.conf file to control -the behavior of winbindd. Configure -smb.conf These are described in more detail in -the winbindd(8) man page. My -smb.conf file was modified to -include the following entries in the [global] section:

        [global]
-     <...>
+is faster (and you don't need to reboot) if you do it manually:
+
        
+root# /sbin/ldconfig -v | grep winbind
+
        
+This makes libnss_winbind available to winbindd 
+and echos back a check to you.
+

        NSS Winbind on AIX

        (This section is only for those running AIX)

        +The winbind AIX identification module gets built as libnss_winbind.so in the +nsswitch directory of the samba source. This file can be copied to +/usr/lib/security, and the AIX naming convention would indicate that it +should be named WINBIND. A stanza like the following: +

        +WINBIND:
+        program = /usr/lib/security/WINBIND
+        options = authonly
+

        can then be added to +/usr/lib/security/methods.cfg. This module only +supports identification, but there have been success reports using the +standard winbind pam module for authentication. Use caution configuring +loadable authentication modules as it is possible to make it impossible +to logon to the system. More information about the AIX authentication +module API can be found at "Kernel Extensions and Device Support +Programming Concepts for AIX": +Chapter 18. Loadable Authentication Module Programming Interface +and more information on administering the modules at +"System Management Guide: Operating System and Devices". +

        Configure smb.conf

        +Several parameters are needed in the smb.conf file to control +the behavior of winbindd. Configure +smb.conf These are described in more detail in +the winbindd(8) man page. My +smb.conf file was modified to +include the following entries in the [global] section: +

        +[global]
+     <...>
      # separate domain and username with '+', like DOMAIN+username
-     winbind separator = +
+     winbind separator = +
      # use uids from 10000 to 20000 for domain users
-     winbind uid = 10000-20000
+     winbind uid = 10000-20000
      # use gids from 10000 to 20000 for domain groups
-     winbind gid = 10000-20000
+     winbind gid = 10000-20000
      # allow enumeration of winbind users and groups
-     winbind enum users = yes
-     winbind enum groups = yes
+     winbind enum users = yes
+     winbind enum groups = yes
      # give winbind users a real shell (only needed if they have telnet access)
-     template homedir = /home/winnt/%D/%U
-     template shell = /bin/bash

        Join the SAMBA server to the PDC domain

        +Enter the following command to make the SAMBA server join the +PDC domain, where DOMAIN is the name of +your Windows domain and Administrator is +a domain user who has administrative privileges in the domain. +

        +root# /usr/local/samba/bin/net join -S PDC -U Administrator +

        +The proper response to the command should be: "Joined the domain +DOMAIN" where DOMAIN +is your DOMAIN name. +

        Start up the winbindd daemon and test it!

        +Eventually, you will want to modify your smb startup script to automatically invoke the winbindd daemon when the other parts of SAMBA start, but it is possible to test out just the winbind portion first. To start up winbind services, enter the following -command as root:

        root# /usr/local/samba/bin/winbindd

        I'm always paranoid and like to make sure the daemon -is really running...

        root# ps -ae | grep winbindd

        This command should produce output like this, if the daemon is running

        3025 ? 00:00:00 winbindd

        Now... for the real test, try to get some information about the -users on your PDC

        root# /usr/local/samba/bin/wbinfo -u

        +command as root: +

        +root# /usr/local/samba/bin/winbindd +

        +Winbindd can now also run in 'dual daemon mode'. This will make it +run as 2 processes. The first will answer all requests from the cache, +thus making responses to clients faster. The other will +update the cache for the query that the first has just responded. +Advantage of this is that responses stay accurate and are faster. +You can enable dual daemon mode by adding -B to the commandline: +

        +root# /usr/local/samba/bin/winbindd -B +

        +I'm always paranoid and like to make sure the daemon +is really running... +

        +root# ps -ae | grep winbindd +

        +This command should produce output like this, if the daemon is running +

        +3025 ?        00:00:00 winbindd
+

        +Now... for the real test, try to get some information about the +users on your PDC +

        +root# /usr/local/samba/bin/wbinfo -u +

        This should echo back a list of users on your Windows users on -your PDC. For example, I get the following response:

        CEO+Administrator
-CEO+burdell
-CEO+Guest
-CEO+jt-ad
-CEO+krbtgt
-CEO+TsInternetUser

        Obviously, I have named my domain 'CEO' and my winbind -separator is '+'.

        You can do the same sort of thing to get group information from -the PDC:

        root# /usr/local/samba/bin/wbinfo -g
-CEO+Domain Admins
-CEO+Domain Users
-CEO+Domain Guests
-CEO+Domain Computers
-CEO+Domain Controllers
-CEO+Cert Publishers
-CEO+Schema Admins
-CEO+Enterprise Admins
-CEO+Group Policy Creator Owners

        The function 'getent' can now be used to get unified +your PDC. For example, I get the following response: +

        +	CEO+Administrator
+	CEO+burdell
+	CEO+Guest
+	CEO+jt-ad
+	CEO+krbtgt
+	CEO+TsInternetUser
+

        +Obviously, I have named my domain 'CEO' and my winbind +separator is '+'. +

        +You can do the same sort of thing to get group information from +the PDC: +

        +root# /usr/local/samba/bin/wbinfo -g
+	CEO+Domain Admins
+	CEO+Domain Users
+	CEO+Domain Guests
+	CEO+Domain Computers
+	CEO+Domain Controllers
+	CEO+Cert Publishers
+	CEO+Schema Admins
+	CEO+Enterprise Admins
+	CEO+Group Policy Creator Owners
+

        +The function 'getent' can now be used to get unified lists of both local and PDC users and groups. -Try the following command:

        root# getent passwd

        You should get a list that looks like your /etc/passwd +Try the following command: +

        +root# getent passwd +

        +You should get a list that looks like your /etc/passwd list followed by the domain users with their new uids, gids, home -directories and default shells.

        The same thing can be done for groups with the command

        root# getent group

        15.5.3.6. Fix the init.d startup scripts

        Fix the init.d startup scripts

        Linux

        +The winbindd daemon needs to start up after the +smbd and nmbd daemons are running. +To accomplish this task, you need to modify the startup scripts of your system. +They are located at /etc/init.d/smb in RedHat and +/etc/init.d/samba in Debian. script to add commands to invoke this daemon in the proper sequence. My -startup script starts up smbd, -nmbd, and winbindd from the -/usr/local/samba/bin directory directly. The 'start' -function in the script looks like this:

        start() {
-        KIND="SMB"
-        echo -n $"Starting $KIND services: "
+startup script starts up smbd, nmbd, and winbindd from the 
+/usr/local/samba/bin directory directly.  The 'start' 
+function in the script looks like this:
+
        +start() {
+        KIND="SMB"
+        echo -n $"Starting $KIND services: "
         daemon /usr/local/samba/bin/smbd $SMBDOPTIONS
         RETVAL=$?
         echo
-        KIND="NMB"
-        echo -n $"Starting $KIND services: "
+        KIND="NMB"
+        echo -n $"Starting $KIND services: "
         daemon /usr/local/samba/bin/nmbd $NMBDOPTIONS
         RETVAL2=$?
         echo
-        KIND="Winbind"
-        echo -n $"Starting $KIND services: "
+        KIND="Winbind"
+        echo -n $"Starting $KIND services: "
         daemon /usr/local/samba/bin/winbindd
         RETVAL3=$?
         echo
-        [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && touch /var/lock/subsys/smb || \
-           RETVAL=1
+        [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \
+		touch /var/lock/subsys/smb || RETVAL=1
         return $RETVAL
-}
        The 'stop' function has a corresponding entry to shut down the 
-services and look s like this:
        stop() {
-        KIND="SMB"
-        echo -n $"Shutting down $KIND services: "
+}
+
        If you would like to run winbindd in dual daemon mode, replace 
+the line 
+
        +        daemon /usr/local/samba/bin/winbindd
+
        
+
+in the example above with:
+
+
        +        daemon /usr/local/samba/bin/winbindd -B
+
        .
+
        
+The 'stop' function has a corresponding entry to shut down the 
+services and looks like this:
+
        +stop() {
+        KIND="SMB"
+        echo -n $"Shutting down $KIND services: "
         killproc smbd
         RETVAL=$?
         echo
-        KIND="NMB"
-        echo -n $"Shutting down $KIND services: "
+        KIND="NMB"
+        echo -n $"Shutting down $KIND services: "
         killproc nmbd
         RETVAL2=$?
         echo
-        KIND="Winbind"
-        echo -n $"Shutting down $KIND services: "
+        KIND="Winbind"
+        echo -n $"Shutting down $KIND services: "
         killproc winbindd
         RETVAL3=$?
-        [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && rm -f /var/lock/subsys/smb
-        echo ""
+        [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \
+		 rm -f /var/lock/subsys/smb
+        echo ""
         return $RETVAL
-}
        Solaris

        Winbind doesn't work on solaris 9, see the Portability chapter for details.

        On solaris, you need to modify the +/etc/init.d/samba.server startup script. It usually only starts smbd and nmbd but should now start winbindd too. If you -have samba installed in /usr/local/samba/bin, -the file could contains something like this:

        ##
-## samba.server
-##
+have samba installed in /usr/local/samba/bin, 
+the file could contains something like this:
+
        +	##
+	## samba.server
+	##
 
-if [ ! -d /usr/bin ]
-then                    # /usr not mounted
-        exit
-fi
+	if [ ! -d /usr/bin ]
+	then                    # /usr not mounted
+		exit
+	fi
 
-killproc() {            # kill the named process(es)
-        pid=`/usr/bin/ps -e |
-             /usr/bin/grep -w $1 |
-             /usr/bin/sed -e 's/^  *//' -e 's/ .*//'`
-        [ "$pid" != "" ] && kill $pid
-}
- 
-# Start/stop processes required for samba server
+	killproc() {            # kill the named process(es)
+		pid=`/usr/bin/ps -e |
+		     /usr/bin/grep -w $1 |
+		     /usr/bin/sed -e 's/^  *//' -e 's/ .*//'`
+		[ "$pid" != "" ] && kill $pid
+	}
+	 
+	# Start/stop processes required for samba server
+
+	case "$1" in
+
+	'start')
+	#
+	# Edit these lines to suit your installation (paths, workgroup, host)
+	#
+	echo Starting SMBD
+	   /usr/local/samba/bin/smbd -D -s \
+		/usr/local/samba/smb.conf
 
-case "$1" in
+	echo Starting NMBD
+	   /usr/local/samba/bin/nmbd -D -l \
+		/usr/local/samba/var/log -s /usr/local/samba/smb.conf
 
-'start')
-#
-# Edit these lines to suit your installation (paths, workgroup, host)
-#
-echo Starting SMBD
-   /usr/local/samba/bin/smbd -D -s \
-	/usr/local/samba/smb.conf
+	echo Starting Winbind Daemon
+	   /usr/local/samba/bin/winbindd
+	   ;;
 
-echo Starting NMBD
-   /usr/local/samba/bin/nmbd -D -l \
-	/usr/local/samba/var/log -s /usr/local/samba/smb.conf
+	'stop')
+	   killproc nmbd
+	   killproc smbd
+	   killproc winbindd
+	   ;;
 
-echo Starting Winbind Daemon
-   /usr/local/samba/bin/winbindd
-   ;;
+	*)
+	   echo "Usage: /etc/init.d/samba.server { start | stop }"
+	   ;;
+	esac
+
        
+Again, if you would like to run samba in dual daemon mode, replace 
+
        +	/usr/local/samba/bin/winbindd
+
        
 
-'stop')
-   killproc nmbd
-   killproc smbd
-   killproc winbindd
-   ;;
+in the script above with:
 
-*)
-   echo "Usage: /etc/init.d/samba.server { start | stop }"
-   ;;
-esac

        Restarting

        +If you restart the smbd, nmbd, and winbindd daemons at this point, you should be able to connect to the samba server as a domain member just as -if you were a local user.

        Configure Winbind and PAM

        +If you have made it this far, you know that winbindd and samba are working together. If you want to use winbind to provide authentication for other services, keep reading. The pam configuration files need to be altered in this step. (Did you remember to make backups of your original -/etc/pam.d files? If not, do it now.)

        You will need a pam module to use winbindd with these other services. This -module will be compiled in the ../source/nsswitch directory -by invoking the command

        root# make nsswitch/pam_winbind.so

        from the ../source directory. The -pam_winbind.so file should be copied to the location of +/etc/pam.d files? If not, do it now.) +

        +You will need a pam module to use winbindd with these other services. This +module will be compiled in the ../source/nsswitch directory +by invoking the command +

        +root# make nsswitch/pam_winbind.so +

        +from the ../source directory. The +pam_winbind.so file should be copied to the location of your other pam security modules. On my RedHat system, this was the -/lib/security directory. On Solaris, the pam security -modules reside in /usr/lib/security.

        root# cp ../samba/source/nsswitch/pam_winbind.so /lib/security

        15.5.3.7.1. Linux/FreeBSD-specific PAM configuration

        The /etc/pam.d/samba file does not need to be changed. I -just left this fileas it was:

        auth    required        /lib/security/pam_stack.so service=system-auth
-account required        /lib/security/pam_stack.so service=system-auth

        The other services that I modified to allow the use of winbind +/lib/security directory. On Solaris, the pam security +modules reside in /usr/lib/security. +

        +root# cp ../samba/source/nsswitch/pam_winbind.so /lib/security +

        Linux/FreeBSD-specific PAM configuration

        +The /etc/pam.d/samba file does not need to be changed. I +just left this fileas it was: +

        +	auth    required        /lib/security/pam_stack.so service=system-auth
+	account required        /lib/security/pam_stack.so service=system-auth
+

        +The other services that I modified to allow the use of winbind as an authentication service were the normal login on the console (or a terminal session), telnet logins, and ftp service. In order to enable these services, you may first need to change the entries in -/etc/xinetd.d (or /etc/inetd.conf). +/etc/xinetd.d (or /etc/inetd.conf). RedHat 7.1 uses the new xinetd.d structure, in this case you need -to change the lines in /etc/xinetd.d/telnet -and /etc/xinetd.d/wu-ftp from 

        enable = no

        to

        enable = yes

        +to change the lines in /etc/xinetd.d/telnet +and /etc/xinetd.d/wu-ftp from +

        +	enable = no
+

        +to +

        +	enable = yes
+

        For ftp services to work properly, you will also need to either have individual directories for the domain users already present on the server, or change the home directory template to a general directory for all domain users. These can be easily set using -the smb.conf global entry -template homedir.

        The /etc/pam.d/ftp file can be changed +the smb.conf global entry +template homedir. +

        +The /etc/pam.d/ftp file can be changed to allow winbind ftp access in a manner similar to the -samba file. My /etc/pam.d/ftp file was -changed to look like this:

        auth       required     /lib/security/pam_listfile.so item=user sense=deny file=/etc/ftpusers onerr=succeed
-auth       sufficient   /lib/security/pam_winbind.so
-auth       required     /lib/security/pam_stack.so service=system-auth
-auth       required     /lib/security/pam_shells.so
-account    sufficient   /lib/security/pam_winbind.so
-account    required     /lib/security/pam_stack.so service=system-auth
-session    required     /lib/security/pam_stack.so service=system-auth

        The /etc/pam.d/login file can be changed nearly the -same way. It now looks like this:

        auth       required     /lib/security/pam_securetty.so
-auth       sufficient   /lib/security/pam_winbind.so
-auth       sufficient   /lib/security/pam_unix.so use_first_pass
-auth       required     /lib/security/pam_stack.so service=system-auth
-auth       required     /lib/security/pam_nologin.so
-account    sufficient   /lib/security/pam_winbind.so
-account    required     /lib/security/pam_stack.so service=system-auth
-password   required     /lib/security/pam_stack.so service=system-auth
-session    required     /lib/security/pam_stack.so service=system-auth
-session    optional     /lib/security/pam_console.so

        In this case, I added the auth sufficient /lib/security/pam_winbind.so -lines as before, but also added the required pam_securetty.so +samba file. My /etc/pam.d/ftp file was +changed to look like this: +

        +	auth       required     /lib/security/pam_listfile.so item=user sense=deny \
+		 file=/etc/ftpusers onerr=succeed
+	auth       sufficient   /lib/security/pam_winbind.so
+	auth       required     /lib/security/pam_stack.so service=system-auth
+	auth       required     /lib/security/pam_shells.so
+	account    sufficient   /lib/security/pam_winbind.so
+	account    required     /lib/security/pam_stack.so service=system-auth
+	session    required     /lib/security/pam_stack.so service=system-auth
+

        +The /etc/pam.d/login file can be changed nearly the +same way. It now looks like this: +

        +	auth       required     /lib/security/pam_securetty.so
+	auth       sufficient   /lib/security/pam_winbind.so
+	auth       sufficient   /lib/security/pam_unix.so use_first_pass
+	auth       required     /lib/security/pam_stack.so service=system-auth
+	auth       required     /lib/security/pam_nologin.so
+	account    sufficient   /lib/security/pam_winbind.so
+	account    required     /lib/security/pam_stack.so service=system-auth
+	password   required     /lib/security/pam_stack.so service=system-auth
+	session    required     /lib/security/pam_stack.so service=system-auth
+	session    optional     /lib/security/pam_console.so
+

        +In this case, I added the 

        auth sufficient /lib/security/pam_winbind.so

        +lines as before, but also added the 

        required pam_securetty.so

        above it, to disallow root logins over the network. I also added a -sufficient /lib/security/pam_unix.so use_first_pass -line after the winbind.so line to get rid of annoying -double prompts for passwords.

        Solaris-specific configuration

        +The /etc/pam.conf needs to be changed. I changed this file so that my Domain users can logon both locally as well as telnet.The following are the changes that I made.You can customize the pam.conf file as per your requirements,but be sure of those changes because in the worst case it will leave your system -nearly impossible to boot.

        #
-#ident	"@(#)pam.conf	1.14	99/09/16 SMI"
-#
-# Copyright (c) 1996-1999, Sun Microsystems, Inc.
-# All Rights Reserved.
-#
-# PAM configuration
-#
-# Authentication management
-#
-login   auth required   /usr/lib/security/pam_winbind.so
-login	auth required 	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass 
-login	auth required 	/usr/lib/security/$ISA/pam_dial_auth.so.1 try_first_pass 
-#
-rlogin  auth sufficient /usr/lib/security/pam_winbind.so
-rlogin  auth sufficient /usr/lib/security/$ISA/pam_rhosts_auth.so.1
-rlogin	auth required 	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
-#
-dtlogin auth sufficient /usr/lib/security/pam_winbind.so
-dtlogin	auth required 	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
-#
-rsh	auth required	/usr/lib/security/$ISA/pam_rhosts_auth.so.1
-other   auth sufficient /usr/lib/security/pam_winbind.so
-other	auth required	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
-#
-# Account management
-#
-login   account sufficient      /usr/lib/security/pam_winbind.so
-login	account requisite	/usr/lib/security/$ISA/pam_roles.so.1 
-login	account required	/usr/lib/security/$ISA/pam_unix.so.1 
-#
-dtlogin account sufficient      /usr/lib/security/pam_winbind.so
-dtlogin	account requisite	/usr/lib/security/$ISA/pam_roles.so.1 
-dtlogin	account required	/usr/lib/security/$ISA/pam_unix.so.1 
-#
-other   account sufficient      /usr/lib/security/pam_winbind.so
-other	account requisite	/usr/lib/security/$ISA/pam_roles.so.1 
-other	account required	/usr/lib/security/$ISA/pam_unix.so.1 
-#
-# Session management
-#
-other	session required	/usr/lib/security/$ISA/pam_unix.so.1 
-#
-# Password management
-#
-#other   password sufficient     /usr/lib/security/pam_winbind.so
-other	password required	/usr/lib/security/$ISA/pam_unix.so.1 
-dtsession auth required	/usr/lib/security/$ISA/pam_unix.so.1
-#
-# Support for Kerberos V5 authentication (uncomment to use Kerberos)
-#
-#rlogin	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
-#login	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
-#dtlogin	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
-#other	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
-#dtlogin	account optional /usr/lib/security/$ISA/pam_krb5.so.1
-#other	account optional /usr/lib/security/$ISA/pam_krb5.so.1
-#other	session optional /usr/lib/security/$ISA/pam_krb5.so.1
-#other	password optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass

        I also added a try_first_pass line after the winbind.so line to get rid of -annoying double prompts for passwords.

        Now restart your Samba & try connecting through your application that you -configured in the pam.conf.

        15.6. Limitations

        Winbind has a number of limitations in its current +nearly impossible to boot. +

        +	#
+	#ident	"@(#)pam.conf	1.14	99/09/16 SMI"
+	#
+	# Copyright (c) 1996-1999, Sun Microsystems, Inc.
+	# All Rights Reserved.
+	#
+	# PAM configuration
+	#
+	# Authentication management
+	#
+	login   auth required   /usr/lib/security/pam_winbind.so
+	login	auth required 	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass 
+	login	auth required 	/usr/lib/security/$ISA/pam_dial_auth.so.1 try_first_pass 
+	#
+	rlogin  auth sufficient /usr/lib/security/pam_winbind.so
+	rlogin  auth sufficient /usr/lib/security/$ISA/pam_rhosts_auth.so.1
+	rlogin	auth required 	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
+	#
+	dtlogin auth sufficient /usr/lib/security/pam_winbind.so
+	dtlogin	auth required 	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
+	#
+	rsh	auth required	/usr/lib/security/$ISA/pam_rhosts_auth.so.1
+	other   auth sufficient /usr/lib/security/pam_winbind.so
+	other	auth required	/usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
+	#
+	# Account management
+	#
+	login   account sufficient      /usr/lib/security/pam_winbind.so
+	login	account requisite	/usr/lib/security/$ISA/pam_roles.so.1 
+	login	account required	/usr/lib/security/$ISA/pam_unix.so.1 
+	#
+	dtlogin account sufficient      /usr/lib/security/pam_winbind.so
+	dtlogin	account requisite	/usr/lib/security/$ISA/pam_roles.so.1 
+	dtlogin	account required	/usr/lib/security/$ISA/pam_unix.so.1 
+	#
+	other   account sufficient      /usr/lib/security/pam_winbind.so
+	other	account requisite	/usr/lib/security/$ISA/pam_roles.so.1 
+	other	account required	/usr/lib/security/$ISA/pam_unix.so.1 
+	#
+	# Session management
+	#
+	other	session required	/usr/lib/security/$ISA/pam_unix.so.1 
+	#
+	# Password management
+	#
+	#other   password sufficient     /usr/lib/security/pam_winbind.so
+	other	password required	/usr/lib/security/$ISA/pam_unix.so.1 
+	dtsession auth required	/usr/lib/security/$ISA/pam_unix.so.1
+	#
+	# Support for Kerberos V5 authentication (uncomment to use Kerberos)
+	#
+	#rlogin	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
+	#login	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
+	#dtlogin	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
+	#other	auth optional	/usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
+	#dtlogin	account optional /usr/lib/security/$ISA/pam_krb5.so.1
+	#other	account optional /usr/lib/security/$ISA/pam_krb5.so.1
+	#other	session optional /usr/lib/security/$ISA/pam_krb5.so.1
+	#other	password optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
+

        +I also added a try_first_pass line after the winbind.so line to get rid of +annoying double prompts for passwords. +

        +Now restart your Samba and try connecting through your application that you +configured in the pam.conf. +

        Conclusion

        The winbind system, through the use of the Name Service + Switch, Pluggable Authentication Modules, and appropriate + Microsoft RPC calls have allowed us to provide seamless + integration of Microsoft Windows NT domain users on a + UNIX system. The result is a great reduction in the administrative + cost of running a mixed UNIX and NT network.

        Common Errors

        Winbind has a number of limitations in its current released version that we hope to overcome in future - releases:

        PrevHomeNext
        Printing SupportUpPassdb MySQL plugin
        \ No newline at end of file + that may be been set for Windows NT users, this is + instead up to the PDC to enforce.

        Prev Up Next
        Chapter 20. Stackable VFS modules Home Chapter 22. Advanced Network Manangement
        diff --git a/docs/htmldocs/winbindd.8.html b/docs/htmldocs/winbindd.8.html index fb8c9c0458..c1a64d6a00 100644 --- a/docs/htmldocs/winbindd.8.html +++ b/docs/htmldocs/winbindd.8.html @@ -1,644 +1,153 @@ - -winbindd

        winbindd

        Name

        winbindd -- Name Service Switch daemon for resolving names - from NT servers

        Synopsis

        winbindd [-F] [-S] [-i] [-B] [-d <debug level>] [-s <smb config file>] [-n]

        DESCRIPTION

        This program is part of the Samba suite.

        winbindd is a daemon that provides +winbindd

        Name

        winbindd — Name Service Switch daemon for resolving names + from NT servers

        Synopsis

        winbindd [-F] [-S] [-i] [-B] [-d <debug level>] [-s <smb config file>] [-n]

        DESCRIPTION

        This program is part of the Samba(7) suite.

        winbindd is a daemon that provides a service for the Name Service Switch capability that is present in most modern C libraries. The Name Service Switch allows user and system information to be obtained from different databases services such as NIS or DNS. The exact behaviour can be configured - throught the /etc/nsswitch.conf file. + throught the /etc/nsswitch.conf file. Users and groups are allocated as they are resolved to a range of user and group ids specified by the administrator of the - Samba system.

        The service provided by winbindd is called `winbind' and + Samba system.

        The service provided by winbindd is called `winbind' and can be used to resolve user and group information from a Windows NT server. The service can also provide authentication - services via an associated PAM module.

        The pam_winbind module in the 2.2.2 release only - supports the auth and account + services via an associated PAM module.

        + The pam_winbind module in the 2.2.2 release only + supports the auth and account module-types. The latter simply performs a getpwnam() to verify that the system can obtain a uid for the - user. If the libnss_winbind library has been correctly + user. If the libnss_winbind library has been correctly installed, this should always succeed. -

        The following nsswitch databases are implemented by - the winbindd service:

        hosts

        User information traditionally stored in - the hosts(5) file and used by - gethostbyname(3) functions. Names are +

        The following nsswitch databases are implemented by + the winbindd service:

        hosts

        User information traditionally stored in + the hosts(5) file and used by + gethostbyname(3) functions. Names are resolved through the WINS server or by broadcast. -

        passwd

        User information traditionally stored in - the passwd(5) file and used by - getpwent(3) functions.

        group

        Group information traditionally stored in - the group(5) file and used by - getgrent(3) functions.

        For example, the following simple configuration in the - /etc/nsswitch.conf file can be used to initially - resolve user and group information from /etc/passwd - and /etc/group and then from the - Windows NT server. 

        passwd:         files winbind
+		
        passwd
        User information traditionally stored in 
+		the passwd(5) file and used by 
+		getpwent(3) functions. 
        group
        Group information traditionally stored in 
+		the group(5) file and used by 		
+		getgrent(3) functions. 
        For example, the following simple configuration in the
+	/etc/nsswitch.conf file can be used to initially 
+	resolve user and group information from /etc/passwd
+	 and /etc/group and then from the 
+	Windows NT server.
+
        +passwd:         files winbind
 group:          files winbind
-

        The following simple configuration in the - /etc/nsswitch.conf file can be used to initially - resolve hostnames from /etc/hosts and then from the - WINS server.

        OPTIONS

        -F

        If specified, this parameter causes - the main winbindd process to not daemonize, +

        The following simple configuration in the + /etc/nsswitch.conf file can be used to initially + resolve hostnames from /etc/hosts and then from the + WINS server.

        OPTIONS

        -F

        If specified, this parameter causes + the main winbindd process to not daemonize, i.e. double-fork and disassociate with the terminal. Child processes are still created as normal to service each connection request, but the main process does not exit. This operation mode is suitable for running - winbindd under process supervisors such - as supervise and svscan - from Daniel J. Bernstein's daemontools + winbindd under process supervisors such + as supervise and svscan + from Daniel J. Bernstein's daemontools package, or the AIX process monitor. -

        -S

        If specified, this parameter causes - winbindd to log to standard output rather - than a file.

        -d debuglevel

        Sets the debuglevel to an integer between - 0 and 100. 0 is for no debugging and 100 is for reams and - reams. To submit a bug report to the Samba Team, use debug - level 100 (see BUGS.txt).

        -i

        Tells winbindd to not +

        -S

        If specified, this parameter causes + winbindd to log to standard output rather + than a file.

        -V

        Prints the version number for +smbd.

        -s <configuration file>

        The file specified contains the +configuration details required by the server. The +information in this file includes server-specific +information such as what printcap file to use, as well +as descriptions of all the services that the server is +to provide. See +smb.conf(5) for more information. +The default configuration file name is determined at +compile time.

        -d|--debug=debuglevel

        debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero.

        The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of +information about operations carried out.

        Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.

        Note that specifying this parameter here will +override the log +level parameter in the +smb.conf(5) file.

        -l|--logfile=logbasename

        File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. +

        -h|--help

        Print a summary of command line options. +

        -i

        Tells winbindd to not become a daemon and detach from the current terminal. This option is used by developers when interactive debugging - of winbindd is required. - winbindd also logs to standard output, - as if the -S parameter had been given. -

        -n

        Disable caching. This means winbindd will + of winbindd is required. + winbindd also logs to standard output, + as if the -S parameter had been given. +

        -n

        Disable caching. This means winbindd will always have to wait for a response from the domain controller before it can respond to a client and this thus makes things slower. The results will however be more accurate, since results from the cache might not be up-to-date. This might also temporarily hang winbindd if the DC doesn't respond. -

        -B

        Dual daemon mode. This means winbindd will run +

        -B

        Dual daemon mode. This means winbindd will run as 2 threads. The first will answer all requests from the cache, thus making responses to clients faster. The other will update the cache for the query that the first has just responded. - Advantage of this is that responses are accurate and fast. -

        -s|--conf=smb.conf

        Specifies the location of the all-important - smb.conf file.

        NAME AND ID RESOLUTION

        Users and groups on a Windows NT server are assigned + Advantage of this is that responses stay accurate and are faster. +

        NAME AND ID RESOLUTION

        Users and groups on a Windows NT server are assigned a relative id (rid) which is unique for the domain when the user or group is created. To convert the Windows NT user or group into a unix user or group, a mapping between rids and unix user - and group ids is required. This is one of the jobs that winbindd performs.

        As winbindd users and groups are resolved from a server, user + and group ids is required. This is one of the jobs that + winbindd performs.

        As winbindd users and groups are resolved from a server, user and group ids are allocated from a specified range. This is done on a first come, first served basis, although all existing users and groups will be mapped as soon as a client performs a user or group enumeration command. The allocated unix ids are stored in a database file under the Samba lock directory and will be - remembered.

        WARNING: The rid to unix id database is the only location + remembered.

        WARNING: The rid to unix id database is the only location where the user and group mappings are stored by winbindd. If this file is deleted or corrupted, there is no way for winbindd to determine which user and group ids correspond to Windows NT user - and group rids.

        CONFIGURATION

        Configuration of the winbindd daemon - is done through configuration parameters in the smb.conf(5) - file. All parameters should be specified in the - [global] section of smb.conf.

        EXAMPLE SETUP

        To setup winbindd for user and group lookups plus + and group rids.

        CONFIGURATION

        Configuration of the winbindd daemon + is done through configuration parameters in the smb.conf(5) file. All parameters should be specified in the + [global] section of smb.conf.

        EXAMPLE SETUP

        To setup winbindd for user and group lookups plus authentication from a domain controller use something like the - following setup. This was tested on a RedHat 6.2 Linux box.

        In /etc/nsswitch.conf put the - following:

        passwd:     files winbind
+	following setup. This was tested on a RedHat 6.2 Linux box. 
        In /etc/nsswitch.conf put the 
+	following:
+
        +passwd:     files winbind
 group:      files winbind
-

        In /etc/pam.d/* replace the - auth lines with something like this: 

        auth       required	/lib/security/pam_securetty.so
+

        In /etc/pam.d/* replace the + auth lines with something like this: +

        +auth       required	/lib/security/pam_securetty.so
 auth       required	/lib/security/pam_nologin.so
 auth       sufficient	/lib/security/pam_winbind.so
 auth       required     /lib/security/pam_pwdb.so use_first_pass shadow nullok
-

        Note in particular the use of the sufficient - keyword and the use_first_pass keyword.

        Now replace the account lines with this:

        account required /lib/security/pam_winbind.so -

        The next step is to join the domain. To do that use the - smbpasswd program like this:

        smbpasswd -j DOMAIN -r PDC -U - Administrator

        The username after the -U can be any +

        Note in particular the use of the sufficient + keyword and the use_first_pass keyword.

        Now replace the account lines with this:

        account required /lib/security/pam_winbind.so +

        The next step is to join the domain. To do that use the + net program like this:

        net join -S PDC -U Administrator

        The username after the -U can be any Domain user that has administrator privileges on the machine. - Substitute your domain name for "DOMAIN" and the name of your PDC - for "PDC".

        Next copy libnss_winbind.so to - /lib and pam_winbind.so - to /lib/security. A symbolic link needs to be - made from /lib/libnss_winbind.so to - /lib/libnss_winbind.so.2. If you are using an + Substitute the name or IP of your PDC for "PDC".

        Next copy libnss_winbind.so to + /lib and pam_winbind.so + to /lib/security. A symbolic link needs to be + made from /lib/libnss_winbind.so to + /lib/libnss_winbind.so.2. If you are using an older version of glibc then the target of the link should be - /lib/libnss_winbind.so.1.

        Finally, setup a smb.conf containing directives like the - following: 

        [global]
+	/lib/libnss_winbind.so.1.
        Finally, setup a smb.conf(5) containing directives like the 
+	following:
+
        +[global]
 	winbind separator = +
         winbind cache time = 10
         template shell = /bin/bash
@@ -648,274 +157,58 @@ CLASS="PROGRAMLISTING"
         workgroup = DOMAIN
         security = domain
         password server = *
-

        Now start winbindd and you should find that your user and +

        Now start winbindd and you should find that your user and group database is expanded to include your NT users and groups, and that you can login to your unix box as a domain user, using the DOMAIN+user syntax for the username. You may wish to use the - commands getent passwd and getent group - to confirm the correct operation of winbindd.

        NOTES

        The following notes are useful when configuring and - running winbindd:

        nmbd must be running on the local machine - for winbindd to work. winbindd - queries the list of trusted domains for the Windows NT server - on startup and when a SIGHUP is received. Thus, for a running winbindd to become aware of new trust relationships between - servers, it must be sent a SIGHUP signal.

        Client processes resolving names through the winbindd - nsswitch module read an environment variable named $WINBINDD_DOMAIN. If this variable contains a comma separated - list of Windows NT domain names, then winbindd will only resolve users - and groups within those Windows NT domains.

        PAM is really easy to misconfigure. Make sure you know what + commands getent passwd and getent group + to confirm the correct operation of winbindd.

        NOTES

        The following notes are useful when configuring and + running winbindd:

        nmbd(8) must be running on the local machine + for winbindd to work. winbindd queries + the list of trusted domains for the Windows NT server + on startup and when a SIGHUP is received. Thus, for a running + winbindd to become aware of new trust relationships between + servers, it must be sent a SIGHUP signal.

        PAM is really easy to misconfigure. Make sure you know what you are doing when modifying PAM configuration files. It is possible - to set up PAM such that you can no longer log into your system.

        If more than one UNIX machine is running winbindd, + to set up PAM such that you can no longer log into your system.

        If more than one UNIX machine is running winbindd, then in general the user and groups ids allocated by winbindd will not be the same. The user and group ids will only be valid for the local - machine.

        If the the Windows NT RID to UNIX user and group id mapping - file is damaged or destroyed then the mappings will be lost.

        SIGNALS

        The following signals can be used to manipulate the - winbindd daemon.

        SIGHUP

        Reload the smb.conf(5) - file and apply any parameter changes to the running + machine.

        If the the Windows NT RID to UNIX user and group id mapping + file is damaged or destroyed then the mappings will be lost.

        SIGNALS

        The following signals can be used to manipulate the + winbindd daemon.

        SIGHUP

        Reload the smb.conf(5) file and + apply any parameter changes to the running version of winbindd. This signal also clears any cached user and group information. The list of other domains trusted - by winbindd is also reloaded.

        SIGUSR1

        The SIGUSR1 signal will cause winbindd to write status information to the winbind + by winbindd is also reloaded.

        SIGUSR1

        The SIGUSR1 signal will cause + winbindd to write status information to the winbind log file including information about the number of user and - group ids allocated by winbindd.

        Log files are stored in the filename specified by the - log file parameter.

        FILES

        /etc/nsswitch.conf(5)

        Name service switch configuration file.

        /tmp/.winbindd/pipe

        The UNIX pipe over which clients communicate with - the winbindd program. For security reasons, the + group ids allocated by winbindd.

        Log files are stored in the filename specified by the + log file parameter.

        FILES

        /etc/nsswitch.conf(5)

        Name service switch configuration file.

        /tmp/.winbindd/pipe

        The UNIX pipe over which clients communicate with + the winbindd program. For security reasons, the winbind client will only attempt to connect to the winbindd daemon - if both the /tmp/.winbindd directory - and /tmp/.winbindd/pipe file are owned by - root.

        /lib/libnss_winbind.so.X

        Implementation of name service switch library. -

        $LOCKDIR/winbindd_idmap.tdb

        Storage for the Windows NT rid to UNIX user/group + if both the /tmp/.winbindd directory + and /tmp/.winbindd/pipe file are owned by + root.

        $LOCKDIR/winbindd_privilaged/pipe

        The UNIX pipe over which 'privilaged' clients + communicate with the winbindd program. For security + reasons, access to some winbindd functions - like those needed by + the ntlm_auth utility - is restricted. By default, + only users in the 'root' group will get this access, however the administrator + may change the group permissions on $LOCKDIR/winbindd_privilaged to allow + programs like 'squid' to use ntlm_auth. + Note that the winbind client will only attempt to connect to the winbindd daemon + if both the $LOCKDIR/winbindd_privilaged directory + and $LOCKDIR/winbindd_privilaged/pipe file are owned by + root.

        /lib/libnss_winbind.so.X

        Implementation of name service switch library. +

        $LOCKDIR/winbindd_idmap.tdb

        Storage for the Windows NT rid to UNIX user/group id mapping. The lock directory is specified when Samba is initially - compiled using the --with-lockdir option. - This directory is by default /usr/local/samba/var/locks - .

        $LOCKDIR/winbindd_cache.tdb

        Storage for cached user and group information. -

        VERSION

        This man page is correct for version 3.0 of - the Samba suite.

        SEE ALSO

        nsswitch.conf(5), - samba(7), - wbinfo(1), - smb.conf(5)

        AUTHOR

        The original Samba software and related utilities + compiled using the --with-lockdir option. + This directory is by default /usr/local/samba/var/locks + .

        $LOCKDIR/winbindd_cache.tdb

        Storage for cached user and group information. +

        VERSION

        This man page is correct for version 3.0 of + the Samba suite.

        SEE ALSO

        nsswitch.conf(5), Samba(7), wbinfo(8), smb.conf(5)

        AUTHOR

        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.

        wbinfo and winbindd - were written by Tim Potter.

        The conversion to DocBook for Samba 2.2 was done - by Gerald Carter

        \ No newline at end of file + to the way the Linux kernel is developed.

        wbinfo and winbindd were + written by Tim Potter.

        The conversion to DocBook for Samba 2.2 was done + by Gerald Carter. The conversion to DocBook XML 4.2 for + Samba 3.0 was done by Alexander Bokovoy.

        -- cgit