diff options
Diffstat (limited to 'docs/docbook/projdoc')
34 files changed, 10511 insertions, 10156 deletions
diff --git a/docs/docbook/projdoc/AccessControls.xml b/docs/docbook/projdoc/AccessControls.xml index 344e51e5c0..72348d44cd 100644 --- a/docs/docbook/projdoc/AccessControls.xml +++ b/docs/docbook/projdoc/AccessControls.xml @@ -7,12 +7,12 @@ </chapterinfo> <title>File, Directory and Share Access Controls</title> -<indexterm><primary>ACLs</primary></indexterm> <para> +<indexterm><primary>ACLs</primary></indexterm> Advanced MS Windows users are frequently perplexed when file, directory and share manipulation of resources shared via Samba do not behave in the manner they might expect. MS Windows network administrators are often confused regarding network access controls and how to -provide users with the access they need while protecting resources from unauthorised access. +provide users with the access they need while protecting resources from unauthorized access. </para> <para> @@ -23,17 +23,19 @@ and directory access permissions. <para> The problem lies in the differences in how file and directory permissions and controls work -between the two environments. This difference is one that Samba can not completely hide, even +between the two environments. This difference is one that Samba cannot completely hide, even though it does try to bridge the chasm to a degree. </para> -<indexterm><primary>Extended Attributes</primary></indexterm> <para> +<indexterm><primary>Extended Attributes</primary></indexterm> +<indexterm><primary>ACLs</primary><secondary>POSIX</secondary></indexterm> + POSIX Access Control List technology has been available (along with Extended Attributes) for UNIX for many years, yet there is little evidence today of any significant use. This explains to some extent the slow adoption of ACLs into commercial Linux products. MS Windows -administrators are astounded at this given that ACLs were a foundational capability of the now -decade old MS Windows NT operating system. +administrators are astounded at this, given that ACLs were a foundational capability of the now +decade-old MS Windows NT operating system. </para> <para> @@ -44,9 +46,9 @@ for delivering the best environment for MS Windows desktop users. <para> This is an opportune point to mention that Samba was created to provide a means of interoperability -and interchange of data between differing operating environments. Samba has no intent change +and interchange of data between differing operating environments. Samba has no intent to change UNIX/Linux into a platform like MS Windows. Instead the purpose was and is to provide a sufficient -level of exchange of data between the two environments. What is available today extends well +level of exchange of data between the two environments. What is available today extends well beyond early plans and expectations, yet the gap continues to shrink. </para> @@ -61,11 +63,12 @@ beyond early plans and expectations, yet the gap continues to shrink. <itemizedlist> <title>Samba Access Control Facilities</title> <listitem><para> + <indexterm><primary>permissions</primary><secondary>UNIX file and directory</secondary></indexterm> <emphasis>UNIX File and Directory Permissions</emphasis> </para> <para> - Samba honours and implements UNIX file system access controls. Users + Samba honors and implements UNIX file system access controls. Users who access a Samba server will do so as a particular MS Windows user. This information is passed to the Samba server as part of the logon or connection setup process. Samba uses this user identity to validate @@ -80,10 +83,10 @@ beyond early plans and expectations, yet the gap continues to shrink. </para> <para> - In configuring share settings and controls in the &smb.conf; file - the network administrator can exercise over-rides to native file - system permissions and behaviours. This can be handy and convenient - to affect behaviour that is more like what MS Windows NT users expect + In configuring share settings and controls in the &smb.conf; file, + the network administrator can exercise overrides to native file + system permissions and behaviors. This can be handy and convenient + to effect behavior that is more like what MS Windows NT users expect but it is seldom the <emphasis>best</emphasis> way to achieve this. The basic options and techniques are described herein. </para> @@ -91,27 +94,30 @@ beyond early plans and expectations, yet the gap continues to shrink. <listitem><para> <emphasis>Samba Share ACLs</emphasis> + <indexterm><primary>ACLs</primary><secondary>share</secondary></indexterm> </para> <para> Just like it is possible in MS Windows NT to set ACLs on shares themselves, so it is possible to do this in Samba. - Very few people make use of this facility, yet it remains on of the + Few people make use of this facility, yet it remains on of the easiest ways to affect access controls (restrictions) and can often do so with minimum invasiveness compared with other methods. </para> </listitem> <listitem><para> + <indexterm><primary>ACLs</primary><secondary>POSIX</secondary></indexterm> + <indexterm><primary>ACLs</primary><secondary>Windows</secondary></indexterm> <emphasis>MS Windows ACLs through UNIX POSIX ACLs</emphasis> </para> <para> - The use of POSIX ACLs on UNIX/Linux is possible ONLY if the underlying + The use of POSIX ACLs on UNIX/Linux is possible only if the underlying operating system supports them. If not, then this option will not be available to you. Current UNIX technology platforms have native support - for POSIX ACLs. There are patches for the Linux kernel that provide - this also. Sadly, few Linux platforms ship today with native ACLs and + for POSIX ACLs. There are patches for the Linux kernel that also provide + this. Sadly, few Linux platforms ship today with native ACLs and Extended Attributes enabled. This chapter has pertinent information for users of platforms that support them. </para> @@ -124,43 +130,50 @@ beyond early plans and expectations, yet the gap continues to shrink. <title>File System Access Controls</title> <para> -Perhaps the most important recognition to be made is the simple fact that MS Windows NT4 / 200x / XP +Perhaps the most important recognition to be made is the simple fact that MS Windows NT4/200x/XP implement a totally divergent file system technology from what is provided in the UNIX operating system -environment. Firstly we should consider what the most significant differences are, then we shall look +environment. First we consider what the most significant differences are, then we look at how Samba helps to bridge the differences. </para> -<indexterm><primary>NTFS</primary></indexterm> -<indexterm><primary>File System</primary></indexterm> <sect2> <title>MS Windows NTFS Comparison with UNIX File Systems</title> <para> +<indexterm><primary>NTFS</primary></indexterm> +<indexterm><primary>File System</primary></indexterm> +<indexterm><primary>File System</primary><secondary>UNIX</secondary></indexterm> +<indexterm><primary>File System</primary><secondary>Windows</secondary></indexterm> + Samba operates on top of the UNIX file system. This means it is subject to UNIX file system conventions and permissions. It also means that if the MS Windows networking environment requires file system - behaviour that differs from unix file system behaviour then somehow Samba is responsible for emulating + behavior that differs from UNIX file system behavior then somehow Samba is responsible for emulating that in a transparent and consistent manner. </para> <para> - It is good news that Samba does this to a very large extent and on top of that provides a high degree - of optional configuration to over-ride the default behaviour. We will look at some of these over-rides, - but for the greater part we will stay within the bounds of default behaviour. Those wishing to explore - to depths of control ability should review the &smb.conf; man page. + It is good news that Samba does this to a large extent and on top of that provides a high degree + of optional configuration to override the default behavior. We look at some of these over-rides, + but for the greater part we will stay within the bounds of default behavior. Those wishing to explore + the depths of control ability should review the &smb.conf; man page. + </para> + + <para>The following compares file system features for UNIX with those of Microsoft Windows NT/200x: + <indexterm><primary>File System</primary><secondary>feature comparison</secondary></indexterm> + </para> <variablelist> - <title>File System Feature Comparison</title> <varlistentry> <term>Name Space</term> <listitem> <para> - MS Windows NT4 / 200x/ XP files names may be up to 254 characters long, UNIX file names - may be 1023 characters long. In MS Windows file extensions indicate particular file types, + MS Windows NT4/200x/XP files names may be up to 254 characters long, and UNIX file names + may be 1023 characters long. In MS Windows, file extensions indicate particular file types, in UNIX this is not so rigorously observed as all names are considered arbitrary. </para> <para> - What MS Windows calls a Folder, UNIX calls a directory. + What MS Windows calls a folder, UNIX calls a directory. </para> </listitem> </varlistentry> @@ -169,28 +182,35 @@ at how Samba helps to bridge the differences. <term>Case Sensitivity</term> <listitem> <para> - <indexterm><primary>8.3</primary><secondary>file names</secondary></indexterm> - MS Windows file names are generally upper case if made up of 8.3 (ie: 8 character file name - and 3 character extension. If longer than 8.3 file names are Case Preserving, and Case - Insensitive. + <indexterm><primary>8.3 file names</primary></indexterm> + <indexterm><primary>File System</primary><secondary>case sensitivity</secondary></indexterm> + MS Windows file names are generally upper case if made up of 8.3 (8 character file name + and 3 character extension. File names that are longer than 8.3 are case preserving and case + insensitive. </para> + <para> UNIX file and directory names are case sensitive and case preserving. Samba implements the - MS Windows file name behaviour, but it does so as a user application. The UNIX file system + MS Windows file name behavior, but it does so as a user application. The UNIX file system provides no mechanism to perform case insensitive file name lookups. MS Windows does this by default. This means that Samba has to carry the processing overhead to provide features - that are NOT native to the UNIX operating system environment. + that are not native to the UNIX operating system environment. </para> <para> - Consider the following, all are unique UNIX names but one single MS Windows file name: - <computeroutput> + Consider the following. All are unique UNIX names but one single MS Windows file name: + <screen> MYFILE.TXT MyFile.txt myfile.txt - </computeroutput> - So clearly, In an MS Windows file name space these three files CAN NOT co-exist! But in UNIX - they can. So what should Samba do if all three are present? Answer, the one that is lexically - first will be accessible to MS Windows users, the others are invisible and unaccessible - any + </screen></para> + + <para> + So clearly, in an MS Windows file name space these three files cannot co-exist, but in UNIX + they can. + </para> + <para> + So what should Samba do if all three are present? That which is lexically first will be + accessible to MS Windows users, the others are invisible and unaccessible &smbmdash; any other solution would be suicidal. </para> </listitem> @@ -199,9 +219,11 @@ at how Samba helps to bridge the differences. <varlistentry> <term>Directory Separators</term> <listitem> + <para> - MS Windows and DOS uses the back-slash '\' as a directory delimiter, UNIX uses the forward-slash '/' - as it's directory delimiter. This is transparently handled by Samba. + <indexterm><primary>Directory Separators</primary></indexterm> + MS Windows and DOS uses the backslash <constant>\</constant> as a directory delimiter, and UNIX uses + the forward-slash <constant>/</constant> as its directory delimiter. This is handled transparently by Samba. </para> </listitem> </varlistentry> @@ -210,11 +232,12 @@ at how Samba helps to bridge the differences. <term>Drive Identification</term> <listitem> <para> + <indexterm><primary>Drive Identification</primary></indexterm> MS Windows products support a notion of drive letters, like <command>C:</command> to represent - disk partitions. UNIX has NO concept if separate identifiers for file partitions since each - such file system is <filename>mounted</filename> to become part of the over-all directory tree. - The UNIX directory tree begins at '/', just like the root of a DOS drive is specified like - <command>C:\</command>. + disk partitions. UNIX has no concept of separate identifiers for file partitions, each + such file system is mounted to become part of the overall directory tree. + The UNIX directory tree begins at <constant>/</constant> just like the root of a DOS drive is specified as + <constant>C:\</constant>. </para> </listitem> </varlistentry> @@ -223,9 +246,10 @@ at how Samba helps to bridge the differences. <term>File Naming Conventions</term> <listitem> <para> - MS Windows generally never experiences file names that begin with a '.', while in UNIX these - are commonly found in a user's home directory. Files that begin with a '.' are typically - either start up files for various UNIX applications, or they may be files that contain + <indexterm><primary>File Naming Conventions</primary></indexterm> + MS Windows generally never experiences file names that begin with a dot (<constant>.</constant>) while in UNIX these + are commonly found in a user's home directory. Files that begin with a dot (<constant>.</constant>) are typically + either start-up files for various UNIX applications, or they may be files that contain start-up configuration data. </para> </listitem> @@ -238,15 +262,14 @@ at how Samba helps to bridge the differences. <indexterm><primary>Links</primary><secondary>hard</secondary></indexterm> <indexterm><primary>Links</primary><secondary>soft</secondary></indexterm> <indexterm><primary>Short-Cuts</primary></indexterm> - - MS Windows make use of "links and Short-Cuts" that are actually special types of files that will + MS Windows make use of <quote>links and short-cuts</quote> that are actually special types of files that will redirect an attempt to execute the file to the real location of the file. UNIX knows of file and directory links, but they are entirely different from what MS Windows users are used to. </para> <para> - Symbolic links are files in UNIX that contain the actual location of the data (file OR directory). An + Symbolic links are files in UNIX that contain the actual location of the data (file or directory). An operation (like read or write) will operate directly on the file referenced. Symbolic links are also - referred to as 'soft links'. A hard link is something that MS Windows is NOT familiar with. It allows + referred to as <quote>soft links.</quote> A hard link is something that MS Windows is not familiar with. It allows one physical file to be known simultaneously by more than one file name. </para> </listitem> @@ -256,7 +279,7 @@ at how Samba helps to bridge the differences. <para> There are many other subtle differences that may cause the MS Windows administrator some temporary discomfort in the process of becoming familiar with UNIX/Linux. These are best left for a text that is dedicated to the - purpose of UNIX/Linux training/education. + purpose of UNIX/Linux training and education. </para> </sect2> @@ -265,9 +288,9 @@ at how Samba helps to bridge the differences. <title>Managing Directories</title> <para> - There are three basic operations for managing directories, <command>create, delete, rename</command>. + There are three basic operations for managing directories: <command>create, delete, rename</command>. <table frame="all"> - <title>Managing directories with unix and windows</title> + <title>Managing Directories with UNIX and Windows</title> <tgroup align="center" cols="3"> <thead> <row><entry>Action</entry><entry>MS Windows Command</entry><entry>UNIX Command</entry></row> @@ -287,7 +310,9 @@ at how Samba helps to bridge the differences. <sect2> <title>File and Directory Access Control</title> + <para> + <indexterm><primary>ACLs</primary><secondary>File System</secondary></indexterm> The network administrator is strongly advised to read foundational training manuals and reference materials regarding file and directory permissions maintenance. Much can be achieved with the basic UNIX permissions without having to resort to more complex facilities like POSIX Access Control Lists (ACLs) or Extended @@ -295,9 +320,8 @@ at how Samba helps to bridge the differences. </para> <para> - UNIX/Linux file and directory access permissions involves setting three (3) primary sets of data and one (1) control set. - A UNIX file listing looks as follows:- - + UNIX/Linux file and directory access permissions involves setting three primary sets of data and one control set. + A UNIX file listing looks as follows: <screen> &prompt;<userinput>ls -la</userinput> total 632 @@ -322,20 +346,20 @@ drwsrwsrwx 2 maryo gnomes 48 2003-05-12 22:29 muchado08 </para> <para> - An overview of the permissions field can be found in <link linkend="access1">the image below</link>. + An overview of the permissions field can be found in <link linkend="access1"/>. </para> - <image scale="40"><imagedescription>Overview of unix permissions field</imagedescription><imagefile>access1</imagefile></image> + <image id="access1" scale="40"><imagedescription>Overview of UNIX permissions field.</imagedescription><imagefile>access1</imagefile></image> <para> - Any bit flag may be unset. An unset bit flag is the equivalent of 'Can NOT' and is represented as a '-' character. + Any bit flag may be unset. An unset bit flag is the equivalent of <quote>cannot</quote> and is represented as a <quote>-</quote> character. <example> <title>Example File</title> <programlisting> -rwxr-x--- Means: The owner (user) can read, write, execute the group can read and execute - everyone else can NOT do anything with it + everyone else cannot do anything with it. </programlisting> </example> @@ -346,7 +370,7 @@ drwsrwsrwx 2 maryo gnomes 48 2003-05-12 22:29 muchado08 </para> <para> - The letters `rwxXst' set permissions for the user, group and others as: read (r), write (w), execute (or access for directories) (x), + The letters <constant>rwxXst</constant> set permissions for the user, group and others as: read (r), write (w), execute (or access for directories) (x), execute only if the file is a directory or already has execute permission for some user (X), set user or group ID on execution (s), sticky (t). </para> @@ -354,20 +378,20 @@ drwsrwsrwx 2 maryo gnomes 48 2003-05-12 22:29 muchado08 <para> When the sticky bit is set on a directory, files in that directory may be unlinked (deleted) or renamed only by root or their owner. Without the sticky bit, anyone able to write to the directory can delete or rename files. The sticky bit is commonly found on - directories, such as /tmp, that are world-writable. + directories, such as <filename>/tmp</filename>, that are world-writable. </para> <para> When the set user or group ID bit (s) is set on a directory, then all files created within it will be owned by the user and/or - group whose 'set user or group' bit is set. This can be very helpful in setting up directories that for which it is desired that + group whose `set user or group' bit is set. This can be helpful in setting up directories for which it is desired that all users who are in a group should be able to write to and read from a file, particularly when it is undesirable for that file - to be exclusively owned by a user who's primary group is not the group that all such users belong to. + to be exclusively owned by a user whose primary group is not the group that all such users belong to. </para> <para> When a directory is set <constant>drw-r-----</constant> this means that the owner can read and create (write) files in it, but because - the (x) execute flags are not set files can not be listed (seen) in the directory by anyone. The group can read files in the - directory but can NOT create new files. NOTE: If files in the directory are set to be readable and writable for the group, then + the (x) execute flags are not set, files cannot be listed (seen) in the directory by anyone. The group can read files in the + directory but cannot create new files. If files in the directory are set to be readable and writable for the group, then group members will be able to write to (or delete) them. </para> @@ -378,34 +402,40 @@ drwsrwsrwx 2 maryo gnomes 48 2003-05-12 22:29 muchado08 <sect1> <title>Share Definition Access Controls</title> + <para> -The following parameters in the &smb.conf; file sections that define a share control or affect access controls. -Before using any of the following options please refer to the man page for &smb.conf;. +<indexterm><primary>permissions</primary><secondary>share</secondary></indexterm> +The following parameters in the &smb.conf; file sections define a share control or effect access controls. +Before using any of the following options, please refer to the man page for &smb.conf;. </para> <sect2> - <title>User and Group Based Controls</title> + <title>User and Group-Based Controls</title> <para> - User and group based controls can prove very useful. In some situations it is distinctly desirable to affect all - file system operations as if a single user is doing this, the use of the <smbconfoption><name>force user</name></smbconfoption> and - <smbconfoption><name>force group</name></smbconfoption> behaviour will achieve this. In other situations it may be necessary to affect a - paranoia level of control to ensure that only particular authorised persons will be able to access a share or - it's contents, here the use of the <smbconfoption><name>valid users</name></smbconfoption> or the <smbconfoption><name>invalid users</name></smbconfoption> may - be most useful. + User and group-based controls can prove quite useful. In some situations it is distinctly desirable to affect all + file system operations as if a single user were doing so. The use of the <smbconfoption><name>force user</name></smbconfoption> and + <smbconfoption><name>force group</name></smbconfoption> behavior will achieve this. In other situations it may be necessary to effect a + paranoia level of control to ensure that only particular authorized persons will be able to access a share or + its contents. Here the use of the <smbconfoption><name>valid users</name></smbconfoption> or the + <smbconfoption><name>invalid users</name></smbconfoption> may be most useful. </para> <para> As always, it is highly advisable to use the least difficult to maintain and the least ambiguous method for - controlling access. Remember, that when you leave the scene someone else will need to provide assistance and - if that person finds too great a mess, or if they do not understand what you have done then there is risk of + controlling access. Remember, when you leave the scene someone else will need to provide assistance and + if he finds too great a mess or does not understand what you have done, there is risk of Samba being removed and an alternative solution being adopted. </para> - <table frame='all' pgwide='0'><title>User and Group Based Controls</title> + <para> + <link linkend="ugbc"/> enumerates these controls. + </para> + + <table frame='all' pgwide='0' id="ugbc"><title>User and Group Based Controls</title> <tgroup cols='2'> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" colwidth="1*"/> <thead> <row> <entry align="center">Control Parameter</entry> @@ -417,7 +447,7 @@ Before using any of the following options please refer to the man page for &smb. <entry><smbconfoption><name>admin users</name></smbconfoption></entry> <entry><para> List of users who will be granted administrative privileges on the share. - They will do all file operations as the super-user (root). + They will do all file operations as the super-user (root). Any user in this list will be able to do anything they like on the share, irrespective of file permissions. </para></entry> @@ -465,7 +495,7 @@ Before using any of the following options please refer to the man page for &smb. <row> <entry><smbconfoption><name>username</name></smbconfoption></entry> <entry><para> - Refer to the &smb.conf; man page for more information - this is a complex and potentially misused parameter. + Refer to the &smb.conf; man page for more information -- this is a complex and potentially misused parameter. </para></entry> </row> <row> @@ -487,19 +517,24 @@ Before using any of the following options please refer to the man page for &smb. </sect2> <sect2> - <title>File and Directory Permissions Based Controls</title> + <title>File and Directory Permissions-Based Controls</title> <para> - The following file and directory permission based controls, if misused, can result in considerable difficulty to - diagnose the cause of mis-configuration. Use them sparingly and carefully. By gradually introducing each one by one - undesirable side-effects may be detected. In the event of a problem, always comment all of them out and then gradually - re-introduce them in a controlled fashion. + The following file and directory permission-based controls, if misused, can result in considerable difficulty to + diagnose causes of misconfiguration. Use them sparingly and carefully. By gradually introducing each one by one, + undesirable side effects may be detected. In the event of a problem, always comment all of them out and then gradually + reintroduce them in a controlled way. </para> - <table frame='all'><title>File and Directory Permission Based Controls</title> + <para> + Refer to <link linkend="fdpbc"/> for information regarding the parameters that may be used to affect file and + directory permission-based access controls. + </para> + + <table frame='all' id="fdpbc"><title>File and Directory Permission Based Controls</title> <tgroup cols='2'> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" colwidth="1*"/> <thead> <row> <entry align="center">Control Parameter</entry> @@ -540,7 +575,7 @@ Before using any of the following options please refer to the man page for &smb. <row> <entry><smbconfoption><name>force directory security mode</name></smbconfoption></entry> <entry><para> - Controls UNIX permission bits modified when a Windows NT client is manipulating UNIX permissions on a directory + Controls UNIX permission bits modified when a Windows NT client is manipulating UNIX permissions on a directory. </para></entry> </row> <row> @@ -584,13 +619,13 @@ Before using any of the following options please refer to the man page for &smb. <para> The following are documented because of the prevalence of administrators creating inadvertent barriers to file - access by not understanding the full implications of &smb.conf; file settings. + access by not understanding the full implications of &smb.conf; file settings. See <link linkend="mcoc"/>. </para> - <table frame='all'><title>Other Controls</title> + <table frame='all' id="mcoc"><title>Other Controls</title> <tgroup cols='2'> - <colspec align="justify"/> - <colspec align="justify"/> + <colspec align="justify" colwidth="1*"/> + <colspec align="justify" colwidth="1*"/> <thead> <row> <entry align="center">Control Parameter</entry> @@ -602,7 +637,7 @@ Before using any of the following options please refer to the man page for &smb. <entry><smbconfoption><name>case sensitive</name></smbconfoption>, <smbconfoption><name>default case</name></smbconfoption>, <smbconfoption><name>short preserve case</name></smbconfoption></entry> <entry><para> This means that all file name lookup will be done in a case sensitive manner. - Files will be created with the precise filename Samba received from the MS Windows client. + Files will be created with the precise file name Samba received from the MS Windows client. </para></entry> </row> <row> @@ -614,7 +649,7 @@ Before using any of the following options please refer to the man page for &smb. <row> <entry><smbconfoption><name>dont descend</name></smbconfoption></entry> <entry><para> - Allows to specify a comma-delimited list of directories that the server should always show as empty. + Allows specifying a comma-delimited list of directories that the server should always show as empty. </para></entry> </row> <row> @@ -626,15 +661,15 @@ Before using any of the following options please refer to the man page for &smb. <row> <entry><smbconfoption><name>dos filetimes</name></smbconfoption></entry> <entry><para> - DOS and Windows allows users to change file time stamps if they can write to the file. POSIX semantics prevent this. - This options allows DOS and Windows behaviour. + DOS and Windows allow users to change file time stamps if they can write to the file. POSIX semantics prevent this. + This option allows DOS and Windows behavior. </para></entry> </row> <row> <entry><smbconfoption><name>fake oplocks</name></smbconfoption></entry> <entry><para> Oplocks are the way that SMB clients get permission from a server to locally cache file operations. If a server grants an - oplock then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data. + oplock, the client is free to assume that it is the only one accessing the file and it will aggressively cache file data. </para></entry> </row> <row> @@ -666,16 +701,18 @@ Before using any of the following options please refer to the man page for &smb. <sect1> <title>Access Controls on Shares</title> + <para> +<indexterm><primary>permissions</primary><secondary>share ACLs</secondary></indexterm> This section deals with how to configure Samba per share access control restrictions. By default, Samba sets no restrictions on the share itself. Restrictions on the share itself - can be set on MS Windows NT4/200x/XP shares. This can be a very effective way to limit who can + can be set on MS Windows NT4/200x/XP shares. This can be an effective way to limit who can connect to a share. In the absence of specific restrictions the default setting is to allow - the global user <constant>Everyone</constant> Full Control (ie: Full control, Change and Read). + the global user <constant>Everyone - Full Control</constant> (full control, change and read). </para> <para> - At this time Samba does NOT provide a tool for configuring access control setting on the Share + At this time Samba does not provide a tool for configuring access control setting on the share itself. Samba does have the capacity to store and act on access control settings, but the only way to create those settings is to use either the NT4 Server Manager or the Windows 200x MMC for Computer Management. @@ -683,10 +720,10 @@ Before using any of the following options please refer to the man page for &smb. <para> Samba stores the per share access control settings in a file called <filename>share_info.tdb</filename>. - The location of this file on your system will depend on how samba was compiled. The default location + The location of this file on your system will depend on how Samba was compiled. The default location for Samba's tdb files is under <filename>/usr/local/samba/var</filename>. If the <filename>tdbdump</filename> utility has been compiled and installed on your system, then you can examine the contents of this file - by: <userinput>tdbdump share_info.tdb</userinput>. + by executing: <command>tdbdump share_info.tdb</command> in the directory containing the tdb files. </para> <sect2> @@ -701,18 +738,20 @@ Before using any of the following options please refer to the man page for &smb. <para> The tool you need to use to manage share permissions on a Samba server is the NT Server Manager. Server Manager is shipped with Windows NT4 Server products but not with Windows NT4 Workstation. - You can obtain the NT Server Manager for MS Windows NT4 Workstation from Microsoft - see details below. + You can obtain the NT Server Manager for MS Windows NT4 Workstation from Microsoft &smbmdash; see details below. </para> + <?latex \newpage ?> + <procedure> <title>Instructions</title> <step><para> - Launch the <application>NT4 Server Manager</application>, click on the Samba server you want to administer, then from the menu - select <guimenu>Computer</guimenu>, then click on the <guimenuitem>Shared Directories</guimenuitem> entry. + Launch the <application>NT4 Server Manager</application>, click on the Samba server you want to administer. From the menu + select <guimenu>Computer</guimenu>, then click on <guimenuitem>Shared Directories</guimenuitem>. </para></step> <step><para> - Now click on the share that you wish to manage, then click on the <guilabel>Properties</guilabel> tab, next click on + Click on the share that you wish to manage, then click the <guilabel>Properties</guilabel> tab. then click the <guilabel>Permissions</guilabel> tab. Now you can add or change access control settings as you wish. </para></step> </procedure> @@ -724,47 +763,47 @@ Before using any of the following options please refer to the man page for &smb. <para> On <application>MS Windows NT4/200x/XP</application> system access control lists on the share itself are set using native - tools, usually from file manager. For example, in Windows 200x: right click on the shared folder, + tools, usually from File Manager. For example, in Windows 200x, right click on the shared folder, then select <guimenuitem>Sharing</guimenuitem>, then click on <guilabel>Permissions</guilabel>. The default - Windows NT4/200x permission allows <emphasis>Everyone</emphasis> Full Control on the Share. + Windows NT4/200x permission allows <quote>Everyone</quote> full control on the share. </para> <para> - MS Windows 200x and later all comes with a tool called the <application>Computer Management</application> snap-in for the - Microsoft Management Console (MMC). This tool is located by clicking on <filename>Control Panel -> - Administrative Tools -> Computer Management</filename>. + MS Windows 200x and later versions come with a tool called the <application>Computer Management</application> snap-in for the + Microsoft Management Console (MMC). This tool is located by clicking on <guimenu>Control Panel -> + Administrative Tools -> Computer Management</guimenu>. </para> <procedure> <title>Instructions</title> <step><para> - After launching the MMC with the Computer Management snap-in, click on the menu item <guimenuitem>Action</guimenuitem>, - select <guilabel>Connect to another computer</guilabel>. If you are not logged onto a domain you will be prompted - to enter a domain login user identifier and a password. This will authenticate you to the domain. - If you where already logged in with administrative privilege this step is not offered. + After launching the MMC with the Computer Management snap-in, click the menu item <guimenuitem>Action</guimenuitem>, + and select <guilabel>Connect to another computer</guilabel>. If you are not logged onto a domain you will be prompted + to enter a domain login user identifier and a password. This will authenticate you to the domain. + If you are already logged in with administrative privilege, this step is not offered. </para></step> <step><para> - If the Samba server is not shown in the <guilabel>Select Computer</guilabel> box, then type in the name of the target - Samba server in the field <guilabel>Name:</guilabel>. Now click on the <guibutton>[+]</guibutton> next to + If the Samba server is not shown in the <guilabel>Select Computer</guilabel> box, type in the name of the target + Samba server in the field <guilabel>Name:</guilabel>. Now click the on <guibutton>[+]</guibutton> next to <guilabel>System Tools</guilabel>, then on the <guibutton>[+]</guibutton> next to <guilabel>Shared Folders</guilabel> in the left panel. </para></step> <step><para> - Now in the right panel, double-click on the share you wish to set access control permissions on. - Then click on the tab <guilabel>Share Permissions</guilabel>. It is now possible to add access control entities - to the shared folder. Do NOT forget to set what type of access (full control, change, read) you + In the right panel, double-click on the share on which you wish to set access control permissions. + Then click the tab <guilabel>Share Permissions</guilabel>. It is now possible to add access control entities + to the shared folder. Remember to set what type of access (full control, change, read) you wish to assign for each entry. </para></step> </procedure> <warning> <para> - Be careful. If you take away all permissions from the <constant>Everyone</constant> user without removing this user - then effectively no user will be able to access the share. This is a result of what is known as - ACL precedence. ie: Everyone with <emphasis>no access</emphasis> means that MaryK who is part of the group - <constant>Everyone</constant> will have no access even if this user is given explicit full control access. + Be careful. If you take away all permissions from the <constant>Everyone</constant> user without removing this user, + effectively no user will be able to access the share. This is a result of what is known as + ACL precedence. Everyone with <emphasis>no access</emphasis> means that <constant>MaryK</constant> who is part of the group + <constant>Everyone</constant> will have no access even if she is given explicit full control access. </para> </warning> @@ -777,27 +816,29 @@ Before using any of the following options please refer to the man page for &smb. <title>MS Windows Access Control Lists and UNIX Interoperability</title> <sect2> - <title>Managing UNIX permissions Using NT Security Dialogs</title> + <title>Managing UNIX Permissions Using NT Security Dialogs</title> + <para> +<indexterm><primary>permissions</primary><secondary>file/directory ACLs</secondary></indexterm> Windows NT clients can use their native security settings dialog box to view and modify the underlying UNIX permissions. </para> <para> - Note that this ability is careful not to compromise the security of the UNIX host Samba is running on, and + This ability is careful not to compromise the security of the UNIX host on which Samba is running, and still obeys all the file permission rules that a Samba administrator can set. </para> <para> - Samba does not attempt to go beyond POSIX ACLs, so that the various finer-grained access control - options provided in Windows are actually ignore. + Samba does not attempt to go beyond POSIX ACLs, so the various finer-grained access control + options provided in Windows are actually ignored. </para> <note> <para> All access to UNIX/Linux system files via Samba is controlled by the operating system file access controls. - When trying to figure out file access problems it is vitally important to find the identity of the Windows + When trying to figure out file access problems, it is vitally important to find the identity of the Windows user as it is presented by Samba at the point of file access. This can best be determined from the Samba log files. </para> @@ -808,57 +849,57 @@ Before using any of the following options please refer to the man page for &smb. <title>Viewing File Security on a Samba Share</title> <para> - From an NT4/2000/XP client, single-click with the right mouse button on any file or directory in a Samba - mounted drive letter or UNC path. When the menu pops-up, click on the <guilabel>Properties</guilabel> - entry at the bottom of the menu. This brings up the file properties dialog box. Click on the tab - <guilabel>Security</guilabel> and you will see three buttons, <guibutton>Permissions</guibutton>, + From an NT4/2000/XP client, right click on any file or directory in a Samba-mounted drive letter + or UNC path. When the menu pops up, click on the <guilabel>Properties</guilabel> entry at the bottom + of the menu. This brings up the file <constant>Properties</constant> dialog box. Click on the + <guilabel>Security</guilabel> tab and you will see three buttons: <guibutton>Permissions</guibutton>, <guibutton>Auditing</guibutton>, and <guibutton>Ownership</guibutton>. The <guibutton>Auditing</guibutton> - button will cause either an error message <errorname>A requested privilege is not held by the client</errorname> + button will cause either an error message <errorname>`A requested privilege is not held by the client'</errorname> to appear if the user is not the NT Administrator, or a dialog which is intended to allow an Administrator to add auditing requirements to a file if the user is logged on as the NT Administrator. This dialog is non-functional with a Samba share at this time, as the only useful button, the <guibutton>Add</guibutton> - button will not currently allow a list of users to be seen. + button, will not currently allow a list of users to be seen. </para> </sect2> <sect2> - <title>Viewing file ownership</title> + <title>Viewing File Ownership</title> <para> Clicking on the <guibutton>Ownership</guibutton> button brings up a dialog box telling you who owns - the given file. The owner name will be of the form: + the given file. The owner name will be displayed like this: </para> <para> - <command>"SERVER\user (Long name)"</command> + <command><quote>SERVER\user (Long name)</quote></command> </para> <para> - Where <replaceable>SERVER</replaceable> is the NetBIOS name of the Samba server, <replaceable>user</replaceable> + <replaceable>SERVER</replaceable> is the NetBIOS name of the Samba server, <replaceable>user</replaceable> is the user name of the UNIX user who owns the file, and <replaceable>(Long name)</replaceable> is the descriptive string identifying the user (normally found in the GECOS field of the UNIX password database). Click on the <guibutton>Close </guibutton> button to remove this dialog. </para> <para> - If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant> - then the file owner will be shown as the NT user <constant>"Everyone"</constant>. + If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant>, + the file owner will be shown as the NT user <emphasis>Everyone</emphasis>. </para> <para> The <guibutton>Take Ownership</guibutton> button will not allow you to change the ownership of this file to - yourself (clicking on it will display a dialog box complaining that the user you are currently logged onto + yourself (clicking it will display a dialog box complaining that the user you are currently logged onto the NT client cannot be found). The reason for this is that changing the ownership of a file is a privileged operation in UNIX, available only to the <emphasis>root</emphasis> user. As clicking on this button causes - NT to attempt to change the ownership of a file to the current user logged into the NT client this will + NT to attempt to change the ownership of a file to the current user logged into the NT clienti, this will not work with Samba at this time.</para> <para> - There is an NT chown command that will work with Samba and allow a user with Administrator privilege connected + There is an NT <command>chown</command> command that will work with Samba and allow a user with Administrator privilege connected to a Samba server as root to change the ownership of files on both a local NTFS filesystem or remote mounted NTFS or Samba drive. This is available as part of the <application>Seclib</application> NT security library written - by Jeremy Allison of the Samba-Team, available from the main Samba FTP site.</para> + by Jeremy Allison of the Samba Team, and is available from the main Samba FTP site.</para> </sect2> @@ -867,12 +908,12 @@ Before using any of the following options please refer to the man page for &smb. <para> The third button is the <guibutton>Permissions</guibutton> button. Clicking on this brings up a dialog box - that shows both the permissions and the UNIX owner of the file or directory. The owner is displayed in the form: + that shows both the permissions and the UNIX owner of the file or directory. The owner is displayed like this: </para> - <para><command>"<replaceable>SERVER</replaceable>\ + <para><command><replaceable>SERVER</replaceable>\ <replaceable>user</replaceable> - <replaceable>(Long name)</replaceable>"</command></para> + <replaceable>(Long name)</replaceable></command></para> <para>Where <replaceable>SERVER</replaceable> is the NetBIOS name of the Samba server, <replaceable>user</replaceable> is the user name of the UNIX user who owns the file, and @@ -880,9 +921,9 @@ Before using any of the following options please refer to the man page for &smb. GECOS field of the UNIX password database).</para> <para> - If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant> - then the file owner will be shown as the NT user <constant>"Everyone"</constant> and the permissions will be - shown as NT "Full Control". + If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> is set to <constant>false</constant>, + the file owner will be shown as the NT user <constant>Everyone</constant> and the permissions will be + shown as NT <quote>Full Control</quote>. </para> @@ -894,76 +935,59 @@ Before using any of the following options please refer to the man page for &smb. <sect3> <title>File Permissions</title> - <para>The standard UNIX user/group/world triplet and - the corresponding "read", "write", "execute" permissions - triplets are mapped by Samba into a three element NT ACL - with the 'r', 'w', and 'x' bits mapped into the corresponding - NT permissions. The UNIX world permissions are mapped into - the global NT group <constant>Everyone</constant>, followed - by the list of permissions allowed for UNIX world. The UNIX - owner and group permissions are displayed as an NT - <guiicon>user</guiicon> icon and an NT <guiicon>local - group</guiicon> icon respectively followed by the list + <para>The standard UNIX user/group/world triplet and the corresponding <constant>read, write, execute</constant> permissions + triplets are mapped by Samba into a three element NT ACL with the <quote>r</quote>, <quote>w</quote> and <quote>x</quote> bits mapped into the corresponding + NT permissions. The UNIX world permissions are mapped into the global NT group <constant>Everyone</constant>, followed + by the list of permissions allowed for UNIX world. The UNIX owner and group permissions are displayed as an NT + <guiicon>user</guiicon> icon and an NT <guiicon>local group</guiicon> icon, respectively, followed by the list of permissions allowed for the UNIX user and group.</para> - <para>As many UNIX permission sets don't map into common - NT names such as <constant>read</constant>, <constant> - "change"</constant> or <constant>full control</constant> then - usually the permissions will be prefixed by the words <constant> - "Special Access"</constant> in the NT display list.</para> - - <para>But what happens if the file has no permissions allowed - for a particular UNIX user group or world component? In order - to allow "no permissions" to be seen and modified then Samba - overloads the NT <command>"Take Ownership"</command> ACL attribute - (which has no meaning in UNIX) and reports a component with - no permissions as having the NT <command>"O"</command> bit set. - This was chosen of course to make it look like a zero, meaning - zero permissions. More details on the decision behind this will - be given below.</para> + <para>Because many UNIX permission sets do not map into common NT names such as <constant>read</constant>, + <constant>change</constant> or <constant>full control</constant>, usually the permissions will be prefixed + by the words <constant>Special Access</constant> in the NT display list.</para> + + <para>But what happens if the file has no permissions allowed for a particular UNIX user group or world component? In order + to allow <quote>no permissions</quote> to be seen and modified Samba then overloads the NT <constant>Take Ownership</constant> ACL attribute + (which has no meaning in UNIX) and reports a component with no permissions as having the NT <command>O</command> bit set. + This was chosen, of course, to make it look like a zero, meaning zero permissions. More details on the decision behind this is + given below.</para> </sect3> <sect3> <title>Directory Permissions</title> - <para>Directories on an NT NTFS file system have two - different sets of permissions. The first set of permissions - is the ACL set on the directory itself, this is usually displayed - in the first set of parentheses in the normal <constant>"RW"</constant> - NT style. This first set of permissions is created by Samba in - exactly the same way as normal file permissions are, described + <para>Directories on an NT NTFS file system have two different sets of permissions. The first set is the ACL set on the + directory itself, which is usually displayed in the first set of parentheses in the normal <constant>RW</constant> + NT style. This first set of permissions is created by Samba in exactly the same way as normal file permissions are, described above, and is displayed in the same way.</para> - <para>The second set of directory permissions has no real meaning - in the UNIX permissions world and represents the <constant> - inherited</constant> permissions that any file created within - this directory would inherit.</para> + <para>The second set of directory permissions has no real meaning in the UNIX permissions world and represents the <constant> + inherited</constant> permissions that any file created within this directory would inherit.</para> - <para>Samba synthesises these inherited permissions for NT by - returning as an NT ACL the UNIX permission mode that a new file + <para>Samba synthesises these inherited permissions for NT by returning as an NT ACL the UNIX permission mode that a new file created by Samba on this share would receive.</para> </sect3> </sect2> <sect2> - <title>Modifying file or directory permissions</title> + <title>Modifying File or Directory Permissions</title> <para>Modifying file and directory permissions is as simple as changing the displayed permissions in the dialog box, and - clicking the <guibutton>OK</guibutton> button. However, there are + clicking on <guibutton>OK</guibutton>. However, there are limitations that a user needs to be aware of, and also interactions with the standard Samba permission masks and mapping of DOS attributes that need to also be taken into account.</para> <para>If the parameter <smbconfoption><name>nt acl support</name></smbconfoption> - is set to <constant>false</constant> then any attempt to set - security permissions will fail with an <errorname>"Access Denied" + is set to <constant>false</constant>, any attempt to set + security permissions will fail with an <errorname>`Access Denied' </errorname> message.</para> - <para>The first thing to note is that the <guibutton>"Add"</guibutton> + <para>The first thing to note is that the <guibutton>Add</guibutton> button will not return a list of users in Samba (it will give - an error message of <errorname>The remote procedure call failed - and did not execute</errorname>). This means that you can only + an error message saying <errorname>`The remote procedure call failed + and did not execute'</errorname>). This means that you can only manipulate the current user/group/world permissions listed in the dialog box. This actually works quite well as these are the only permissions that UNIX actually has.</para> @@ -971,88 +995,82 @@ Before using any of the following options please refer to the man page for &smb. <para>If a permission triplet (either user, group, or world) is removed from the list of permissions in the NT dialog box, then when the <guibutton>OK</guibutton> button is pressed it will - be applied as "no permissions" on the UNIX side. If you then - view the permissions again the "no permissions" entry will appear - as the NT <command>"O"</command> flag, as described above. This + be applied as <quote>no permissions</quote> on the UNIX side. If you then + view the permissions again, the <quote>no permissions</quote> entry will appear + as the NT <command>O</command> flag, as described above. This allows you to add permissions back to a file or directory once you have removed them from a triplet component.</para> - <para>As UNIX supports only the "r", "w" and "x" bits of - an NT ACL then if other NT security attributes such as "Delete - access" are selected then they will be ignored when applied on - the Samba server.</para> + <para>As UNIX supports only the <quote>r</quote>, <quote>w</quote> and <quote>x</quote> bits of + an NT ACL, if other NT security attributes such as <constant>Delete Access</constant> are + selected they will be ignored when applied on the Samba server.</para> - <para>When setting permissions on a directory the second + <para>When setting permissions on a directory, the second set of permissions (in the second set of parentheses) is by default applied to all files within that directory. If this - is not what you want you must uncheck the <guilabel>Replace + is not what you want, you must uncheck the <guilabel>Replace permissions on existing files</guilabel> checkbox in the NT - dialog before clicking <guibutton>OK</guibutton>.</para> + dialog before clicking on <guibutton>OK</guibutton>.</para> <para>If you wish to remove all permissions from a - user/group/world component then you may either highlight the - component and click the <guibutton>Remove</guibutton> button, + user/group/world component, you may either highlight the + component and click on the <guibutton>Remove</guibutton> button, or set the component to only have the special <constant>Take - Ownership</constant> permission (displayed as <command>"O" + Ownership</constant> permission (displayed as <command>O </command>) highlighted.</para> </sect2> <sect2> - <title>Interaction with the standard Samba create mask - parameters</title> + <title>Interaction with the Standard Samba <quote>create mask</quote> Parameters</title> - <para>There are four parameters - to control interaction with the standard Samba create mask parameters. - These are : + <para>There are four parameters that control interaction with the standard Samba <parameter>create mask</parameter> parameters. + These are: <itemizedlist> - <listitem><para><smbconfoption><name>security mask</name></smbconfoption></para></listitem> - <listitem><para><smbconfoption><name>force security mode</name></smbconfoption></para></listitem> - <listitem><para><smbconfoption><name>directory security mask</name></smbconfoption></para></listitem> - <listitem><para><smbconfoption><name>force directory security mode</name></smbconfoption></para></listitem> - </itemizedlist> + <listitem><smbconfoption><name>security mask</name></smbconfoption></listitem> + <listitem><smbconfoption><name>force security mode</name></smbconfoption></listitem> + <listitem><smbconfoption><name>directory security mask</name></smbconfoption></listitem> + <listitem><smbconfoption><name>force directory security mode</name></smbconfoption></listitem> + </itemizedlist> </para> - <para>Once a user clicks <guibutton>OK</guibutton> to apply the - permissions Samba maps the given permissions into a user/group/world - r/w/x triplet set, and then will check the changed permissions for a + <para>Once a user clicks on <guibutton>OK</guibutton> to apply the + permissions, Samba maps the given permissions into a user/group/world + r/w/x triplet set, and then checks the changed permissions for a file against the bits set in the <smbconfoption><name>security mask</name></smbconfoption> parameter. Any bits that - were changed that are not set to '1' in this parameter are left alone + were changed that are not set to <quote>1</quote> in this parameter are left alone in the file permissions.</para> <para>Essentially, zero bits in the <smbconfoption><name>security mask</name></smbconfoption> - mask may be treated as a set of bits the user is <emphasis>not</emphasis> + may be treated as a set of bits the user is <emphasis>not</emphasis> allowed to change, and one bits are those the user is allowed to change. </para> - <para>If not set explicitly this parameter is set to the same value as - the <smbconfoption><name>create mask</name></smbconfoption> parameter. To allow a user to modify all the - user/group/world permissions on a file, set this parameter - to 0777.</para> + <para>If not explicitly set, this parameter defaults to the same value as + the <smbconfoption><name>create mask</name></smbconfoption> parameter. To allow a user to modify all the + user/group/world permissions on a file, set this parameter to 0777. + </para> - <para>Next Samba checks the changed permissions for a file against - the bits set in the + <para>Next Samba checks the changed permissions for a file against the bits set in the <smbconfoption><name>force security mode</name></smbconfoption> parameter. Any bits - that were changed that correspond to bits set to '1' in this parameter + that were changed that correspond to bits set to <quote>1</quote> in this parameter are forced to be set.</para> - <para>Essentially, bits set in the <parameter>force security mode - </parameter> parameter may be treated as a set of bits that, when - modifying security on a file, the user has always set to be 'on'.</para> + <para>Essentially, bits set in the <parameter>force security mode</parameter> parameter + may be treated as a set of bits that, when modifying security on a file, the user has always set to be <quote>on</quote>.</para> - <para>If not set explicitly this parameter is set to the same value - as the <smbconfoption><name>force create mode</name></smbconfoption> parameter. + <para>If not explicitly set, this parameter defaults to the same value + as the <smbconfoption><name>force create mode</name></smbconfoption> parameter. To allow a user to modify all the user/group/world permissions on a file - with no restrictions set this parameter to 000.</para> - - <para>The <smbconfoption><name>security mask</name></smbconfoption> and <parameter>force + with no restrictions set this parameter to 000. The + <smbconfoption><name>security mask</name></smbconfoption> and <parameter>force security mode</parameter> parameters are applied to the change request in that order.</para> - <para>For a directory Samba will perform the same operations as - described above for a file except using the parameter <parameter> + <para>For a directory, Samba will perform the same operations as + described above for a file except it uses the parameter <parameter> directory security mask</parameter> instead of <parameter>security mask</parameter>, and <parameter>force directory security mode </parameter> parameter instead of <parameter>force security mode @@ -1062,16 +1080,15 @@ Before using any of the following options please refer to the man page for &smb. by default is set to the same value as the <parameter>directory mask </parameter> parameter and the <parameter>force directory security mode</parameter> parameter by default is set to the same value as - the <smbconfoption><name>force directory mode</name></smbconfoption> parameter. </para> - - <para>In this way Samba enforces the permission restrictions that - an administrator can set on a Samba share, whilst still allowing users + the <smbconfoption><name>force directory mode</name></smbconfoption> parameter. + In this way Samba enforces the permission restrictions that + an administrator can set on a Samba share, while still allowing users to modify the permission bits within that restriction.</para> <para>If you want to set up a share that allows users full control in modifying the permission bits on their files and directories and - doesn't force any particular bits to be set 'on', then set the following - parameters in the &smb.conf; file in that share specific section : + does not force any particular bits to be set <quote>on</quote>, then set the following + parameters in the &smb.conf; file in that share-specific section: </para> <smbconfblock> @@ -1083,29 +1100,29 @@ Before using any of the following options please refer to the man page for &smb. </sect2> <sect2> - <title>Interaction with the standard Samba file attribute mapping</title> + <title>Interaction with the Standard Samba File Attribute Mapping</title> <note> - <para>Samba maps some of the DOS attribute bits (such as "read - only") into the UNIX permissions of a file. This means there can + <para>Samba maps some of the DOS attribute bits (such as <quote>read + only</quote>) into the UNIX permissions of a file. This means there can be a conflict between the permission bits set via the security dialog and the permission bits set by the file attribute mapping. </para> </note> - <para>One way this can show up is if a file has no UNIX read access - for the owner it will show up as "read only" in the standard - file attributes tabbed dialog. Unfortunately this dialog is - the same one that contains the security info in another tab.</para> + <para>If a file has no UNIX read access for the owner, it will show up + as <quote>read only</quote> in the standard file attributes tabbed dialog. + Unfortunately, this dialog is the same one that contains the security information + in another tab.</para> <para>What this can mean is that if the owner changes the permissions - to allow themselves read access using the security dialog, clicks + to allow himself read access using the security dialog, clicks on <guibutton>OK</guibutton> to get back to the standard attributes tab - dialog, and then clicks <guibutton>OK</guibutton> on that dialog, then + dialog, and clicks on <guibutton>OK</guibutton> on that dialog, then NT will set the file permissions back to read-only (as that is what the attributes still say in the dialog). This means that after setting - permissions and clicking <guibutton>OK</guibutton> to get back to the - attributes dialog you should always hit <guibutton>Cancel</guibutton> + permissions and clicking on <guibutton>OK</guibutton> to get back to the + attributes dialog, you should always press <guibutton>Cancel</guibutton> rather than <guibutton>OK</guibutton> to ensure that your changes are not overridden.</para> </sect2> @@ -1115,31 +1132,31 @@ Before using any of the following options please refer to the man page for &smb. <title>Common Errors</title> <para> -File, Directory and Share access problems are very common on the mailing list. The following +File, directory and share access problems are common on the mailing list. The following are examples taken from the mailing list in recent times. </para> <sect2> - <title>Users can not write to a public share</title> + <title>Users Cannot Write to a Public Share</title> <para> <quote> - We are facing some troubles with file / directory permissions. I can log on the domain as admin user(root), - and there's a public share, on which everyone needs to have permission to create / modify files, but only - root can change the file, no one else can. We need to constantly go to server to + We are facing some troubles with file/directory permissions. I can log on the domain as admin user(root), + and there's a public share on which everyone needs to have permission to create/modify files, but only + root can change the file, no one else can. We need to constantly go to the server to <userinput>chgrp -R users *</userinput> and <userinput>chown -R nobody *</userinput> to allow others users to change the file. </quote> </para> <para> - There are many ways to solve this problem, here are a few hints: + There are many ways to solve this problem and here are a few hints: </para> <procedure> <step> <para> - Go to the top of the directory that is shared + Go to the top of the directory that is shared. </para> </step> @@ -1155,7 +1172,7 @@ are examples taken from the mailing list in recent times. </para> <note><para> - The above will set the 'sticky bit' on all directories. Read your + The above will set the <constant>sticky bit</constant> on all directories. Read your UNIX/Linux man page on what that does. It causes the OS to assign to all files created in the directories the ownership of the directory. @@ -1170,16 +1187,16 @@ are examples taken from the mailing list in recent times. </screen> </para> - <note> + <note><para> <para>This is the same as doing:</para> <screen> &prompt;<userinput>chown jack /foodbar</userinput> &prompt;<userinput>chgrp engr /foodbar</userinput> </screen> - </note> + </para></note> </step> <step> - <para>Now do: + <para>Now type: <screen> &prompt;<userinput>chmod 6775 /foodbar</userinput> @@ -1196,7 +1213,7 @@ drwsrwsr-x 2 jack engr 48 2003-02-04 09:55 foodbar </step> <step> - <para>Now do: + <para>Now type: <screen> &prompt;<userinput>su - jill</userinput> &prompt;<userinput>cd /foodbar</userinput> @@ -1224,8 +1241,8 @@ drwsrwsr-x 2 jack engr 48 2003-02-04 09:55 foodbar </para> <note><para> - The above are only needed <emphasis>if</emphasis> your users are <emphasis>not</emphasis> members of the group - you have used. ie: Within the OS do not have write permission on the directory. + These procedures are needed only if your users are not members of the group + you have used. That is if within the OS do not have write permission on the directory. </para> </note> @@ -1242,34 +1259,35 @@ drwsrwsr-x 2 jack engr 48 2003-02-04 09:55 foodbar <sect2> - <title>I have set force user but Samba still makes <emphasis>root</emphasis> the owner of all the files I touch!</title> + <title>File Operations Done as <emphasis>root</emphasis> with <emphasis>force user</emphasis> Set</title> + <para> - When you have a user in <smbconfoption><name>admin users</name></smbconfoption>, samba will always do file operations for - this user as <emphasis>root</emphasis>, even if <smbconfoption><name>force user</name></smbconfoption> has been set. + When you have a user in <smbconfoption><name>admin users</name></smbconfoption>, Samba will always do file operations for + this user as <emphasis>root</emphasis>, even if <smbconfoption><name>force user</name></smbconfoption> has been set. </para> </sect2> <sect2> - <title>MS Word with Samba changes owner of file</title> + <title>MS Word with Samba Changes Owner of File</title> <para> - <emphasis>Question:</emphasis> <quote>When userB saves a word document that is owned by userA the updated file is now owned by userB. + <emphasis>Question:</emphasis> <quote>When user B saves a word document that is owned by user A the updated file is now owned by user B. Why is Samba doing this? How do I fix this?</quote> </para> <para> - <emphasis>Answer:</emphasis> Word does the following when you modify/change a Word document: Word Creates a NEW document with + <emphasis>Answer:</emphasis> Word does the following when you modify/change a Word document: MS Word creates a NEW document with a temporary name, Word then closes the old document and deletes it, Word then renames the new document to the original document name. - There is NO mechanism by which Samba CAN IN ANY WAY know that the new document really should be owned by the owners - of the original file. Samba has no way of knowing that the file will be renamed by MS Word. As far as Samba is able + There is no mechanism by which Samba can in any way know that the new document really should be owned by the owners + of the original file. Samba has no way of knowing that the file will be renamed by MS Word. As far as Samba is able to tell, the file that gets created is a NEW file, not one that the application (Word) is updating. </para> <para> There is a work-around to solve the permissions problem. That work-around involves understanding how you can manage file - system behaviour from within the &smb.conf; file, as well as understanding how Unix file systems work. Set on the directory - in which you are changing word documents: <command>chmod g+s 'directory_name'</command> This ensures that all files will - be created with the group that owns the directory. In smb.conf share declaration section set: + system behavior from within the &smb.conf; file, as well as understanding how UNIX file systems work. Set on the directory + in which you are changing Word documents: <command>chmod g+s `directory_name'</command> This ensures that all files will + be created with the group that owns the directory. In &smb.conf; share declaration section set: </para> <para> diff --git a/docs/docbook/projdoc/AdvancedNetworkAdmin.xml b/docs/docbook/projdoc/AdvancedNetworkAdmin.xml index ee1f351e41..65d50b496e 100644 --- a/docs/docbook/projdoc/AdvancedNetworkAdmin.xml +++ b/docs/docbook/projdoc/AdvancedNetworkAdmin.xml @@ -9,7 +9,7 @@ <para> This section documents peripheral issues that are of great importance to network administrators who want to improve network resource access control, to automate the user -environment, and to make their lives a little easier. +environment and to make their lives a little easier. </para> <sect1> @@ -17,15 +17,16 @@ environment, and to make their lives a little easier. <para> Often the difference between a working network environment and a well appreciated one can -best be measured by the <emphasis>little things</emphasis> that makes everything work more -harmoniously. A key part of every network environment solution is the ability to remotely -manage MS Windows workstations, to remotely access the Samba server, to provide customised -logon scripts, as well as other house keeping activities that help to sustain more reliable +best be measured by the <emphasis>little things</emphasis> that make everything work more +harmoniously. A key part of every network environment solution is the +ability to remotely +manage MS Windows workstations, remotely access the Samba server, provide customized +logon scripts, as well as other housekeeping activities that help to sustain more reliable network operations. </para> <para> -This chapter presents information on each of these area. They are placed here, and not in +This chapter presents information on each of these areas. They are placed here, and not in other chapters, for ease of reference. </para> @@ -34,35 +35,37 @@ other chapters, for ease of reference. <sect1> <title>Remote Server Administration</title> -<para> -<emphasis>How do I get 'User Manager' and 'Server Manager'?</emphasis> -</para> + +<para><quote>How do I get `User Manager' and `Server Manager'?</quote></para> <para> - Since I don't need to buy an <application>NT4 Server</application>, how do I get the 'User Manager for Domains', -the 'Server Manager'? +<indexterm><primary>User Manager</primary></indexterm> +<indexterm><primary>Server Manager</primary></indexterm> +<indexterm><primary>Event Viewer</primary></indexterm> +Since I do not need to buy an <application>NT4 Server</application>, how do I get the `User Manager for Domains' +and the `Server Manager'? </para> <para> -Microsoft distributes a version of these tools called nexus for installation -on <application>Windows 9x / Me</application> systems. The tools set includes: +<indexterm><primary>Nexus.exe</primary></indexterm> +Microsoft distributes a version of these tools called <filename>Nexus.exe</filename> for installation +on <application>Windows 9x/Me</application> systems. The tools set includes: </para> -<simplelist> - <member>Server Manager</member> - <member>User Manager for Domains</member> - <member>Event Viewer</member> -</simplelist> +<itemizedlist> + <listitem>Server Manager</listitem> + <listitem>User Manager for Domains</listitem> + <listitem>Event Viewer</listitem> +</itemizedlist> <para> -Click here to download the archived file <ulink -url="ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE</ulink> +Download the archived file at <ulink noescape="1" url="ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE.</ulink> </para> <para> -The <application>Windows NT 4.0</application> version of the 'User Manager for -Domains' and 'Server Manager' are available from Microsoft via ftp -from <ulink url="ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE</ulink> +<indexterm><primary>SRVTOOLS.EXE</primary></indexterm> +The <application>Windows NT 4.0</application> version of the `User Manager for +Domains' and `Server Manager' are available from Microsoft <ulink url="ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE">via ftp</ulink>. </para> </sect1> @@ -72,87 +75,83 @@ from <ulink url="ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE">ftp://ft <para> There are a number of possible remote desktop management solutions that range from free -through costly. Do not let that put you off. Sometimes the most costly solutions is the +through costly. Do not let that put you off. Sometimes the most costly solution is the most cost effective. In any case, you will need to draw your own conclusions as to which is the best tool in your network environment. </para> <sect2> - <title>Remote Management from NoMachines.Com</title> + <title>Remote Management from NoMachine.Com</title> <para> + <indexterm><primary>NoMachine.Com</primary></indexterm> The following information was posted to the Samba mailing list at Apr 3 23:33:50 GMT 2003. It is presented in slightly edited form (with author details omitted for privacy reasons). The entire answer is reproduced below with some comments removed. </para> -<para> -<screen> -> I have a wonderful linux/samba server running as PDC for a network. -> Now I would like to add remote desktop capabilities so that -> users outside could login to the system and get their desktop up from -> home or another country.. -> -> Is there a way to accomplish this? Do I need a windows terminal server? -> Do I need to configure it so that it is a member of the domain or a -> BDC,PDC? Are there any hacks for MS Windows XP to enable remote login -> even if the computer is in a domain? -> -> Any ideas/experience would be appreciated :) -</screen> -</para> + <para><quote> + I have a wonderful Linux/Samba server running as pdc for a network. Now I would like to add remote + desktop capabilities so users outside could login to the system and get their desktop up from home or + another country. + </quote></para> - <para> - Answer provided: Check out the new offer from NoMachine, "NX" software: - <ulink url="http://www.nomachine.com/">http://www.nomachine.com/</ulink>. - </para> + <para><quote> + Is there a way to accomplish this? Do I need a Windows Terminal Server? Do I need to configure it so + it is a member of the domain or a BDC,PDC? Are there any hacks for MS Windows XP to enable remote login + even if the computer is in a domain? + </quote></para> + + <para> + Answer provided: Check out the new offer from NoMachine, <quote>NX</quote> software: + <ulink noescape="1" url="http://www.nomachine.com/">http://www.nomachine.com/</ulink>. + </para> <para> - It implements a very easy-to-use interface to the remote X protocol as + It implements an easy-to-use interface to the Remote X protocol as well as incorporating VNC/RFB and rdesktop/RDP into it, but at a speed - performance much better than anything you may have ever seen... + performance much better than anything you may have ever seen. </para> <para> - Remote X is not new at all -- but what they did achieve successfully is - a new way of compression and caching technologies which makes the thing + Remote X is not new at all, but what they did achieve successfully is + a new way of compression and caching technologies that makes the thing fast enough to run even over slow modem/ISDN connections. </para> <para> - I could test drive their (public) RedHat machine in Italy, over a loaded - internet connection, with enabled thumbnail previews in KDE konqueror - which popped up immediately on "mouse-over". From inside that (remote X) + I could test drive their (public) Red Hat machine in Italy, over a loaded + Internet connection, with enabled thumbnail previews in KDE konqueror + which popped up immediately on <quote>mouse-over</quote>. From inside that (remote X) session I started a rdesktop session on another, a Windows XP machine. - To test the performance, I played Pinball. I am proud to announce here - that my score was 631750 points at first try... + To test the performance, I played Pinball. I am proud to announce + that my score was 631750 points at first try. </para> <para> - NX performs better on my local LAN than any of the other "pure" + NX performs better on my local LAN than any of the other <quote>pure</quote> connection methods I am using from time to time: TightVNC, rdesktop or - remote X. It is even faster than a direct crosslink connection between + Remote X. It is even faster than a direct crosslink connection between two nodes. </para> <para> - I even got sound playing from the remote X app to my local boxes, and - had a working "copy'n'paste" from an NX window (running a KDE session - in Italy) to my Mozilla mailing agent... These guys are certainly doing + I even got sound playing from the Remote X app to my local boxes, and + had a working <quote>copy'n'paste</quote> from an NX window (running a KDE session + in Italy) to my Mozilla mailing agent. These guys are certainly doing something right! </para> <para> - I recommend to test drive NX to anybody with a only a remote interest - in remote computing - <ulink url="http://www.nomachine.com/testdrive.php">http://www.nomachine.com/testdrive.php</ulink>. + I recommend to test drive NX to anybody with a only a passing interest in remote computing + <ulink noescape="1" url="http://www.nomachine.com/testdrive.php">http://www.nomachine.com/testdrive.php</ulink>. </para> <para> - Just download the free of charge client software (available for RedHat, - SuSE, Debian and Windows) and be up and running within 5 minutes (they + Just download the free of charge client software (available for Red Hat, + SuSE, Debian and Windows) and be up and running within five minutes (they need to send you your account data, though, because you are assigned - a real Unix account on their testdrive.nomachine.com box... + a real UNIX account on their testdrive.nomachine.com box. </para> <para> @@ -160,17 +159,17 @@ is the best tool in your network environment. running as a cluster of nodes, and users simply start an NX session locally, and can select applications to run transparently (apps may even run on another NX node, but pretend to be on the same as used for initial login, - because it displays in the same window.... well, you also can run it + because it displays in the same window. You also can run it fullscreen, and after a short time you forget that it is a remote session at all). </para> <para> - Now the best thing at the end: all the core compression and caching + Now the best thing for last: All the core compression and caching technologies are released under the GPL and available as source code to anybody who wants to build on it! These technologies are working, albeit started from the command line only (and very inconvenient to - use in order to get a fully running remote X session up and running....) + use in order to get a fully running remote X session up and running.) </para> <para> @@ -179,32 +178,32 @@ is the best tool in your network environment. <itemizedlist> <listitem><para> - You don't need to install a terminal server; XP has RDP support built in. + You do not need to install a terminal server; XP has RDP support built in. </para></listitem> <listitem><para> - NX is much cheaper than Citrix -- and comparable in performance, probably faster + NX is much cheaper than Citrix &smbmdash; and comparable in performance, probably faster. </para></listitem> <listitem><para> - You don't need to hack XP -- it just works + You do not need to hack XP &smbmdash; it just works. </para></listitem> <listitem><para> You log into the XP box from remote transparently (and I think there is no - need to change anything to get a connection, even if authentication is against a domain) + need to change anything to get a connection, even if authentication is against a domain). </para></listitem> <listitem><para> - The NX core technologies are all Open Source and released under the GPL -- - you can today use a (very inconvenient) commandline to use it at no cost, - but you can buy a comfortable (proprietary) NX GUI frontend for money + The NX core technologies are all Open Source and released under the GPL &smbmdash; + you can now use a (very inconvenient) commandline at no cost, + but you can buy a comfortable (proprietary) NX GUI frontend for money. </para></listitem> <listitem><para> NoMachine are encouraging and offering help to OSS/Free Software implementations for such a frontend too, even if it means competition to them (they have written - to this effect even to the LTSP, KDE and GNOME developer mailing lists) + to this effect even to the LTSP, KDE and GNOME developer mailing lists). </para></listitem> </itemizedlist> @@ -216,22 +215,17 @@ is the best tool in your network environment. <title>Network Logon Script Magic</title> <para> -This section needs work. Volunteer contributions most welcome. Please send your patches or updates -to <ulink url="mailto:jht@samba.org">John Terpstra</ulink>. -</para> - -<para> There are several opportunities for creating a custom network startup configuration environment. </para> -<simplelist> - <member>No Logon Script</member> - <member>Simple universal Logon Script that applies to all users</member> - <member>Use of a conditional Logon Script that applies per user or per group attributes</member> - <member>Use of Samba's Preexec and Postexec functions on access to the NETLOGON share to create - a custom Logon Script and then execute it.</member> - <member>User of a tool such as KixStart</member> -</simplelist> +<itemizedlist> + <listitem>No Logon Script.</listitem> + <listitem>Simple universal Logon Script that applies to all users.</listitem> + <listitem>Use of a conditional Logon Script that applies per user or per group attributes.</listitem> + <listitem>Use of Samba's preexec and postexec functions on access to the NETLOGON share to create + a custom logon script and then execute it.</listitem> + <listitem>User of a tool such as KixStart.</listitem> +</itemizedlist> <para> The Samba source code tree includes two logon script generation/execution tools. @@ -243,7 +237,9 @@ See <filename>examples</filename> directory <filename>genlogon</filename> and The following listings are from the genlogon directory. </para> + <para> +<indexterm><primary>genlogon.pl</primary></indexterm> This is the <filename>genlogon.pl</filename> file: <programlisting> @@ -252,8 +248,8 @@ This is the <filename>genlogon.pl</filename> file: # genlogon.pl # # Perl script to generate user logon scripts on the fly, when users - # connect from a Windows client. This script should be called from smb.conf - # with the %U, %G and %L parameters. I.e: + # connect from a Windows client. This script should be called from + # smb.conf with the %U, %G and %L parameters. I.e: # # root preexec = genlogon.pl %U %G %L # @@ -274,7 +270,8 @@ This is the <filename>genlogon.pl</filename> file: #($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); open LOG, ">>/var/log/samba/netlogon.log"; - print LOG "$mon/$mday/$year $hour:$min:$sec - User $ARGV[0] logged into $ARGV[1]\n"; + print LOG "$mon/$mday/$year $hour:$min:$sec"; + print LOG " - User $ARGV[0] logged into $ARGV[1]\n"; close LOG; # Start generating logon script @@ -300,7 +297,7 @@ This is the <filename>genlogon.pl</filename> file: print LOGON "NET USE K: \\\\$ARGV[2]\\MKTING\r\n"; } - # Now connect Printers. We handle just two or three users a little + # Now connect Printers. We handle just two or three users a little # differently, because they are the exceptions that have desktop # printers on LPT1: - all other user's go to the LaserJet on the # server. @@ -322,40 +319,30 @@ This is the <filename>genlogon.pl</filename> file: </para> <para> -Those wishing to use more elaborate or capable logon processing system should check out the following sites: +Those wishing to use more elaborate or capable logon processing system should check out these sites: </para> -<simplelist> - <member><ulink url="http://www.craigelachie.org/rhacer/ntlogon">http://www.craigelachie.org/rhacer/ntlogon</ulink></member> - <member><ulink url="http://www.kixtart.org">http://www.kixtart.org</ulink></member> - <member><ulink url="http://support.microsoft.com/default.asp?scid=kb;en-us;189105">http://support.microsoft.com/default.asp?scid=kb;en-us;189105</ulink></member> -</simplelist> +<itemizedlist> + <listitem><ulink noescape="1" url="http://www.craigelachi.e.org/rhacer/ntlogon">http://www.craigelachi.e.org/rhacer/ntlogon</ulink></listitem> + <listitem><ulink noescape="1" url="http://www.kixtart.org">http://www.kixtart.org</ulink></listitem> +</itemizedlist> <sect2> -<title>Adding printers without user intervention</title> +<title>Adding Printers without User Intervention</title> + <para> +<indexterm><primary>rundll32</primary></indexterm> Printers may be added automatically during logon script processing through the use of: -<programlisting> - rundll32 printui.dll,PrintUIEntry /? -</programlisting> +<screen> +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /?</userinput> +</screen> -See the documentation in the <ulink url="http://support.microsoft.com/default.asp?scid=kb;en-us;189105">Microsoft knowledgebase article no: 189105</ulink>. +See the documentation in the <ulink url="http://support.microsoft.com/default.asp?scid=kb;en-us;189105">Microsoft knowledgebase article 189105.</ulink> </para> </sect2> </sect1> -<sect1> -<title>Common Errors</title> - -<para> -The information provided in this chapter has been reproduced from postings on the samba@samba.org -mailing list. No implied endorsement or recommendation is offered. Administrators should conduct -their own evaluation of alternatives and are encouraged to draw their own conclusions. -</para> - -</sect1> - </chapter> diff --git a/docs/docbook/projdoc/Bugs.xml b/docs/docbook/projdoc/Bugs.xml index 0688e23cf3..15bd14ac1a 100644 --- a/docs/docbook/projdoc/Bugs.xml +++ b/docs/docbook/projdoc/Bugs.xml @@ -1,8 +1,9 @@ <chapter id="bugreport"> <chapterinfo> + &author.jht; &author.jelmer; - &author.tridge; <!-- This is mostly a guess --> + &author.tridge; <pubdate> 27 June 1997 </pubdate> </chapterinfo> @@ -11,79 +12,76 @@ <sect1> <title>Introduction</title> -<para>Please report bugs using - <ulink url="https://bugzilla.samba.org/">bugzilla</ulink>.</para> - -<para> -Please take the time to read this file before you submit a bug -report. Also, please see if it has changed between releases, as we -may be changing the bug reporting mechanism at some time. +<para>Please report bugs using Samba's +<ulink url="https://bugzilla.samba.org/">Bugzilla</ulink> facilities and +take the time to read this file before you submit a bug +report. Also, check to see if it has changed between releases, as we +may be changing the bug reporting mechanism at some point. </para> <para> -Please also do as much as you can yourself to help track down the +Please do as much as you can yourself to help track down the bug. Samba is maintained by a dedicated group of people who volunteer -their time, skills and efforts. We receive far more mail 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 +their time, skills and efforts. We receive far more mail than +we can possibly answer, so you have a much higher chance of a response +and a fix if you send us a <quote>developer friendly</quote> bug report that lets us fix it fast. </para> <para> Do not assume that if you post the bug to the comp.protocols.smb newsgroup or the mailing list that we will read it. If you suspect that your -problem is not a bug but a configuration problem then it is better to send -it to the Samba mailing list, as there are (at last count) 5000 other users on -that list that may be able to help you. +problem is not a bug but a configuration problem, it is better to send +it to the Samba mailing list, as there are thousands of other users on +that list who may be able to help you. </para> <para> You may also like to look though the recent mailing list archives, -which are conveniently accessible on the Samba web pages +which are conveniently accessible on the Samba Web pages at <ulink noescape="1" url="http://samba.org/samba/">http://samba.org/samba/</ulink>. </para> </sect1> <sect1> -<title>General info</title> +<title>General Information</title> <para> -Before submitting a bug report check your config for silly -errors. Look in your log files for obvious messages that tell you that -you've misconfigured something and run testparm to test your config +Before submitting a bug report, check your config for silly +errors. Look in your log files for obvious messages that tell +you've misconfigured something. Run testparm to check your config file for correct syntax. </para> <para> -Have you run through the <link linkend="diagnosis">diagnosis</link>? -This is very important. +Have you looked through <link linkend="diagnosis"/>? This is extremely important. </para> <para> -If you include part of a log file with your bug report then be sure to +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. +time and exactly what the results were. </para> </sect1> <sect1> -<title>Debug levels</title> +<title>Debug Levels</title> <para> If the bug has anything to do with Samba behaving incorrectly as a -server (like refusing to open a file) then the log files will probably -be very useful. Depending on the problem a log level of between 3 and +server (like refusing to open a file), then the log files will probably +be quite useful. Depending on the problem, a log level of between 3 and 10 showing the problem may be appropriate. A higher level gives more detail, but may use too much disk space. </para> <para> -To set the debug level use the <smbconfoption><name>log level</name></smbconfoption> in your +To set the debug level, use the <smbconfoption><name>log level</name></smbconfoption> 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 add the following lines to your main &smb.conf; file: +To do this, add the following lines to your main &smb.conf; file: </para> <para><smbconfblock> @@ -93,47 +91,46 @@ To do this add the following lines to your main &smb.conf; file: </smbconfblock></para> <para> -then create a file -<filename>/usr/local/samba/lib/smb.conf.<replaceable>machine</replaceable></filename> where +and create a file <filename>/usr/local/samba/lib/smb.conf.<replaceable>machine</replaceable></filename> where <replaceable>machine</replaceable> is the name of the client you wish to debug. In that file put any &smb.conf; commands you want, for example <smbconfoption><name>log level</name></smbconfoption> may be useful. This also allows you to -experiment with different security systems, protocol levels etc on just +experiment with different security systems, protocol levels and so on, on just one machine. </para> <para> The &smb.conf; entry <smbconfoption><name>log level</name></smbconfoption> is synonymous with the parameter <smbconfoption><name>debuglevel</name></smbconfoption> that has -been used in older versions of Samba and is being retained for backwards +been used in older versions of Samba and is being retained for backward compatibility of &smb.conf; files. </para> <para> -As the <smbconfoption><name>log level</name></smbconfoption> 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 +As the <smbconfoption><name>log level</name></smbconfoption> value is increased, you will record +a significantly greater level of debugging information. For most +debugging operations, you may not need a setting higher than <constant>3</constant>. Nearly all bugs can be tracked at a setting of <constant>10</constant>, but be -prepared for a VERY large volume of log data. +prepared for a large volume of log data. </para> </sect1> <sect1> -<title>Internal errors</title> +<title>Internal Errors</title> <para> -If you get a <errorname>INTERNAL ERROR</errorname> message in your log files +If you get the message <quote><errorname>INTERNAL ERROR</errorname></quote> in your log files, it means that Samba got an unexpected signal while running. It is probably a segmentation fault and almost certainly means a bug in Samba (unless you have faulty hardware or system software). </para> <para> -If the message came from smbd then it will probably be accompanied by -a message which details the last SMB message received by smbd. This -info is often very useful in tracking down the problem so please +If the message came from smbd, it will probably be accompanied by +a message that details the last SMB message received by smbd. This +information is often useful in tracking down the problem so please include it in your bug report. </para> @@ -142,17 +139,17 @@ You should also detail how to reproduce the problem, if possible. Please make this reasonably detailed. </para> -<indexterm><primary>core files</primary></indexterm> <para> +<indexterm><primary>core files</primary></indexterm> You may also find that a core file appeared in a <filename>corefiles</filename> -subdirectory of the directory where you keep your samba log +subdirectory of the directory where you keep your Samba log files. This file is the most useful tool for tracking down the bug. To -use it you do this: -</para> - +use it, you do this: <indexterm><primary>gdb</primary></indexterm> <indexterm><primary>debug</primary></indexterm> +</para> + <screen> &prompt;<userinput>gdb smbd core</userinput> @@ -160,29 +157,28 @@ use it you do this: <para> adding appropriate paths to smbd and core so gdb can find them. If you -don't have gdb then try <userinput>dbx</userinput>. Then within the debugger +do not have gdb, try <userinput>dbx</userinput>. Then within the debugger, use the command <command>where</command> to give a stack trace of where the problem occurred. Include this in your report. </para> <para> -If you know any assembly language then do a -<command>disass</command> of the routine -where the problem occurred (if its in a library routine then +If you know any assembly language, do a <command>disass</command> 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, including this info in the bug report can be +do not know assembly, including this information in the bug report can be useful. </para> </sect1> <sect1> -<title>Attaching to a running process</title> +<title>Attaching to a Running Process</title> <para> -Unfortunately some unixes (in particular some recent linux kernels) +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 +does often). To debug with this sort of system, you could try to attach to the running process using <userinput>gdb smbd <replaceable>PID</replaceable></userinput> where you get <replaceable>PID</replaceable> from <application>smbstatus</application>. @@ -196,12 +192,12 @@ where it occurred. <sect1> <title>Patches</title> -<indexterm><primary>diff</primary></indexterm> -<indexterm><primary>patch</primary></indexterm> <para> +<indexterm><primary>diff</primary></indexterm> +<indexterm><primary>patch</primary></indexterm> The best sort of bug report is one that includes a fix! If you send us -patches please use <userinput>diff -u</userinput> format if your version of +patches, please use <userinput>diff -u</userinput> format if your version of diff supports it, otherwise use <userinput>diff -c4</userinput>. Make sure you do the diff against a clean version of the source and let me know exactly what version you used. diff --git a/docs/docbook/projdoc/CUPS-printing.xml b/docs/docbook/projdoc/CUPS-printing.xml index 945092d413..5a8e9f5846 100644 --- a/docs/docbook/projdoc/CUPS-printing.xml +++ b/docs/docbook/projdoc/CUPS-printing.xml @@ -22,7 +22,7 @@ <pubdate> (3 June 2003) </pubdate> </chapterinfo> -<title>CUPS Printing Support in Samba 3.0</title> +<title>CUPS Printing Support</title> <sect1> @@ -32,26 +32,25 @@ <title>Features and Benefits</title> <para> - The Common UNIX Print System (<ulink - url="http://www.cups.org/">CUPS</ulink>) has become very popular. All - major Linux distributions now ship it as their default printing - system. To many it is still a very mystical tool. Mostly, it - "just works" (TM). People tend to regard it as a "black box" - which they don't want to look into, as long as it works. But once - there is a little problem, they are in trouble to find out where to - start debugging it. Refer to the "Classical Printing" chapter also, it - contains a lot of information that is relevant for CUPS. + The Common UNIX Print System (<ulink url="http://www.cups.org/">CUPS</ulink>) + has become quite popular. All major Linux distributions now ship it as their default printing + system. To many, it is still a mystical tool. Mostly, it just works. + People tend to regard it as a <quote>black box</quote> + that they do not want to look into as long as it works. But once + there is a little problem, they are in trouble to find out where to + start debugging it. Refer to the chapter <quote>Classical Printing</quote> that + contains a lot of information that is relevant for CUPS. </para> <para> - CUPS sports quite a few unique and powerful features. While their - basic functions may be grasped quite easily, they are also - new. Because they are different from other, more traditional printing - systems, it is best to try and not apply any prior knowledge about - printing upon this new system. Rather, try to understand CUPS - from the beginning. This documentation will lead you to a - complete understanding of CUPS. Let's start with the most basic - things first. + CUPS sports quite a few unique and powerful features. While their + basic functions may be grasped quite easily, they are also + new. Because they are different from other, more traditional printing + systems, it is best not to try and apply any prior knowledge about + printing to this new system. Rather, try to understand CUPS + from the beginning. This documentation will lead you to a + complete understanding of CUPS. Let's start with the most basic + things first. </para> </sect2> @@ -60,65 +59,64 @@ <title>Overview</title> <para> - CUPS is more than just a print spooling system. It is a complete - printer management system that complies with the new IPP - (<emphasis>Internet Printing Protocol</emphasis>). IPP is an industry - and IETF (<emphasis>Internet Engineering Task Force</emphasis>) - standard for network printing. Many of its functions can be managed - remotely (or locally) via a web browser (giving you a - platform-independent access to the CUPS print server). Additionally, it - has the traditional command line and several more modern GUI interfaces - (GUI interfaces developed by 3rd parties, like KDE's - overwhelming <ulink url="http://printing.kde.org/">KDEPrint</ulink>). + CUPS is more than just a print spooling system. It is a complete + printer management system that complies with the new + Internet Printing Protocol (IPP). IPP is an industry + and Internet Engineering Task Force (IETF) + standard for network printing. Many of its functions can be managed + remotely (or locally) via a Web browser (giving you a + platform-independent access to the CUPS print server). Additionally, it + has the traditional command line and several more modern GUI interfaces + (GUI interfaces developed by third parties, like KDE's + overwhelming <ulink url="http://printing.kde.org/">KDEPrint</ulink>). </para> <para> - CUPS allows creation of "raw" printers (ie: NO print file - format translation) as well as "smart" printers (i.e. CUPS does - file format conversion as required for the printer). In many ways - this gives CUPS similar capabilities to the MS Windows print - monitoring system. Of course, if you are a CUPS advocate, you would - argue that CUPS is better! In any case, let us now move on to - explore how one may configure CUPS for interfacing with MS Windows - print clients via Samba. + CUPS allows creation of <quote>raw</quote> printers (i.e., no print file + format translation) as well as <quote>smart</quote> printers (i.e., CUPS does + file format conversion as required for the printer). In many ways + this gives CUPS similar capabilities to the MS Windows print + monitoring system. Of course, if you are a CUPS advocate, you would + argue that CUPS is better! In any case, let us now move on to + explore how one may configure CUPS for interfacing with MS Windows + print clients via Samba. </para> </sect2> </sect1> <sect1> - <title>Basic Configuration of CUPS support</title> + <title>Basic CUPS Support Configuration</title> <para> - Printing with CUPS in the most basic &smb.conf; setup in Samba 3.0 (as was true for 2.2.x) only needs two - settings: <smbconfoption><name>printing</name><value>cups</value></smbconfoption> and - <smbconfoption><name>printcap</name><value>cups</value></smbconfoption>. CUPS does not need a printcap file. - However, the <filename>cupsd.conf</filename> configuration file knows of two related directives that control - how such a file will be automatically created and maintained by CUPS for the convenience of third party - applications (example: <parameter>Printcap /etc/printcap</parameter> and <parameter>PrintcapFormat BSD</parameter>). - Legacy programs often require the existence of a printcap file containing printer names or they will refuse to - print. Make sure CUPS is set to generate and maintain a printcap file! For details see - <command>man cupsd.conf</command> and other CUPS-related documentation, like the wealth of documents on your CUPS server - itself: <ulink noescape="1" url="http://localhost:631/documentation.html">http://localhost:631/documentation.html</ulink>. + Printing with CUPS in the most basic &smb.conf; setup in Samba-3.0 (as was true for 2.2.x) only needs two + settings: <smbconfoption><name>printing</name><value>cups</value></smbconfoption> and + <smbconfoption><name>printcap</name><value>cups</value></smbconfoption>. CUPS does not need a printcap file. + However, the <filename>cupsd.conf</filename> configuration file knows of two related directives that control + how such a file will be automatically created and maintained by CUPS for the convenience of third-party + applications (example: <parameter>Printcap /etc/printcap</parameter> and <parameter>PrintcapFormat BSD</parameter>). + Legacy programs often require the existence of a printcap file containing printer names or they will refuse to + print. Make sure CUPS is set to generate and maintain a printcap file. For details, see + <command>man cupsd.conf</command> and other CUPS-related documentation, like the wealth of documents on your CUPS server + itself: <ulink noescape="1" url="http://localhost:631/documentation.html">http://localhost:631/documentation.html</ulink>. </para> <sect2> - <title>Linking of smbd with libcups.so</title> + <title>Linking smbd with libcups.so</title> <para> - Samba has a very special relationship to CUPS. Samba can be compiled with CUPS library support. - Most recent installations have this support enabled. Per default CUPS linking is compiled - into smbd and other Samba binaries. Of course, you can use CUPS even - if Samba is not linked against <filename>libcups.so</filename> -- but - there are some differences in required or supported configuration - then. + Samba has a special relationship to CUPS. Samba can be compiled with CUPS library support. + Most recent installations have this support enabled. Per default, CUPS linking is compiled + into smbd and other Samba binaries. Of course, you can use CUPS even + if Samba is not linked against <filename>libcups.so</filename> &smbmdash; but + there are some differences in required or supported configuration. </para> <para> - When Samba is compiled against libcups, <smbconfoption><name>printcap</name><value>cups</value></smbconfoption> - uses the CUPS API to list printers, submit jobs, query queues, etc. Otherwise it maps to the System V - commands with an additional <command>-oraw</command> option for printing. On a Linux - system, you can use the <command>ldd</command> utility to find out details (ldd may not be present on - other OS platforms, or its function may be embodied by a different command): + When Samba is compiled against <filename>libcups</filename>, <smbconfoption><name>printcap</name><value>cups</value></smbconfoption> + uses the CUPS API to list printers, submit jobs, query queues, and so on. Otherwise it maps to the System V + commands with an additional <command>-oraw</command> option for printing. On a Linux + system, you can use the <command>ldd</command> utility to find out details (ldd may not be present on + other OS platforms, or its function may be embodied by a different command): </para> <para><screen> @@ -130,32 +128,33 @@ libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000) </screen></para> <para> - The line <computeroutput>libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000)</computeroutput> shows - there is CUPS support compiled into this version of Samba. If this is the case, and printing = cups - is set, then <emphasis>any otherwise manually set print command in &smb.conf; is ignored</emphasis>. - This is an important point to remember! + The line <computeroutput>libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000)</computeroutput> shows + there is CUPS support compiled into this version of Samba. If this is the case, and printing = cups + is set, then <emphasis>any otherwise manually set print command in &smb.conf; is ignored</emphasis>. + This is an important point to remember! </para> <tip><para> Should it be necessary, for any reason, to set your own print commands, you can do this by setting <smbconfoption><name>printing</name><value>sysv</value></smbconfoption>. However, you will loose all the benefits of tight CUPS/Samba integration. When you do this you must manually configure the printing system commands - (most important: <smbconfoption><name>print command</name></smbconfoption>; other commands are - <smbconfoption><name>lppause command</name></smbconfoption>, - <smbconfoption><name>lpresume command</name></smbconfoption>, - <smbconfoption><name>lpq command</name></smbconfoption>, - <smbconfoption><name>lprm command</name></smbconfoption>, - <smbconfoption><name>queuepause command</name></smbconfoption> and - <smbconfoption><name>queue resume command</name></smbconfoption>).</para></tip> + (most important: + <smbconfoption><name>print command</name></smbconfoption>; other commands are + <smbconfoption><name>lppause command</name></smbconfoption>, + <smbconfoption><name>lpresume command</name></smbconfoption>, + <smbconfoption><name>lpq command</name></smbconfoption>, + <smbconfoption><name>lprm command</name></smbconfoption>, + <smbconfoption><name>queuepause command</name></smbconfoption> and + <smbconfoption><name>queue resume command</name></smbconfoption>).</para></tip> </sect2> <sect2> <title>Simple &smb.conf; Settings for CUPS</title> <para> - To summarize, here is the simplest printing-related setup for &smb.conf; to enable basic CUPS support: + To summarize, <link linkend="cups-exam-simple"/> shows simplest printing-related setup for &smb.conf; to enable basic CUPS support: </para> - <para><smbconfexample> + <para><smbconfexample id="cups-exam-simple"> <title>Simplest printing-related smb.conf</title> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>load printers</name><value>yes</value></smbconfoption> @@ -175,673 +174,673 @@ libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000) </smbconfexample></para> <para> - This is all you need for basic printing setup for CUPS. It will print - all Graphic, Text, PDF and PostScript file submitted from Windows - clients. However, most of your Windows users would not know how to - send these kind of files to print without opening a GUI - application. Windows clients tend to have local printer drivers - installed. And the GUI application's print buttons start a printer - driver. Your users also very rarely send files from the command - line. Unlike UNIX clients, they hardly submit graphic, text or PDF - formatted files directly to the spooler. They nearly exclusively print - from GUI applications, with a "printer driver" hooked in between the - applications native format and the print data stream. If the backend - printer is not a PostScript device, the print data stream is "binary", - sensible only for the target printer. Read on to learn which problem - this may cause and how to avoid it. + This is all you need for basic printing setup for CUPS. It will print + all graphic, text, PDF, and PostScript files submitted from Windows + clients. However, most of your Windows users would not know how to + send these kinds of files to print without opening a GUI + application. Windows clients tend to have local printer drivers + installed, and the GUI application's print buttons start a printer + driver. Your users also rarely send files from the command + line. Unlike UNIX clients, they hardly submit graphic, text or PDF + formatted files directly to the spooler. They nearly exclusively print + from GUI applications with a <quote>printer driver</quote> hooked in between the + application's native format and the print-data-stream. If the backend + printer is not a PostScript device, the print data stream is <quote>binary,</quote> + sensible only for the target printer. Read on to learn which problem + this may cause and how to avoid it. </para> </sect2> -<sect2> -<title>More complex &smb.conf; Settings for -CUPS</title> - -<para> -Here is a slightly more complex printing-related setup -for &smb.conf;. It enables general CUPS printing -support for all printers, but defines one printer share which is set -up differently. -</para> + <sect2> + <title>More Complex CUPS &smb.conf; Settings</title> -<para><smbconfexample> -<title>Overriding global CUPS settings for one printer</title> -<smbconfsection>[global]</smbconfsection> -<smbconfoption><name>printing</name><value>cups</value></smbconfoption> -<smbconfoption><name>printcap name</name><value>cups</value></smbconfoption> -<smbconfoption><name>load printers</name><value>yes</value></smbconfoption> + <para> + <link linkend="overridesettings"/> is a slightly more complex printing-related setup + for &smb.conf;. It enables general CUPS printing + support for all printers, but defines one printer share, which is set + up differently. + </para> -<smbconfsection>[printers]</smbconfsection> -<smbconfoption><name>comment</name><value>All Printers</value></smbconfoption> -<smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> -<smbconfoption><name>public</name><value>yes</value></smbconfoption> -<smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> -<smbconfoption><name>writable</name><value>no</value></smbconfoption> -<smbconfoption><name>printable</name><value>yes</value></smbconfoption> -<smbconfoption><name>printer admin</name><value>root, @ntadmins</value></smbconfoption> - -<smbconfsection>[special_printer]</smbconfsection> -<smbconfoption><name>comment</name><value>A special printer with his own settings</value></smbconfoption> -<smbconfoption><name>path</name><value>/var/spool/samba-special</value></smbconfoption> -<smbconfoption><name>printing</name><value>sysv</value></smbconfoption> -<smbconfoption><name>printcap</name><value>lpstat</value></smbconfoption> -<smbconfoption><name>print command</name><value>echo "NEW: `date`: printfile %f" >> /tmp/smbprn.log ; \</value></smbconfoption> -<member><parameter>echo " `date`: p-%p s-%s f-%f" >> /tmp/smbprn.log ; \</parameter></member> -<member><parameter>echo " `date`: j-%j J-%J z-%z c-%c" >> /tmp/smbprn.log : rm %f</parameter></member> -<smbconfoption><name>public</name><value>no</value></smbconfoption> -<smbconfoption><name>guest ok</name><value>no</value></smbconfoption> -<smbconfoption><name>writeable</name><value>no</value></smbconfoption> -<smbconfoption><name>printable</name><value>yes</value></smbconfoption> -<smbconfoption><name>printer admin</name><value>kurt</value></smbconfoption> -<smbconfoption><name>hosts deny</name><value>0.0.0.0</value></smbconfoption> -<smbconfoption><name>hosts allow</name><value>turbo_xp, 10.160.50.23, 10.160.51.60</value></smbconfoption> -</smbconfexample></para> + <para><smbconfexample id="overridesettings"> + <title>Overriding global CUPS settings for one printer</title> + <smbconfsection>[global]</smbconfsection> + <smbconfoption><name>printing</name><value>cups</value></smbconfoption> + <smbconfoption><name>printcap name</name><value>cups</value></smbconfoption> + <smbconfoption><name>load printers</name><value>yes</value></smbconfoption> + + <smbconfsection>[printers]</smbconfsection> + <smbconfoption><name>comment</name><value>All Printers</value></smbconfoption> + <smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> + <smbconfoption><name>public</name><value>yes</value></smbconfoption> + <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> + <smbconfoption><name>writable</name><value>no</value></smbconfoption> + <smbconfoption><name>printable</name><value>yes</value></smbconfoption> + <smbconfoption><name>printer admin</name><value>root, @ntadmins</value></smbconfoption> + + <smbconfsection>[special_printer]</smbconfsection> + <smbconfoption><name>comment</name><value>A special printer with his own settings</value></smbconfoption> + <smbconfoption><name>path</name><value>/var/spool/samba-special</value></smbconfoption> + <smbconfoption><name>printing</name><value>sysv</value></smbconfoption> + <smbconfoption><name>printcap</name><value>lpstat</value></smbconfoption> + <smbconfoption><name>print command</name><value>echo "NEW: `date`: printfile %f" >> /tmp/smbprn.log ; \</value></smbconfoption> + <member><parameter>echo " `date`: p-%p s-%s f-%f" >> /tmp/smbprn.log ; \</parameter></member> + <member><parameter>echo " `date`: j-%j J-%J z-%z c-%c" >> /tmp/smbprn.log : rm %f</parameter></member> + <smbconfoption><name>public</name><value>no</value></smbconfoption> + <smbconfoption><name>guest ok</name><value>no</value></smbconfoption> + <smbconfoption><name>writeable</name><value>no</value></smbconfoption> + <smbconfoption><name>printable</name><value>yes</value></smbconfoption> + <smbconfoption><name>printer admin</name><value>kurt</value></smbconfoption> + <smbconfoption><name>hosts deny</name><value>0.0.0.0</value></smbconfoption> + <smbconfoption><name>hosts allow</name><value>turbo_xp, 10.160.50.23, 10.160.51.60</value></smbconfoption> + </smbconfexample></para> -<para> -This special share is only there for testing purposes. It does not write the print job to a file. It just logs the job parameters -known to Samba into the <filename>/tmp/smbprn.log</filename> file and deletes the jobfile. Moreover, the -<smbconfoption><name>printer admin</name></smbconfoption> of this share is "kurt" (not the "@ntadmins" group); -guest access is not allowed; the share isn not published to the Network Neighbourhood (so you need to know it is there), and it only -allows access from only three hosts. To prevent CUPS kicking in and taking over the print jobs for that share, we need to set -<smbconfoption><name>printing</name><value>sysv</value></smbconfoption> and -<smbconfoption><name>printcap</name><value>lpstat</value></smbconfoption>. -</para> -</sect2> + <para> + This special share is only there for testing purposes. It does not write the print job to a file. It just logs the job parameters + known to Samba into the <filename>/tmp/smbprn.log</filename> file and deletes the jobfile. Moreover, the + <smbconfoption><name>printer admin</name></smbconfoption> of this share is <quote>kurt</quote> (not the <quote>@ntadmins</quote> group), + guest access is not allowed, the share isn't published to the Network Neighborhood (so you need to know it is there), and it only + allows access from only three hosts. To prevent CUPS kicking in and taking over the print jobs for that share, we need to set + <smbconfoption><name>printing</name><value>sysv</value></smbconfoption> and + <smbconfoption><name>printcap</name><value>lpstat</value></smbconfoption>. + </para> + </sect2> </sect1> <sect1> -<title>Advanced Configuration</title> + <title>Advanced Configuration</title> -<para> -Before we delve into all the configuration options, let us clarify a few -points. <emphasis>Network printing needs to be organized and setup -correctly</emphasis>. Often this is not done correctly. Legacy systems -or small business LAN environments often lack design and good housekeeping. -</para> + <para> + Before we delve into all the configuration options, let us clarify a few + points. <emphasis>Network printing needs to be organized and setup + correctly</emphasis>. This frequently doesn't happen. Legacy systems + or small business LAN environments often lack design and good housekeeping. + </para> -<sect2> -<title>Central spooling vs. "Peer-to-Peer" printing</title> + <sect2> + <title>Central Spooling vs. <quote>Peer-to-Peer</quote> Printing</title> + + <para> <indexterm><primary>spooling</primary><secondary>central</secondary></indexterm> <indexterm><primary>spooling</primary><secondary>peer-to-peer</secondary></indexterm> + Many small office or home networks, as well as badly organized larger + environments, allow each client a direct access to available network + printers. This is generally a bad idea. It often blocks one client's + access to the printer when another client's job is printing. It might + freeze the first client's application while it is waiting to get + rid of the job. Also, there are frequent complaints about various jobs + being printed with their pages mixed with each other. A better concept + is the usage of a print server: it routes all jobs through one + central system, which responds immediately, takes jobs from multiple + concurrent clients at the same time, and in turn transfers them to the + printer(s) in the correct order. + </para> + </sect2> -<para> -Many small office or home networks, as well as badly organized larger -environments, allow each client a direct access to available network -printers. This is generally a bad idea. It often blocks one client's -access to the printer when another client's job is printing. It also -might freeze the first client's application while it is waiting to get -rid of the job. Also, there are frequent complaints about various jobs -being printed with their pages mixed with each other. A better concept -is the usage of a "print server": it routes all jobs through one -central system, which responds immediately, takes jobs from multiple -concurrent clients at the same time and in turn transfers them to the -printer(s) in the correct order. -</para> -</sect2> + <sect2> + <title>Raw Print Serving &smbmdash; Vendor Drivers on Windows Clients</title> -<sect2> -<title>CUPS/Samba as a "spooling-only" Print Server; "raw" printing -with Vendor Drivers on Windows Clients</title> -<indexterm><primary>spooling-only</primary></indexterm> -<indexterm><primary>"raw" printing</primary></indexterm> + <para> + <indexterm><primary>spooling-only</primary></indexterm> + <indexterm><primary>"raw" printing</primary></indexterm> + Most traditionally configured UNIX print servers acting on behalf of + Samba's Windows clients represented a really simple setup. Their only + task was to manage the <quote>raw</quote> spooling of all jobs handed to them by + Samba. This approach meant that the Windows clients were expected to + prepare the print job file that its ready to be sent to the printing + device. Here is a native (vendor-supplied) Windows printer + driver for the target device needed to be installed on each and every + client. + </para> -<para> -Most traditionally configured UNIX print servers acting on behalf of -Samba's Windows clients represented a really simple setup. Their only -task was to manage the "raw" spooling of all jobs handed to them by -Samba. This approach meant that the Windows clients were expected to -prepare the print job file that it s ready to be sent to the printing -device. Here a native (vendor-supplied) Windows printer -driver for the target device needed to be installed on each and every -client. -</para> + <para> + It is possible to configure CUPS, Samba and your Windows clients in the + same traditional and simple way. When CUPS printers are configured + for RAW print-through mode operation, it is the responsibility of the + Samba client to fully render the print job (file). The file must be + sent in a format that is suitable for direct delivery to the + printer. Clients need to run the vendor-provided drivers to do + this. In this case, CUPS will not do any print file format conversion + work. + </para> + </sect2> -<para> -It is possible to configure CUPS, Samba and your Windows clients in the -same, traditional and simple way. When CUPS printers are configured -for RAW print-through mode operation it is the responsibility of the -Samba client to fully render the print job (file). The file must be -sent in a format that is suitable for direct delivery to the -printer. Clients need to run the vendor-provided drivers to do -this. In this case CUPS will NOT do any print file format conversion -work. -</para> -</sect2> + <sect2> + <title>Installation of Windows Client Drivers</title> -<sect2> -<title>Driver Installation Methods on Windows Clients</title> + <para> + The printer drivers on the Windows clients may be installed + in two functionally different ways: + </para> -<para> -The printer drivers on the Windows clients may be installed -in two functionally different ways: -</para> + <itemizedlist> + <listitem><para>Manually install the drivers locally on each client, + one by one; this yields the old <emphasis>LanMan</emphasis> style + printing and uses a <filename>\\sambaserver\printershare</filename> + type of connection.</para></listitem> -<itemizedlist> -<listitem><para>manually install the drivers locally on each client, -one by one; this yields the old <emphasis>LanMan</emphasis> style -printing; it uses a <filename>\\sambaserver\printershare</filename> -type of connection.</para></listitem> + <listitem><para> + <indexterm><primary>point 'n' print</primary></indexterm> + Deposit and prepare the drivers (for later download) on + the print server (Samba); this enables the clients to use + <quote>Point'n'Print</quote> to get drivers semi-automatically installed the + first time they access the printer; with this method NT/200x/XP + clients use the <emphasis>SPOOLSS/MS-RPC</emphasis> + type printing calls.</para></listitem> + </itemizedlist> -<listitem><para> -<indexterm><primary>point and print</primary></indexterm> - deposit and prepare the drivers (for later download) on -the print server (Samba); this enables the clients to use -"Point and Print" to get drivers semi-automatically installed the -first time they access the printer; with this method NT/2K/XP -clients use the <emphasis>SPOOLSS/MS-RPC</emphasis> -type printing calls.</para></listitem> -</itemizedlist> + <para> + The second method is recommended for use over the first. + </para> + </sect2> -<para> -The second method is recommended for use over the first. -</para> -</sect2> + <sect2 id="cups-raw"> + <title>Explicitly Enable <quote>raw</quote> Printing for <emphasis>application/octet-stream</emphasis></title> -<sect2> -<title>Explicitly enable "raw" printing for -<emphasis>application/octet-stream</emphasis>!</title> -<indexterm><primary>application/octet-stream</primary></indexterm> + <para> + <indexterm><primary>application/octet-stream</primary></indexterm> + <indexterm><primary>raw printing</primary></indexterm> + <indexterm><primary>MIME</primary><secondary>raw</secondary></indexterm> + If you use the first option (drivers are installed on the client + side), there is one setting to take care of: CUPS needs to be told + that it should allow <quote>raw</quote> printing of deliberate (binary) file + formats. The CUPS files that need to be correctly set for RAW mode + printers to work are: + </para> -<para> -If you use the first option (drivers are installed on the client -side), there is one setting to take care of: CUPS needs to be told -that it should allow "raw" printing of deliberate (binary) file -formats. The CUPS files that need to be correctly set for RAW mode -printers to work are: -</para> + <itemizedlist> + <listitem><para><filename>/etc/cups/mime.types</filename></para></listitem> + <listitem><para><filename>/etc/cups/mime.convs</filename></para></listitem> + </itemizedlist> -<itemizedlist> -<listitem><para>/etc/cups/mime.types -</para></listitem> + <para> + Both contain entries (at the end of the respective files) which must + be uncommented to allow RAW mode operation. + In <filename>/etc/cups/mime.types</filename>, make sure this line is + present: -<listitem><para>/etc/cups/mime.convs</para></listitem> -</itemizedlist> + <filterline> + application/octet-stream + </filterline> -<para> -Both contain entries (at the end of the respective files) which must -be uncommented to allow RAW mode operation. -In<filename>/etc/cups/mime.types</filename> make sure this line is -present: -</para> + <indexterm><primary>/etc/cups/mime.convs</primary></indexterm> + <indexterm><primary>/etc/cups/mime.types</primary></indexterm> -<para><screen> - application/octet-stream -</screen></para> + In <filename>/etc/cups/mime.convs</filename>, + have this line: -<para> -In <filename>/etc/cups/mime.convs</filename>, -have this line: -</para> + <indexterm><primary>application/vnd.cups-raw</primary></indexterm> -<indexterm><primary>application/vnd.cups-raw</primary></indexterm> + <filterline> + application/octet-stream application/vnd.cups-raw 0 - + </filterline> -<para><screen> - application/octet-stream application/vnd.cups-raw 0 - -</screen></para> + If these two files are not set up correctly for raw Windows client + printing, you may encounter the dreaded <computeroutput>Unable to + convert file 0</computeroutput> in your CUPS error_log file. + </para> -<para> -If these two files are not set up correctly for raw Windows client -printing, you may encounter the dreaded <computeroutput>Unable to -convert file 0</computeroutput> in your CUPS error_log file. -</para> + <note><para>Editing the <filename>mime.convs</filename> and the + <filename>mime.types</filename> file does not + <emphasis>enforce</emphasis> <quote>raw</quote> printing, it only + <emphasis>allows</emphasis> it. + </para></note> -<note><para>editing the <filename>mime.convs</filename> and the -<filename>mime.types</filename> file does not -<emphasis>enforce</emphasis> "raw" printing, it only -<emphasis>allows</emphasis> it. -</para></note> + <formalpara><title>Background</title> -<formalpara><title>Background</title> -<indexterm><primary>application/octet-stream</primary></indexterm> + <para> + <indexterm><primary>application/octet-stream</primary></indexterm> + CUPS being a more security-aware printing system than traditional ones + does not by default allow a user to send deliberate (possibly binary) + data to printing devices. This could be easily abused to launch a + <quote>Denial of Service</quote> attack on your printer(s), causing at least + the loss of a lot of paper and ink. <quote>Unknown</quote> data are tagged by CUPS + as <parameter>MIME type: application/octet-stream</parameter> and not + allowed to go to the printer. By default, you can only send other + (known) MIME types <quote>raw</quote>. Sending data <quote>raw</quote> means that CUPS does not + try to convert them and passes them to the printer untouched (see the next + chapter for even more background explanations). + </para> + </formalpara> -<para> -CUPS being a more security-aware printing system than traditional ones -does not by default allow a user to send deliberate (possibly binary) -data to printing devices. This could be easily abused to launch a -"Denial of Service" attack on your printer(s), causing at the least -the loss of a lot of paper and ink. "Unknown" data are tagged by CUPS -as <emphasis>MIME type: application/octet-stream</emphasis> and not -allowed to go to the printer. By default, you can only send other -(known) MIME types "raw". Sending data "raw" means that CUPS does not -try to convert them and passes them to the printer untouched (see next -chapter for even more background explanations). -</para> -</formalpara> + <para> + This is all you need to know to get the CUPS/Samba combo printing + <quote>raw</quote> files prepared by Windows clients, which have vendor drivers + locally installed. If you are not interested in background information about + more advanced CUPS/Samba printing, simply skip the remaining sections + of this chapter. + </para> + </sect2> -<para> -This is all you need to know to get the CUPS/Samba combo printing -"raw" files prepared by Windows clients, which have vendor drivers -locally installed. If you are not interested in background information about -more advanced CUPS/Samba printing, simply skip the remaining sections -of this chapter. -</para> -</sect2> + <sect2> + <title>Driver Upload Methods</title> -<sect2> -<title>Three familiar Methods for driver upload plus a new one</title> + <para> + This section describes three familiar methods, plus one new one, by which + printer drivers may be uploaded. + </para> -<indexterm><primary>point and print</primary></indexterm> + <para> + <indexterm><primary>point 'n' print</primary></indexterm> + If you want to use the MS-RPC type printing, you must upload the + drivers onto the Samba server first (<smbconfsection>[print$]</smbconfsection> + share). For a discussion on how to deposit printer drivers on the + Samba host (so the Windows clients can download and use them via + <quote>Point'n'Print</quote>), please refer to the previous chapter of this + HOWTO Collection. There you will find a description or reference to + three methods of preparing the client drivers on the Samba server: + </para> + <itemizedlist> + <listitem><para> + <indexterm><primary>add printer wizard</primary></indexterm> + The GUI, <quote>Add Printer Wizard</quote> + <emphasis>upload-from-a-Windows-client</emphasis> + method.</para></listitem> -<para> -If you want to use the MS-RPC type printing, you must upload the -drivers onto the Samba server first (<smbconfsection>[print$]</smbconfsection> -share). For a discussion on how to deposit printer drivers on the -Samba host (so that the Windows clients can download and use them via -"Point'n'Print") please also refer to the previous chapter of this -HOWTO Collection. There you will find a description or reference to -three methods of preparing the client drivers on the Samba server: -</para> + <listitem><para>The command line, <quote>smbclient/rpcclient</quote> + upload-from-a-UNIX-workstation method.</para></listitem> -<indexterm><primary>add printer wizard</primary></indexterm> -<itemizedlist> -<listitem><para>the GUI, "Add Printer Wizard" -<emphasis>upload-from-a-Windows-client</emphasis> -method;</para></listitem> + <listitem><para> + <indexterm><primary>imprints</primary></indexterm> + The Imprints Toolset + method.</para></listitem> + </itemizedlist> -<listitem><para>the commandline, "smbclient/rpcclient" -<emphasis>upload-from-a-UNIX-workstation</emphasis> -method;</para></listitem> + <para> + These three methods apply to CUPS all the same. A new and more + convenient way to load the Windows drivers into Samba is provided + if you use CUPS: + </para> -<listitem><para> -<indexterm><primary>imprints</primary></indexterm> - the <emphasis>Imprints</emphasis> Toolset -method.</para></listitem> -</itemizedlist> + <itemizedlist> + <listitem><para> + <indexterm><primary>cupsaddsmb</primary></indexterm> + the <parameter>cupsaddsmb</parameter> + utility.</para></listitem> + </itemizedlist> -<para> -These 3 methods apply to CUPS all the same. A new and more -convenient way to load the Windows drivers into Samba is provided -if you use CUPS: -</para> + <para> + <command>cupsaddsmb</command> is discussed in much detail further below. But we first + explore the CUPS filtering system and compare the Windows and UNIX printing architectures. + </para> + </sect2> +</sect1> -<indexterm><primary>cupsaddsmb</primary></indexterm> +<sect1> + <title>Advanced Intelligent Printing with PostScript Driver Download</title> -<itemizedlist> -<listitem><para>the <emphasis>cupsaddsmb</emphasis> -utility.</para></listitem> -</itemizedlist> -<para> -cupsaddsmb is discussed in much detail further below. But we will -first explore the CUPS filtering system and compare the Windows and -UNIX printing architectures. -</para> -</sect2> -</sect1> + <para> + <indexterm><primary>PostScript</primary><seealso>Ghostscript</seealso></indexterm> + We now know + how to set up a <quote>dump</quote> printserver, that is, a server which is spooling + printjobs <quote>raw</quote>, leaving the print data untouched. + </para> -<sect1> -<title>Using CUPS/Samba in an advanced Way -- intelligent printing -with PostScript Driver Download</title> + <para> + Possibly you need to setup CUPS in a smarter way. The reasons could + be manifold: + </para> -<indexterm><primary>PostScript</primary><seealso>Ghostscript</seealso></indexterm> + <itemizedlist> + <listitem><para>Maybe your boss wants to get monthly statistics: Which + printer did how many pages? What was the average data size of a job? + What was the average print run per day? What are the typical hourly + peaks in printing? Which department prints how much?</para></listitem> -<para> -Are you still following this? Good. Let's go into more detail then. We now know -how to set up a "dump" printserver, that is, a server which is spooling -printjobs "raw", leaving the print data untouched. -</para> + <listitem><para>Maybe you are asked to setup a print quota system: + Users should not be able to print more jobs, once they have surpassed + a given limit per period.</para></listitem> -<para> -Possibly you need to setup CUPS in a more smart way. The reasons could -be manifold: -</para> + <listitem><para>Maybe your previous network printing setup is a mess + and must be re-organized from a clean beginning.</para></listitem> -<itemizedlist> -<listitem><para>Maybe your boss wants to get monthly statistics: Which -printer did how many pages? What was the average data size of a job? -What was the average print run per day? What are the typical hourly -peaks in printing? Which departments prints how -much?</para></listitem> - -<listitem><para>Maybe you are asked to setup a print quota system: -users should not be able to print more jobs, once they have surpassed -a given limit per period?</para></listitem> - -<listitem><para>Maybe your previous network printing setup is a mess -and shall be re-organized from a clean beginning?</para></listitem> - -<listitem><para>Maybe you have experiencing too many "Blue Screens", -originating from poorly debugged printer drivers running in NT "kernel -mode"?</para></listitem> -</itemizedlist> + <listitem><para>Maybe you have experiencing too many <quote>blue screens</quote> + originating from poorly debugged printer drivers running in NT <quote>kernel mode</quote>?</para></listitem> + </itemizedlist> -<para> -These goals cannot be achieved by a raw print server. To build a -server meeting these requirements, you'll first need to learn about -how CUPS works and how you can enable its features. -</para> + <para> + These goals cannot be achieved by a raw print server. To build a + server meeting these requirements, you'll first need to learn about + how CUPS works and how you can enable its features. + </para> -<para> -What follows is the comparison of some fundamental concepts for -Windows and UNIX printing; then is the time for a description of the -CUPS filtering system, how it works and how you can tweak it. -</para> + <para> + What follows is the comparison of some fundamental concepts for + Windows and UNIX printing; then follows a description of the + CUPS filtering system, how it works and how you can tweak it. + </para> -<sect2 id="gdipost"> -<title>GDI on Windows -- PostScript on UNIX</title> + <sect2 id="gdipost"> + <title>GDI on Windows -- PostScript on UNIX</title> -<indexterm><primary>GDI</primary></indexterm> -<indexterm><primary>PostScript</primary></indexterm> -<para> -Network printing is one of the most complicated and error-prone -day-to-day tasks any user or an administrator may encounter. This is -true for all OS platforms. And there are reasons for this. -</para> + <para> + <indexterm><primary>GDI</primary></indexterm> + <indexterm><primary>PostScript</primary></indexterm> + Network printing is one of the most complicated and error-prone + day-to-day tasks any user or administrator may encounter. This is + true for all OS platforms. And there are reasons for this. + </para> -<indexterm><primary>PCL</primary></indexterm> -<indexterm><primary>PDL</primary></indexterm> -<para> -You can't expect for most file formats to just throw them towards -printers and they get printed. There needs to be a file format -conversion in between. The problem is: there is no common standard for -print file formats across all manufacturers and printer types. While -<emphasis>PostScript</emphasis> (trademark held by Adobe), and, to an -extent, <emphasis>PCL</emphasis> (trademark held by HP), have developed -into semi-official "standards", by being the most widely used PDLs -(<emphasis>Page Description Languages</emphasis>), there are still -many manufacturers who "roll their own" (their reasons may be -unacceptable license fees for using printer-embedded PostScript -interpreters, etc.). -</para> -</sect2> + <para> + <indexterm><primary>PCL</primary></indexterm> + <indexterm><primary>PDL</primary></indexterm> + You can't expect most file formats to just throw them toward + printers and they get printed. There needs to be a file format + conversion in between. The problem is that there is no common standard for + print file formats across all manufacturers and printer types. While + PostScript (trademark held by Adobe) and, to an + extent, PCL (trademark held by HP) have developed + into semi-official <quote>standards</quote> by being the most widely used PDLs + Page Description Languages (PDLs), there are still + many manufacturers who <quote>roll their own</quote> (their reasons may be + unacceptable license fees for using printer-embedded PostScript + interpreters, and so on). + </para> + </sect2> -<sect2> -<title>Windows Drivers, GDI and EMF</title> + <sect2> + <title>Windows Drivers, GDI and EMF</title> -<indexterm><primary>GDI</primary></indexterm> -<indexterm><primary>EMF</primary></indexterm> -<indexterm><primary>WYSIWYG</primary></indexterm> - -<para> -In Windows OS, the format conversion job is done by the printer -drivers. On MS Windows OS platforms all application programmers have -at their disposal a built-in API, the GDI (<emphasis>Graphical Device -Interface</emphasis>), as part and parcel of the OS itself, to base -themselves on. This GDI core is used as one common unified ground, for -all Windows programs, to draw pictures, fonts and documents -<emphasis>on screen</emphasis> as well as <emphasis>on -paper</emphasis> (=print). Therefore printer driver developers can -standardize on a well-defined GDI output for their own driver -input. Achieving WYSIWYG ("What You See Is What You Get") is -relatively easy, because the on-screen graphic primitives, as well as -the on-paper drawn objects, come from one common source. This source, -the GDI, produces often a file format called EMF (<emphasis>Enhanced -MetaFile</emphasis>). The EMF is processed by the printer driver and -converted to the printer-specific file format. -</para> -<note><para> -<indexterm><primary>PDF</primary></indexterm> -To the GDI foundation in MS Windows, Apple has chosen to -put paper and screen output on a common foundation for their -(BSD-UNIX-based, did you know??) Mac OS X and Darwin Operating -Systems. Their <emphasis>Core Graphic Engine</emphasis> uses a -<emphasis>PDF</emphasis> derivative for all display work. -</para></note> + <para> + <indexterm><primary>GDI</primary></indexterm> + <indexterm><primary>EMF</primary></indexterm> + <indexterm><primary>WYSIWYG</primary></indexterm> + In Windows OS, the format conversion job is done by the printer + drivers. On MS Windows OS platforms all application programmers have + at their disposal a built-in API, the Graphical Device + Interface (GDI), as part and parcel of the OS itself to base + themselves on. This GDI core is used as one common unified ground for + all Windows programs to draw pictures, fonts and documents + <emphasis>on screen</emphasis> as well as <emphasis>on + paper</emphasis> (print). Therefore, printer driver developers can + standardize on a well-defined GDI output for their own driver + input. Achieving WYSIWYG (<quote>What You See Is What You Get</quote>) is + relatively easy, because the on-screen graphic primitives, as well as + the on-paper drawn objects, come from one common source. This source, + the GDI, often produces a file format called Enhanced + MetaFile (EMF). The EMF is processed by the printer driver and + converted to the printer-specific file format. + </para> -<para> + <note><para> + <indexterm><primary>PDF</primary></indexterm> + To the GDI foundation in MS Windows, Apple has chosen to + put paper and screen output on a common foundation for their + (BSD-UNIX-based, did you know?) Mac OS X and Darwin Operating + <indexterm><primary>X Window System</primary></indexterm> + <indexterm><primary>PostScript</primary></indexterm> + <indexterm><primary>PCL</primary></indexterm> + <indexterm><primary>Xprint</primary></indexterm> + Systems. Their <emphasis>Core Graphic Engine</emphasis> uses a + <emphasis>PDF</emphasis> derivative for all display work. + </para></note> -<image id="small1"><imagedescription>Windows Printing to a local Printer</imagedescription><imagefile>1small</imagefile></image> -</para> -</sect2> + <para> -<sect2> -<title>UNIX Printfile Conversion and GUI Basics</title> + <image><imagedescription>Windows printing to a local printer.</imagedescription><imagefile>1small</imagefile></image> + </para> + </sect2> -<indexterm><primary>X Window System</primary></indexterm> -<indexterm><primary>PostScript</primary></indexterm> -<indexterm><primary>PCL</primary></indexterm> -<indexterm><primary>Xprint</primary></indexterm> - -<para> -In UNIX and Linux, there is no comparable layer built into the OS -kernel(s) or the X (screen display) server. Every application is -responsible for itself to create its print output. Fortunately, most -use PostScript. That gives at least some common ground. Unfortunately, -there are many different levels of quality for this PostScript. And -worse: there is a huge difference (and no common root) in the way how -the same document is displayed on screen and how it is presented on -paper. WYSIWYG is more difficult to achieve. This goes back to the -time decades ago, when the predecessors of <emphasis>X.org</emphasis>, -designing the UNIX foundations and protocols for Graphical User -Interfaces refused to take over responsibility for "paper output" -also, as some had demanded at the time, and restricted itself to -"on-screen only". (For some years now, the "Xprint" project has been -under development, attempting to build printing support into the X -framework, including a PostScript and a PCL driver, but it is not yet -ready for prime time.) You can see this unfavorable inheritance up to -the present day by looking into the various "font" directories on your -system; there are separate ones for fonts used for X display and fonts -to be used on paper. -</para> + <sect2> + <title>UNIX Printfile Conversion and GUI Basics</title> -<formalpara> -<title>Background</title> -<indexterm><primary>PostScript</primary></indexterm> + <para> + <indexterm><primary>X Window System</primary></indexterm> + <indexterm><primary>PostScript</primary></indexterm> + <indexterm><primary>PCL</primary></indexterm> + <indexterm><primary>Xprint</primary></indexterm> + In UNIX and Linux, there is no comparable layer built into the OS + kernel(s) or the X (screen display) server. Every application is + responsible for itself to create its print output. Fortunately, most + use PostScript and that at least gives some common ground. Unfortunately, + there are many different levels of quality for this PostScript. And + worse, there is a huge difference (and no common root) in the way + the same document is displayed on screen and how it is presented on + paper. WYSIWYG is more difficult to achieve. This goes back to the + time, decades ago, when the predecessors of X.org, + designing the UNIX foundations and protocols for Graphical User + Interfaces, refused to take responsibility for <quote>paper output</quote> + also, as some had demanded at the time, and restricted itself to + <quote>on-screen only.</quote> (For some years now, the <quote>Xprint</quote> project has been + under development, attempting to build printing support into the X + framework, including a PostScript and a PCL driver, but it is not yet + ready for prime time.) You can see this unfavorable inheritance up to + the present day by looking into the various <quote>font</quote> directories on your + system; there are separate ones for fonts used for X display and fonts + to be used on paper. + </para> -<para> -The PostScript programming language is an "invention" by Adobe Inc., -but its specifications have been published to the full. Its strength -lies in its powerful abilities to describe graphical objects (fonts, -shapes, patterns, lines, curves, dots...), their attributes (color, -linewidth...) and the way to manipulate (scale, distort, rotate, -shift...) them. Because of its open specification, anybody with the -skill can start writing his own implementation of a PostScript -interpreter and use it to display PostScript files on screen or on -paper. Most graphical output devices are based on the concept of -"raster images" or "pixels" (one notable exception are pen -plotters). Of course, you can look at a PostScript file in its textual -form and you will be reading its PostScript code, the language -instructions which need to be interpreted by a rasterizer. Rasterizers -produce pixel images, which may be displayed on screen by a viewer -program or on paper by a printer. -</para> -</formalpara> -</sect2> + <formalpara> + <title>Background</title> -<sect2 id="post-and-ghost"> -<title>PostScript and Ghostscript</title> -<indexterm><primary>PostScript</primary></indexterm> -<indexterm><primary>GhostScript</primary><seealso>PostScript</seealso></indexterm> -<indexterm><primary>PostScript</primary><secondary>RIP</secondary></indexterm> + <para> + <indexterm><primary>PostScript</primary></indexterm> + The PostScript programming language is an <quote>invention</quote> by Adobe Inc., + but its specifications have been published to the full. Its strength + lies in its powerful abilities to describe graphical objects (fonts, + shapes, patterns, lines, curves, and dots), their attributes (color, + linewidth) and the way to manipulate (scale, distort, rotate, + shift) them. Because of its open specification, anybody with the + skill can start writing his own implementation of a PostScript + interpreter and use it to display PostScript files on screen or on + paper. Most graphical output devices are based on the concept of + <quote>raster images</quote> or <quote>pixels</quote> (one notable exception is pen + plotters). Of course, you can look at a PostScript file in its textual + form and you will be reading its PostScript code, the language + instructions which need to be interpreted by a rasterizer. Rasterizers + produce pixel images, which may be displayed on screen by a viewer + program or on paper by a printer. + </para> + </formalpara> + </sect2> -<para> -So, UNIX is lacking a common ground for printing on paper and -displaying on screen. Despite this unfavorable legacy for UNIX, basic -printing is fairly easy: if you have PostScript printers at your -disposal! The reason is: these devices have a built-in PostScript -language "interpreter", also called a <emphasis>Raster Image -Processor</emphasis> (RIP), (which makes them more expensive than -other types of printers); throw PostScript towards them, and they will -spit out your printed pages. Their RIP is doing all the hard work of -converting the PostScript drawing commands into a bitmap picture as -you see it on paper, in a resolution as done by your printer. This is -no different to PostScript printing of a file from a Windows origin. -</para> + <sect2 id="post-and-ghost"> + <title>PostScript and Ghostscript</title> -<note><para> -<indexterm><primary>PPD</primary></indexterm> -Traditional UNIX programs and printing systems -- while -using PostScript -- are largely not PPD-aware. PPDs are "PostScript -Printer Description" files. They enable you to specify and control all -options a printer supports: duplexing, stapling, punching... Therefore -UNIX users for a long time couldn't choose many of the supported -device and job options, unlike Windows or Apple users. But now there -is CUPS.... -</para> -</note> -<para> - <image id="small2"><imagedescription>Printing to a Postscript Printer</imagedescription> - <imagefile>2small</imagefile></image> -</para> + <para> + <indexterm><primary>PostScript</primary></indexterm> + <indexterm><primary>GhostScript</primary><seealso>PostScript</seealso></indexterm> + <indexterm><primary>PostScript</primary><secondary>RIP</secondary></indexterm> + So, UNIX is lacking a common ground for printing on paper and + displaying on screen. Despite this unfavorable legacy for UNIX, basic + printing is fairly easy if you have PostScript printers at your + disposal. The reason is these devices have a built-in PostScript + language <quote>interpreter,</quote> also called a Raster Image + Processor (RIP) (which makes them more expensive than + other types of printers); throw PostScript toward them, and they will + spit out your printed pages. Their RIP is doing all the hard work of + converting the PostScript drawing commands into a bitmap picture as + you see it on paper, in a resolution as done by your printer. This is + no different to PostScript printing a file from a Windows origin. + </para> -<indexterm><primary>PDL</primary></indexterm> + <note><para> + <indexterm><primary>PPD</primary></indexterm> + Traditional UNIX programs and printing systems &smbmdash; while + using PostScript &smbmdash; are largely not PPD-aware. PPDs are <quote>PostScript + Printer Description</quote> files. They enable you to specify and control all + options a printer supports: duplexing, stapling and punching. Therefore, + UNIX users for a long time couldn't choose many of the supported + device and job options, unlike Windows or Apple users. But now there + is CUPS. + </para> + </note> -<para> -However, there are other types of printers out there. These don't know -how to print PostScript. They use their own <emphasis>Page Description -Language</emphasis> (PDL, often proprietary). To print to them is much -more demanding. Since your UNIX applications mostly produce -PostScript, and since these devices don't understand PostScript, you -need to convert the printfiles to a format suitable for your printer -on the host, before you can send it away. -</para> -</sect2> + <para> + <image><imagedescription>Printing to a PostScript printer.</imagedescription> + <imagefile>2small</imagefile></image> + </para> -<sect2> -<title>Ghostscript -- the Software RIP for non-PostScript Printers</title> -<indexterm><primary>GhostScript</primary></indexterm> + <para> + <indexterm><primary>PDL</primary></indexterm> + However, there are other types of printers out there. These do not know + how to print PostScript. They use their own Page Description + Language (PDL, often proprietary). To print to them is much + more demanding. Since your UNIX applications mostly produce + PostScript, and since these devices do not understand PostScript, you + need to convert the printfiles to a format suitable for your printer + on the host before you can send it away. + </para> + </sect2> -<para> -Here is where <emphasis>Ghostscript</emphasis> kicks in. Ghostscript is -the traditional (and quite powerful) PostScript interpreter used on -UNIX platforms. It is a RIP in software, capable to do a -<emphasis>lot</emphasis> of file format conversions, for a very broad -spectrum of hardware devices as well as software file formats. -Ghostscript technology and drivers is what enables PostScript printing -to non-PostScript hardware. -</para> + <sect2> + <title>Ghostscript &smbmdash; the Software RIP for Non-PostScript Printers</title> -<para> - <image id="small3"><imagedescription>Ghostscript as a RIP for non-postscript printers</imagedescription> - <imagefile>3small</imagefile> -</image> -</para> -<tip><para> -Use the "gs -h" command to check for all built-in "devices" of your -Ghostscript version. If you specify e.g. a parameter of -<parameter>-sDEVICE=png256</parameter> on your Ghostscript command -line, you are asking Ghostscript to convert the input into a PNG -file. Naming a "device" on the commandline is the most important -single parameter to tell Ghostscript how exactly it should render the -input. New Ghostscript versions are released at fairly regular -intervals, now by artofcode LLC. They are initially put under the -"AFPL" license, but re-released under the GNU GPL as soon as the next -AFPL version appears. GNU Ghostscript is probably the version -installed on most Samba systems. But it has got some -deficiencies. <indexterm><primary>Ghostscript</primary><secondary>ESP</secondary><see>ESP GhostScript</see></indexterm>Therefore ESP Ghostscript was developed as an -enhancement over GNU Ghostscript, with lots of bug-fixes, additional -devices and improvements. It is jointly maintained by developers from -CUPS, Gimp-Print, MandrakeSoft, SuSE, RedHat and Debian. It includes -the "cups" device (essential to print to non-PS printers from CUPS). -</para></tip> -</sect2> + <para> + <indexterm><primary>GhostScript</primary></indexterm> + Here is where Ghostscript kicks in. Ghostscript is + the traditional (and quite powerful) PostScript interpreter used on + UNIX platforms. It is a RIP in software, capable of doing a + <emphasis>lot</emphasis> of file format conversions for a very broad + spectrum of hardware devices as well as software file formats. + Ghostscript technology and drivers are what enable PostScript printing + to non-PostScript hardware. + </para> -<sect2> -<title>PostScript Printer Description (PPD) Specification</title> + <para> + <image><imagedescription>Ghostscript as a RIP for non-postscript printers.</imagedescription> + <imagefile>3small</imagefile> + </image> + </para> -<indexterm><primary>PPD</primary></indexterm> + <tip><para> + Use the <quote>gs -h</quote> command to check for all built-in <quote>devices</quote> + of your Ghostscript version. If you specify a parameter of + <parameter>-sDEVICE=png256</parameter> on your Ghostscript command + line, you are asking Ghostscript to convert the input into a PNG + file. Naming a <quote>device</quote> on the command line is the most important + single parameter to tell Ghostscript exactly how it should render the + input. New Ghostscript versions are released at fairly regular + intervals, now by artofcode LLC. They are initially put under the + <quote>AFPL</quote> license, but re-released under the GNU GPL as soon as the next + AFPL version appears. GNU Ghostscript is probably the version + installed on most Samba systems. But it has some deficiencies. + <indexterm><primary>Ghostscript</primary><secondary>ESP</secondary><see>ESP GhostScript</see></indexterm> + Therefore, ESP Ghostscript was developed as an + enhancement over GNU Ghostscript, with lots of bug-fixes, additional + devices and improvements. It is jointly maintained by developers from + CUPS, Gimp-Print, MandrakeSoft, SuSE, RedHat, and Debian. It includes + the <quote>cups</quote> device (essential to print to non-PS printers from CUPS). + </para></tip> + </sect2> -<para> -While PostScript in essence is a <emphasis>Page Description -Language</emphasis> (PDL) to represent the page layout in a -<emphasis>device independent</emphasis> way, real world print jobs are -always ending up to be output on a hardware with device-specific -features. To take care of all the differences in hardware, and to -allow for innovations, Adobe has specified a syntax and file format -for <emphasis>PostScript Printer Description</emphasis> (PPD) -files. Every PostScript printer ships with one of these files. -</para> + <sect2> + <title>PostScript Printer Description (PPD) Specification</title> -<para> -PPDs contain all information about general and special features of the -given printer model: Which different resolutions can it handle? Does -it have a Duplexing Unit? How many paper trays are there? What media -types and sizes does it take? For each item it also names the special -command string to be sent to the printer (mostly inside the PostScript -file) in order to enable it. -</para> -<para> -Information from these PPDs is meant to be taken into account by the -printer drivers. Therefore, installed as part of the Windows -PostScript driver for a given printer is the printer's PPD. Where it -makes sense, the PPD features are presented in the drivers' UI dialogs -to display to the user as choice of print options. In the end, the -user selections are somehow written (in the form of special -PostScript, PJL, JCL or vendor-dependent commands) into the PostScript -file created by the driver. -</para> + <para> + <indexterm><primary>PPD</primary></indexterm> + While PostScript in essence is a Page Description + Language (PDL) to represent the page layout in a + device-independent way, real-world print jobs are + always ending up being output on hardware with device-specific + features. To take care of all the differences in hardware and to + allow for innovations, Adobe has specified a syntax and file format + for PostScript Printer Description (PPD) + files. Every PostScript printer ships with one of these files. + </para> -<warning><para> -<indexterm><primary>PDF</primary></indexterm> -A PostScript file that was created to contain device-specific commands -for achieving a certain print job output (e.g. duplexed, stapled and -punched) on a specific target machine, may not print as expected, or -may not be printable at all on other models; it also may not be fit -for further processing by software (e.g. by a PDF distilling program). -</para></warning> -</sect2> + <para> + PPDs contain all the information about general and special features of the + given printer model: Which different resolutions can it handle? Does + it have a Duplexing Unit? How many paper trays are there? What media + types and sizes does it take? For each item, it also names the special + command string to be sent to the printer (mostly inside the PostScript + file) in order to enable it. + </para> -<sect2> -<title>CUPS can use all Windows-formatted Vendor PPDs</title> + <para> + Information from these PPDs is meant to be taken into account by the + printer drivers. Therefore, installed as part of the Windows + PostScript driver for a given printer is the printer's PPD. Where it + makes sense, the PPD features are presented in the drivers' UI dialogs + to display to the user a choice of print options. In the end, the + user selections are somehow written (in the form of special + PostScript, PJL, JCL or vendor-dependent commands) into the PostScript + file created by the driver. + </para> -<para> -CUPS can handle all spec-compliant PPDs as supplied by the -manufacturers for their PostScript models. Even if a -UNIX/Linux-illiterate vendor might not have mentioned our favorite -OS in his manuals and brochures -- you can safely trust this: -<emphasis>if you get hold of the Windows NT version of the PPD, you -can use it unchanged in CUPS</emphasis> and thus access the full -power of your printer just like a Windows NT user could! -</para> + <warning><para> + <indexterm><primary>PDF</primary></indexterm> + A PostScript file that was created to contain device-specific commands + for achieving a certain print job output (e.g., duplexed, stapled and + punched) on a specific target machine, may not print as expected, or + may not be printable at all on other models; it also may not be fit + for further processing by software (e.g., by a PDF distilling program). + </para></warning> + </sect2> -<tip><para> -To check the spec compliance of any PPD online, go to <ulink -noescape="1" url="http://www.cups.org/testppd.php">http://www.cups.org/testppd.php</ulink> -and upload your PPD. You will see the results displayed -immediately. CUPS in all versions after 1.1.19 has a much more strict -internal PPD parsing and checking code enabled; in case of printing -trouble this online resource should be one of your first pitstops. -</para></tip> + <sect2> + <title>Using Windows-Formatted Vendor PPDs</title> -<warning><para> -<indexterm><primary>foomatic</primary></indexterm> -<indexterm><primary>cupsomatic</primary></indexterm> -For real PostScript printers <emphasis>don't</emphasis> use the -<emphasis>Foomatic</emphasis> or <emphasis>cupsomatic</emphasis> -PPDs from Linuxprinting.org. With these devices the original -vendor-provided PPDs are always the first choice! -</para></warning> + <para> + CUPS can handle all spec-compliant PPDs as supplied by the + manufacturers for their PostScript models. Even if a + vendor might not have mentioned our favorite + OS in his manuals and brochures, you can safely trust this: + <emphasis>If you get the Windows NT version of the PPD, you + can use it unchanged in CUPS</emphasis> and thus access the full + power of your printer just like a Windows NT user could! + </para> -<tip><para> -If you are looking for an original vendor-provided PPD of a specific -device, and you know that an NT4 box (or any other Windows box) on -your LAN has the PostScript driver installed, just use -<command>smbclient //NT4-box/print\$ -U username</command> to -access the Windows directory where all printer driver files are -stored. First look in the <filename>W32X86/2</filename> subdir for -the PPD you are seeking. -</para></tip> -</sect2> + <tip><para> + To check the spec compliance of any PPD online, go to <ulink + noescape="1" url="http://www.cups.org/testppd.php">http://www.cups.org/testppd.php</ulink> + and upload your PPD. You will see the results displayed + immediately. CUPS in all versions after 1.1.19 has a much more strict + internal PPD parsing and checking code enabled; in case of printing + trouble, this online resource should be one of your first pitstops. + </para></tip> -<sect2> -<title>CUPS also uses PPDs for non-PostScript Printers</title> + <warning><para> + <indexterm><primary>foomatic</primary></indexterm> + <indexterm><primary>cupsomatic</primary></indexterm> + For real PostScript printers, <emphasis>do not</emphasis> use the + <emphasis>Foomatic</emphasis> or <emphasis>cupsomatic</emphasis> + PPDs from Linuxprinting.org. With these devices, the original + vendor-provided PPDs are always the first choice! + </para></warning> + + <tip><para> + If you are looking for an original vendor-provided PPD of a specific + device, and you know that an NT4 box (or any other Windows box) on + your LAN has the PostScript driver installed, just use + <command>smbclient //NT4-box/print\$ -U username</command> to + access the Windows directory where all printer driver files are + stored. First look in the <filename>W32X86/2</filename> subdir for + the PPD you are seeking. + </para></tip> + </sect2> -<para> -CUPS also uses specially crafted PPDs to handle non-PostScript -printers. These PPDs are usually not available from the vendors (and -no, you can't just take the PPD of a Postscript printer with the same -model name and hope it works for the non-PostScript version too). To -understand how these PPDs work for non-PS printers we first need to -dive deeply into the CUPS filtering and file format conversion -architecture. Stay tuned. -</para> -</sect2> + <sect2> + <title>CUPS Also Uses PPDs for Non-PostScript Printers</title> + + <para> + CUPS also uses specially crafted PPDs to handle non-PostScript + printers. These PPDs are usually not available from the vendors (and + no, you can't just take the PPD of a PostScript printer with the same + model name and hope it works for the non-PostScript version too). To + understand how these PPDs work for non-PS printers, we first need to + dive deeply into the CUPS filtering and file format conversion + architecture. Stay tuned. + </para> + </sect2> </sect1> <sect1> @@ -849,12 +848,12 @@ architecture. Stay tuned. <para> The core of the CUPS filtering system is based on -<emphasis>Ghostscript</emphasis>. In addition to Ghostscript, CUPS +Ghostscript. In addition to Ghostscript, CUPS uses some other filters of its own. You (or your OS vendor) may have plugged in even more filters. CUPS handles all data file formats under -the label of various <emphasis>MIME types</emphasis>. Every incoming +the label of various MIME types. Every incoming printfile is subjected to an initial -<emphasis>auto-typing</emphasis>. The auto-typing determines its given +auto-typing. The auto-typing determines its given MIME type. A given MIME type implies zero or more possible filtering chains relevant to the selected target printer. This section discusses how MIME types recognition and conversion rules interact. They are @@ -863,44 +862,44 @@ given input data format. </para> <para> -If CUPS rasterizes a PostScript file <emphasis>natively</emphasis> to -a bitmap, this is done in 2 stages: +If CUPS rasterizes a PostScript file natively to +a bitmap, this is done in two stages: </para> <itemizedlist> -<listitem><para>the first stage uses a Ghostscript device named "cups" + <listitem><para>The first stage uses a Ghostscript device named <quote>cups</quote> (this is since version 1.1.15) and produces a generic raster format -called "CUPS raster". +called <quote>CUPS raster</quote>. </para></listitem> -<listitem><para>the second stage uses a "raster driver" which converts -the generic CUPS raster to a device specific raster.</para></listitem> +<listitem><para>The second stage uses a <quote>raster driver</quote> that converts + the generic CUPS raster to a device-specific raster.</para></listitem> </itemizedlist> <para> -Make sure your Ghostscript version has the "cups" device compiled in -(check with <command>gs -h | grep cups</command>). Otherwise you +Make sure your Ghostscript version has the <quote>cups</quote> device compiled in +(check with <command>gs -h | grep cups</command>). Otherwise you may encounter the dreaded <computeroutput>Unable to convert file -0</computeroutput> in your CUPS error_log file. To have "cups" as a -device in your Ghostscript, you either need to <emphasis>patch GNU -Ghostscript</emphasis> and re-compile or use <indexterm><primary>ESP</primary><secondary>Ghostscript</secondary></indexterm><ulink +0</computeroutput> in your CUPS error_log file. To have <quote>cups</quote> as a +device in your Ghostscript, you either need to patch GNU +Ghostscript and re-compile, or use <indexterm><primary>ESP</primary><secondary>Ghostscript</secondary></indexterm><ulink url="http://www.cups.org/ghostscript.php">ESP Ghostscript</ulink>. The -superior alternative is ESP Ghostscript: it supports not just CUPS, +superior alternative is ESP Ghostscript. It supports not just CUPS, but 300 other devices too (while GNU Ghostscript supports only about 180). Because of this broad output device support, ESP Ghostscript is -the first choice for non-CUPS spoolers too. It is now recommended by +the first choice for non-CUPS spoolers, too. It is now recommended by Linuxprinting.org for all spoolers. </para> <para> <indexterm><primary>cupsomatic</primary></indexterm> <indexterm><primary>foomatic</primary></indexterm> -CUPS printers may be setup to use <emphasis>external</emphasis> -rendering paths. One of the most common ones is provided by the -<emphasis>Foomatic/cupsomatic</emphasis> concept, from <ulink -url="http://www.linuxprinting.org/">Linuxprinting.org</ulink>. This +CUPS printers may be setup to use external +rendering paths. One of the most common is provided by the +Foomatic/cupsomatic concept from <ulink +url="http://www.linuxprinting.org/">Linuxprinting.org.</ulink> This uses the classical Ghostscript approach, doing everything in one -step. It doesn't use the "cups" device, but one of the many +step. It does not use the <quote>cups</quote> device, but one of the many others. However, even for Foomatic/cupsomatic usage, best results and <indexterm><primary>ESP</primary><secondary>Ghostscript</secondary></indexterm> broadest printer model support is provided by ESP Ghostscript (more @@ -909,230 +908,222 @@ about cupsomatic/Foomatic, particularly the new version called now </para> <sect2> -<title>MIME types and CUPS Filters</title> +<title>MIME Types and CUPS Filters</title> + <para> +<indexterm><primary>MIME</primary><secondary>filters</secondary></indexterm> <indexterm><primary>MIME</primary></indexterm> CUPS reads the file <filename>/etc/cups/mime.types</filename> (and all other files carrying a <filename>*.types</filename> suffix in the same directory) upon startup. These files contain the MIME -type recognition rules which are applied when CUPS runs its +type recognition rules that are applied when CUPS runs its auto-typing routines. The rule syntax is explained in the man page for <filename>mime.types</filename> and in the comments section of the <filename>mime.types</filename> file itself. A simple rule reads like this: -</para> -<para> <indexterm><primary>application/pdf</primary></indexterm> -<screen> +<filterline> application/pdf pdf string(0,%PDF) -</screen></para> +</filterline> -<para> -This means: if a filename has either a -<filename>.pdf</filename> suffix, or if the magic +This means if a filename has either a +<filename>.pdf</filename> suffix or if the magic string <emphasis>%PDF</emphasis> is right at the beginning of the file itself (offset 0 from the start), then it is -a PDF file (<emphasis>application/pdf</emphasis>). +a PDF file (<parameter>application/pdf</parameter>). Another rule is this: -</para> -<para><screen> +<filterline> application/postscript ai eps ps string(0,%!) string(0,<04>%!) -</screen></para> +</filterline> -<para> -Its meaning: if the filename has one of the suffixes +If the filename has one of the suffixes <filename>.ai</filename>, <filename>.eps</filename>, <filename>.ps</filename> or if the file itself starts with one of the strings <emphasis>%!</emphasis> or <emphasis><![CDATA[<04>%!]]></emphasis>, it is a generic PostScript file -(<emphasis>application/postscript</emphasis>). +(<parameter>application/postscript</parameter>). </para> +<warning><para> +Don't confuse the other mime.types files your system might be using +with the one in the <filename>/etc/cups/</filename> directory. +</para></warning> + <note><para> -There is a very important difference between two similar MIME type in -CUPS: one is <emphasis>application/postscript</emphasis>, the other is -<emphasis>application/vnd.cups-postscript</emphasis>. While -<emphasis>application/postscript</emphasis> is meant to be device +There is an important difference between two similar MIME types in +CUPS: one is <parameter>application/postscript</parameter>, the other is +<parameter>application/vnd.cups-postscript</parameter>. While +<parameter>application/postscript</parameter> is meant to be device independent (job options for the file are still outside the PS file -content, embedded in commandline or environment variables by CUPS), -<emphasis>application/vnd.cups-postscript</emphasis> may have the job -options inserted into the PostScript data itself (were +content, embedded in command line or environment variables by CUPS), +<parameter>application/vnd.cups-postscript</parameter> may have the job +options inserted into the PostScript data itself (where applicable). The transformation of the generic PostScript -(application/postscript) to the device-specific version -(application/vnd.cups-postscript) is the responsibility of the -CUPS <emphasis>pstops</emphasis> filter. pstops uses information +(<parameter>application/postscript</parameter>) to the device-specific version +(<parameter>application/vnd.cups-postscript</parameter>) is the responsibility of the +CUPS <parameter>pstops</parameter> filter. pstops uses information contained in the PPD to do the transformation. </para></note> -<warning><para> -Don't confuse the other mime.types file your system might be using -with the one in the <filename>/etc/cups/</filename> directory. -</para></warning> - <para> -CUPS can handle ASCII text, HP-GL, PDF, PostScript, DVI and a -lot of image formats (GIF. PNG, TIFF, JPEG, Photo-CD, SUN-Raster, -PNM, PBM, SGI-RGB and some more) and their associated MIME types +CUPS can handle ASCII text, HP-GL, PDF, PostScript, DVI, and +many image formats (GIF. PNG, TIFF, JPEG, Photo-CD, SUN-Raster, +PNM, PBM, SGI-RGB, and more) and their associated MIME types with its filters. </para> </sect2> <sect2> -<title>MIME type Conversion Rules</title> +<title>MIME Type Conversion Rules</title> -<indexterm><primary>MIME</primary></indexterm> <para> +<indexterm><primary>MIME</primary></indexterm> +<indexterm><primary>application/pdf</primary></indexterm> CUPS reads the file <filename>/etc/cups/mime.convs</filename> (and all other files named with a <filename>*.convs</filename> suffix in the same directory) upon startup. These files contain lines naming an input MIME type, an output MIME type, a format -conversion filter which can produce the output from the input type +conversion filter that can produce the output from the input type and virtual costs associated with this conversion. One example line reads like this: -</para> -<para><screen> +<filterline> application/pdf application/postscript 33 pdftops -</screen></para> +</filterline> -<para> -This means that the <emphasis>pdftops</emphasis> filter will take -<emphasis>application/pdf</emphasis> as input and produce -<emphasis>application/postscript</emphasis> as output, the virtual +This means that the <parameter>pdftops</parameter> filter will take +<parameter>application/pdf</parameter> as input and produce +<parameter>application/postscript</parameter> as output; the virtual cost of this operation is 33 CUPS-$. The next filter is more expensive, costing 66 CUPS-$: -</para> <indexterm><primary>pdf</primary></indexterm> -<para><screen> +<filterline> application/vnd.hp-HPGL application/postscript 66 hpgltops -</screen></para> +</filterline> -<para> -This is the <emphasis>hpgltops</emphasis>, which processes HP-GL +This is the <parameter>hpgltops</parameter>, which processes HP-GL plotter files to PostScript. -</para> <indexterm><primary>application/octet-stream</primary></indexterm> -<para><screen> +<filterline> application/octet-stream -</screen></para> +</filterline> -<para> Here are two more examples: -</para> <indexterm><primary>text/plain</primary></indexterm> -<para><screen> +<filterline> application/x-shell application/postscript 33 texttops text/plain application/postscript 33 texttops -</screen></para> +</filterline> -<para> -The last two examples name the <emphasis>texttops</emphasis> filter -to work on "text/plain" as well as on "application/x-shell". (Hint: -this differentiation is needed for the syntax highlighting feature of -"texttops"). +The last two examples name the <parameter>texttops</parameter> filter +to work on <parameter>text/plain</parameter> as well as on <parameter>application/x-shell</parameter>. (Hint: +This differentiation is needed for the syntax highlighting feature of +<parameter>texttops</parameter>). </para> </sect2> <sect2> -<title>Filter Requirements</title> +<title>Filtering Overview</title> -<indexterm><primary>MIME</primary></indexterm> <para> -There are many more combinations named in mime.convs. However, you +<indexterm><primary>MIME</primary></indexterm> +There are many more combinations named in <filename>mime.convs</filename>. However, you are not limited to use the ones pre-defined there. You can plug in any filter you like into the CUPS framework. It must meet, or must be made -to meet some minimal requirements. If you find (or write) a cool +to meet, some minimal requirements. If you find (or write) a cool conversion filter of some kind, make sure it complies to what CUPS -needs, and put in the right lines in <filename>mime.types</filename> +needs and put in the right lines in <filename>mime.types</filename> and <filename>mime.convs</filename>, then it will work seamlessly -inside CUPS! +inside CUPS. </para> -<tip><para> -The mentioned "CUPS requirements" for filters are simple. Take +<sect3> +<title>Filter requirements</title> +<para> +The mentioned <quote>CUPS requirements</quote> for filters are simple. Take filenames or <filename>stdin</filename> as input and write to <filename>stdout</filename>. They should take these 5 or 6 arguments: <emphasis>printer job user title copies options [filename]</emphasis> </para> <variablelist> -<varlistentry><term>Printer</term> +<varlistentry><term>Printer </term> <listitem><para>The name of the printer queue (normally this is the -name of the filter being run)</para></listitem> +name of the filter being run).</para></listitem> </varlistentry> -<varlistentry><term>job</term> +<varlistentry><term>job </term> <listitem><para>The numeric job ID for the job being -printed</para></listitem> +printed.</para></listitem> </varlistentry> -<varlistentry><term>user</term> +<varlistentry><term>user </term> <listitem><para>The string from the originating-user-name -attribute</para></listitem> +attribute.</para></listitem> </varlistentry> -<varlistentry><term>title</term> -<listitem><para>The string from the job-name attribute</para></listitem> +<varlistentry><term>title </term> +<listitem><para>The string from the job-name attribute.</para></listitem> </varlistentry> -<varlistentry><term>copies</term> +<varlistentry><term>copies </term> <listitem><para>The numeric value from the number-copies -attribute</para></listitem> +attribute.</para></listitem> </varlistentry> -<varlistentry><term>options</term> -<listitem><para>The job options</para></listitem> +<varlistentry><term>options </term> +<listitem><para>The job options.</para></listitem> </varlistentry> -<varlistentry><term>filename</term> +<varlistentry><term>filename </term> <listitem><para>(Optionally) The print request file (if missing, filters expected data fed through <filename>stdin</filename>). In most -cases it is very easy to write a simple wrapper script around existing +cases, it is easy to write a simple wrapper script around existing filters to make them work with CUPS.</para></listitem> </varlistentry> </variablelist> -</tip> +</sect3> </sect2> <sect2> <title>Prefilters</title> -<indexterm><primary>PostScript</primary></indexterm> <para> -As was said, PostScript is the central file format to any UNIX based +<indexterm><primary>PostScript</primary></indexterm> +As previously stated, PostScript is the central file format to any UNIX-based printing system. From PostScript, CUPS generates raster data to feed non-PostScript printers. </para> <para> -But what is happening if you send one of the supported non-PS formats -to print? Then CUPS runs "pre-filters" on these input formats to +But what happens if you send one of the supported non-PS formats +to print? Then CUPS runs <quote>pre-filters</quote> on these input formats to generate PostScript first. There are pre-filters to create PS from -ASCII text, PDF, DVI or HP-GL. The outcome of these filters is always -of MIME type <emphasis>application/postscript</emphasis> (meaning that +ASCII text, PDF, DVI, or HP-GL. The outcome of these filters is always +of MIME type <parameter>application/postscript</parameter> (meaning that any device-specific print options are not yet embedded into the PostScript by CUPS, and that the next filter to be called is pstops). Another pre-filter is running on all supported image formats, -the <emphasis>imagetops</emphasis> filter. Its outcome is always of -MIME type <emphasis>application/vnd.cups-postscript</emphasis> -(<emphasis>not</emphasis> application/postscript), meaning it has the +the <parameter>imagetops</parameter> filter. Its outcome is always of +MIME type <parameter>application/vnd.cups-postscript</parameter> +(not application/postscript), meaning it has the print options already embedded into the file. </para> <para> - <image id="small4" scale="25"><imagedescription>Prefiltering in CUPS to form Postscript</imagedescription> + <image scale="25"><imagedescription>Pre-filtering in CUPS to form PostScript.</imagedescription> <imagefile>4small</imagefile> </image> </para> @@ -1142,38 +1133,38 @@ print options already embedded into the file. <title>pstops</title> <para> -<emphasis>pstops</emphasis>is the filter to convert -<emphasis>application/postscript</emphasis> to -<emphasis>application/vnd.cups-postscript</emphasis>. It was said +<emphasis>pstops</emphasis> is the filter to convert +<parameter>application/postscript</parameter> to <?latex \linebreak ?> +<parameter>application/vnd.cups-postscript</parameter>. It was said above that this filter inserts all device-specific print options (commands to the printer to ask for the duplexing of output, or -stapling an punching it, etc.) into the PostScript file. +stapling and punching it, and so on) into the PostScript file. </para> <para> - <image id="small5" scale="25"><imagedescription>Adding Device-specific Print Options</imagedescription> + <image scale="25"><imagedescription>Adding device-specific print options.</imagedescription> <imagefile>5small</imagefile> </image> </para> <para> -This is not all: other tasks performed by it are: +This is not all. Other tasks performed by it are: </para> <itemizedlist> <listitem><para> -selecting the range of pages to be printed (if you choose to -print only pages "3, 6, 8-11, 16, 19-21", or only the odd numbered -ones) +Selecting the range of pages to be printed (if you choose to +print only pages <quote>3, 6, 8-11, 16, 19-21</quote>, or only the odd numbered +ones). </para></listitem> <listitem><para> -putting 2 or more logical pages on one sheet of paper (the -so-called "number-up" function) +Putting 2 or more logical pages on one sheet of paper (the +so-called <quote>number-up</quote> function). </para></listitem> -<listitem><para>counting the pages of the job to insert the accounting -information into the <filename>/var/log/cups/page_log</filename> +<listitem><para>Counting the pages of the job to insert the accounting +information into the <filename>/var/log/cups/page_log</filename>. </para></listitem> </itemizedlist> </sect2> @@ -1182,53 +1173,53 @@ information into the <filename>/var/log/cups/page_log</filename> <title>pstoraster</title> <para> -<emphasis>pstoraster</emphasis> is at the core of the CUPS filtering +<parameter>pstoraster</parameter> is at the core of the CUPS filtering system. It is responsible for the first stage of the rasterization process. Its input is of MIME type application/vnd.cups-postscript; its output is application/vnd.cups-raster. This output format is not yet meant to be printable. Its aim is to serve as a general purpose -input format for more specialized <emphasis>raster drivers</emphasis>, +input format for more specialized <emphasis>raster drivers</emphasis> that are able to generate device-specific printer data. </para> <para> - <image id="small6" scale="25"><imagedescription>Postscript to intermediate Raster format</imagedescription><imagefile>6small</imagefile></image> + <image scale="25"><imagedescription>PostScript to intermediate raster format.</imagedescription><imagefile>6small</imagefile></image> </para> <para> CUPS raster is a generic raster format with powerful features. It is -able to include per-page information, color profiles and more to be +able to include per-page information, color profiles, and more, to be used by the following downstream raster drivers. Its MIME type is -registered with IANA and its specification is of course completely -open. It is designed to make it very easy and inexpensive for +registered with IANA and its specification is, of course, completely +open. It is designed to make it quite easy and inexpensive for manufacturers to develop Linux and UNIX raster drivers for their printer models, should they choose to do so. CUPS always takes care -for the first stage of rasterization so these vendors don't need to care +for the first stage of rasterization so these vendors do not need to care about Ghostscript complications (in fact, there is currently more than one vendor financing the development of CUPS raster drivers). </para> <para> - <image id="small7"><imagedescription>CUPS-raster production using Ghostscript</imagedescription> + <image><imagedescription>CUPS-raster production using Ghostscript.</imagedescription> <imagefile>7small</imagefile> </image> </para> <para> CUPS versions before version 1.1.15 were shipping a binary (or source -code) standalone filter, named "pstoraster". pstoraster was derived +code) standalone filter, named <parameter>pstoraster</parameter>. <parameter>pstoraster</parameter> was derived from GNU Ghostscript 5.50, and could be installed besides and in addition to any GNU or AFPL Ghostscript package without conflicting. </para> <para> -From version 1.1.15, this has changed. The functions for this has been +>From version 1.1.15, this has changed. The functions for this have been integrated back into Ghostscript (now based on GNU Ghostscript version -7.05). The "pstoraster" filter is now a simple shell script calling +7.05). The <parameter>pstoraster</parameter> filter is now a simple shell script calling <command>gs</command> with the <command>-sDEVICE=cups</command> -parameter. If your Ghostscript doesn't show a success on asking for +parameter. If your Ghostscript does not show a success on asking for <command>gs -h |grep cups</command>, you might not be able to -print. Update your Ghostscript then! +print. Update your Ghostscript. </para> </sect2> @@ -1236,16 +1227,16 @@ print. Update your Ghostscript then! <title>imagetops and imagetoraster</title> <para> -Above in the section about prefilters, we mentioned the prefilter -that generates PostScript from image formats. The imagetoraster +In the section about pre-filters, we mentioned the pre-filter +that generates PostScript from image formats. The <parameter>imagetoraster</parameter> filter is used to convert directly from image to raster, without the intermediate PostScript stage. It is used more often than the above -mentioned prefilters. Here is a summarizing flowchart of image file -filtering: +mentioned pre-filters. A summarizing flowchart of image file +filtering is shown in <link linkend="small8"/>. </para> <para> - <image id="small8"><imagedescription>Image format to CUPS-raster format conversion</imagedescription> + <image id="small8"><imagedescription>Image format to CUPS-raster format conversion.</imagedescription> <imagefile>8small</imagefile> </image> </para> @@ -1256,21 +1247,21 @@ filtering: <title>rasterto [printers specific]</title> <para> -CUPS ships with quite some different raster drivers processing CUPS +CUPS ships with quite different raster drivers processing CUPS raster. On my system I find in /usr/lib/cups/filter/ these: <parameter>rastertoalps</parameter>, <parameter>rastertobj</parameter>, <parameter>rastertoepson</parameter>, <parameter>rastertoescp</parameter>, <parameter>rastertopcl</parameter>, <parameter>rastertoturboprint</parameter>, <parameter>rastertoapdk</parameter>, <parameter>rastertodymo</parameter>, -<parameter>rastertoescp</parameter>, <parameter>rastertohp</parameter> and +<parameter>rastertoescp</parameter>, <parameter>rastertohp</parameter>, and <parameter>rastertoprinter</parameter>. Don't worry if you have less than this; some of these are installed by commercial add-ons to CUPS (like <parameter>rastertoturboprint</parameter>), others (like -<parameter>rastertoprinter</parameter>) by 3rd party driver +<parameter>rastertoprinter</parameter>) by third-party driver development projects (such as Gimp-Print) wanting to cooperate as closely as possible with CUPS. </para> <para> - <image id="small9"><imagedescription>Raster to Printer Specific formats</imagedescription> + <image id="small9"><imagedescription>Raster to printer-specific formats.</imagedescription> <imagefile>9small</imagefile> </image> </para> @@ -1280,11 +1271,11 @@ closely as possible with CUPS. <title>CUPS Backends</title> <para> -The last part of any CUPS filtering chain is a "backend". Backends +The last part of any CUPS filtering chain is a backend. Backends are special programs that send the print-ready file to the final device. There is a separate backend program for any transfer -"protocol" of sending printjobs over the network, or for every local -interface. Every CUPS printqueue needs to have a CUPS "device-URI" +protocol of sending printjobs over the network, or for every local +interface. Every CUPS print queue needs to have a CUPS <quote>device-URI</quote> associated with it. The device URI is the way to encode the backend used to send the job to its destination. Network device-URIs are using two slashes in their syntax, local device URIs only one, as you can @@ -1293,100 +1284,105 @@ may vary much from my examples, if your OS is not Linux: </para> <variablelist> -<varlistentry><term>usb</term> -<listitem><para> -This backend sends printfiles to USB-connected printers. An -example for the CUPS device-URI to use is: -<filename>usb:/dev/usb/lp0</filename> -</para></listitem></varlistentry> + <varlistentry><term>usb </term> + <listitem><para> + This backend sends printfiles to USB-connected printers. An + example for the CUPS device-URI to use is: + <filename>usb:/dev/usb/lp0</filename>. + </para></listitem></varlistentry> -<varlistentry><term>serial</term> -<listitem><para> -This backend sends printfiles to serially connected printers. -An example for the CUPS device-URI to use is: -<filename>serial:/dev/ttyS0?baud=11500</filename> -</para></listitem></varlistentry> + <varlistentry><term>serial </term> + <listitem><para> + This backend sends printfiles to serially connected printers. + An example for the CUPS device-URI to use is: + <filename>serial:/dev/ttyS0?baud=11500</filename>. + </para></listitem></varlistentry> -<varlistentry><term>parallel</term> -<listitem><para> -This backend sends printfiles to printers connected to the -parallel port. An example for the CUPS device-URI to use is: -<filename>parallel:/dev/lp0</filename> -</para></listitem></varlistentry> + <varlistentry><term>parallel </term> + <listitem><para> + This backend sends printfiles to printers connected to the + parallel port. An example for the CUPS device-URI to use is: + <filename>parallel:/dev/lp0</filename>. + </para></listitem></varlistentry> -<varlistentry><term>scsi</term> -<listitem><para> -This backend sends printfiles to printers attached to the -SCSI interface. An example for the CUPS device-URI to use is: -<filename>scsi:/dev/sr1</filename> -</para></listitem></varlistentry> + <varlistentry><term>scsi </term> + <listitem><para> + This backend sends printfiles to printers attached to the + SCSI interface. An example for the CUPS device-URI to use is: + <filename>scsi:/dev/sr1</filename>. + </para></listitem></varlistentry> -<varlistentry><term>lpd</term> -<listitem><para> -This backend sends printfiles to LPR/LPD connected network -printers. An example for the CUPS device-URI to use is: -<filename>lpd://remote_host_name/remote_queue_name</filename> -</para></listitem></varlistentry> + <varlistentry><term>lpd </term> + <listitem><para> + This backend sends printfiles to LPR/LPD connected network + printers. An example for the CUPS device-URI to use is: + <filename>lpd://remote_host_name/remote_queue_name</filename>. + </para></listitem></varlistentry> -<varlistentry><term>AppSocket/HP JetDirect</term> -<listitem><para> -This backend sends printfiles to AppSocket (a.k.a. "HP -JetDirect") connected network printers. An example for the CUPS -device-URI to use is: -<filename>socket://10.11.12.13:9100</filename> -</para></listitem></varlistentry> + <varlistentry><term>AppSocket/HP JetDirect </term> + <listitem><para> + This backend sends printfiles to AppSocket (a.k.a. "HP + JetDirect") connected network printers. An example for the CUPS + device-URI to use is: + <filename>socket://10.11.12.13:9100</filename>. + </para></listitem></varlistentry> -<varlistentry><term>ipp</term> -<listitem><para> -This backend sends printfiles to IPP connected network -printers (or to other CUPS servers). Examples for CUPS device-URIs -to use are: -<filename>ipp:://192.193.194.195/ipp</filename> -(for many HP printers) or -<filename>ipp://remote_cups_server/printers/remote_printer_name</filename> -</para></listitem></varlistentry> + <varlistentry><term>ipp </term> + <listitem><para> + This backend sends printfiles to IPP connected network + printers (or to other CUPS servers). Examples for CUPS device-URIs + to use are: + <filename>ipp:://192.193.194.195/ipp</filename> + (for many HP printers) or + <filename>ipp://remote_cups_server/printers/remote_printer_name</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>http </term> + <listitem><para> + This backend sends printfiles to HTTP connected printers. + (The http:// CUPS backend is only a symlink to the ipp:// backend.) + Examples for the CUPS device-URIs to use are: + <filename>http:://192.193.194.195:631/ipp</filename> + (for many HP printers) or + <filename>http://remote_cups_server:631/printers/remote_printer_name</filename>. + </para></listitem></varlistentry> + + <varlistentry><term>smb </term> + <listitem><para> + This backend sends printfiles to printers shared by a Windows + host. An example for CUPS device-URIs that may be used includes: + </para> -<varlistentry><term>http</term> -<listitem><para> -This backend sends printfiles to HTTP connected printers. -(The http:// CUPS backend is only a symlink to the ipp:// backend.) -Examples for the CUPS device-URIs to use are: -<filename>http:://192.193.194.195:631/ipp</filename> -(for many HP printers) or -<filename>http://remote_cups_server:631/printers/remote_printer_name</filename> -</para></listitem></varlistentry> + <para> + <simplelist> + <member><filename>smb://workgroup/server/printersharename</filename></member> + <member><filename>smb://server/printersharename</filename></member> + <member><filename>smb://username:password@workgroup/server/printersharename</filename></member> + <member><filename>smb://username:password@server/printersharename</filename></member> + </simplelist> + </para> -<varlistentry><term>smb</term> -<listitem><para> -This backend sends printfiles to printers shared by a Windows -host. An example for CUPS device-URIs to use are: -<filename>smb://workgroup/server/printersharename</filename> -Or -<filename>smb://server/printersharename</filename> -or -<filename>smb://username:password@workgroup/server/printersharename</filename> -or -<filename>smb://username:password@server/printersharename</filename>. -The smb:// backend is a symlink to the Samba utility -<emphasis>smbspool</emphasis> (doesn't ship with CUPS). If the -symlink is not present in your CUPS backend directory, have your -root user create it: <command>ln -s `which smbspool` -/usr/lib/cups/backend/smb</command>. -</para></listitem></varlistentry> + <para> + The smb:// backend is a symlink to the Samba utility + <parameter>smbspool</parameter> (does not ship with CUPS). If the + symlink is not present in your CUPS backend directory, have your + root user create it: <command>ln -s `which smbspool' + /usr/lib/cups/backend/smb</command>. + </para></listitem></varlistentry> </variablelist> <para> -It is easy to write your own backends as Shell or Perl scripts, if you +It is easy to write your own backends as shell or Perl scripts, if you need any modification or extension to the CUPS print system. One -reason could be that you want to create "special" printers which send -the printjobs as email (through a "mailto:/" backend), convert them to -PDF (through a "pdfgen:/" backend) or dump them to "/dev/null" (In +reason could be that you want to create <quote>special</quote> printers that send +the printjobs as email (through a <quote>mailto:/</quote> backend), convert them to +PDF (through a <quote>pdfgen:/</quote> backend) or dump them to <quote>/dev/null</quote>. (In fact I have the system-wide default printer set up to be connected to -a "devnull:/" backend: there are just too many people sending jobs -without specifying a printer, or scripts and programs which don't name +a devnull:/ backend: there are just too many people sending jobs +without specifying a printer, or scripts and programs which do not name a printer. The system-wide default deletes the job and sends a polite -mail back to the $USER asking him to always specify a correct -printername). +email back to the $USER asking him to always specify the correct +printer name.) </para> <para> @@ -1403,73 +1399,64 @@ all available backends: </sect2> <sect2> -<title>cupsomatic/Foomatic -- how do they fit into the Picture?</title> +<title>The Role of <parameter>cupsomatic/foomatic</parameter></title> +<para> <indexterm><primary>cupsomatic</primary></indexterm> <indexterm><primary>foomatic</primary></indexterm> - -<para> -"cupsomatic" filters may be the most widely used on CUPS +<parameter>cupsomatic</parameter> filters may be the most widely used on CUPS installations. You must be clear about the fact that these were not -developed by the CUPS people. They are a "Third Party" add-on to +developed by the CUPS people. They are a third party add-on to CUPS. They utilize the traditional Ghostscript devices to render jobs for CUPS. When troubleshooting, you should know about the difference. Here the whole rendering process is done in one stage, -inside Ghostscript, using an appropriate "device" for the target -printer. cupsomatic uses PPDs which are generated from the "Foomatic" +inside Ghostscript, using an appropriate device for the target +printer. <parameter>cupsomatic</parameter> uses PPDs that are generated from the Foomatic Printer & Driver Database at Linuxprinting.org. </para> <para> You can recognize these PPDs from the line calling the -<emphasis>cupsomatic</emphasis> filter: -</para> +<parameter>cupsomatic</parameter> filter: -<para><screen> +<filterline> *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" -</screen></para> +</filterline> -<para> -This line you may find amongst the first 40 or so lines of the PPD +You may find this line among the first 40 or so lines of the PPD file. If you have such a PPD installed, the printer shows up in the -CUPS web interface with a <emphasis>foomatic</emphasis> namepart for -the driver description. cupsomatic is a Perl script that runs -Ghostscript, with all the complicated commandline options -auto-constructed from the selected PPD and commandline options give to +CUPS Web interface with a <parameter>foomatic</parameter> namepart for +the driver description. <parameter>cupsomatic</parameter> is a Perl script that runs +Ghostscript with all the complicated command line options +auto-constructed from the selected PPD and command line options give to the printjob. </para> -<indexterm><primary>point and print</primary></indexterm> - <para> -However, cupsomatic is now deprecated. Its PPDs (especially the first +<indexterm><primary>point 'n' print</primary></indexterm> + However, <parameter>cupsomatic</parameter> is now deprecated. Its PPDs (especially the first generation of them, still in heavy use out there) are not meeting the Adobe specifications. You might also suffer difficulties when you try -to download them with "Point'n'Print" to Windows clients. A better, -and more powerful successor is now in a very stable Beta-version -available: it is called <emphasis>foomatic-rip</emphasis>. To use -foomatic-rip as a filter with CUPS, you need the new-type PPDs. These -have a similar, but different line: -</para> - -<para><screen> +to download them with <quote>Point'n'Print</quote> to Windows clients. A better +and more powerful successor is now in a stable beta-version: it is called <parameter>foomatic-rip</parameter>. To use +<parameter>foomatic-rip</parameter> as a filter with CUPS, you need the new-type PPDs. These +have a similar but different line: +<filterline> *cupsFilter: "application/vnd.cups-postscript 0 foomatic-rip" +</filterline> -</screen></para> - -<para> The PPD generating engine at Linuxprinting.org has been revamped. The new PPDs comply to the Adobe spec. On top, they also provide a new way to specify different quality levels (hi-res photo, normal -color, grayscale, draft...) with a single click (whereas before you -could have required 5 or more different selections (media type, -resolution, inktype, dithering algorithm...). There is support for +color, grayscale, and draft) with a single click, whereas before you +could have required five or more different selections (media type, +resolution, inktype and dithering algorithm). There is support for custom-size media built in. There is support to switch -print-options from page to page, in the middle of a job. And the -best thing is: the new foomatic-rip now works seamlessly with all -legacy spoolers too (like LPRng, BSD-LPD, PDQ, PPR etc.), providing -for them access to use PPDs for their printing! +print-options from page to page in the middle of a job. And the +best thing is the new foomatic-rip now works seamlessly with all +legacy spoolers too (like LPRng, BSD-LPD, PDQ, PPR and so on), providing +for them access to use PPDs for their printing. </para> </sect2> @@ -1477,7 +1464,7 @@ for them access to use PPDs for their printing! <title>The Complete Picture</title> <para> -If you want to see an overview over all the filters and how they +If you want to see an overview of all the filters and how they relate to each other, the complete picture of the puzzle is at the end of this document. </para> @@ -1489,34 +1476,34 @@ of this document. <para> CUPS auto-constructs all possible filtering chain paths for any given MIME type, and every printer installed. But how does it decide in -favor or against a specific alternative? (There may often be cases, +favor or against a specific alternative? (There may often be cases where there is a choice of two or more possible filtering chains for -the same target printer). Simple: you may have noticed the figures in -the 3rd column of the mime.convs file. They represent virtual costs +the same target printer.) Simple. You may have noticed the figures in +the third column of the mime.convs file. They represent virtual costs assigned to this filter. Every possible filtering chain will sum up to -a total "filter cost". CUPS decides for the most "inexpensive" route. +a total <quote>filter cost.</quote> CUPS decides for the most <quote>inexpensive</quote> route. </para> <tip><para> The setting of <parameter>FilterLimit 1000</parameter> in <filename>cupsd.conf</filename> will not allow more filters to run concurrently than will consume a total of 1000 virtual filter -cost. This is a very efficient way to limit the load of any CUPS -server by setting an appropriate "FilterLimit" value. A FilterLimit of -200 allows roughly 1 job at a time, while a FilterLimit of 1000 allows -approximately 5 jobs maximum at a time. +cost. This is an efficient way to limit the load of any CUPS +server by setting an appropriate <quote>FilterLimit</quote> value. A FilterLimit of +200 allows roughly one job at a time, while a FilterLimit of 1000 allows +approximately five jobs maximum at a time. </para></tip> </sect2> <sect2> -<title>"Raw" printing</title> + <title><quote>Raw</quote> Printing</title> <para> -You can tell CUPS to print (nearly) any file "raw". "Raw" means it -will not be filtered. CUPS will send the file to the printer "as is" + You can tell CUPS to print (nearly) any file <quote>raw</quote>. <quote>Raw</quote> means it + will not be filtered. CUPS will send the file to the printer <quote>as is</quote> without bothering if the printer is able to digest it. Users need to take care themselves that they send sensible data formats only. Raw -printing can happen on any queue if the "-o raw" option is specified +printing can happen on any queue if the <quote><parameter>-o raw</parameter></quote> option is specified on the command line. You can also set up raw-only queues by simply not associating any PPD with it. This command: </para> @@ -1526,40 +1513,40 @@ associating any PPD with it. This command: </screen></para> <para> -sets up a queue named "rawprinter", connected via the "socket" -protocol (a.k.a. "HP JetDirect") to the device at IP address + sets up a queue named <quote>rawprinter</quote>, connected via the <quote>socket</quote> + protocol (a.k.a. <quote>HP JetDirect</quote>) to the device at IP address 11.12.1.3.14, using port 9100. (If you had added a PPD with <command>-P /path/to/PPD</command> to this command line, you would -have installed a "normal" printqueue. +have installed a <quote>normal</quote> print queue. </para> <para> -CUPS will automatically treat each job sent to a queue as a "raw" one, -if it can't find a PPD associated with the queue. However, CUPS will +CUPS will automatically treat each job sent to a queue as a <quote>raw</quote> one, +if it can't find a PPD associated with the queue. However, CUPS will only send known MIME types (as defined in its own mime.types file) and refuse others. </para> </sect2> <sect2> -<title>"application/octet-stream" printing</title> +<title>application/octet-stream Printing</title> <para> Any MIME type with no rule in the <filename>/etc/cups/mime.types</filename> file is regarded as unknown -or <emphasis>application/octet-stream</emphasis> and will not be +or <parameter>application/octet-stream</parameter> and will not be sent. Because CUPS refuses to print unknown MIME types per default, -you will probably have experienced the fact that printjobs originating +you will probably have experienced the fact that print jobs originating from Windows clients were not printed. You may have found an error message in your CUPS logs like: </para> -<para><screen> +<para><computeroutput> Unable to convert file 0 to printable format for job -</screen></para> +</computeroutput></para> <para> -To enable the printing of "application/octet-stream" files, edit +To enable the printing of <parameter>application/octet-stream</parameter> files, edit these two files: </para> @@ -1572,41 +1559,37 @@ these two files: <para> Both contain entries (at the end of the respective files) which must be uncommented to allow RAW mode operation for -application/octet-stream. In <filename>/etc/cups/mime.types</filename> +<parameter>application/octet-stream</parameter>. In <filename>/etc/cups/mime.types</filename> make sure this line is present: -</para> <indexterm><primary>application/octet-stream</primary></indexterm> -<para><screen> - application/octet-stream -</screen></para> +<filterline> +application/octet-stream +</filterline> -<para> This line (with no specific auto-typing rule set) makes all files -not otherwise auto-typed a member of application/octet-stream. In +not otherwise auto-typed a member of <parameter>application/octet-stream</parameter>. In <filename>/etc/cups/mime.convs</filename>, have this line: -</para> -<para><screen> - application/octet-stream application/vnd.cups-raw 0 - -</screen></para> +<filterline> +application/octet-stream application/vnd.cups-raw 0 - +</filterline> <indexterm><primary>MIME</primary></indexterm> -<para> This line tells CUPS to use the <emphasis>Null Filter</emphasis> -(denoted as "-", doing... nothing at all) on -<emphasis>application/octet-stream</emphasis>, and tag the result as -<emphasis>application/vnd.cups-raw</emphasis>. This last one is +(denoted as <quote>-</quote>, doing nothing at all) on +<parameter>application/octet-stream</parameter>, and tag the result as +<parameter>application/vnd.cups-raw</parameter>. This last one is always a green light to the CUPS scheduler to now hand the file over -to the "backend" connecting to the printer and sending it over. +to the backend connecting to the printer and sending it over. </para> -<note><para> Editing the <filename>mime.convs</filename> and the +<note><para>Editing the <filename>mime.convs</filename> and the <filename>mime.types</filename> file does not -<emphasis>enforce</emphasis> "raw" printing, it only +<emphasis>enforce</emphasis> <quote>raw</quote> printing, it only <emphasis>allows</emphasis> it. </para></note> @@ -1616,14 +1599,14 @@ to the "backend" connecting to the printer and sending it over. <para> CUPS being a more security-aware printing system than traditional ones does not by default allow one to send deliberate (possibly binary) -data to printing devices. (This could be easily abused to launch a +data to printing devices. (This could be easily abused to launch a Denial of Service attack on your printer(s), causing at least the loss -of a lot of paper and ink...) "Unknown" data are regarded by CUPS +of a lot of paper and ink...) <quote>Unknown</quote> data are regarded by CUPS as <emphasis>MIME type</emphasis> <emphasis>application/octet-stream</emphasis>. While you -<emphasis>can</emphasis> send data "raw", the MIME type for these must +<emphasis>can</emphasis> send data <quote>raw</quote>, the MIME type for these must be one that is known to CUPS and an allowed one. The file -<filename>/etc/cups/mime.types</filename> defines the "rules" how CUPS +<filename>/etc/cups/mime.types</filename> defines the <quote>rules</quote> of how CUPS recognizes MIME types. The file <filename>/etc/cups/mime.convs</filename> decides which file conversion filter(s) may be applied to which MIME types. @@ -1632,18 +1615,18 @@ conversion filter(s) may be applied to which MIME types. </sect2> <sect2> -<title>PostScript Printer Descriptions (PPDs) for non-PS Printers</title> +<title>PostScript Printer Descriptions (PPDs) for Non-PS Printers</title> -<indexterm><primary>PPD</primary></indexterm> <para> +<indexterm><primary>PPD</primary></indexterm> Originally PPDs were meant to be used for PostScript printers only. Here, they help to send device-specific commands and settings to the RIP which processes the jobfile. CUPS has extended this scope for PPDs to cover non-PostScript printers too. This was not -very difficult, because it is a standardized file format. In a way +difficult, because it is a standardized file format. In a way it was logical too: CUPS handles PostScript and uses a PostScript -RIP (=Ghostscript) to process the jobfiles. The only difference is: +RIP (Ghostscript) to process the jobfiles. The only difference is: a PostScript printer has the RIP built-in, for other types of printers the Ghostscript RIP runs on the host computer. </para> @@ -1651,22 +1634,20 @@ printers the Ghostscript RIP runs on the host computer. <para> PPDs for a non-PS printer have a few lines that are unique to CUPS. The most important one looks similar to this: -</para> <indexterm><primary>application/vnd.cups-raster</primary></indexterm> -<para><screen> +<filterline> *cupsFilter: application/vnd.cups-raster 66 rastertoprinter -</screen></para> +</filterline> -<para> It is the last piece in the CUPS filtering puzzle. This line tells the -CUPS daemon to use as a last filter "rastertoprinter". This filter -should be served as input an "application/vnd.cups-raster" MIME type -file. Therefore CUPS should auto-construct a filtering chain, which +CUPS daemon to use as a last filter <parameter>rastertoprinter</parameter>. This filter +should be served as input an <parameter>application/vnd.cups-raster</parameter> MIME type +file. Therefore, CUPS should auto-construct a filtering chain, which delivers as its last output the specified MIME type. This is then -taken as input to the specified "rastertoprinter" filter. After this -the last filter has done its work ("rastertoprinter" is a Gimp-Print +taken as input to the specified <parameter>rastertoprinter</parameter> filter. After this +the last filter has done its work (<parameter>rastertoprinter</parameter> is a Gimp-Print filter), the file should go to the backend, which sends it to the output device. </para> @@ -1675,17 +1656,17 @@ output device. CUPS by default ships only a few generic PPDs, but they are good for several hundred printer models. You may not be able to control different paper trays, or you may get larger margins than your -specific model supports): +specific model supports. See <link linkend="cups-ppds"/> for summary information. </para> -<table frame="all"> - <title>PPD's shipped with CUPS</title> +<table frame="all" id="cups-ppds"> + <title>PPDs shipped with CUPS</title> <tgroup cols="2" align="left"> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" width="1*"/> <thead><row><entry>PPD file</entry><entry>Printer type</entry></row></thead> <tbody> - <row><entry>deskjet.ppd</entry><entry>older HP inkjet printers and compatible</entry></row> + <row><entry>deskjet.ppd</entry><entry>older HP inkjet printers and compatible</entry></row> <row><entry>deskjet2.ppd</entry> <entry>newer HP inkjet printers and compatible </entry> </row> @@ -1707,7 +1688,8 @@ specific model supports): <row><entry>stphoto2.ppd</entry> <entry>newer Epson Stylus Photo printers </entry> </row> - <row><entry>laserjet.ppd</entry> <entry>all PCL printers. Further below is a discussion of several other driver/PPD-packages suitable for use with CUPS. </entry> </row> + <row><entry>laserjet.ppd</entry> <entry>all PCL printers. Further below is a discussion + of several other driver/PPD-packages suitable for use with CUPS. </entry> </row> </tbody> </tgroup> @@ -1716,28 +1698,27 @@ specific model supports): </sect2> <sect2> -<title>Difference between <emphasis>cupsomatic/foomatic-rip</emphasis> and -<emphasis>native CUPS</emphasis> printing</title> +<title><emphasis>cupsomatic/foomatic-rip</emphasis> Versus <emphasis>native CUPS</emphasis> Printing</title> -<indexterm><primary>cupsomatic</primary></indexterm> -<indexterm><primary>foomatic-rip</primary></indexterm> <para> -Native CUPS rasterization works in two steps. +<indexterm><primary>cupsomatic</primary></indexterm> +<indexterm><primary>foomatic-rip</primary></indexterm> +Native CUPS rasterization works in two steps: </para> <itemizedlist> <listitem><para> -First is the "pstoraster" step. It uses the special "cups" +First is the <parameter>pstoraster</parameter> step. It uses the special CUPS <indexterm><primary>ESP</primary><secondary>Ghostscript</secondary></indexterm> -device from ESP Ghostscript 7.05.x as its tool +device from ESP Ghostscript 7.05.x as its tool. </para></listitem> <listitem><para> -Second comes the "rasterdriver" step. It uses various +Second comes the <parameter>rasterdriver</parameter> step. It uses various device-specific filters; there are several vendors who provide good -quality filters for this step, some are Free Software, some are -Shareware/Non-Free, some are proprietary.</para></listitem> +quality filters for this step. Some are free software, some are +shareware/non-free and some are proprietary.</para></listitem> </itemizedlist> <para> @@ -1746,33 +1727,33 @@ advantages) than other methods. </para> <para> - <image id="small10"><imagedescription>cupsomatic/foomatic processing versus Native CUPS</imagedescription> + <image id="cupsomatic-dia"><imagedescription>cupsomatic/foomatic Processing versus Native CUPS.</imagedescription> <imagefile>10small</imagefile> </image> </para> <para> -One other method is the <emphasis>cupsomatic/foomatic-rip</emphasis> -way. Note that cupsomatic is <emphasis>not</emphasis> made by the CUPS +One other method is the <parameter>cupsomatic/foomatic-rip</parameter> +way. Note that <parameter>cupsomatic</parameter> is <emphasis>not</emphasis> made by the CUPS developers. It is an independent contribution to printing development, -made by people from Linuxprinting.org (see also <ulink - noescape="1" url="http://www.cups.org/cups-help.html">http://www.cups.org/cups-help.html</ulink>). -cupsomatic is no longer developed and maintained and is no longer +made by people from Linuxprinting.org <footnote>see also <ulink + noescape="1" url="http://www.cups.org/cups-help.html">http://www.cups.org/cups-help.html</ulink></footnote>. +<parameter>cupsomatic</parameter> is no longer developed and maintained and is no longer supported. It has now been replaced by -<emphasis>foomatic-rip</emphasis>. foomatic-rip is a complete re-write -of the old cupsomatic idea, but very much improved and generalized to +<parameter>foomatic-rip</parameter>. <parameter>foomatic-rip</parameter> is a complete re-write +of the old <parameter>cupsomatic</parameter> idea, but very much improved and generalized to other (non-CUPS) spoolers. An upgrade to foomatic-rip is strongly -advised, especially if you are upgrading to a recent version of CUPS +advised, especially if you are upgrading to a recent version of CUPS, too. </para> <para> <indexterm><primary>cupsomatic</primary></indexterm> <indexterm><primary>foomatic</primary></indexterm> -Both the cupsomatic (old) and the foomatic-rip (new) methods from +Both the <parameter>cupsomatic</parameter> (old) and the <parameter>foomatic-rip</parameter> (new) methods from Linuxprinting.org use the traditional Ghostscript print file processing, doing everything in a single step. It therefore relies on -all the other devices built-in into Ghostscript. The quality is as +all the other devices built into Ghostscript. The quality is as good (or bad) as Ghostscript rendering is in other spoolers. The advantage is that this method supports many printer models not supported (yet) by the more modern CUPS method. @@ -1780,25 +1761,25 @@ supported (yet) by the more modern CUPS method. <para> Of course, you can use both methods side by side on one system (and -even for one printer, if you set up different queues), and find out +even for one printer, if you set up different queues) and find out which works best for you. </para> <para> -cupsomatic "kidnaps" the printfile after the -<emphasis>application/vnd.cups-postscript</emphasis> stage and -deviates it through the CUPS-external, system wide Ghostscript -installation: Therefore the printfile bypasses the "pstoraster" filter -(and thus also bypasses the CUPS-raster-drivers -"rastertosomething"). After Ghostscript finished its rasterization, -cupsomatic hands the rendered file directly to the CUPS backend. The -flowchart above illustrates the difference between native CUPS -rendering and the Foomatic/cupsomatic method. +<parameter>cupsomatic</parameter> kidnaps the printfile after the +<parameter>application/vnd.cups-postscript</parameter> stage and +deviates it through the CUPS-external, system-wide Ghostscript +installation. Therefore the printfile bypasses the <parameter>pstoraster</parameter> filter +(and also bypasses the CUPS-raster-drivers +<parameter>rastertosomething</parameter>). After Ghostscript finished its rasterization, +<parameter>cupsomatic</parameter> hands the rendered file directly to the CUPS backend. The +flowchart in <link linkend="cupsomatic-dia"/> illustrates the difference between native CUPS +rendering and the <parameter>Foomatic/cupsomatic</parameter> method. </para> </sect2> <sect2> -<title>Examples for filtering Chains</title> +<title>Examples for Filtering Chains</title> <para> Here are a few examples of commonly occurring filtering chains to @@ -1806,96 +1787,98 @@ illustrate the workings of CUPS. </para> <para> -Assume you want to print a PDF file to a HP JetDirect-connected +Assume you want to print a PDF file to an HP JetDirect-connected PostScript printer, but you want to print the pages 3-5, 7, 11-13 -only, and you want to print them "2-up" and "duplex": +only, and you want to print them <quote>two-up</quote> and <quote>duplex</quote>: </para> <itemizedlist> -<listitem><para>your print options (page selection as required, 2-up, -duplex) are passed to CUPS on the commandline;</para></listitem> - -<listitem><para>the (complete) PDF file is sent to CUPS and autotyped as -<emphasis>application/pdf</emphasis>;</para></listitem> - -<listitem><para>the file therefore first must pass the -<emphasis>pdftops</emphasis> pre-filter, which produces PostScript -MIME type <emphasis>application/postscript</emphasis> (a preview here -would still show all pages of the original PDF);</para></listitem> - -<listitem><para>the file then passes the <emphasis>pstops</emphasis> -filter which applies the commandline options: it selects the pages -2-5, 7 and 11-13, creates and imposed layout "2 pages on 1 sheet" and -inserts the correct "duplex" command (as is defined in the printer's -PPD) into the new PostScript file; the file now is of PostScript MIME +<listitem><para>Your print options (page selection as required, two-up, +duplex) are passed to CUPS on the command line.</para></listitem> + +<listitem><para>The (complete) PDF file is sent to CUPS and autotyped as +<parameter>application/pdf</parameter>.</para></listitem> + +<listitem><para>The file therefore must first pass the +<parameter>pdftops</parameter> pre-filter, which produces PostScript +MIME type <parameter>application/postscript</parameter> (a preview here +would still show all pages of the original PDF).</para></listitem> + +<listitem><para>The file then passes the <parameter>pstops</parameter> +filter that applies the command line options: it selects the pages +2-5, 7 and 11-13, creates an imposed layout <quote>2 pages on 1 sheet</quote> and +inserts the correct <quote>duplex</quote> command (as defined in the printer's +PPD) into the new PostScript file; the file is now of PostScript MIME type -<emphasis>application/vnd.cups-postscript</emphasis>;</para></listitem> +<parameter>application/vnd.cups-postscript</parameter>.</para></listitem> -<listitem><para>the file goes to the <emphasis>socket</emphasis> +<listitem><para>The file goes to the <parameter>socket</parameter> backend, which transfers the job to the printers.</para></listitem> </itemizedlist> <para> - The resulting filter chain therefore is as drawn in <link linkend="pdftosocket">the image below</link>. + The resulting filter chain, therefore, is as drawn in <link linkend="pdftosocket"/>. </para> -<image><imagefile>pdftosocket</imagefile><imagedescription>PDF to socket chain</imagedescription></image> +<image id="pdftosocket"><imagefile>pdftosocket</imagefile><imagedescription>PDF to socket chain.</imagedescription></image> <para> Assume your want to print the same filter to an USB-connected -Epson Stylus Photo printer, installed with the CUPS +Epson Stylus Photo printer installed with the CUPS <filename>stphoto2.ppd</filename>. The first few filtering stages are nearly the same: </para> <itemizedlist> -<listitem><para>your print options (page selection as required, 2-up, -duplex) are passed to CUPS on the commandline;</para></listitem> +<listitem><para>Your print options (page selection as required, two-up, +duplex) are passed to CUPS on the commandline.</para></listitem> -<listitem><para>the (complete) PDF file is sent to CUPS and autotyped as -<emphasis>application/pdf</emphasis>;</para></listitem> +<listitem><para>The (complete) PDF file is sent to CUPS and autotyped as +<parameter>application/pdf</parameter>.</para></listitem> -<listitem><para>the file therefore first must pass the -<emphasis>pdftops</emphasis> pre-filter, which produces PostScript -MIME type <emphasis>application/postscript</emphasis> (a preview here -would still show all pages of the original PDF);</para></listitem> +<listitem><para>The file must first pass the +<parameter>pdftops</parameter> pre-filter, which produces PostScript +MIME type <parameter>application/postscript</parameter> (a preview here +would still show all pages of the original PDF).</para></listitem> -<listitem><para>the file then passes the "pstops" filter which applies +<listitem><para>The file then passes the <quote>pstops</quote> filter that applies the commandline options: it selects the pages 2-5, 7 and 11-13, -creates and imposed layout "2 pages on 1 sheet" and inserts the -correct "duplex" command... (OOoops -- this printer and his PPD -don't support duplex printing at all -- this option will be ignored -then) into the new PostScript file; the file now is of PostScript +creates an imposed layout <quote>two pages on one sheet</quote> and inserts the +correct <quote>duplex</quote> command... (Oops &smbmdash; this printer and PPD +do not support duplex printing at all &smbmdash; so this option will +be ignored) into the new PostScript file; the file is now of PostScript MIME type -<emphasis>application/vnd.cups-postscript</emphasis>;</para></listitem> +<parameter>application/vnd.cups-postscript</parameter>.</para></listitem> -<listitem><para>the file then passes the -<emphasis>pstoraster</emphasis> stage and becomes MIME type -<emphasis>application/cups-raster</emphasis>;</para></listitem> +<listitem><para>The file then passes the + <!--FIXME--> +<parameter>pstoraster</parameter> stage and becomes MIME type +<parameter>application/ +cups-raster</parameter>.</para></listitem> -<listitem><para>finally, the <emphasis>rastertoepson</emphasis> filter -does its work (as is indicated in the printer's PPD), creating the -printer-specific raster data and embedding any user-selected -print-options into the print data stream;</para></listitem> +<listitem><para>Finally, the <parameter>rastertoepson</parameter> filter +does its work (as indicated in the printer's PPD), creating the +rinter-specific raster data and embedding any user-selected +print-options into the print data stream.</para></listitem> -<listitem><para>the file goes to the <emphasis>usb</emphasis> backend, +<listitem><para>The file goes to the <parameter>usb</parameter> backend, which transfers the job to the printers.</para></listitem> </itemizedlist> <para> - The resulting filter chain therefore is as drawn in <link linkend="pdftoepsonusb">the image below</link>. +The resulting filter chain therefore is as drawn in <link linkend="pdftoepsonusb"/>. </para> -<image><imagefile>pdftoepsonusb</imagefile><imagedescription>PDF to USB chain</imagedescription></image> +<image id="pdftoepsonusb"><imagefile>pdftoepsonusb</imagefile><imagedescription>PDF to USB chain.</imagedescription></image> </sect2> <sect2> -<title>Sources of CUPS drivers / PPDs</title> +<title>Sources of CUPS Drivers/PPDs</title> <para> -On the internet you can find now many thousand CUPS-PPD files -(with their companion filters), in many national languages, -supporting more than 1000 non-PostScript models. +On the Internet you can now find many thousands of CUPS-PPD files +(with their companion filters), in many national languages +supporting more than thousand non-PostScript models. </para> <itemizedlist> @@ -1903,61 +1886,56 @@ supporting more than 1000 non-PostScript models. <indexterm><primary>PrintPro</primary><see>ESP Print Pro</see></indexterm> <listitem><para><ulink url="http://wwwl.easysw.com/printpro/">ESP PrintPro</ulink> (commercial, -non-Free) is packaged with more than 3000 PPDs, ready for -successful use "out of the box" on Linux, Mac OS X, IBM-AIX, -HP-UX, Sun-Solaris, SGI-IRIX, Compaq Tru64, Digital UNIX and some +non-free) is packaged with more than three thousand PPDs, ready for +successful use <quote>out of the box</quote> on Linux, Mac OS X, IBM-AIX, +HP-UX, Sun-Solaris, SGI-IRIX, Compaq Tru64, Digital UNIX, and some more commercial Unices (it is written by the CUPS developers themselves and its sales help finance the further development of CUPS, as they feed their creators).</para></listitem> -<listitem><para>the <ulink +<listitem><para>The <ulink url="http://gimp-print.sourceforge.net/">Gimp-Print-Project -</ulink> (GPL, Free Software) +</ulink> (GPL, free software) provides around 140 PPDs (supporting nearly 400 printers, many driven to photo quality output), to be used alongside the Gimp-Print CUPS -filters;</para></listitem> +filters.</para></listitem> <listitem><para><ulink url="http://www.turboprint.com/">TurboPrint -</ulink> (Shareware, non-Free) supports +</ulink> (shareware, non-free) supports roughly the same amount of printers in excellent -quality;</para></listitem> +quality.</para></listitem> <listitem><para><ulink url="http://www-124.ibm.com/developerworks/oss/linux/projects/omni/">OMNI </ulink> -(LPGL, Free) is a package made by IBM, now containing support for more +(LPGL, free) is a package made by IBM, now containing support for more than 400 printers, stemming from the inheritance of IBM OS/2 Know-How -ported over to Linux (CUPS support is in a Beta-stage at -present);</para></listitem> +ported over to Linux (CUPS support is in a beta-stage at +present).</para></listitem> <listitem><para><ulink url="http://hpinkjet.sourceforge.net/">HPIJS -</ulink> (BSD-style licenses, Free) +</ulink> (BSD-style licenses, free) supports around 150 of HP's own printers and is also providing excellent print quality now (currently available only via the Foomatic -path);</para></listitem> +path).</para></listitem> <listitem><para><ulink url="http://www.linuxprinting.org/">Foomatic/cupsomatic -</ulink> (LPGL, Free) from +</ulink> (LPGL, free) from Linuxprinting.org are providing PPDs for practically every Ghostscript filter known to the world (including Omni, Gimp-Print and HPIJS).</para></listitem> </itemizedlist> -<note><para> -The cupsomatic/Foomatic trick from Linuxprinting.org works -differently from the other drivers. This is explained elsewhere in this -document. -</para></note> </sect2> <sect2> <title>Printing with Interface Scripts</title> <para> -CUPS also supports the usage of "interface scripts" as known from +CUPS also supports the usage of <quote>interface scripts</quote> as known from System V AT&T printing systems. These are often used for PCL -printers, from applications that generate PCL print jobs. Interface +printers, from applications that generate PCL print jobs. Interface scripts are specific to printer models. They have a similar role as PPDs for PostScript printers. Interface scripts may inject the Escape sequences as required into the print data stream, if the user has @@ -1974,8 +1952,8 @@ the <command>-i</command> option: </screen></para> <para> -Interface scripts might be the "unknown animal" to many. However, -with CUPS they provide the most easy way to plug in your own +Interface scripts might be the <quote>unknown animal</quote> to many. However, +with CUPS they provide the easiest way to plug in your own custom-written filtering script or program into one specific print queue (some information about the traditional usage of interface scripts is to be found at <ulink @@ -1985,12 +1963,12 @@ to be found at <ulink </sect1> <sect1> -<title>Network printing (purely Windows)</title> + <title>Network Printing (Purely Windows)</title> <para> Network printing covers a lot of ground. To understand what exactly goes on with Samba when it is printing on behalf of its Windows -clients, let's first look at a "purely Windows" setup: Windows clients +clients, let's first look at a <quote>purely Windows</quote> setup: Windows clients with a Windows NT print server. </para> @@ -1999,24 +1977,24 @@ with a Windows NT print server. <para> Windows clients printing to an NT-based print server have two -options. They may -</para> - +options. They may: <indexterm><primary>GDI</primary></indexterm> <indexterm><primary>EMF</primary></indexterm> +</para> + <itemizedlist> -<listitem><para>execute the driver locally and render the GDI output -(EMF) into the printer specific format on their own, -or</para></listitem> + <listitem><para>Execute the driver locally and render the GDI output + (EMF) into the printer-specific format on their own. + </para></listitem> -<listitem><para>send the GDI output (EMF) to the server, where the + <listitem><para>Send the GDI output (EMF) to the server, where the driver is executed to render the printer specific output.</para></listitem> </itemizedlist> <para> -Both print paths are shown in the flowcharts below. +Both print paths are shown in the flowcharts in <link linkend="small11"/> and <link linkend="small12"/>. </para> </sect2> @@ -2024,19 +2002,19 @@ Both print paths are shown in the flowcharts below. <title>Driver Execution on the Client</title> <para> -In the first case the print server must spool the file as "raw", +In the first case the print server must spool the file as raw, meaning it shouldn't touch the jobfile and try to convert it in any -way. This is what traditional UNIX-based print server can do too; and -at a better performance and more reliably than NT print server. This +way. This is what a traditional UNIX-based print server can do too, and +at a better performance and more reliably than an NT print server. This is what most Samba administrators probably are familiar with. One -advantage of this setup is that this "spooling-only" print server may +advantage of this setup is that this <quote>spooling-only</quote> print server may be used even if no driver(s) for UNIX are available it is sufficient -to have the Windows client drivers available and installed on the +to have the Windows client drivers available; and installed on the clients. </para> <para> - <image id="small11"><imagedescription>Print Driver execution on the Client</imagedescription> + <image id="small11"><imagedescription>Print driver execution on the client.</imagedescription> <imagefile>11small</imagefile> </image> </para> @@ -2045,51 +2023,51 @@ clients. <sect2> <title>Driver Execution on the Server</title> + +<para> <indexterm><primary>PostScript</primary></indexterm> <indexterm><primary>PCL</primary></indexterm> <indexterm><primary>ESC/P</primary></indexterm> <indexterm><primary>EMF</primary></indexterm> <indexterm><primary>GDI</primary></indexterm> - -<para> -The other path executes the printer driver on the server. The clients +The other path executes the printer driver on the server. The client transfers print files in EMF format to the server. The server uses the PostScript, PCL, ESC/P or other driver to convert the EMF file into the printer-specific language. It is not possible for UNIX to do the -same. Currently there is no program or method to convert a Windows +same. Currently, there is no program or method to convert a Windows client's GDI output on a UNIX server into something a printer could understand. </para> <para> - <image id="small12"><imagedescription>Print Driver execution on the Server</imagedescription> + <image id="small12"><imagedescription>Print driver execution on the server.</imagedescription> <imagefile>12small</imagefile> </image> </para> <para> -However, there is something similar possible with CUPS. Read on... +However, there is something similar possible with CUPS. Read on. </para> </sect2> </sect1> <sect1> -<title>Network Printing (Windows clients -- UNIX/Samba Print +<title>Network Printing (Windows Clients &smbmdash; UNIX/Samba Print Servers)</title> <para> Since UNIX print servers <emphasis>cannot</emphasis> execute the Win32 program code on their platform, the picture is somewhat -different. However, this doesn't limit your options all that -much. In the contrary, you may have a way here to implement printing -features which are not possible otherwise. +different. However, this does not limit your options all that +much. On the contrary, you may have a way here to implement printing +features that are not possible otherwise. </para> <sect2> <title>From Windows Clients to a CUPS/Samba Print Server</title> <para> -Here is a simple recipe showing how you can take advantage of CUPS +Here is a simple recipe showing how you can take advantage of CUPS' powerful features for the benefit of your Windows network printing clients: </para> @@ -2099,35 +2077,33 @@ clients: <listitem><para>Let the Windows clients send PostScript to the CUPS server.</para></listitem> -<listitem><para>Let the CUPS server render the PostScript into device -specific raster format.</para></listitem> +<listitem><para>Let the CUPS server render the PostScript into device-specific raster format.</para></listitem> </itemizedlist> <para> This requires the clients to use a PostScript driver (even if the printer is a non-PostScript model. It also requires that you have a -"driver" on the CUPS server. +driver on the CUPS server. </para> <para> -Firstly, to enable CUPS based printing through Samba the +First, to enable CUPS-based rinting through Samba the following options should be set in your &smb.conf; file [global] section: </para> -<itemizedlist> -<listitem><para><smbconfoption><name>printing</name><value>cups</value></smbconfoption></para></listitem> - -<listitem><para><smbconfoption><name>printcap</name><value>cups</value></smbconfoption></para></listitem> -</itemizedlist> +<smbconfblock> +<smbconfoption><name>printing</name><value>cups</value></smbconfoption> +<smbconfoption><name>printcap</name><value>cups</value></smbconfoption> +</smbconfblock> <para> When these parameters are specified, all manually set print directives (like <smbconfoption><name>print command</name></smbconfoption>, or <smbconfoption><name>lppause command</name></smbconfoption>) in &smb.conf; (as well as -in samba itself) will be ignored. Instead, Samba will directly -interface with CUPS through it's application program interface (API) - +in Samba itself) will be ignored. Instead, Samba will directly +interface with CUPS through its application program interface (API), as long as Samba has been compiled with CUPS library (libcups) -support. If Samba has NOT been compiled with CUPS support, and if no +support. If Samba has not been compiled with CUPS support, and if no other print commands are set up, then printing will use the <emphasis>System V</emphasis> AT&T command set, with the -oraw option automatically passing through (if you want your own defined @@ -2136,14 +2112,14 @@ simply use <smbconfoption><name>printing</name><value>sysv</value></smbconfoptio </para> <para> -<image id="small13"><imagedescription>Printing via CUPS/samba server</imagedescription> +<image><imagedescription>Printing via CUPS/Samba server.</imagedescription> <imagefile>13small</imagefile> </image> </para> </sect2> <sect2> -<title>Samba receiving Jobfiles and passing them to CUPS</title> +<title>Samba Receiving Jobfiles and Passing Them to CUPS</title> <para> Samba <emphasis>must</emphasis> use its own spool directory (it is set @@ -2154,62 +2130,66 @@ in the <smbconfsection>[printers]</smbconfsection> or spool space and passes it into the spool directory of CUPS (the CUPS spooling directory is set by the <parameter>RequestRoot</parameter> directive, in a line that defaults to <parameter>RequestRoot -/var/spool/cups</parameter>). CUPS checks the access rights of its -spool dir and resets it to healthy values with every re-start. We have -seen quite some people who had used a common spooling space for Samba -and CUPS, and were struggling for weeks with this "problem". +/var/spool/cups</parameter>). CUPS checks the access rights of its +spool dir and resets it to healthy values with every restart. We have +seen quite a few people who had used a common spooling space for Samba +and CUPS, and were struggling for weeks with this <quote>problem.</quote> </para> <para> A Windows user authenticates only to Samba (by whatever means is configured). If Samba runs on the same host as CUPS, you only need to -allow "localhost" to print. If they run on different machines, you +allow <quote>localhost</quote> to print. If they run on different machines, you need to make sure the Samba host gets access to printing on CUPS. </para> </sect2> </sect1> <sect1> -<title>Network PostScript RIP: CUPS Filters on Server -- clients use -PostScript Driver with CUPS-PPDs</title> +<title>Network PostScript RIP</title> + +<para> +This section discusses the use of CUPS filters on the server &smbmdash; configuration where +clients make use of a PostScript driver with CUPS-PPDs. +</para> + +<para> <indexterm><primary>PostScript</primary></indexterm> <indexterm><primary>PCL</primary></indexterm> <indexterm><primary>PJL</primary></indexterm> - -<para> PPDs can control all print device options. They are usually provided -by the manufacturer; if you own a PostScript printer, that is. PPD +by the manufacturer, if you own a PostScript printer, that is. PPD files (PostScript Printer Descriptions) are always a component of PostScript printer drivers on MS Windows or Apple Mac OS systems. They are ASCII files containing user-selectable print options, mapped to appropriate PostScript, PCL or PJL commands for the target printer. Printer driver GUI dialogs translate these options -"on-the-fly" into buttons and drop-down lists for the user to select. +<quote>on-the-fly</quote> into buttons and drop-down lists for the user to select. </para> <para> CUPS can load, without any conversions, the PPD file from any Windows (NT is recommended) PostScript driver and handle the options. There is -a web browser interface to the print options (select <ulink +a Web browser interface to the print options (select <ulink noescape="1" url="http://localhost:631/printers/">http://localhost:631/printers/</ulink> -and click on one <emphasis>Configure Printer</emphasis> button to see -it), or a commandline interface (see <command>man lpoptions</command> -or see if you have lphelp on your system). There are also some +and click on one <guibutton>Configure Printer</guibutton> button to see +it), or a command line interface (see <command>man lpoptions</command> +or see if you have <command>lphelp</command> on your system). There are also some different GUI frontends on Linux/UNIX, which can present PPD options to users. PPD options are normally meant to be evaluated by the PostScript RIP on the real PostScript printer. </para> <sect2> -<title>PPDs for non-PS Printers on UNIX</title> +<title>PPDs for Non-PS Printers on UNIX</title> -<indexterm><primary>PPD</primary></indexterm> <para> -CUPS doesn't limit itself to "real" PostScript printers in its usage +<indexterm><primary>PPD</primary></indexterm> +CUPS does not limit itself to <quote>real</quote> PostScript printers in its usage of PPDs. The CUPS developers have extended the scope of the PPD -concept, to also describe available device and driver options for +concept to also describe available device and driver options for non-PostScript printers through CUPS-PPDs. </para> @@ -2219,7 +2199,7 @@ interpreter (RIP). This RIP is based on Ghostscript. It can process all received PostScript (and additionally many other file formats) from clients. All CUPS-PPDs geared to non-PostScript printers contain an additional line, starting with the keyword -<parameter>*cupsFilter</parameter> . This line tells the CUPS print +<parameter>*cupsFilter</parameter>. This line tells the CUPS print system which printer-specific filter to use for the interpretation of the supplied PostScript. Thus CUPS lets all its printers appear as PostScript devices to its clients, because it can act as a PostScript @@ -2229,36 +2209,36 @@ proper raster print format. </sect2> <sect2> -<title>PPDs for non-PS Printers on Windows</title> +<title>PPDs for Non-PS Printers on Windows</title> -<indexterm><primary>PPD</primary></indexterm> <para> +<indexterm><primary>PPD</primary></indexterm> CUPS-PPDs can also be used on Windows-Clients, on top of a -"core" PostScript driver (now recommended is the "CUPS PostScript -Driver for WindowsNT/2K/XP"; you can also use the Adobe one, with +<quote>core</quote> PostScript driver (now recommended is the "CUPS PostScript +Driver for WindowsNT/200x/XP"; you can also use the Adobe one, with limitations). This feature enables CUPS to do a few tricks no other spooler can do: </para> <itemizedlist> -<listitem><para>act as a networked PostScript RIP (Raster Image +<listitem><para>Act as a networked PostScript RIP (Raster Image Processor), handling printfiles from all client platforms in a uniform -way;</para></listitem> +way.</para></listitem> -<listitem><para>act as a central accounting and billing server, since -all files are passed through the pstops filter and are therefore +<listitem><para>Act as a central accounting and billing server, since +all files are passed through the pstops filter and are, therefore, logged in the CUPS <filename>page_log</filename> file. -<emphasis>NOTE:</emphasis> this can not happen with "raw" print jobs, -which always remain unfiltered per definition;</para></listitem> +<emphasis>Note:</emphasis> this cannot happen with <quote>raw</quote> print jobs, +which always remain unfiltered per definition.</para></listitem> -<listitem><para>enable clients to consolidate on a single PostScript +<listitem><para>Enable clients to consolidate on a single PostScript driver, even for many different target printers.</para></listitem> </itemizedlist> <para> Using CUPS PPDs on Windows clients enables these to control -all print job settings just as a UNIX client can do too. +all print job settings just as a UNIX client can do. </para> </sect2> </sect1> @@ -2268,123 +2248,123 @@ all print job settings just as a UNIX client can do too. <para> This setup may be of special interest to people experiencing major -problems in WTS environments. WTS need often a multitude of +problems in WTS environments. WTS often need a multitude of non-PostScript drivers installed to run their clients' variety of different printer models. This often imposes the price of much increased instability. </para> <sect2> -<title>Printer Drivers running in "Kernel Mode" cause many +<title>Printer Drivers Running in <quote>Kernel Mode</quote> Cause Many Problems</title> <para> -The reason is that in Win NT printer drivers run in "Kernel -Mode", this introduces a high risk for the stability of the system + In Windows NT printer drivers which run in <quote>Kernel +Mode</quote>, introduces a high risk for the stability of the system if the driver is not really stable and well-tested. And there are a lot of bad drivers out there! Especially notorious is the example of the PCL printer driver that had an additional sound module running, to notify users via soundcard of their finished jobs. Do I -need to say that this one was also reliably causing "Blue Screens -of Death" on a regular basis? +need to say that this one was also reliably causing <quote>blue screens +of death</quote> on a regular basis? </para> <para> -PostScript drivers generally are very well tested. They are not known -to cause any problems, even though they run in Kernel Mode too. This -might be because there have so far only been 2 different PostScript +PostScript drivers are generally well tested. They are not known +to cause any problems, even though they also run in kernel mode. This +might be because there have been so far only two different PostScript drivers: the ones from Adobe and the one from Microsoft. Both are -very well tested and are as stable as you ever can imagine on +well tested and are as stable as you can imagine on Windows. The CUPS driver is derived from the Microsoft one. </para> </sect2> <sect2> -<title>Workarounds impose Heavy Limitations</title> +<title>Workarounds Impose Heavy Limitations</title> <para> In many cases, in an attempt to work around this problem, site -administrators have resorted to restrict the allowed drivers installed -on their WTS to one generic PCL- and one PostScript driver. This -however restricts the clients in the amount of printer options -available for them; often they can't get out more than simplex +administrators have resorted to restricting the allowed drivers installed +on their WTS to one generic PCL and one PostScript driver. This, +however, restricts the clients in the number of printer options +available for them. Often they can't get out more than simplex prints from one standard paper tray, while their devices could do much -better, if driven by a different driver! ) +better, if driven by a different driver! </para> </sect2> <sect2> -<title>CUPS: a "Magical Stone"?</title> +<title>CUPS: A <quote>Magical Stone</quote>?</title> -<indexterm><primary>PPD</primary></indexterm> -<indexterm><primary>PostScript</primary></indexterm> <para> +<indexterm><primary>PPD</primary></indexterm> +<indexterm><primary>PostScript</primary></indexterm> Using a PostScript driver, enabled with a CUPS-PPD, seems to be a very elegant way to overcome all these shortcomings. There are, depending -on the version of Windows OS you use, up to 3 different PostScript +on the version of Windows OS you use, up to three different PostScript drivers available: Adobe, Microsoft and CUPS PostScript drivers. None of them is known to cause major stability problems on WTS (even if used with many different PPDs). The clients will be able to (again) chose paper trays, duplex printing and other settings. However, there is a certain price for this too: a CUPS server acting as a PostScript RIP for its clients requires more CPU and RAM than when just acting as -a "raw spooling" device. Plus, this setup is not yet widely tested, +a <quote>raw spooling</quote> device. Plus, this setup is not yet widely tested, although the first feedbacks look very promising. </para> </sect2> <sect2> -<title>PostScript Drivers with no major problems -- even in Kernel +<title>PostScript Drivers with No Major Problems &smbmdash; Even in Kernel Mode</title> -<indexterm><primary>DDK</primary></indexterm> <para> -More recent printer drivers on W2K and XP don't run in Kernel mode -(unlike Win NT) any more. However, both operating systems can still -use the NT drivers, running in Kernel mode (you can roughly tell which -is which as the drivers in subdirectory "2" of "W32X86" are "old" -ones). As was said before, the Adobe as well as the Microsoft +<indexterm><primary>DDK</primary></indexterm> +More recent printer drivers on W200x and XP no longer run in kernel mode +(unlike Windows NT). However, both operating systems can still +use the NT drivers, running in kernel mode (you can roughly tell which +is which as the drivers in subdirectory <quote>2</quote> of <quote>W32X86</quote> are <quote>old</quote> +ones). As was said before, the Adobe as well as the Microsoft PostScript drivers are not known to cause any stability problems. The CUPS driver is derived from the Microsoft one. There is a simple -reason for this: The MS DDK (Device Development Kit) for Win NT (which +reason for this: The MS DDK (Device Development Kit) for Windows NT (which used to be available at no cost to licensees of Visual Studio) includes the source code of the Microsoft driver, and licensees of Visual Studio are allowed to use and modify it for their own driver development efforts. This is what the CUPS people have done. The -license doesn't allow them to publish the whole of the source code. -However, they have released the "diff" under the GPL, and if you are -owner of an "MS DDK for Win NT", you can check the driver yourself. +license does not allow them to publish the whole of the source code. +However, they have released the <quote>diff</quote> under the GPL, and if you are +the owner of an <quote>MS DDK for Windows NT,</quote> you can check the driver yourself. </para> </sect2> </sect1> <sect1> -<title>Setting up CUPS for driver Download</title> +<title>Configuring CUPS for Driver Download</title> <para> -As we have said before: all previously known methods to prepare client -printer drivers on the Samba server for download and "Point'n'Print" -convenience of Windows workstations are working with CUPS too. These +As we have said before, all previously known methods to prepare client +printer drivers on the Samba server for download and Point'n'Print +convenience of Windows workstations are working with CUPS, too. These methods were described in the previous chapter. In reality, this is a -pure Samba business, and only relates to the Samba/Win client +pure Samba business and only relates to the Samba/Windows client relationship. </para> <sect2> -<title><emphasis>cupsaddsmb</emphasis>: the unknown Utility</title> +<title><emphasis>cupsaddsmb</emphasis>: The Unknown Utility</title> -<indexterm><primary>cupsaddsmb</primary></indexterm> <para> -The cupsaddsmb utility (shipped with all current CUPS versions) is an -alternative method to transfer printer drivers into the Samba +<indexterm><primary>cupsaddsmb</primary></indexterm> +The <command>cupsaddsmb</command> utility (shipped with all current CUPS versions) is an +alternate method to transfer printer drivers into the Samba <smbconfsection>[print$]</smbconfsection> share. Remember, this share is where clients expect drivers deposited and setup for download and -installation. It makes the sharing of any (or all) installed CUPS -printers very easy. cupsaddsmb can use the Adobe PostScript driver as -well as the newly developed <emphasis>CUPS PostScript Driver for -WinNT/2K/XP</emphasis>. Note, that cupsaddsmb does +installation. It makes the sharing of any (or all) installed CUPS +printers quite easy. <command>cupsaddsmb</command> can use the Adobe PostScript driver as +well as the newly developed CUPS PostScript Driver for +Windows NT/200x/XP. <parameter>cupsaddsmb</parameter> does <emphasis>not</emphasis> work with arbitrary vendor printer drivers, but only with the <emphasis>exact</emphasis> driver files that are named in its man page. @@ -2398,34 +2378,34 @@ advantages: </para> <itemizedlist> -<listitem><para>it supports a much more accurate page -accounting;</para></listitem> +<listitem><para>It supports a much more accurate page +accounting.</para></listitem> -<listitem><para>it supports banner pages, and page labels on all -printers;</para></listitem> +<listitem><para>It supports banner pages, and page labels on all +printers.</para></listitem> -<listitem><para>it supports the setting of a number of job IPP +<listitem><para>It supports the setting of a number of job IPP attributes (such as job-priority, page-label and -job-billing)</para></listitem> +job-billing).</para></listitem> </itemizedlist> <para> -However, currently only Windows NT, 2000, and XP are supported by the -CUPS drivers. You will need to get the respective part of Adobe driver -too if you need to support Windows 95, 98, and ME clients. +However, currently only Windows NT, 2000 and XP are supported by the +CUPS drivers. You will also need to get the respective part of Adobe driver +if you need to support Windows 95, 98 and ME clients. </para> </sect2> <sect2> -<title>Prepare your &smb.conf; for cupsaddsmb</title> + <title>Prepare Your &smb.conf; for <command>cupsaddsmb</command></title> <para> -Prior to running cupsaddsmb, you need the following settings in -&smb.conf;: +Prior to running <command>cupsaddsmb</command>, you need the settings in +&smb.conf; as shown in <link linkend="cupsadd-ex"/>: </para> -<para><smbconfexample> - <title>smb.conf for cupsaddsmb usage</title> +<para><smbconfexample id="cupsadd-ex"> +<title>smb.conf for cupsaddsmb usage</title> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>load printers</name><value>yes</value></smbconfoption> <smbconfoption><name>printing</name><value>cups</value></smbconfoption> @@ -2452,16 +2432,16 @@ Prior to running cupsaddsmb, you need the following settings in </sect2> <sect2> -<title>CUPS Package of "PostScript Driver for WinNT/2k/XP"</title> -<indexterm><primary>PostScript</primary></indexterm> +<title>CUPS <quote>PostScript Driver for Windows NT/200x/XP</quote></title> <para> -CUPS users may get the exactly same packages from <ulink +<indexterm><primary>PostScript</primary></indexterm> +CUPS users may get the exact same packages from <ulink noescape="1" url="http://www.cups.org/software.html">http://www.cups.org/software.html</ulink>. It is a separate package from the CUPS base software files, tagged as -<emphasis>CUPS 1.1.x Windows NT/2k/XP Printer Driver for Samba -(tar.gz, 192k)</emphasis>. The filename to download is -<filename>cups-samba-1.1.x.tar.gz</filename>. Upon untar-/unzip-ing, +CUPS 1.1.x Windows NT/200x/XP Printer Driver for Samba +(tar.gz, 192k). The filename to download is +<filename>cups-samba-1.1.x.tar.gz</filename>. Upon untar and unzipping, it will reveal these files: </para> @@ -2478,12 +2458,12 @@ cups-samba.ss <indexterm><primary>ESP</primary><secondary>meta packager</secondary></indexterm> <indexterm><primary>EPM</primary><see>ESP meta packager</see></indexterm> These have been packaged with the ESP meta packager software -"EPM". The <filename>*.install</filename> and +EPM. The <filename>*.install</filename> and <filename>*.remove</filename> files are simple shell scripts, which untars the <filename>*.ss</filename> (the <filename>*.ss</filename> is -nothing else but a tar-archive, which can be untar-ed by "tar" +nothing else but a tar-archive, which can be untarred by <quote>tar</quote> too). Then it puts the content into -<filename>/usr/share/cups/drivers/</filename>. This content includes 3 +<filename>/usr/share/cups/drivers/</filename>. This content includes three files: </para> @@ -2495,7 +2475,7 @@ cups.hlp </screen></para> <para> -The <emphasis>cups-samba.install</emphasis> shell scripts is easy to +The <parameter>cups-samba.install</parameter> shell scripts are easy to handle: </para> @@ -2505,7 +2485,7 @@ handle: Installing software... Updating file permissions... Running post-install commands... -Installation is complete. +Installation is complete. </screen></para> <para> @@ -2520,81 +2500,81 @@ into<filename>/usr/share/drivers/</filename> instead of <filename>/usr/share/cups/drivers/</filename>. To work around this, copy/move the file (after running the <command>./cups-samba.install</command> script) manually to the -right place. +correct place. </para></warning> <para><screen> &rootprompt;<userinput>cp /usr/share/drivers/cups.hlp /usr/share/cups/drivers/</userinput> </screen></para> -<indexterm><primary>DDK</primary></indexterm> <para> +<indexterm><primary>DDK</primary></indexterm> This new CUPS PostScript driver is currently binary-only, but free of -charge. No complete source code is provided (yet). The reason is this: -it has been developed with the help of the <emphasis>Microsoft Driver -Developer Kit</emphasis> (DDK) and compiled with Microsoft Visual +charge. No complete source code is provided (yet). The reason is that +it has been developed with the help of the Microsoft Driver +Developer Kit (DDK) and compiled with Microsoft Visual Studio 6. Driver developers are not allowed to distribute the whole of -the source code as Free Software. However, CUPS developers released -the "diff" in source code under the GPL, so anybody with a license of +the source code as free software. However, CUPS developers released +the <quote>diff</quote> in source code under the GPL, so anybody with a license of Visual Studio and a DDK will be able to compile for him/herself. </para> </sect2> <sect2> -<title>Recognize the different Driver Files</title> +<title>Recognizing Different Driver Files</title> <para> -The CUPS drivers don't support the "older" Windows 95/98/ME, but only -the Windows NT/2000/XP client: +The CUPS drivers do not support the older Windows 95/98/Me, but only +the Windows NT/2000/XP client. </para> -<para>Windows NT, 2000, and XP are supported by:</para> +<para>Windows NT, 2000 and XP are supported by:</para> <para> <itemizedlist> - <listitem><para>cups.hlp</para></listitem> - <listitem><para>cupsdrvr.dll</para></listitem> - <listitem><para>cupsui.dll</para></listitem> + <listitem>cups.hlp</listitem> + <listitem>cupsdrvr.dll</listitem> + <listitem>cupsui.dll</listitem> </itemizedlist> </para> <para> -Adobe drivers are available for the older Windows 95/98/ME as well as -the Windows NT/2000/XP clients. The set of files is different for the +Adobe drivers are available for the older Windows 95/98/Me as well as +the Windows NT/2000/XP clients. The set of files is different from the different platforms. </para> -<para>Windows 95, 98, and Me are supported by:</para> +<para>Windows 95, 98 and ME are supported by:</para> <para> <itemizedlist> - <listitem><para>ADFONTS.MFM</para></listitem> - <listitem><para>ADOBEPS4.DRV</para></listitem> - <listitem><para>ADOBEPS4.HLP</para></listitem> - <listitem><para>DEFPRTR2.PPD</para></listitem> - <listitem><para>ICONLIB.DLL</para></listitem> - <listitem><para>PSMON.DLL</para></listitem> + <listitem>ADFONTS.MFM</listitem> + <listitem>ADOBEPS4.DRV</listitem> + <listitem>ADOBEPS4.HLP</listitem> + <listitem>DEFPRTR2.PPD</listitem> + <listitem>ICONLIB.DLL</listitem> + <listitem>PSMON.DLL</listitem> </itemizedlist> </para> -<para>Windows NT, 2000, and XP are supported by:</para> +<para>Windows NT, 2000 and XP are supported by:</para> <para> <itemizedlist> - <listitem><para>ADOBEPS5.DLL</para></listitem> - <listitem><para>ADOBEPSU.DLL</para></listitem> - <listitem><para>ADOBEPSU.HLP</para></listitem> + <listitem>ADOBEPS5.DLL</listitem> + <listitem>ADOBEPSU.DLL</listitem> + <listitem>ADOBEPSU.HLP</listitem> </itemizedlist> </para> <note><para> -If both, the Adobe driver files and the CUPS driver files for the -support of WinNT/2k/XP are present in , the Adobe ones will be ignored -and the CUPS ones will be used. If you prefer -- for whatever reason --- to use Adobe-only drivers, move away the 3 CUPS driver files. The -Win95/98/ME clients use the Adobe drivers in any case. +If both the Adobe driver files and the CUPS driver files for the +support of Windows NT/200x/XP are present in FIXME, the Adobe ones will be ignored +and the CUPS ones will be used. If you prefer &smbmdash; for whatever reason +&smbmdash; to use Adobe-only drivers, move away the three CUPS driver files. The +Windows 9x/Me clients use the Adobe drivers in any case. </para></note> </sect2> @@ -2603,60 +2583,57 @@ Win95/98/ME clients use the Adobe drivers in any case. <para> Acquiring the Adobe driver files seems to be unexpectedly difficult -for many users. They are not available on the Adobe website as single -files and the self-extracting and/or self-installing Windows-exe is +for many users. They are not available on the Adobe Web site as single +files and the self-extracting and/or self-installing Windows-.exe is not easy to locate either. Probably you need to use the included native installer and run the installation process on one client once. This will install the drivers (and one Generic PostScript -printer) locally on the client. When they are installed, share the -Generic PostScript printer. After this, the client's +printer) locally on the client. When they are installed, share the +Generic PostScript printer. After this, the client's <smbconfsection>[print$]</smbconfsection> share holds the Adobe files, from -where you can get them with smbclient from the CUPS host. A more -detailed description about this is in the next (the CUPS printing) -chapter. +where you can get them with smbclient from the CUPS host. </para> </sect2> <sect2> -<title>ESP Print Pro Package of "PostScript Driver for -WinNT/2k/XP"</title> +<title>ESP Print Pro PostScript Driver for Windows NT/200x/XP</title> -<indexterm><primary>ESP</primary><secondary>Print Pro</secondary></indexterm> <para> -Users of the ESP Print Pro software are able to install their "Samba -Drivers" package for this purpose with no problem. Retrieve the driver +<indexterm><primary>ESP</primary><secondary>Print Pro</secondary></indexterm> +Users of the ESP Print Pro software are able to install their Samba +drivers package for this purpose with no problem. Retrieve the driver files from the normal download area of the ESP Print Pro software at <ulink noescape="1" url="http://www.easysw.com/software.html">http://www.easysw.com/software.html</ulink>. -You need to locate the link labelled "SAMBA" amongst the -<emphasis>Download Printer Drivers for ESP Print Pro 4.x</emphasis> +You need to locate the link labelled <quote>SAMBA</quote> among the +<guilabel>Download Printer Drivers for ESP Print Pro 4.x</guilabel> area and download the package. Once installed, you can prepare any driver by simply highlighting the printer in the Printer Manager GUI -and select <emphasis>Export Driver...</emphasis> from the menu. Of -course you need to have prepared Samba beforehand too to handle the -driver files; i.e. mainly setup the <smbconfsection>[print$]</smbconfsection> -share, etc. The ESP Print Pro package includes the CUPS driver files -as well as a (licensed) set of Adobe drivers for the Windows 95/98/ME +and select <guilabel>Export Driver...</guilabel> from the menu. Of +course you need to have prepared Samba beforehand to handle the +driver files; i.e., setup the <smbconfsection>[print$]</smbconfsection> +share, and so on. The ESP Print Pro package includes the CUPS driver files +as well as a (licensed) set of Adobe drivers for the Windows 95/98/Me client family. </para> </sect2> <sect2> -<title>Caveats to be considered</title> +<title>Caveats to be Considered</title> -<indexterm><primary>cupsaddsmb</primary></indexterm> <para> +<indexterm><primary>cupsaddsmb</primary></indexterm> Once you have run the install script (and possibly manually moved the <filename>cups.hlp</filename> file to <filename>/usr/share/cups/drivers/</filename>), the driver is ready to be put into Samba's <smbconfsection>[print$]</smbconfsection> share (which often maps to -<filename>/etc/samba/drivers/</filename> and contains a subdir +<filename>/etc/samba/drivers/</filename> and contains a subdirectory tree with <emphasis>WIN40</emphasis> and -<emphasis>W32X86</emphasis> branches): You do this by running -"cupsaddsmb" (see also <command>man cupsaddsmb</command> for +<emphasis>W32X86</emphasis> branches). You do this by running +<command>cupsaddsmb</command> (see also <command>man cupsaddsmb</command> for CUPS since release 1.1.16). </para> @@ -2666,159 +2643,155 @@ You may need to put root into the smbpasswd file by running <command>smbpasswd</command>; this is especially important if you should run this whole procedure for the first time, and are not working in an environment where everything is configured for -<emphasis>Single Sign On</emphasis> to a Windows Domain Controller. +<emphasis>single sign on</emphasis> to a Windows Domain Controller. </para></tip> <para> Once the driver files are in the <smbconfsection>[print$]</smbconfsection> share and are initialized, they are ready to be downloaded and installed by -the Win NT/2k/XP clients. +the Windows NT/200x/XP clients. </para> <note><para> -<orderedlist> -<listitem><para> -Win 9x/ME clients won't work with the CUPS PostScript driver. For -these you'd still need to use the <filename>ADOBE*.*</filename> -drivers as previously. -</para></listitem> +Win 9x/Me clients will not work with the CUPS PostScript driver. For +these you still need to use the <filename>ADOBE*.*</filename> +drivers as previously stated. +</para></note> -<listitem><para> +<note> +<para> It is not harmful if you still have the <filename>ADOBE*.*</filename> driver files from previous installations in the <filename>/usr/share/cups/drivers/</filename> -directory. The new <emphasis>cupsaddsmb</emphasis> (from 1.1.16) will -automatically prefer "its own" drivers if it finds both. -</para></listitem> +directory. The new <command>cupsaddsmb</command> (from 1.1.16) will +automatically prefer its own drivers if it finds both. +</para></note> -<listitem><para> +<note><para> <indexterm><primary>"Printers" folder</primary></indexterm> -Should your Win clients have had the old <filename>ADOBE*.*</filename> +Should your Windows clients have had the old <filename>ADOBE*.*</filename> files for the Adobe PostScript driver installed, the download and -installation of the new CUPS PostScript driver for Windows NT/2k/XP +installation of the new CUPS PostScript driver for Windows NT/200x/XP will fail at first. You need to wipe the old driver from the clients -first. It is not enough to "delete" the printer, as the driver files +first. It is not enough to <quote>delete</quote> the printer, as the driver files will still be kept by the clients and re-used if you try to re-install the printer. To really get rid of the Adobe driver files on the -clients, open the "Printers" folder (possibly via <emphasis>Start, Settings, Control Panel, Printers</emphasis>), -right-click onto the folder background and select <emphasis>Server -Properties</emphasis>. When the new dialog opens, select the -<emphasis>Drivers</emphasis> tab. On the list select the driver you -want to delete and click on the <emphasis>Delete</emphasis> +clients, open the <guilabel>Printers</guilabel> folder (possibly via <guilabel>Start > Settings > Control Panel > Printers</guilabel>), +right-click on the folder background and select <guimenuitem>Server +Properties</guimenuitem>. When the new dialog opens, select the +<guilabel>Drivers</guilabel> tab. On the list select the driver you +want to delete and click the <guilabel>Delete</guilabel> button. This will only work if there is not one single printer left -which uses that particular driver. You need to "delete" all printers -using this driver in the "Printers" folder first. You will need +that uses that particular driver. You need to <quote>delete</quote> all printers +using this driver in the <guilabel>Printers</guilabel> folder first. You will need Administrator privileges to do this. -</para></listitem> +</para></note> -<listitem><para> +<note><para> <indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> Once you have successfully downloaded the CUPS PostScript driver to a client, you can easily switch all printers to this one by proceeding -as described in <link linkend="printing">the printing chapter</link>: either change -a driver for an existing printer by running the "Printer Properties" +as described in <link linkend="printing"/>. Either change +a driver for an existing printer by running the <guilabel>Printer Properties</guilabel> dialog, or use <command>rpcclient</command> with the -<command>setdriver</command> sub-command. -</para></listitem> -</orderedlist> +<command>setdriver</command> subcommand. </para></note> </sect2> <sect2> -<title>Benefits of using "CUPS PostScript Driver for -Windows NT/2k/XP" instead of Adobe Driver</title> +<title>Windows CUPS PostScript Driver Versus Adobe Driver</title> <para> -You are interested in a comparison between the CUPS and the Adobe +Are you interested in a comparison between the CUPS and the Adobe PostScript drivers? For our purposes these are the most important -items which weigh in favor of the CUPS ones: +items that weigh in favor of the CUPS ones: </para> <itemizedlist> -<listitem><para>no hassle with the Adobe EULA</para></listitem> +<listitem><para>No hassle with the Adobe EULA.</para></listitem> -<listitem><para>no hassle with the question <quote>Where do I +<listitem><para>No hassle with the question <quote>Where do I get the ADOBE*.* driver files from?</quote></para></listitem> <listitem><para> <indexterm><primary>PJL</primary></indexterm> - the Adobe drivers (on request of the printer PPD +The Adobe drivers (on request of the printer PPD associated with them) often put a PJL header in front of the main -PostScript part of the print file. Thus the printfile starts with +PostScript part of the print file. Thus, the printfile starts with <parameter><1B >%-12345X</parameter> or <parameter><escape>%-12345X</parameter> instead of <parameter>%!PS</parameter>). This leads to the CUPS daemon auto-typing the incoming file as a print-ready file, -not initiating a pass through the "pstops" filter (to speak more -technically, it is not regarded as the generic MIME type +not initiating a pass through the <parameter>pstops</parameter> filter (to speak more +technically, it is not regarded as the generic MIME-type <indexterm><primary>application/postscript</primary></indexterm> -<emphasis>application/postscript</emphasis>, but as +<parameter>application/postscript</parameter>, but as the more special MIME type <indexterm><primary>application/cups.vnd-postscript</primary></indexterm> -<emphasis>application/cups.vnd-postscript</emphasis>), +<parameter>application/cups.vnd-postscript</parameter>), which therefore also leads to the page accounting in -<emphasis>/var/log/cups/page_log</emphasis> not +<parameter>/var/log/cups/page_log</parameter> not receiving the exact number of pages; instead the dummy page number -of "1" is logged in a standard setup)</para></listitem> +of <quote>1</quote> is logged in a standard setup).</para></listitem> -<listitem><para>the Adobe driver has more options to "mis-configure" the +<listitem><para>The Adobe driver has more options to misconfigure the PostScript generated by it (like setting it inadvertently to -<emphasis>Optimize for Speed</emphasis>, instead of -<emphasis>Optimize for Portability</emphasis>, which -could lead to CUPS being unable to process it)</para></listitem> - -<listitem><para>the CUPS PostScript driver output sent by Windows -clients to the CUPS server will be guaranteed to be auto-typed always -as generic MIME type <emphasis>application/postscript</emphasis>, -thusly passing through the CUPS "pstops" filter and logging the +<guilabel>Optimize for Speed</guilabel>, instead of +<guilabel>Optimize for Portability</guilabel>, which +could lead to CUPS being unable to process it).</para></listitem> + +<listitem><para>The CUPS PostScript driver output sent by Windows +clients to the CUPS server is guaranteed to auto-type +as the generic MIME type <parameter>application/postscript</parameter>, +thus passing through the CUPS <parameter>pstops</parameter> filter and logging the correct number of pages in the <filename>page_log</filename> for -accounting and quota purposes</para></listitem> +accounting and quota purposes.</para></listitem> -<listitem><para>the CUPS PostScript driver supports the sending of -additional standard (IPP) print options by Win NT/2k/XP clients. Such +<listitem><para>The CUPS PostScript driver supports the sending of +additional standard (IPP) print options by Windows NT/200x/XP clients. Such additional print options are: naming the CUPS standard <emphasis>banner pages</emphasis> (or the custom ones, should they be installed at the time of driver download), using the CUPS -<emphasis>page-label</emphasis> option, setting a -<emphasis>job-priority</emphasis> and setting the <emphasis>scheduled -time of printing</emphasis> (with the option to support additional +page-label option, setting a +job-priority, and setting the scheduled +time of printing (with the option to support additional useful IPP job attributes in the future).</para></listitem> -<listitem><para>the CUPS PostScript driver supports the inclusion of -the new <emphasis>*cupsJobTicket</emphasis> comments at the +<listitem><para>The CUPS PostScript driver supports the inclusion of +the new <parameter>*cupsJobTicket</parameter> comments at the beginning of the PostScript file (which could be used in the future for all sort of beneficial extensions on the CUPS side, but which will not disturb any other applications as they will regard it as a comment and simply ignore it).</para></listitem> -<listitem><para>the CUPS PostScript driver will be the heart of the -fully fledged CUPS IPP client for Windows NT/2K/XP to be released soon -(probably alongside the first Beta release for CUPS +<listitem><para>The CUPS PostScript driver will be the heart of the +fully fledged CUPS IPP client for Windows NT/200x/XP to be released soon +(probably alongside the first beta release for CUPS 1.2).</para></listitem> </itemizedlist> </sect2> <sect2> -<title>Run "cupsaddsmb" (quiet Mode)</title> +<title>Run cupsaddsmb (Quiet Mode)</title> -<indexterm><primary>cupsaddsmb</primary></indexterm> -<indexterm><primary>point and print</primary></indexterm> <para> -The cupsaddsmb command copies the needed files into your +<indexterm><primary>cupsaddsmb</primary></indexterm> +<indexterm><primary>point 'n' print</primary></indexterm> +The <command>cupsaddsmb</command> command copies the needed files into your <smbconfsection>[print$]</smbconfsection> share. Additionally, the PPD associated with this printer is copied from <filename>/etc/cups/ppd/</filename> to <smbconfsection>[print$]</smbconfsection>. There the files wait for convenient Windows client installations via Point'n'Print. Before we can run the command successfully, we need to be sure that we can authenticate -towards Samba. If you have a small network you are probably using user -level security (<smbconfoption><name>security</name><value>user</value></smbconfoption>). +toward Samba. If you have a small network, you are probably using user-level +security (<smbconfoption><name>security</name><value>user</value></smbconfoption>). </para> <para> -Here is an example of a successfully run cupsaddsmb command. +Here is an example of a successfully run <command>cupsaddsmb</command> command: </para> <para><screen> @@ -2829,20 +2802,20 @@ Password for root required to access localhost via Samba: <userinput>['secret']< <para> To share <emphasis>all</emphasis> printers and drivers, use the <option>-a</option> parameter instead of a printer name. Since -cupsaddsmb "exports" the printer drivers to Samba, it should be +<command>cupsaddsmb</command> <quote>exports</quote> the printer drivers to Samba, it should be obvious that it only works for queues with a CUPS driver associated. </para> </sect2> <sect2> -<title>Run "cupsaddsmb" with verbose Output</title> +<title>Run cupsaddsmb with Verbose Output</title> -<indexterm><primary>cupsaddsmb</primary></indexterm> <para> +<indexterm><primary>cupsaddsmb</primary></indexterm> Probably you want to see what's going on. Use the <option>-v</option> parameter to get a more verbose output. The -output below was edited for better readability: all "\" at the end of +output below was edited for better readability: all <quote>\</quote> at the end of a line indicate that I inserted an artificial line break plus some indentation here: </para> @@ -2852,9 +2825,11 @@ You will see the root password for the Samba account printed on screen. </para></warning> +<para> + <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> -<para><screen> + <screen> &rootprompt;<userinput>cupsaddsmb -U root -v infotec_2105</userinput> Password for root required to access localhost via &example.server.samba;: Running command: smbclient //localhost/print\$ -N -U'root%secret' \ @@ -2873,10 +2848,11 @@ putting file /usr/share/cups/drivers/cups.hlp as \W32X86/cups.hlp Running command: rpcclient localhost -N -U'root%secret' -c 'adddriver "Windows NT x86" \ - "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL: \ + "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL: \ RAW:NULL"' cmd = adddriver "Windows NT x86" \ - "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL:RAW:NULL" + "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL: \ + RAW:NULL" Printer Driver infotec_2105 successfully installed. Running command: smbclient //localhost/print\$ -N -U'root%secret' \ @@ -2904,9 +2880,10 @@ Running command: smbclient //localhost/print\$ -N -U'root%secret' \ "infotec_2105:ADOBEPS4.DRV:infotec_2105.PPD:NULL:ADOBEPS4.HLP: \ PSMON.DLL:RAW:ADOBEPS4.DRV,infotec_2105.PPD,ADOBEPS4.HLP,PSMON.DLL, \ ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL"' - cmd = adddriver "Windows 4.0" "infotec_2105:ADOBEPS4.DRV:infotec_2105.PPD:NULL: \ - ADOBEPS4.HLP:PSMON.DLL:RAW:ADOBEPS4.DRV,infotec_2105.PPD,ADOBEPS4.HLP, \ - PSMON.DLL,ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL" + cmd = adddriver "Windows 4.0" "infotec_2105:ADOBEPS4.DRV:\ + infotec_2105.PPD:NULL:ADOBEPS4.HLP:PSMON.DLL:RAW:ADOBEPS4.DRV,\ + infotec_2105.PPD,ADOBEPS4.HLP,PSMON.DLL,ADFONTS.MFM,DEFPRTR2.PPD,\ + ICONLIB.DLL" Printer Driver infotec_2105 successfully installed. Running command: rpcclient localhost -N -U'root%secret' \ @@ -2918,101 +2895,99 @@ Running command: smbclient //localhost/print\$ -N -U'root%secret' \ <para> If you look closely, you'll discover your root password was transferred -unencrypted over the wire, so beware! Also, if you look further her, -you'll discover error messages like NT_STATUS_OBJECT_NAME_COLLISION in -between. They occur, because the directories WIN40 and W32X86 already -existed in the <smbconfsection>[print$]</smbconfsection> driver download share -(from a previous driver installation). They are harmless here. +unencrypted over the wire, so beware! Also, if you look further, +you'll discover error messages like <?latex \linebreak ?>NT_STATUS_OBJECT_NAME_COLLISION in between. They occur, because the directories WIN40 and W32X86 already existed in the <smbconfsection>[print$]</smbconfsection> driver download share (from a previous driver installation). They are harmless here. </para> </sect2> <sect2> <title>Understanding cupsaddsmb</title> -<indexterm><primary>cupsaddsmb</primary></indexterm> <para> -What has happened? What did cupsaddsmb do? There are five stages of -the procedure +<indexterm><primary>cupsaddsmb</primary></indexterm> +What has happened? What did <command>cupsaddsmb</command> do? There are five stages of +the procedure: </para> <orderedlist> <listitem><para> <indexterm><primary>IPP</primary></indexterm> - call the CUPS server via IPP and request the -driver files and the PPD file for the named printer;</para></listitem> + Call the CUPS server via IPP and request the +driver files and the PPD file for the named printer.</para></listitem> -<listitem><para>store the files temporarily in the local +<listitem><para>Store the files temporarily in the local TEMPDIR (as defined in -<filename>cupsd.conf</filename>);</para></listitem> +<filename>cupsd.conf</filename>).</para></listitem> -<listitem><para>connect via smbclient to the Samba server's +<listitem><para>Connect via smbclient to the Samba server's <smbconfsection>[print$]</smbconfsection> share and put the files into the - share's WIN40 (for Win95/98/ME) and W32X86/ (for WinNT/2k/XP) sub - directories;</para></listitem> + share's WIN40 (for Windows 9x/Me) and W32X86/ (for Windows NT/200x/XP) subdirectories.</para></listitem> <listitem><para> <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> - connect via rpcclient to the Samba server and -execute the "adddriver" command with the correct -parameters;</para></listitem> + Connect via rpcclient to the Samba server and +execute the <command>adddriver</command> command with the correct +parameters.</para></listitem> <listitem><para> <indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> - connect via rpcclient to the Samba server a second -time and execute the "setdriver" command.</para></listitem> + Connect via rpcclient to the Samba server a second +time and execute the <command>setdriver</command> command.</para></listitem> </orderedlist> +<note> <para> -Note, that you can run the cupsaddsmb utility with parameters to +You can run the <command>cupsaddsmb</command> utility with parameters to specify one remote host as Samba host and a second remote host as CUPS host. Especially if you want to get a deeper understanding, it is a -good idea try it and see more clearly what is going on (though in real +good idea to try it and see more clearly what is going on (though in real life most people will have their CUPS and Samba servers run on the same host): </para> <para><screen> -&rootprompt;<userinput>cupsaddsmb -H sambaserver -h cupsserver -v printername</userinput> +&rootprompt;<userinput>cupsaddsmb -H sambaserver -h cupsserver -v printer</userinput> </screen></para> +</note> </sect2> <sect2> -<title>How to recognize if cupsaddsmb completed successfully</title> +<title>How to Recognize If cupsaddsmb Completed Successfully</title> <para> You <emphasis>must</emphasis> always check if the utility completed -successfully in all fields. You need as a minimum these 3 messages -amongst the output: +successfully in all fields. You need as a minimum these three messages +among the output: </para> <orderedlist> <listitem><para><emphasis>Printer Driver infotec_2105 successfully -installed.</emphasis> # (for the W32X86 == WinNT/2K/XP -architecture...)</para></listitem> +installed.</emphasis> # (for the W32X86 == Windows NT/200x/XP +architecture).</para></listitem> <listitem><para><emphasis>Printer Driver infotec_2105 successfully -installed.</emphasis> # (for the WIN40 == Win9x/ME -architecture...)</para></listitem> +installed.</emphasis> # (for the WIN40 == Windows 9x/Me +architecture).</para></listitem> <listitem><para><emphasis>Successfully set [printerXPZ] to driver [printerXYZ].</emphasis></para></listitem> </orderedlist> <para> -These messages probably not easily recognized in the general -output. If you run cupsaddsmb with the <option>-a</option> +These messages are probably not easily recognized in the general +output. If you run <command>cupsaddsmb</command> with the <option>-a</option> parameter (which tries to prepare <emphasis>all</emphasis> active CUPS printer drivers for download), you might miss if individual printers -drivers had problems to install properly. Here a redirection of the +drivers had problems installing properly. Here a redirection of the output will help you analyze the results in retrospective. </para> <note><para> -It is impossible to see any diagnostic output if you don't run -cupsaddsmb in verbose mode. Therefore we strongly recommend to not -use the default quiet mode. It will hide any problems from you which +It is impossible to see any diagnostic output if you do not run +<command>cupsaddsmb</command> in verbose mode. Therefore, we strongly recommend to not +use the default quiet mode. It will hide any problems from you that might occur. </para></note> </sect2> @@ -3020,11 +2995,11 @@ might occur. <sect2> <title>cupsaddsmb with a Samba PDC</title> -<indexterm><primary>cupsaddsmb</primary></indexterm> <para> -You can't get the standard cupsaddsmb command to run on a Samba PDC? -You are asked for the password credential all over again and again and +<indexterm><primary>cupsaddsmb</primary></indexterm> +Can't get the standard <command>cupsaddsmb</command> command to run on a Samba PDC? +Are you asked for the password credential all over again and again and the command just will not take off at all? Try one of these variations: </para> @@ -3037,22 +3012,22 @@ variations: <para> (Note the two backslashes: the first one is required to -"escape" the second one). +<quote>escape</quote> the second one). </para> </sect2> <sect2> <title>cupsaddsmb Flowchart</title> -<indexterm><primary>cupsaddsmb</primary></indexterm> <para> -Here is a chart about the procedures, commandflows and -dataflows of the "cupaddsmb" command. Note again: cupsaddsmb is -not intended to, and does not work with, "raw" queues! +<indexterm><primary>cupsaddsmb</primary></indexterm> +<link linkend="small14"/> shows a chart about the procedures, commandflows and +dataflows of the <command>cupaddsmb</command> command. Note again: cupsaddsmb is +not intended to, and does not work with, raw queues! </para> <para> - <image id="small14"><imagedescription>cupsaddsmb flowchart</imagedescription> + <image id="small14"><imagedescription>cupsaddsmb flowchart.</imagedescription> <imagefile>14small</imagefile></image> </para> </sect2> @@ -3060,50 +3035,51 @@ not intended to, and does not work with, "raw" queues! <sect2> <title>Installing the PostScript Driver on a Client</title> -<indexterm><primary>point and print</primary></indexterm> <para> -After cupsaddsmb completed, your driver is prepared for the clients to +<indexterm><primary>point 'n' print</primary></indexterm> +After <command>cupsaddsmb</command> is completed, your driver is prepared for the clients to use. Here are the steps you must perform to download and install it -via "Point'n'Print". From a Windows client, browse to the CUPS/Samba -server; +via Point'n'Print. From a Windows client, browse to the CUPS/Samba +server: </para> <itemizedlist> -<indexterm><primary>"Printers" folder</primary></indexterm> -<listitem><para>open the <emphasis>Printers</emphasis> -share of Samba in Network Neighbourhood;</para></listitem> +<listitem><para> +<indexterm><primary>"Printers" folder</primary></indexterm> +Open the <guilabel>Printers</guilabel> +share of Samba in Network Neighborhood.</para></listitem> -<listitem><para>right-click on the printer in -question;</para></listitem> +<listitem><para>Right-click on the printer in +question.</para></listitem> -<listitem><para>from the opening context-menu select -<emphasis>Install...</emphasis> or -<emphasis>Connect...</emphasis> (depending on the Windows version you +<listitem><para>From the opening context-menu select +<guimenuitem>Install...</guimenuitem> or +<guimenuitem>Connect...</guimenuitem> (depending on the Windows version you use).</para></listitem> </itemizedlist> <para> After a few seconds, there should be a new printer in your -client's <emphasis>local</emphasis> "Printers" folder: On Windows +client's <emphasis>local</emphasis> <guilabel>Printers</guilabel> folder. On Windows XP it will follow a naming convention of <emphasis>PrinterName on SambaServer</emphasis>. (In my current case it is "infotec_2105 on kde-bitshop"). If you want to test it and send your first job from -an application like Winword, the new printer will appears in a +an application like Winword, the new printer appears in a <filename>\\SambaServer\PrinterName</filename> entry in the -dropdown list of available printers. +drop-down list of available printers. </para> -<note><para> +<para> <indexterm><primary>PPD</primary></indexterm> -cupsaddsmb will only reliably work with CUPS version 1.1.15 or higher -and Samba from 2.2.4. If it doesn't work, or if the automatic printer -driver download to the clients doesn't succeed, you can still manually +<command>cupsaddsmb</command> will only reliably work with CUPS version 1.1.15 or higher +and Samba from 2.2.4. If it does not work, or if the automatic printer +driver download to the clients does not succeed, you can still manually install the CUPS printer PPD on top of the Adobe PostScript driver on clients. Then point the client's printer queue to the Samba printer share for a UNC type of connection: -</para></note> +</para> <para><screen> &dosprompt;<userinput>net use lpt1: \\sambaserver\printershare /user:ntadmin</userinput> @@ -3111,21 +3087,20 @@ share for a UNC type of connection: <para> should you desire to use the CUPS networked PostScript RIP -functions. (Note that user "ntadmin" needs to be a valid Samba user -with the required privileges to access the printershare) This would -set up the printer connection in the traditional +functions. (Note that user <quote>ntadmin</quote> needs to be a valid Samba user +with the required privileges to access the printershare.) This +sets up the printer connection in the traditional <emphasis>LanMan</emphasis> way (not using MS-RPC). </para> </sect2> <sect2> -<title>Avoiding critical PostScript Driver Settings on the -Client</title> +<title>Avoiding Critical PostScript Driver Settings on the Client</title> <para> -Soooo: 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 very good. Some jobs print fast, and some are +Printing works, but there are still problems. Most jobs print +well, some do not print at all. Some jobs have problems with fonts, +which do not look very good. Some jobs print fast and some are dead-slow. Many of these problems can be greatly reduced or even completely eliminated if you follow a few guidelines. Remember, if your print device is not PostScript-enabled, you are treating your @@ -3134,63 +3109,62 @@ driver settings produce. Treat it well: </para> <itemizedlist> -<listitem><para>Avoid the <emphasis>PostScript Output Option: Optimize -for Speed</emphasis> setting. Rather use the <emphasis>Optimize for -Portability</emphasis> instead (Adobe PostScript +<listitem><para>Avoid the PostScript Output Option: Optimize +for Speed setting. Use the Optimize for +Portability instead (Adobe PostScript driver).</para></listitem> -<listitem><para>Don't use the <emphasis>Page Independence: -NO</emphasis> setting. Instead use <emphasis>Page Independence -YES</emphasis> (CUPS PostScript Driver)</para></listitem> +<listitem><para>Don't use the Page Independence: +NO setting. Instead, use Page Independence +YES (CUPS PostScript Driver).</para></listitem> -<listitem><para>Recommended is the <emphasis>True Type Font -Downloading Option: Native True Type</emphasis> over -<emphasis>Automatic</emphasis> and <emphasis>Outline</emphasis>; you -should by all means avoid <emphasis>Bitmap</emphasis> (Adobe -PostScript Driver)</para></listitem> +<listitem><para>Recommended is the True Type Font +Downloading Option: Native True Type over +Automatic and Outline; you +should by all means avoid Bitmap (Adobe +PostScript Driver).</para></listitem> -<listitem><para>Choose <emphasis>True Type Font: Download as Softfont -into Printer</emphasis> over the default <emphasis>Replace by Device -Font</emphasis> (for exotic fonts you may need to change it back to -get a printout at all) (Adobe)</para></listitem> +<listitem><para>Choose True Type Font: Download as Softfont +into Printer over the default Replace by Device +Font (for exotic fonts, you may need to change it back to +get a printout at all) (Adobe).</para></listitem> -<listitem><para>Sometimes you can choose <emphasis>PostScript Language -Level</emphasis>: in case of problems try <emphasis>2</emphasis> -instead of <emphasis>3</emphasis> (the latest ESP Ghostscript package +<listitem><para>Sometimes you can choose PostScript Language +Level: In case of problems try 2 +instead of 3 (the latest ESP Ghostscript package handles Level 3 PostScript very well) (Adobe).</para></listitem> -<listitem><para>Say <emphasis>Yes</emphasis> to <emphasis>PostScript -Error Handler</emphasis> (Adobe)</para></listitem> +<listitem><para>Say Yes to PostScript +Error Handler (Adobe).</para></listitem> </itemizedlist> </sect2> </sect1> <sect1> -<title>Installing PostScript Driver Files manually (using -rpcclient)</title> +<title>Installing PostScript Driver Files Manually Using rpcclient</title> <para> -Of course you can run all the commands which are embedded into the +Of course, you can run all the commands that are embedded into the cupsaddsmb convenience utility yourself, one by one, and hereby upload and prepare the driver files for future client downloads. </para> <orderedlist> -<listitem><para>prepare Samba (a CUPS printqueue with the name of the +<listitem><para>Prepare Samba (A CUPS print queue with the name of the printer should be there. We are providing the driver -now);</para></listitem> +now).</para></listitem> -<listitem><para>copy all files to - <smbconfsection>[print$]</smbconfsection></para></listitem> +<listitem><para>Copy all files to + <smbconfsection>[print$]</smbconfsection>.</para></listitem> <listitem><para> <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> - run <command>rpcclient adddriver</command> -(for each client architecture you want to support):</para></listitem> +Run <command>rpcclient adddriver</command> +(for each client architecture you want to support).</para></listitem> <listitem><para> <indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> - run <command>rpcclient +Run <command>rpcclient setdriver.</command></para></listitem> </orderedlist> @@ -3200,33 +3174,33 @@ setdriver.</command></para></listitem> <indexterm><primary>rpcclient</primary><secondary>enumdrivers</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> -We are going to do this now. First, read the man page on "rpcclient" +We are going to do this now. First, read the man page on <parameter>rpcclient</parameter> to get a first idea. Look at all the printing related -sub-commands. <command>enumprinters</command>, +subcommands. <command>enumprinters</command>, <command>enumdrivers</command>, <command>enumports</command>, -<command>adddriver</command>, <command>setdriver</command> are amongst -the most interesting ones. rpcclient implements an important part of -the MS-RPC protocol. You can use it to query (and command) a Win NT -(or 2K/XP) PC too. MS-RPC is used by Windows clients, amongst other -things, to benefit from the "Point'n'Print" features. Samba can now -mimic this too. +<command>adddriver</command>, <command>setdriver</command> are among +the most interesting ones. <parameter>rpcclient</parameter> implements an important part of +the MS-RPC protocol. You can use it to query (and command) a Windows NT +(or 200x/XP) PC, too. MS-RPC is used by Windows clients, among other +things, to benefit from the Point'n'Print features. Samba can now +mimic this as well. </para> <sect2> <title>A Check of the rpcclient man Page</title> <para> -First let's have a little check of the rpcclient man page. Here are + First let's check the <parameter>rpcclient</parameter> man page. Here are two relevant passages: </para> <para> <command>adddriver <arch> <config></command> Execute an -AddPrinterDriver() RPC to install the printer driver information on -the server. Note that the driver files should already exist in the -directory returned by <command>getdriverdir</command>. Possible +<command>AddPrinterDriver()</command> RPC to install the printer driver information on +the server. The driver files should already exist in the +directory returned by <command>getdriverdir</command>. Possible values for <parameter>arch</parameter> are the same as those for the -<command>getdriverdir</command> command. The +<command>getdriverdir</command> command. The <parameter>config</parameter> parameter is defined as follows: </para> @@ -3241,14 +3215,14 @@ Default Data Type:\ Comma Separated list of Files </screen></para> -<para>Any empty fields should be enter as the string "NULL". </para> +<para>Any empty fields should be enter as the string <quote>NULL</quote>. </para> <para>Samba does not need to support the concept of Print Monitors since these only apply to local printers whose driver can make use of -a bi-directional link for communication. This field should be "NULL". +a bi-directional link for communication. This field should be <quote>NULL</quote>. 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 +fail. </para> <para> @@ -3258,24 +3232,23 @@ printer driver associated with an installed printer. The printer driver must already be correctly installed on the print server. </para> -<para> See also the enumprinters and enumdrivers commands for +<para>See also the <command>enumprinters</command> and <command>enumdrivers</command> commands for obtaining a list of installed printers and drivers. </para> </sect2> <sect2> -<title>Understanding the rpcclient man page</title> +<title>Understanding the rpcclient man Page</title> <para> The <emphasis>exact</emphasis> format isn't made too clear by the man page, since you have to deal with some parameters containing spaces. Here is a better description for it. We have line-broken the -command and indicated the breaks with "\". Usually you would type the +command and indicated the breaks with <quote>\</quote>. Usually you would type the command in one line without the linebreaks: -</para> - <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +</para> <para><screen> adddriver "Architecture" \ @@ -3284,59 +3257,59 @@ command in one line without the linebreaks: </screen></para> <para> -What the man pages denotes as a simple <config> -keyword, does in reality consist of 8 colon-separated fields. The -last field may take multiple (in some, very insane, cases, even -20 different additional files. This might sound confusing at first. -Note, that what the man pages names the "LongPrinterName" in -reality should rather be called the "Driver Name". You can name it +What the man pages denote as a simple <parameter><config></parameter> +keyword, in reality consists of eight colon-separated fields. The +last field may take multiple (in some very insane cases, even +20 different additional) files. This might sound confusing at first. +What the man pages names the <quote>LongPrinterName</quote> in +reality should be called the <quote>Driver Name</quote>. You can name it anything you want, as long as you use this name later in the -<emphasis>rpcclient ... setdriver</emphasis> command. For +<command>rpcclient ... setdriver</command> command. For practical reasons, many name the driver the same as the printer. </para> <para> -True: it isn't simple at all. I hear you asking: -<emphasis>How do I know which files are "Driver -File", "Data File", "Config File", "Help File" and "Language -Monitor File" in each case?</emphasis> -- For an answer you may +It isn't simple at all. I hear you asking: +<quote>How do I know which files are "Driver +File</quote>, <quote>Data File</quote>, <quote>Config File</quote>, <quote>Help File</quote> and <quote>Language +Monitor File" in each case?</quote> &smbmdash; For an answer, you may want to have a look at how a Windows NT box with a shared printer presents the files to us. Remember, that this whole procedure has -to be developed by the Samba Team by overhearing the traffic caused +to be developed by the Samba team by overhearing the traffic caused by Windows computers on the wire. We may as well turn to a Windows -box now, and access it from a UNIX workstation. We will query it +box now and access it from a UNIX workstation. We will query it with <command>rpcclient</command> to see what it tells us and -try to understand the man page more clearly which we've read just +try to understand the man page more clearly that we've read just now. </para> </sect2> <sect2> -<title>Producing an Example by querying a Windows Box</title> +<title>Producing an Example by Querying a Windows Box</title> <para> <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> We could run <command>rpcclient</command> with a <command>getdriver</command> or a <command>getprinter</command> -subcommand (in level 3 verbosity) against it. Just sit down at UNIX or -Linux workstation with the Samba utilities installed. Then type the +subcommand (in level 3 verbosity) against it. Just sit down at a UNIX or +Linux workstation with the Samba utilities installed, then type the following command: </para> <para><screen> -&rootprompt;<userinput>rpcclient -U'USERNAME%PASSWORD' NT-SERVER-NAME -c 'getdriver printername 3'</userinput> +&rootprompt;<userinput>rpcclient -U'user%secret' NT-SERVER -c 'getdriver printername 3'</userinput> </screen></para> <para> -From the result it should become clear which is which. Here is an -example from my installation: +From the result it should become clear which is which. Here is an example from my installation: </para> - <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> -<para><screen> -&rootprompt;<userinput>rpcclient -U'Danka%xxxx' W2KSERVER \ +<para> +<indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> + <screen> +&rootprompt;<userinput>rpcclient -U'Danka%xxxx' W200xSERVER \ -c'getdriver "DANKA InfoStream Virtual Printer" 3'</userinput> cmd = getdriver "DANKA InfoStream Virtual Printer" 3 @@ -3365,62 +3338,61 @@ example from my installation: <para> Some printer drivers list additional files under the label -"Dependentfiles": these would go into the last field -<emphasis>ListOfFiles,Comma-separated</emphasis>. For the CUPS -PostScript drivers we don't need any (nor would we for the Adobe -PostScript driver): therefore the field will get a "NULL" entry. +<parameter>Dependentfiles</parameter> and these would go into the last field +<parameter>ListOfFiles,Comma-separated</parameter>. For the CUPS +PostScript drivers, we do not need any (nor would we for the Adobe +PostScript driver), therefore, the field will get a <quote>NULL</quote> entry. </para> </sect2> <sect2> -<title>What is required for adddriver and setdriver to succeed</title> +<title>Requirements for adddriver and setdriver to Succeed</title> <para> -From the manpage (and from the quoted output -of <emphasis>cupsaddsmb</emphasis>, above) it becomes clear that you +>From the man page (and from the quoted output +of <command>cupsaddsmb</command> above) it becomes clear that you need to have certain conditions in order to make the manual uploading -and initializing of the driver files succeed. The two rpcclient +and initializing of the driver files succeed. The two <command>rpcclient</command> <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> subcommands (<command>adddriver</command> and <command>setdriver</command>) need to encounter the following -pre-conditions to complete successfully: +preconditions to complete successfully: </para> <itemizedlist> -<listitem><para>you are connected as <smbconfoption><name>printer admin</name></smbconfoption>, or root (note, -that this is <emphasis>not</emphasis> the "Printer Operators" group in -NT, but the <emphasis>printer admin</emphasis> group, as defined in +<listitem><para>You are connected as <smbconfoption><name>printer admin</name></smbconfoption> or root (this is <emphasis>not</emphasis> the <quote>Printer Operators</quote> group in +NT, but the <emphasis>printer admin</emphasis> group as defined in the <smbconfsection>[global]</smbconfsection> section of -&smb.conf;);</para></listitem> - -<listitem><para>copy all required driver files to -<filename>\\sambaserver\print$\w32x86</filename> and -<filename>\\sambaserver\print$\win40</filename> as appropriate. They -will end up in the "0" respective "2" subdirectories later -- for now -<emphasis>don't</emphasis> put them there, they'll be automatically -used by the <command>adddriver</command> subcommand.! (if you use -"smbclient" to put the driver files into the share, note that you need -to escape the "$": <command>smbclient //sambaserver/print\$ -U -root</command>);</para></listitem> - -<listitem><para>the user you're connecting as must be able to write to +&smb.conf;).</para></listitem> + +<listitem><para>Copy all required driver files to +<filename>\\SAMBA\print$\w32x86</filename> and +<filename>\\SAMBA\print$\win40</filename> as appropriate. They +will end up in the <quote>0</quote> respective <quote>2</quote> subdirectories later. For now, +<emphasis>do not</emphasis> put them there, they'll be automatically +used by the <command>adddriver</command> subcommand. (If you use +<command>smbclient</command> to put the driver files into the share, note that you need +to escape the <quote>$</quote>: <command>smbclient //sambaserver/print\$ -U +root.</command>)</para></listitem> + +<listitem><para>The user you're connecting as must be able to write to the <smbconfsection>[print$]</smbconfsection> share and create -subdirectories;</para></listitem> +subdirectories.</para></listitem> -<listitem><para>the printer you are going to setup for the Windows -clients, needs to be installed in CUPS already;</para></listitem> +<listitem><para>The printer you are going to setup for the Windows +clients needs to be installed in CUPS already.</para></listitem> <listitem><para> <indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> - the CUPS printer must be known to Samba, otherwise the + The CUPS printer must be known to Samba, otherwise the <command>setdriver</command> subcommand fails with an NT_STATUS_UNSUCCESSFUL error. To check if the printer is known by -Samba you may use the <command>enumprinters</command> subcommand to -rpcclient. A long-standing bug prevented a proper update of the +Samba, you may use the <command>enumprinters</command> subcommand to +<command>rpcclient</command>. A long-standing bug prevented a proper update of the printer list until every smbd process had received a SIGHUP or was restarted. Remember this in case you've created the CUPS printer just -shortly ago and encounter problems: try restarting +recently and encounter problems: try restarting Samba.</para></listitem> </itemizedlist> </sect2> @@ -3436,30 +3408,32 @@ single action item as it comes up. </para> <procedure> - <title>Manual Driver Installation installation</title> + <title>Manual Driver Installation</title> <step> -<title>Install the Printer on CUPS</title> +<title>Install the printer on CUPS.</title> <para><screen> -&rootprompt;<userinput>lpadmin -p mysmbtstprn -v socket://10.160.51.131:9100 -E -P canonIR85.ppd</userinput> +&rootprompt;<userinput>lpadmin -p mysmbtstprn -v socket://10.160.51.131:9100 -E \ + -P canonIR85.ppd</userinput> </screen></para> <para> -This installs printer with the name <emphasis>mysmbtstprn</emphasis> +This installs a printer with the name <parameter>mysmbtstprn</parameter> to the CUPS system. The printer is accessed via a socket (a.k.a. JetDirect or Direct TCP/IP) connection. You need to be root -for this step +for this step. </para> </step> <step> -<title>(optional) Check if the Printer is recognized by -Samba</title> +<title>(Optional) Check if the printer is recognized by Samba.</title> - <indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> -<para><screen> -&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumprinters' localhost | grep -C2 mysmbtstprn</userinput> +<para> +<indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> +<screen> + &rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumprinters' localhost \ + | grep -C2 mysmbtstprn</userinput> flags:[0x800000] name:[\\kde-bitshop\mysmbtstprn] description:[\\kde-bitshop\mysmbtstprn,,mysmbtstprn] @@ -3467,26 +3441,27 @@ comment:[mysmbtstprn] </screen></para> <para> -This should show the printer in the list. If not, stop and re-start -the Samba daemon (smbd), or send a HUP signal: <command>kill -HUP -`pidof smbd`</command>. Check again. Troubleshoot and repeat until -success. Note the "empty" field between the two commas in the -"description" line. Here would the driver name appear if there was one -already. You need to know root's Samba password (as set by the +This should show the printer in the list. If not, stop and restart +the Samba daemon (smbd), or send a HUP signal: +<screen> +&rootprompt;<userinput>kill -HUP `pidof smbd`</userinput> +</screen>Check again. Troubleshoot and repeat until +successful. Note the <quote>empty</quote> field between the two commas in the +<quote>description</quote> line. The driver name would appear here if there was one already. You need to know root's Samba password (as set by the <command>smbpasswd</command> command) for this step and most of the -following steps. Alternatively you can authenticate as one of the -users from the "write list" as defined in &smb.conf; for +following steps. Alternately, you can authenticate as one of the +users from the <quote>write list</quote> as defined in &smb.conf; for <smbconfsection>[print$]</smbconfsection>. </para> </step> <step> -<title>(optional) Check if Samba knows a Driver for the -Printer</title> +<title>(Optional) Check if Samba knows a driver for the printer.</title> +<para> <indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> -<para><screen> + <screen> &rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \ | grep driver </userinput> drivername:[] @@ -3509,17 +3484,17 @@ printprocessor:[winprint] </screen></para> <para> -Neither method of the three commands shown above should show a driver. +None of the three commands shown above should show a driver. This step was done for the purpose of demonstrating this condition. An attempt to connect to the printer at this stage will prompt the -message along the lines: "The server has not the required printer -driver installed". +message along the lines of: <quote>The server does not have the required printer +driver installed.</quote> </para> </step> <step> -<title>Put all required Driver Files into Samba's -[print$]</title> +<title>Put all required driver files into Samba's +[print$].</title> <para><screen> &rootprompt;<userinput>smbclient //localhost/print\$ -U 'root%xxxx' \ @@ -3531,19 +3506,19 @@ driver installed". </screen></para> <para> -(Note that this command should be entered in one long single -line. Line-breaks and the line-end indicating "\" has been inserted +(This command should be entered in one long single +line. Line-breaks and the line-end indicated by <quote>\</quote> have been inserted for readability reasons.) This step is <emphasis>required</emphasis> for the next one to succeed. It makes the driver files physically present in the <smbconfsection>[print$]</smbconfsection> share. However, clients would still not be able to install them, because Samba does not yet treat them as driver files. A client asking for the driver would still -be presented with a "not installed here" message. +be presented with a <quote>not installed here</quote> message. </para> </step> <step> -<title>Verify where the Driver Files are now</title> +<title>Verify where the driver files are now.</title> <para><screen> &rootprompt;<userinput>ls -l /etc/samba/drivers/W32X86/</userinput> @@ -3557,40 +3532,39 @@ drwxr-sr-x 2 root ntadmin 670 May 16 03:15 3 </screen></para> <para> -The driver files now are in the W32X86 architecture "root" of +The driver files now are in the W32X86 architecture <quote>root</quote> of <smbconfsection>[print$]</smbconfsection>. </para> </step> <step> -<title>Tell Samba that these are -<emphasis>Driver</emphasis> Files -(<command>adddriver</command>)</title> +<title>Tell Samba that these are driver files (<command>adddriver</command>).</title> - <indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> -<para><screen> -&rootprompt;<userinput>rpcclient -Uroot%xxxx -c `adddriver "Windows NT x86" "mydrivername: \ - cupsdrvr.dll:mysmbtstprn.PPD: \ +<para> +<indexterm><primary>rpcclient</primary><secondary>adddriver</secondary></indexterm> +<screen> +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c `adddriver "Windows NT x86" \ + "mydrivername:cupsdrvr.dll:mysmbtstprn.PPD: \ cupsui.dll:cups.hlp:NULL:RAW:NULL" \ localhost</userinput> Printer Driver mydrivername successfully installed. </screen></para> <para> -Note that your cannot repeat this step if it fails. It could fail even +You cannot repeat this step if it fails. It could fail even as a result of a simple typo. It will most likely have moved a part of -the driver files into the "2" subdirectory. If this step fails, you -need to go back to the fourth step and repeat it, before you can try -this one again. In this step you need to choose a name for your +the driver files into the <quote>2</quote> subdirectory. If this step fails, you +need to go back to the fourth step and repeat it before you can try +this one again. In this step, you need to choose a name for your driver. It is normally a good idea to use the same name as is used for -the printername; however, in big installations you may use this driver -for a number of printers which have obviously different names. So the +the printer name; however, in big installations you may use this driver +for a number of printers that obviously have different names, so the name of the driver is not fixed. </para> </step> <step> -<title>Verify where the Driver Files are now</title> +<title>Verify where the driver files are now.</title> <para><screen> &rootprompt;<userinput>ls -l /etc/samba/drivers/W32X86/</userinput> @@ -3608,19 +3582,19 @@ total 5039 </screen></para> <para> -Notice how step 6 did also move the driver files to the appropriate -subdirectory. Compare with the situation after step 5. +Notice how step 6 also moved the driver files to the appropriate +subdirectory. Compare this with the situation after step 5. </para> </step> <step> -<title>(optional) Verify if Samba now recognizes the -Driver</title> +<title>(Optional) Verify if Samba now recognizes the driver.</title> - <indexterm><primary>rpcclient</primary><secondary>enumdrivers</secondary></indexterm> -<para><screen> -&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumdrivers 3' localhost \ - | grep -B2 -A5 mydrivername</userinput> +<para> +<indexterm><primary>rpcclient</primary><secondary>enumdrivers</secondary></indexterm> +<screen> +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumdrivers 3' \ + localhost | grep -B2 -A5 mydrivername</userinput> Printer Driver Info 3: Version: [2] Driver Name: [mydrivername] @@ -3632,40 +3606,41 @@ Helpfile: [\\kde-bitshop\print$\W32X86\2\cups.hlp] </screen></para> <para> -Remember, this command greps for the name you did choose for the -driver in step Six. This command must succeed before you can proceed. +Remember, this command greps for the name you chose for the +driver in step 6. This command must succeed before you can proceed. </para> </step> <step> -<title>Tell Samba which Printer should use these Driver -Files (<command>setdriver</command>)</title> +<para>Tell Samba which printer should use these driver files (<command>setdriver</command>).</para> -<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> -<para><screen> -&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'setdriver mysmbtstprn mydrivername' localhost</userinput> +<para> +<indexterm><primary>rpcclient</primary><secondary>setdriver</secondary></indexterm> +<screen> +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'setdriver mysmbtstprn mydrivername' \ + localhost</userinput> Successfully set mysmbtstprn to driver mydrivername </screen></para> <para> -Since you can bind any printername (=printqueue) to any driver, this -is a very convenient way to setup many queues which use the same -driver. You don't need to repeat all the previous steps for the -setdriver command to succeed. The only pre-conditions are: +Since you can bind any printername (print queue) to any driver, this +is a convenient way to setup many queues that use the same +driver. You do not need to repeat all the previous steps for the +setdriver command to succeed. The only preconditions are: <command>enumdrivers</command> must find the driver and <command>enumprinters</command> must find the printer. </para> </step> <step> -<title>(optional) Verify if Samba has this Association -recognized</title> + <title>(Optional) Verify if Samba has recognized this association.</title> +<para> <indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>getdriver</secondary></indexterm> <indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> -<para><screen> +<screen> &rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \ | grep driver</userinput> drivername:[mydrivername] @@ -3697,7 +3672,8 @@ Printer Driver Info 3: Monitorname: [] Defaultdatatype: [RAW] -&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumprinters' localhost | grep mysmbtstprn</userinput> +&rootprompt;<userinput>rpcclient -Uroot%xxxx -c 'enumprinters' localhost \ + | grep mysmbtstprn</userinput> name:[\\kde-bitshop\mysmbtstprn] description:[\\kde-bitshop\mysmbtstprn,mydrivername,mysmbtstprn] comment:[mysmbtstprn] @@ -3706,93 +3682,93 @@ Printer Driver Info 3: <para> <indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> -Compare these results with the ones from steps 2 and 3. Note that -every single of these commands show the driver is installed. Even +Compare these results with the ones from steps 2 and 3. Every one of these commands show the driver is installed. Even the <command>enumprinters</command> command now lists the driver -on the "description" line. +on the <quote>description</quote> line. </para> </step> <step> -<title>(optional) Tickle the Driver into a correct -Device Mode</title> +<title>(Optional) Tickle the driver into a correct +device mode.</title> <para> <indexterm><primary>"Printers" folder</primary></indexterm> -You certainly know how to install the driver on the client. In case +You certainly know how to install the driver on the client. In case you are not particularly familiar with Windows, here is a short -recipe: browse the Network Neighbourhood, go to the Samba server, look +recipe: Browse the Network Neighborhood, go to the Samba server, and look for the shares. You should see all shared Samba printers. Double-click on the one in question. The driver should get -installed, and the network connection set up. An alternative way is to -open the "Printers (and Faxes)" folder, right-click on the printer in -question and select "Connect" or "Install". As a result, a new printer -should have appeared in your client's local "Printers (and Faxes)" -folder, named something like "printersharename on Sambahostname". +installed and the network connection set up. An alternate way is to +open the <guilabel>Printers (and Faxes)</guilabel> folder, right-click on the printer in +question and select <guilabel>Connect</guilabel> or <guilabel>Install</guilabel>. As a result, a new printer +should have appeared in your client's local <guilabel>Printers (and Faxes)</guilabel> +folder, named something like <guilabel>printersharename on Sambahostname</guilabel>. </para> <para> It is important that you execute this step as a Samba printer admin (as defined in &smb.conf;). Here is another method -to do this on Windows XP. It uses a commandline, which you may type -into the "DOS box" (type root's smbpassword when prompted): +to do this on Windows XP. It uses a command line, which you may type +into the <quote>DOS box</quote> (type root's smbpassword when prompted): </para> <para><screen> -&dosprompt;<userinput>runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry /in /n\ - \\sambacupsserver\mysmbtstprn"</userinput> +&dosprompt;<userinput>runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry \ + /in /n \\sambaserver\mysmbtstprn"</userinput> </screen></para> <para> -Change any printer setting once (like changing <emphasis>"portrait" to - "landscape"</emphasis>), click <guibutton>Apply</guibutton>; change the setting +Change any printer setting once (like changing <emphasis><guilabel>portrait</guilabel> to + <guilabel>landscape</guilabel></emphasis>), click on <guibutton>Apply</guibutton>; change the setting back. </para> </step> <step> -<title>Install the Printer on a Client -("Point'n'Print")</title> +<title>Install the printer on a client +(Point'n'Print).</title> -<indexterm significance="preferred"><primary>point and print</primary></indexterm> -<para><screen> -&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /in /n "\\sambacupsserver\mysmbtstprn"</userinput> +<para> +<indexterm significance="preferred"><primary>point 'n' print</primary></indexterm> + <screen> +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /in /n <quote>\\sambaserver\mysmbtstprn</quote></userinput> </screen></para> <para> -If it doesn't work it could be a permission problem with the +If it does not work it could be a permission problem with the <smbconfsection>[print$]</smbconfsection> share. </para> </step> <step> -<title>Thirteenth Step (optional): Print a Test Page</title> +<title>(Optional) Print a test page.</title> <para><screen> -&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /p /n "\\sambacupsserver\mysmbtstprn"</userinput> +&dosprompt;<userinput>rundll32 printui.dll,PrintUIEntry /p /n "\\sambaserver\mysmbtstprn"</userinput> </screen></para> <para> -Then hit [TAB] 5 times, [ENTER] twice, [TAB] once and [ENTER] again +Then hit [TAB] five times, [ENTER] twice, [TAB] once and [ENTER] again and march to the printer. </para> </step> <step> -<title>Fourteenth Step (recommended): Study the Test Page</title> +<title>(Recommended) Study the test page.</title> <para> Hmmm.... just kidding! By now you know everything about printer -installations and you don't need to read a word. Just put it in a +installations and you do not need to read a word. Just put it in a frame and bolt it to the wall with the heading "MY FIRST -RPCCLIENT-INSTALLED PRINTER" - why not just throw it away! +RPCCLIENT-INSTALLED PRINTER" &smbmdash; why not just throw it away! </para> </step> <step> -<title>Fifteenth Step (obligatory): Enjoy. Jump. Celebrate your -Success</title> +<title>(Obligatory) Enjoy. Jump. Celebrate your +success.</title> <para><screen> &rootprompt;<userinput>echo "Cheeeeerioooooo! Success..." >> /var/log/samba/log.smbd</userinput> @@ -3802,7 +3778,7 @@ Success</title> </sect2> <sect2> -<title>Troubleshooting revisited</title> +<title>Troubleshooting Revisited</title> <para> The setdriver command will fail, if in Samba's mind the queue is not @@ -3810,64 +3786,62 @@ already there. You had promising messages about the: </para> <para><screen> - Printer Driver ABC successfully installed. - </screen></para> <para> -after the "adddriver" parts of the procedure? But you are also seeing -a disappointing message like this one beneath? +after the <command>adddriver</command> parts of the procedure? But you are also seeing +a disappointing message like this one? </para> -<para><screen> - +<para><computeroutput> result was NT_STATUS_UNSUCCESSFUL - -</screen></para> +</computeroutput></para> <para> <indexterm><primary>lpstat</primary></indexterm> It is not good enough that you -can see the queue <emphasis>in CUPS</emphasis>, using +can see the queue in CUPS, using the <command>lpstat -p ir85wm</command> command. A bug in most recent versions of Samba prevents the proper update of the queuelist. The recognition of newly installed CUPS printers -fails unless you re-start Samba or send a HUP to all smbd -processes. To verify if this is the reason why Samba doesn't -execute the setdriver command successfully, check if Samba "sees" +fails unless you restart Samba or send a HUP to all smbd +processes. To verify if this is the reason why Samba does not +execute the <command>setdriver</command> command successfully, check if Samba <quote>sees</quote> the printer: </para> +<para> <indexterm><primary>rpcclient</primary><secondary>enumprinters</secondary></indexterm> -<para><screen> -&rootprompt;<userinput>rpcclient transmeta -N -U'root%secret' -c 'enumprinters 0'| grep ir85wm</userinput> + <screen> +&rootprompt;<userinput>rpcclient transmeta -N -U'root%xxxx' -c 'enumprinters 0'|grep ir85wm</userinput> printername:[ir85wm] </screen></para> <para> -An alternative command could be this: +An alternate command could be this: </para> +<para> <indexterm><primary>rpcclient</primary><secondary>getprinter</secondary></indexterm> -<para><screen> + <screen> &rootprompt;<userinput>rpcclient transmeta -N -U'root%secret' -c 'getprinter ir85wm' </userinput> cmd = getprinter ir85wm flags:[0x800000] name:[\\transmeta\ir85wm] description:[\\transmeta\ir85wm,ir85wm,DPD] - comment:[CUPS PostScript-Treiber for WinNT/2K/XP] + comment:[CUPS PostScript-Treiber for Windows NT/200x/XP] </screen></para> <para> -BTW, you can use these commands, plus a few more, of course, +By the way, you can use these commands, plus a few more, of course, to install drivers on remote Windows NT print servers too! </para> </sect2> </sect1> <sect1> -<title>The printing <filename>*.tdb</filename> Files</title> +<title>The Printing <filename>*.tdb</filename> Files</title> <para> <indexterm><primary>TDB</primary></indexterm> @@ -3884,13 +3858,13 @@ to install drivers on remote Windows NT print servers too! <indexterm><primary>sessionid.tdb</primary><seealso>TDB</seealso></indexterm> <indexterm><primary>secrets.tdb</primary><seealso>TDB</seealso></indexterm> Some mystery is associated with the series of files with a -tdb-suffix appearing in every Samba installation. They are +tdb suffix appearing in every Samba installation. They are <filename>connections.tdb</filename>, <filename>printing.tdb</filename>, -<filename>share_info.tdb</filename> , +<filename>share_info.tdb</filename>, <filename>ntdrivers.tdb</filename>, <filename>unexpected.tdb</filename>, -<filename>brlock.tdb</filename> , +<filename>brlock.tdb</filename>, <filename>locking.tdb</filename>, <filename>ntforms.tdb</filename>, <filename>messages.tdb</filename> , @@ -3900,19 +3874,19 @@ tdb-suffix appearing in every Samba installation. They are </para> <sect2> -<title>Trivial DataBase Files</title> +<title>Trivial Database Files</title> -<indexterm><primary>TDB</primary></indexterm> <para> -A Windows NT (Print) Server keeps track of all information needed to serve +<indexterm><primary>TDB</primary></indexterm> +A Windows NT (print) server keeps track of all information needed to serve its duty toward its clients by storing entries in the Windows -"Registry". Client queries are answered by reading from the registry, -Administrator or user configuration settings are saved by writing into -the Registry. Samba and UNIX obviously don't have such a kind of +registry. Client queries are answered by reading from the registry, +Administrator or user configuration settings that are saved by writing into +the registry. Samba and UNIX obviously do not have such a Registry. Samba instead keeps track of all client related information in a series of <filename>*.tdb</filename> files. (TDB = Trivial Data Base). These are often located in <filename>/var/lib/samba/</filename> -or <filename>/var/lock/samba/</filename> . The printing related files +or <filename>/var/lock/samba/</filename>. The printing related files are <filename>ntprinters.tdb</filename>, <filename>printing.tdb</filename>,<filename>ntforms.tdb</filename> and <filename>ntdrivers.tdb</filename>. @@ -3924,12 +3898,12 @@ are <filename>ntprinters.tdb</filename>, <para> <filename>*.tdb</filename> files are not human readable. They are -written in a binary format. "Why not ASCII?", you may ask. "After all, -ASCII configuration files are a good and proofed tradition on UNIX." --- The reason for this design decision by the Samba Team is mainly +written in a binary format. <quote>Why not ASCII?</quote>, you may ask. <quote>After all, +ASCII configuration files are a good and proven tradition on UNIX.</quote> +The reason for this design decision by the Samba team is mainly performance. Samba needs to be fast; it runs a separate <command>smbd</command> process for each client connection, in some -environments many thousand of them. Some of these smbds might need to +environments many thousands of them. Some of these smbds might need to write-access the same <filename>*.tdb</filename> file <emphasis>at the same time</emphasis>. The file format of Samba's <filename>*.tdb</filename> files allows for this provision. Many smbd @@ -3945,25 +3919,25 @@ same time. This wouldn't be possible with pure ASCII files. It is very important that all <filename>*.tdb</filename> files remain consistent over all write and read accesses. However, it may happen that these files <emphasis>do</emphasis> get corrupted. (A -<command>kill -9 `pidof smbd`</command> while a write access is in +<command>kill -9 `pidof smbd'</command> while a write access is in progress could do the damage as well as a power interruption, etc.). In cases of trouble, a deletion of the old printing-related -<filename>*.tdb</filename> files may be the only option. You need to -re-create all print related setup after that. Or you have made a +<filename>*.tdb</filename> files may be the only option. After that you need to +re-create all print-related setup or you have made a backup of the <filename>*.tdb</filename> files in time. </para> </sect2> <sect2> -<title>Using <emphasis>tdbbackup</emphasis></title> +<title>Using <command>tdbbackup</command></title> -<indexterm><primary>TDB</primary><secondary>backing up</secondary><see>tdbbackup</see></indexterm> -<indexterm><primary>tdbbackup</primary></indexterm> <para> -Samba ships with a little utility which helps the root user of your -system to back up your <filename>*.tdb</filename> files. If you run it -with no argument, it prints a little usage message: +<indexterm><primary>TDB</primary><secondary>backing up</secondary><see>tdbbackup</see></indexterm> +<indexterm><primary>tdbbackup</primary></indexterm> +Samba ships with a little utility that helps the root user of your +system to backup your <filename>*.tdb</filename> files. If you run it +with no argument, it prints a usage message: </para> <para><screen> @@ -3978,14 +3952,14 @@ with no argument, it prints a little usage message: </screen></para> <para> -Here is how I backed up my printing.tdb file: +Here is how I backed up my <filename>printing.tdb</filename> file: </para> <para><screen> &rootprompt;<userinput>ls</userinput> -. browse.dat locking.tdb ntdrivers.tdb printing.tdb -.. share_info.tdb connections.tdb messages.tdb ntforms.tdb -printing.tdbkp unexpected.tdb brlock.tdb gmon.out namelist.debug +. browse.dat locking.tdb ntdrivers.tdb printing.tdb +.. share_info.tdb connections.tdb messages.tdb ntforms.tdb +printing.tdbkp unexpected.tdb brlock.tdb gmon.out namelist.debug ntprinters.tdb sessionid.tdb &rootprompt;<userinput>tdbbackup -s .bak printing.tdb</userinput> @@ -4002,16 +3976,17 @@ ntprinters.tdb sessionid.tdb <sect1> <title>CUPS Print Drivers from Linuxprinting.org</title> -<indexterm><primary>Linuxprinting.org</primary></indexterm> <para> -CUPS ships with good support for HP LaserJet type printers. You can +<indexterm><primary>Linuxprinting.org</primary></indexterm> +CUPS ships with good support for HP LaserJet-type printers. You can install the generic driver as follows: </para> -<indexterm><primary>lpadmin</primary></indexterm> -<para><screen> +<para> +<indexterm><primary>lpadmin</primary></indexterm> + <screen> &rootprompt;<userinput>lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -m laserjet.ppd</userinput> </screen></para> @@ -4019,56 +3994,57 @@ install the generic driver as follows: The <option>-m</option> switch will retrieve the <filename>laserjet.ppd</filename> from the standard repository for not-yet-installed-PPDs, which CUPS typically stores in -<filename>/usr/share/cups/model</filename>. Alternatively, you may use +<filename>/usr/share/cups/model</filename>. Alternately, you may use <option>-P /path/to/your.ppd</option>. </para> <para> -The generic laserjet.ppd however does not support every special option -for every LaserJet-compatible model. It constitutes a sort of "least -denominator" of all the models. If for some reason it is ruled out to -you to pay for the commercially available ESP Print Pro drivers, your +The generic <filename>laserjet.ppd,</filename> however, does not support every special option +for every LaserJet-compatible model. It constitutes a sort of <quote>least common +denominator</quote> of all the models. If for some reason +you must pay for the commercially available ESP Print Pro drivers, your first move should be to consult the database on <ulink noescape="1" url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink>. Linuxprinting.org has excellent recommendations about which driver is best used for each printer. Its database is kept current by the tireless work of Till Kamppeter from MandrakeSoft, who is also the -principal author of the foomatic-rip utility. +principal author of the <command>foomatic-rip</command> utility. </para> <note><para> <indexterm><primary>foomatic-rip</primary></indexterm> -The former "cupsomatic" concept is now be replaced by the new, much -more powerful "foomatic-rip". foomatic-rip is the successor of -cupsomatic. cupsomatic is no longer maintained. Here is the new URL -to the Foomatic-3.0 database:<ulink +The former <command>cupsomatic</command> concept is now being replaced by the new +successor, a much +more powerful <command>foomatic-rip</command>. +<command>cupsomatic</command> is no longer maintained. Here is the new URL +to the Foomatic-3.0 database: <ulink noescape="1" url="http://www.linuxprinting.org/driver_list.cgi">http://www.linuxprinting.org/driver_list.cgi</ulink>. -If you upgrade to foomatic-rip, don't forget to also upgrade to the -new-style PPDs for your foomatic-driven printers. foomatic-rip will -not work with PPDs generated for the old cupsomatic. The new-style +If you upgrade to <command>foomatic-rip</command>, remember to also upgrade to the +new-style PPDs for your Foomatic-driven printers. foomatic-rip will +not work with PPDs generated for the old <command>cupsomatic</command>. The new-style PPDs are 100% compliant to the Adobe PPD specification. They are -intended to be used by Samba and the cupsaddsmb utility also, to -provide the driver files for the Windows clients also! +also intended to be used by Samba and the cupsaddsmb utility, to +provide the driver files for the Windows clients! </para></note> <sect2> -<title>foomatic-rip and Foomatic explained</title> +<title>foomatic-rip and Foomatic Explained</title> -<indexterm significance="preferred"><primary>foomatic</primary></indexterm> -<indexterm significance="preferred"><primary>foomatic-rip</primary></indexterm> <para> -Nowadays most Linux distros rely on the utilities of Linuxprinting.org -to create their printing related software (which, BTW, works on all -UNIXes and on Mac OS X or Darwin too). It is not known as well as it -should be, that it also has a very end-user friendly interface which -allows for an easy update of drivers and PPDs, for all supported -models, all spoolers, all operating systems and all package formats +<indexterm significance="preferred"><primary>foomatic</primary></indexterm> +<indexterm significance="preferred"><primary>foomatic-rip</primary></indexterm> +Nowadays, most Linux distributions rely on the utilities of Linuxprinting.org +to create their printing-related software (which, by the way, works on all +UNIXes and on Mac OS X or Darwin, too). It is not known as well as it +should be, that it also has a very end-user-friendly interface that +allows for an easy update of drivers and PPDs for all supported +models, all spoolers, all operating systems, and all package formats (because there is none). Its history goes back a few years. </para> <para> -Recently Foomatic has achieved the astonishing milestone of <ulink +Recently, Foomatic has achieved the astonishing milestone of <ulink url="http://www.linuxprinting.org/printer_list.cgi?make=Anyone">1000 listed</ulink> printer models. Linuxprinting.org keeps all the important facts about printer drivers, supported models and which @@ -4077,85 +4053,83 @@ its <ulink url="http://www.linuxprinting.org/foomatic.html">Foomatic</ulink> database. Currently there are <ulink url="http://www.linuxprinting.org/driver_list.cgi">245 drivers</ulink> -in the database: many drivers support various models, and many models -may be driven by different drivers; it's your choice! +in the database. Many drivers support various models, and many models +may be driven by different drivers &smbmdash; its your choice! </para> <sect3> -<title>690 "perfect" Printers</title> +<title>690 <quote>Perfect</quote> Printers</title> <para> -At present there are 690 devices dubbed as working "perfectly", 181 -"mostly", 96 "partially" and 46 are "Paperweights". Keeping in mind +At present, there are 690 devices dubbed as working perfectly, 181 +mostly, 96 partially, and 46 are paperweights. Keeping in mind that most of these are non-PostScript models (PostScript printers are -automatically supported supported by CUPS to perfection, by using -their own manufacturer-provided Windows-PPD...), and that a -multifunctional device never qualifies as working "perfectly" if it -doesn't also scan and copy and fax under GNU/Linux: then this is a -truly astonishing achievement. Three years ago the number was not -more than 500, and Linux or UNIX "printing" at the time wasn't -anywhere near the quality it is today! +automatically supported by CUPS to perfection, by using +their own manufacturer-provided Windows-PPD), and that a +multifunctional device never qualifies as working perfectly if it +does not also scan and copy and fax under GNU/Linux &smbmdash; then this is a +truly astonishing achievement! Three years ago the number was not +more than 500, and Linux or UNIX printing at the time wasn't +anywhere near the quality it is today. </para> </sect3> <sect3> -<title>How the "Printing HOWTO" started it all</title> +<title>How the Printing HOWTO Started It All</title> <para> -A few years ago <ulink -url="http://www2.picante.com:81/~gtaylor/">Grant Taylor</ulink> +A few years ago <ulink url="http://www2.picante.com:81/~gtaylor/">Grant Taylor</ulink> started it all. The roots of today's Linuxprinting.org are in the -first <ulink -url="http://www.linuxprinting.org/foomatic2.9/howto/">Linux Printing -HOWTO</ulink> which he authored. As a side-project to this document, +first <ulink url="http://www.linuxprinting.org/foomatic2.9/howto/">Linux Printing +HOWTO</ulink> that he authored. As a side-project to this document, which served many Linux users and admins to guide their first steps in this complicated and delicate setup (to a scientist, printing is -"applying a structured deposition of distinct patterns of ink or toner -particles on paper substrates" <emphasis>;-)</emphasis>, he started to +<quote>applying a structured deposition of distinct patterns of ink or toner +particles on paper substrates</quote>, he started to build in a little Postgres database with information about the hardware and driver zoo that made up Linux printing of the time. This database became the core component of today's Foomatic collection of -tools and data. In the meantime it has moved to an XML representation +tools and data. In the meantime, it has moved to an XML representation of the data. </para> </sect3> <sect3> -<title>Foomatic's strange Name</title> +<title>Foomatic's Strange Name</title> -<indexterm><primary>foomatic</primary></indexterm> <para> -"Why the funny name?", you ask. When it really took off, around spring +<indexterm><primary>foomatic</primary></indexterm> +<quote>Why the funny name?</quote> you ask. When it really took off, around spring 2000, CUPS was far less popular than today, and most systems used LPD, -LPRng or even PDQ to print. CUPS shipped with a few generic "drivers" +LPRng or even PDQ to print. CUPS shipped with a few generic drivers (good for a few hundred different printer models). These didn't support many device-specific options. CUPS also shipped with its own -built-in rasterization filter ("pstoraster", derived from +built-in rasterization filter (<parameter>pstoraster</parameter>, derived from Ghostscript). On the other hand, CUPS provided brilliant support for <emphasis>controlling</emphasis> all printer options through -standardized and well-defined "PPD files" (PostScript Printers +standardized and well-defined PPD files (PostScript Printers Description files). Plus, CUPS was designed to be easily extensible. </para> <para> -Grant already had in his database a respectable compilation -of facts about a many more printers, and the Ghostscript "drivers" -they run with. His idea, to generate PPDs from the database info +Taylor already had in his database a respectable compilation +of facts about many more printers and the Ghostscript <quote>drivers</quote> +they run with. His idea, to generate PPDs from the database information and use them to make standard Ghostscript filters work within CUPS, -proved to work very well. It also "killed several birds with one -stone": +proved to work very well. It also killed several birds with one +stone: </para> <itemizedlist> <listitem><para>It made all current and future Ghostscript filter -developments available for CUPS;</para></listitem> +developments available for CUPS.</para></listitem> <listitem><para>It made available a lot of additional printer models -to CUPS users (because often the "traditional" Ghostscript way of -printing was the only one available);</para></listitem> +to CUPS users (because often the traditional Ghostscript way of +printing was the only one available).</para></listitem> -<listitem><para>It gave all the advanced CUPS options (web interface, +<listitem><para>It gave all the advanced CUPS options (Web interface, GUI driver configurations) to users wanting (or needing) to use Ghostscript filters.</para></listitem> </itemizedlist> @@ -4164,36 +4138,35 @@ Ghostscript filters.</para></listitem> <sect3> <title>cupsomatic, pdqomatic, lpdomatic, directomatic</title> + +<para> <indexterm><primary>cupsomatic</primary></indexterm> <indexterm><primary>CUPS-PPD</primary></indexterm> <indexterm><primary>PPD</primary><secondary>CUPS</secondary><see>CUPS-PPD</see></indexterm> - -<para> CUPS worked through a quickly-hacked up filter script named <ulink -url="http://www.linuxprinting.org/download.cgi?filename=cupsomatic&show=0">cupsomatic</ulink>. +url="http://www.linuxprinting.org/download.cgi?filename=cupsomatic&show=0">cupsomatic.</ulink> cupsomatic ran the printfile through Ghostscript, constructing automatically the rather complicated command line needed. It just -required to be copied into the CUPS system to make it work. To -"configure" the way cupsomatic controls the Ghostscript rendering +needed to be copied into the CUPS system to make it work. To +configure the way cupsomatic controls the Ghostscript rendering process, it needs a CUPS-PPD. This PPD is generated directly from the contents of the database. For CUPS and the respective printer/filter -combo another Perl script named "CUPS-O-Matic" did the PPD -generation. After that was working, Grant implemented within a few +combo, another Perl script named CUPS-O-Matic did the PPD +generation. After that was working, Taylor implemented within a few days a similar thing for two other spoolers. Names chosen for the config-generator scripts were <ulink url="http://www.linuxprinting.org/download.cgi?filename=lpdomatic&show=0">PDQ-O-Matic</ulink> (for PDQ) and <ulink url="http://www.linuxprinting.org/download.cgi?filename=lpdomatic&show=0">LPD-O-Matic</ulink> -(for - you guessed it - LPD); the configuration here didn't use PPDs +(for &smbmdash; you guessed it &smbmdash; LPD); the configuration here didn't use PPDs but other spooler-specific files. </para> <para> -From late summer of that year, <ulink -url="http://www.linuxprinting.org/till/">Till Kamppeter</ulink> -started to put work into the database. Till had been newly employed by +From late summer of that year, <ulink url="http://www.linuxprinting.org/till/">Till Kamppeter</ulink> +started to put work into the database. Kamppeter had been newly employed by <ulink url="http://www.mandrakesoft.com/">MandrakeSoft</ulink> to -convert their printing system over to CUPS, after they had seen his +convert its printing system over to CUPS, after they had seen his <ulink url="http://www.fltk.org/">FLTK</ulink>-based <ulink url="http://cups.sourceforge.net/xpp/">XPP</ulink> (a GUI frontend to the CUPS lp-command). He added a huge amount of new information and new @@ -4201,104 +4174,101 @@ printers. He also developed the support for other spoolers, like <ulink url="http://ppr.sourceforge.net/">PPR</ulink> (via ppromatic), <ulink url="http://sourceforge.net/projects/lpr/">GNUlpr</ulink> and <ulink url="http://www.lprng.org/">LPRng</ulink> (both via an extended -lpdomatic) and "spoolerless" printing (<ulink -url="http://www.linuxprinting.org/download.cgi?filename=directomatic&show=0">directomatic</ulink>).... +lpdomatic) and spoolerless printing (<ulink +url="http://www.linuxprinting.org/download.cgi?filename=directomatic&show=0">directomatic</ulink>). </para> <para> -So, to answer your question: "Foomatic" is the general name for all -the overlapping code and data behind the "*omatic" scripts.... -- -Foomatic up to versions 2.0.x required (ugly) Perl data structures -attached the Linuxprinting.org PPDs for CUPS. It had a different -"*omatic" script for every spooler, as well as different printer -configuration files.. +So, to answer your question: <quote>Foomatic</quote> is the general name for all +the overlapping code and data behind the <quote>*omatic</quote> scripts. +Foomatic, up to versions 2.0.x, required (ugly) Perl data structures +attached to Linuxprinting.org PPDs for CUPS. It had a different +<quote>*omatic</quote> script for every spooler, as well as different printer +configuration files. </para> </sect3> <sect3> -<title>The <emphasis>Grand Unification</emphasis> -achieved...</title> +<title>The <emphasis>Grand Unification</emphasis> Achieved</title> -<indexterm><primary>foomatic-rip</primary></indexterm> <para> -This all has changed in Foomatic versions 2.9 (Beta) and released as -"stable" 3.0. This has now achieved the convergence of all *omatic -scripts: it is called the <ulink -url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=0">foomatic-rip</ulink>. +<indexterm><primary>foomatic-rip</primary></indexterm> +This has all changed in Foomatic versions 2.9 (beta) and released as +<quote>stable</quote> 3.0. It has now achieved the convergence of all *omatic +scripts and is called the <ulink +url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=0">foomatic-rip.</ulink> This single script is the unification of the previously different spooler-specific *omatic scripts. foomatic-rip is used by all the -different spoolers alike. Because foomatic-rip can read PPDs (both the +different spoolers alike and because it can read PPDs (both the original PostScript printer PPDs and the Linuxprinting.org-generated ones), all of a sudden all supported spoolers can have the power of -PPDs at their disposal; users only need to plug "foomatic-rip" into -their system.... For users there is improved media type and source -support; paper sizes and trays are easier to configure. +PPDs at their disposal. Users only need to plug foomatic-rip into +their system. For users there is improved media type and source +support &smbmdash; paper sizes and trays are easier to configure. </para> <para> -Also, the New Generation of Linuxprinting.org PPDs doesn't contain -Perl data structures any more. If you are a distro maintainer and have +Also, the New Generation of Linuxprinting.org PPDs no longer contains +Perl data structures. If you are a distro maintainer and have used the previous version of Foomatic, you may want to give the new -one a spin: but don't forget to generate a new-version set of PPDs, +one a spin, but remember to generate a new-version set of PPDs via the new <ulink -url="http://www.linuxprinting.org/download/foomatic/foomatic-db-engine-3.0.0beta1.tar.gz">foomatic-db-engine</ulink>! +url="http://www.linuxprinting.org/download/foomatic/foomatic-db-engine-3.0.0beta1.tar.gz">foomatic-db-engine!</ulink> Individual users just need to generate a single new PPD specific to their model by <ulink url="http://www.linuxprinting.org/kpfeifle/LinuxKongress2002/Tutorial/II.Foomatic-User/II.tutorial-handout-foomatic-user.html">following -the steps</ulink> outlined in the Foomatic tutorial or further -below. This new development is truly amazing. +the steps</ulink> outlined in the Foomatic tutorial or in this chapter. This new development is truly amazing. </para> <para> foomatic-rip is a very clever wrapper around the need to run -Ghostscript with a different syntax, different options, different -device selections and/or different filters for each different printer -or different spooler. At the same time it can read the PPD associated +Ghostscript with a different syntax, options, device selections, and/or filters for each different printer +or spooler. At the same time it can read the PPD associated with a print queue and modify the print job according to the user selections. Together with this comes the 100% compliance of the new -Foomatic PPDs with the Adobe spec. Some really innovative features of -the Foomatic concept will surprise users: it will support custom paper -sizes for many printers; and it will support printing on media drawn -from different paper trays within the same job (in both cases: even +Foomatic PPDs with the Adobe spec. Some innovative features of +the Foomatic concept may surprise users. It will support custom paper +sizes for many printers and will support printing on media drawn +from different paper trays within the same job (in both cases, even where there is no support for this from Windows-based vendor printer drivers). </para> </sect3> <sect3> -<title>Driver Development outside</title> +<title>Driver Development Outside</title> <para> Most driver development itself does not happen within Linuxprinting.org. Drivers are written by independent maintainers. -Linuxprinting.org just pools all the information, and stores it in its +Linuxprinting.org just pools all the information and stores it in its database. In addition, it also provides the Foomatic glue to integrate the many drivers into any modern (or legacy) printing system known to the world. </para> <para> -Speaking of the different driver development groups: most of +Speaking of the different driver development groups, most of the work is currently done in three projects. These are: </para> <itemizedlist> <listitem><para><ulink url="http://www-124.ibm.com/developerworks/oss/linux/projects/omni/">Omni</ulink> --- a Free Software project by IBM which tries to convert their printer +&smbmdash; a free software project by IBM that tries to convert their printer driver knowledge from good-ol' OS/2 times into a modern, modular, -universal driver architecture for Linux/UNIX (still Beta). This +universal driver architecture for Linux/UNIX (still beta). This currently supports 437 models.</para></listitem> -<listitem><para><ulink url="http://hpinkjet.sf.net/">HPIJS</ulink> -- -a Free Software project by HP to provide the support for their own +<listitem><para><ulink url="http://hpinkjet.sf.net/">HPIJS</ulink> &smbmdash; +a free software project by HP to provide the support for their own range of models (very mature, printing in most cases is perfect and provides true photo quality). This currently supports 369 models.</para></listitem> <listitem><para><ulink -url="http://gimp-print.sf.net/">Gimp-Print</ulink> -- a Free software +url="http://gimp-print.sf.net/">Gimp-Print</ulink> &smbmdash; a free software effort, started by Michael Sweet (also lead developer for CUPS), now directed by Robert Krawitz, which has achieved an amazing level of photo print quality (many Epson users swear that its quality is @@ -4308,30 +4278,29 @@ platforms). This currently supports 522 models.</para></listitem> </sect3> <sect3> -<title>Forums, Downloads, Tutorials, Howtos -- also for Mac OS X and -commercial UNIX</title> +<title>Forums, Downloads, Tutorials, Howtos &smbmdash; also for Mac OS X and Commercial UNIX</title> <para> -Linuxprinting.org today is the one-stop "shop" to download printer +Linuxprinting.org today is the one-stop shop to download printer drivers. Look for printer information and <ulink url="http://www.linuxprinting.org//kpfeifle/LinuxKongress2002/Tutorial/">tutorials</ulink> or solve printing problems in its popular <ulink -url="http://www.linuxprinting.org/newsportal/">forums</ulink>. But -it's not just for GNU/Linux: users and admins of <ulink +url="http://www.linuxprinting.org/newsportal/">forums.</ulink> This forum +it's not just for GNU/Linux users, but admins of <ulink url="http://www.linuxprinting.org/macosx/">commercial UNIX systems</ulink> are also going there, and the relatively new <ulink url="http://www.linuxprinting.org/newsportal/thread.php3?name=linuxprinting.macosx.general">Mac OS X forum</ulink> has turned out to be one of the most frequented -fora after only a few weeks. +forums after only a few weeks. </para> <para> Linuxprinting.org and the Foomatic driver wrappers around Ghostscript are now a standard toolchain for printing on all the important distros. Most of them also have CUPS underneath. While in recent years -most printer data had been added by Till (who works at Mandrake), many +most printer data had been added by Kamppeter (who works at Mandrake), many additional contributions came from engineers with SuSE, RedHat, -Connectiva, Debian and others. Vendor-neutrality is an important goal +Connectiva, Debian, and others. Vendor-neutrality is an important goal of the Foomatic project. </para> @@ -4343,34 +4312,34 @@ it often, please send him a note showing your appreciation. </sect3> <sect3> -<title>Foomatic Database generated PPDs</title> +<title>Foomatic Database-Generated PPDs</title> <para> The Foomatic database is an amazing piece of ingenuity in itself. Not only does it keep the printer and driver information, but it is -organized in a way that it can generate "PPD" files "on the fly" from +organized in a way that it can generate PPD files on the fly from its internal XML-based datasets. While these PPDs are modelled to the -Adobe specification of "PostScript Printer Descriptions" (PPDs), the -Linuxprinting.org/Foomatic-PPDs don't normally drive PostScript -printers: they are used to describe all the bells and whistles you -could ring or blow on an Epson Stylus inkjet, or a HP Photosmart or -what-have-you. The main "trick" is one little additional line, not -envisaged by the PPD specification, starting with the "*cupsFilter" -keyword: it tells the CUPS daemon how to proceed with the PostScript +Adobe specification of PostScript Printer Descriptions (PPDs), the +Linuxprinting.org/Foomatic-PPDs do not normally drive PostScript +printers. They are used to describe all the bells and whistles you +could ring or blow on an Epson Stylus inkjet, or a HP Photosmart, or +what-have-you. The main trick is one little additional line, not +envisaged by the PPD specification, starting with the <parameter>*cupsFilter</parameter> +keyword. It tells the CUPS daemon how to proceed with the PostScript print file (old-style Foomatic-PPDs named the -<emphasis>cupsomatic</emphasis> filter script, while the new-style -PPDs now call <emphasis>foomatic-rip</emphasis>). This filter +cupsomatic filter script, while the new-style +PPDs are now call foomatic-rip). This filter script calls Ghostscript on the host system (the recommended variant is ESP Ghostscript) to do the rendering work. foomatic-rip knows which filter or internal device setting it should ask from Ghostscript to convert the PostScript printjob into a raster format ready for the target device. This usage of PPDs to describe the options of non-PS -printers was the invention of the CUPS developers. The rest is easy: -GUI tools (like KDE's marvellous <ulink -url="http://printing.kde.org/overview/kprinter.phtml">"kprinter"</ulink>, +printers was the invention of the CUPS developers. The rest is easy. +GUI tools (like KDE's marvelous <ulink +url="http://printing.kde.org/overview/kprinter.phtml">kprinter,</ulink> or the GNOME <ulink -url="http://gtklp.sourceforge.net/">"gtklp"</ulink>, "xpp" and the CUPS -web interface) read the PPD too and use this information to present +url="http://gtklp.sourceforge.net/">gtklp,</ulink> xpp and the CUPS +Web interface) read the PPD as well and use this information to present the available settings to the user as an intuitive menu selection. </para> </sect3> @@ -4380,44 +4349,41 @@ the available settings to the user as an intuitive menu selection. <title>foomatic-rip and Foomatic-PPD Download and Installation</title> <para> -Here are the steps to install a foomatic-rip driven "LaserJet 4 Plus" -compatible printer in CUPS (note that recent distributions of SuSE, -UnitedLinux and Mandrake may ship with a complete package of -Foomatic-PPDs plus the foomatic-rip utility. going directly to -Linuxprinting.org ensures you to get the latest driver/PPD files): +Here are the steps to install a foomatic-rip driven LaserJet 4 Plus-compatible +printer in CUPS (note that recent distributions of SuSE, UnitedLinux and +Mandrake may ship with a complete package of Foomatic-PPDs plus the +<command>foomatic-rip</command> utility. Going directly to +Linuxprinting.org ensures that you get the latest driver/PPD files): </para> + <itemizedlist> -<listitem><para>Surf to <ulink -noescape="1" url="http://www.linuxprinting.org/printer_list.cgi">http://www.linuxprinting.org/printer_list.cgi</ulink> +<listitem><para>Open your browser at the Linuxprinting.org printer list<ulink url="http://www.linuxprinting.org/printer_list.cgi">page.</ulink> </para></listitem> -<listitem><para>Check the complete list of printers in the database: -<ulink noescape="1" -url="http://www.linuxprinting.org/printer_list.cgi?make=Anyone">http://www.linuxprinting.org/printer_list.cgi?make=Anyone</ulink> +<listitem><para>Check the complete list of printers in the +<ulink url="http://www.linuxprinting.org/printer_list.cgi?make=Anyone">database.</ulink>. </para></listitem> -<listitem><para>There select your model and click on the -link.</para></listitem> +<listitem><para>Select your model and click on the link. +</para></listitem> -<listitem><para>You'll arrive at a page listing all drivers working -with this model (for all printers, there will always be -<emphasis>one</emphasis> recommended driver. Try this one -first).</para></listitem> +<listitem><para>You'll arrive at a page listing all drivers working with this +model (for all printers, there will always be <emphasis>one</emphasis> +recommended driver. Try this one first). +</para></listitem> -<listitem><para>In our case ("HP LaserJet 4 Plus"), we'll arrive here: - <ulink noescape="1" -url="http://www.linuxprinting.org/show_printer.cgi?recnum=HP-LaserJet_4_Plus">http://www.linuxprinting.org/show_printer.cgi?recnum=HP-LaserJet_4_Plus</ulink> +<listitem><para>In our case (HP LaserJet 4 Plus), we'll arrive at the default driver for the +<ulink url="http://www.linuxprinting.org/show_printer.cgi?recnum=HP-LaserJet_4_Plus">HP-LaserJet 4 Plus.</ulink> </para></listitem> -<listitem><para>The recommended driver is "ljet4".</para></listitem> +<listitem><para>The recommended driver is ljet4.</para></listitem> -<listitem><para>There are several links provided here. You should -visit them all, if you are not familiar with the Linuxprinting.org -database.</para></listitem> +<listitem><para>Several links are provided here. You should visit them all if you +are not familiar with the Linuxprinting.org database. +</para></listitem> -<listitem><para>There is a link to the database page for the "ljet4": - <ulink noescape="1" -url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">http://www.linuxprinting.org/show_driver.cgi?driver=ljet4</ulink> +<listitem><para>There is a link to the database page for the +<ulink url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">ljet4.</ulink> On the driver's page, you'll find important and detailed information about how to use that driver within the various available spoolers.</para></listitem> @@ -4425,136 +4391,128 @@ spoolers.</para></listitem> <listitem><para>Another link may lead you to the homepage of the driver author or the driver.</para></listitem> -<listitem><para>Important links are the ones which provide hints with -setup instructions for CUPS (<ulink noescape="1" -url="http://www.linuxprinting.org/cups-doc.html">http://www.linuxprinting.org/cups-doc.html</ulink>), -PDQ (<ulink noescape="1" -url="http://www.linuxprinting.org/pdq-doc.html">http://www.linuxprinting.org/pdq-doc.html</ulink>), -LPD, LPRng and GNUlpr (<ulink noescape="1" -url="http://www.linuxprinting.org/lpd-doc.html">http://www.linuxprinting.org/lpd-doc.html</ulink>) -as well as PPR (<ulink noescape="1" -url="http://www.linuxprinting.org/ppr-doc.html">http://www.linuxprinting.org/ppr-doc.html)</ulink> -or "spooler-less" printing (<ulink noescape="1" -url="http://www.linuxprinting.org/direct-doc.html">http://www.linuxprinting.org/direct-doc.html</ulink> -).</para></listitem> - -<listitem><para>You can view the PPD in your browser through this -link: <ulink noescape="1" -url="http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=1">http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=1</ulink> -</para></listitem> <listitem><para>You can also (most importantly) -generate and download the PPD: <ulink noescape="1" -url="http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=0">http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=0</ulink> +<listitem><para>Important links are the ones that provide hints with +setup instructions for <ulink noescape="1" url="http://www.linuxprinting.org/cups-doc.html">CUPS</ulink>, +<ulink url="http://www.linuxprinting.org/pdq-doc.html">PDQ</ulink>, +<ulink url="http://www.linuxprinting.org/lpd-doc.html">LPD, LPRng and GNUlpr</ulink>) +as well as <ulink url="http://www.linuxprinting.org/ppr-doc.html">PPR</ulink> +or <quote>spooler-less</quote> <ulink url="http://www.linuxprinting.org/direct-doc.html">printing.</ulink> +</para></listitem> + +<listitem><para>You can view the PPD in your browser through this link: +<ulink noescape="1" url="http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=1">http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=1</ulink> +</para></listitem> <listitem><para>Most importantly, you can also generate and download +the <ulink url="http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4&printer=HP-LaserJet_4_Plus&show=0">PPD.</ulink> </para></listitem> <listitem><para>The PPD contains all the information needed to use our -model and the driver; this is, once installed, working transparently -for the user. Later you'll only need to choose resolution, paper size -etc. from the web-based menu, or from the print dialog GUI, or from -the commandline.</para></listitem> - -<listitem><para>Should you have ended up on the driver's page (<ulink noescape="1" -url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">http://www.linuxprinting.org/show_driver.cgi?driver=ljet4</ulink>), -you can choose to use the "PPD-O-Matic" online PPD generator +model and the driver; once installed, this works transparently +for the user. Later you'll only need to choose resolution, paper size, +and so on from the Web-based menu, or from the print dialog GUI, or from +the command line.</para></listitem> + +<listitem><para>If you ended up on the drivers +<ulink url="http://www.linuxprinting.org/show_driver.cgi?driver=ljet4">page</ulink> +you can choose to use the <quote>PPD-O-Matic</quote> online PPD generator program.</para></listitem> -<listitem><para>Select the exact model and check either "download" or -"display PPD file" and click on "Generate PPD file".</para></listitem> +<listitem><para>Select the exact model and check either <guilabel>Download</guilabel> or +<guilabel>Display PPD file</guilabel> and click <guilabel>Generate PPD file</guilabel>.</para></listitem> <listitem><para>If you save the PPD file from the browser view, please -don't use "cut'n'past" (since it could possibly damage line endings -and tabs, which makes the PPD likely to fail its duty), but use "Save -as..." in your browser's menu. (Best is to use the "download" option -from the web page directly).</para></listitem> - -<listitem><para>Another very interesting part on each driver page is -the <emphasis>Show execution details</emphasis> button. If you -select your printer model and click that button, you will get -displayed a complete Ghostscript command line, enumerating all options -available for that driver/printermodel combo. This is a great way to -"Learn Ghostscript By Doing". It is also an excellent "cheat sheet" +do not use cut and paste (since it could possibly damage line endings +and tabs, which makes the PPD likely to fail its duty), but use <guimenuitem>Save +as...</guimenuitem> in your browser's menu. (It is best to use the <guilabel>Download</guilabel> option +directly from the Web page).</para></listitem> + +<listitem><para>Another interesting part on each driver page is +the <guimenuitem>Show execution details</guimenuitem> button. If you +select your printer model and click on that button, +a complete Ghostscript command line will be displayed, enumerating all options +available for that combination of driver and printer model. This is a great way to +<quote>learn Ghostscript by doing</quote>. It is also an excellent cheat sheet for all experienced users who need to re-construct a good command line for that damn printing script, but can't remember the exact -syntax. ;-)</para></listitem> +syntax. </para></listitem> <listitem><para>Some time during your visit to Linuxprinting.org, save the PPD to a suitable place on your harddisk, say <filename>/path/to/my-printer.ppd</filename> (if you prefer to install -your printers with the help of the CUPS web interface, save the PPD to -the <filename>/usr/share/cups/model/</filename> path and re-start +your printers with the help of the CUPS Web interface, save the PPD to +the <filename>/usr/share/cups/model/</filename> path and restart cupsd).</para></listitem> -<listitem><para>Then install the printer with a suitable commandline, -e.g.: +<listitem><para>Then install the printer with a suitable command line, +like this: </para> <para><screen> -&rootprompt;<userinput>lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -P path/to/my-printer.ppd</userinput> +&rootprompt;<userinput>lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E \ + -P path/to/my-printer.ppd</userinput> </screen></para></listitem> -<listitem><para>Note again this: for all the new-style "Foomatic-PPDs" -from Linuxprinting.org, you also need a special "CUPS filter" named -"foomatic-rip".Get the latest version of "foomatic-rip" from: <ulink noescape="1" -url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=0">http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=0</ulink> +<listitem><para>For all the new-style <quote>Foomatic-PPDs</quote> +from Linuxprinting.org, you also need a special CUPS filter named +foomatic-rip. </para></listitem> <listitem><para>The foomatic-rip Perlscript itself also makes some -interesting reading (<ulink noescape="1" -url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=1">http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=1</ulink>), -because it is very well documented by Till's inline comments (even +interesting <ulink url="http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip&show=1">reading</ulink> +because it is well documented by Kamppeter's inline comments (even non-Perl hackers will learn quite a bit about printing by reading -it... ;-)</para></listitem> +it).</para></listitem> <listitem><para>Save foomatic-rip either directly in <filename>/usr/lib/cups/filter/foomatic-rip</filename> or somewhere in -your $PATH (and don't forget to make it world-executable). Again, -don't save by "copy'n'paste" but use the appropriate link, or the -"Save as..." menu item in your browser.</para></listitem> +your $PATH (and remember to make it world-executable). Again, +do not save by copy and paste but use the appropriate link or the +<guimenuitem>Save as...</guimenuitem> menu item in your browser.</para></listitem> <listitem><para>If you save foomatic-rip in your $PATH, create a symlink: -<command>cd /usr/lib/cups/filter/ ; ln -s `which -foomatic-rip`</command>. For CUPS to discover this new -available filter at startup, you need to re-start +<screen> +&rootprompt;<userinput>cd /usr/lib/cups/filter/ ; ln -s `which foomatic-rip'</userinput> +</screen> +</para> + +<para> +CUPS will discover this new available filter at startup after restarting cupsd.</para></listitem> </itemizedlist> <para> -Once you print to a printqueue set up with the Foomatic-PPD, CUPS will +Once you print to a print queue set up with the Foomatic-PPD, CUPS will insert the appropriate commands and comments into the resulting PostScript jobfile. foomatic-rip is able to read and act upon -these. foomatic-rip uses some specially encoded Foomatic comments, +these and uses some specially encoded Foomatic comments embedded in the jobfile. These in turn are used to construct -(transparently for you, the user) the complicated ghostscript command -line telling for the printer driver how exactly the resulting raster -data should look like and which printer commands to embed into the -data stream. -</para> - -<para> -You need: +(transparently for you, the user) the complicated Ghostscript command +line telling the printer driver exactly how the resulting raster +data should look and which printer commands to embed into the +data stream. You need: </para> <itemizedlist> -<listitem><para>A "foomatic+something" PPD -- but it this not enough +<listitem><para>A <quote>foomatic+something</quote> PPD &smbmdash; but this is not enough to print with CUPS (it is only <emphasis>one</emphasis> important -component)</para></listitem> +component).</para></listitem> -<listitem><para>The "foomatic-rip" filter script (Perl) in -/usr/lib/cups/filters/</para></listitem> +<listitem><para>The <parameter>foomatic-rip</parameter> filter script (Perl) in +<filename>/usr/lib/cups/filters/</filename>.</para></listitem> -<listitem><para>Perl to make foomatic-rip run</para></listitem> +<listitem><para>Perl to make foomatic-rip run.</para></listitem> <listitem><para>Ghostscript (because it is doing the main work, controlled by the PPD/foomatic-rip combo) to produce the raster data -fit for your printermodel's consumption</para></listitem> +fit for your printer model's consumption.</para></listitem> <listitem><para>Ghostscript <emphasis>must</emphasis> (depending on -the driver/model) contain support for a certain "device", representing -the selected "driver" for your model (as shown by "gs --h")</para></listitem> +the driver/model) contain support for a certain device representing +the selected driver for your model (as shown by <command>gs + -h</command>).</para></listitem> <listitem><para>foomatic-rip needs a new version of PPDs (PPD versions -produced for cupsomatic don't work with +produced for cupsomatic do not work with foomatic-rip).</para></listitem> </itemizedlist> </sect2> @@ -4564,11 +4522,11 @@ foomatic-rip).</para></listitem> <title>Page Accounting with CUPS</title> -<indexterm><primary>CUPS</primary><secondary>Page Accounting</secondary></indexterm> <para> -Often there are questions regarding "print quotas" wherein Samba users +<indexterm><primary>CUPS</primary><secondary>Page Accounting</secondary></indexterm> +Often there are questions regarding print quotas where Samba users (that is, Windows clients) should not be able to print beyond a -certain amount of pages or data volume per day, week or month. This +certain number of pages or data volume per day, week or month. This feature is dependent on the real print subsystem you're using. Samba's part is always to receive the job files from the clients (filtered <emphasis>or</emphasis> unfiltered) and hand it over to this @@ -4576,24 +4534,25 @@ printing subsystem. </para> <para> -Of course one could "hack" things with one's own scripts. But then -there is CUPS. CUPS supports "quotas" which can be based on sizes of -jobs or on the number of pages or both, and are spanning any time +Of course one could hack things with one's own scripts. But then +there is CUPS. CUPS supports quotas that can be based on the size of +jobs or on the number of pages or both, and span any time period you want. </para> <sect2> -<title>Setting up Quotas</title> +<title>Setting Up Quotas</title> -<indexterm><primary>CUPS</primary><secondary>quotas</secondary></indexterm> <para> -This is an example command how root would set a print quota in CUPS, -assuming an existing printer named "quotaprinter": +<indexterm><primary>CUPS</primary><secondary>quotas</secondary></indexterm> +This is an example command of how root would set a print quota in CUPS, +assuming an existing printer named <quote>quotaprinter</quote>: </para> -<indexterm><primary>lpadmin</primary></indexterm> -<para><screen> +<para> +<indexterm><primary>lpadmin</primary></indexterm> + <screen> &rootprompt;<userinput>lpadmin -p quotaprinter -o job-quota-period=604800 \ -o job-k-limit=1024 -o job-page-limit=100</userinput> </screen></para> @@ -4606,26 +4565,26 @@ week). </sect2> <sect2> -<title>Correct and incorrect Accounting</title> +<title>Correct and Incorrect Accounting</title> <para> For CUPS to count correctly, the printfile needs to pass the CUPS -"pstops" filter, otherwise it uses a "dummy" count of "1". Some -printfiles don't pass it (eg: image files) but then those are mostly 1 +pstops filter, otherwise it uses a dummy count of <quote>one</quote>. Some +print files do not pass it (e.g., image files) but then those are mostly one- page jobs anyway. This also means that proprietary drivers for the target printer running on the client computers and CUPS/Samba, which -then spool these files as "raw" (i.e. leaving them untouched, not -filtering them), will be counted as "1-pagers" too! +then spool these files as <quote>raw</quote> (i.e., leaving them untouched, not +filtering them), will be counted as one-pagers too! </para> <para> -You need to send PostScript from the clients (i.e. run a PostScript +You need to send PostScript from the clients (i.e., run a PostScript driver there) to have the chance to get accounting done. If the printer is a non-PostScript model, you need to let CUPS do the job to convert the file to a print-ready format for the target printer. This -will be working for currently about 1,000 different printer models, -see <ulink - url="http://www.linuxprinting.org/printer_list.cgi">the driver list at linuxprinting.org/</ulink>. +is currently working for about a thousand different printer models. +Linuxprinting has a driver +<ulink url="http://www.linuxprinting.org/printer_list.cgi">list.</ulink> </para> </sect2> @@ -4633,40 +4592,38 @@ see <ulink <title>Adobe and CUPS PostScript Drivers for Windows Clients</title> <para> -Before CUPS-1.1.16 your only option was to use the Adobe PostScript +Before CUPS 1.1.16, your only option was to use the Adobe PostScript Driver on the Windows clients. The output of this driver was not -always passed through the "pstops" filter on the CUPS/Samba side, and +always passed through the <command>pstops</command> filter on the CUPS/Samba side, and therefore was not counted correctly (the reason is that it often, -depending on the "PPD" being used, wrote a "PJL"-header in front of -the real PostScript which caused CUPS to skip pstops and go directly -to the "pstoraster" stage). +depending on the PPD being used, wrote a PJL-header in front of +the real PostScript which caused CUPS to skip <command>pstops</command> and go directly +to the <command>pstoraster</command> stage). </para> <para> -From CUPS-1.1.16 onward you can use the "CUPS PostScript Driver for -Windows NT/2K/XP clients" (which is tagged in the download area of -http://www.cups.org/ as the "cups-samba-1.1.16.tar.gz" package). It does -<emphasis>not</emphasis> work for Win9x/ME clients. But it guarantees: +From CUPS 1.1.16 onward, you can use the CUPS PostScript Driver for +Windows <?latex \linebreak ?>NT/200x/XP clients (which is tagged in the download area of +<filename>http://www.cups.org/</filename> as the <filename>cups-samba-1.1.16.tar.gz</filename> +package). It does <emphasis>not</emphasis> work for Windows 9x/ME clients, but it guarantees: </para> <itemizedlist> -<indexterm><primary>PJL</primary></indexterm> -<listitem><para>to not write an PJL-header</para></listitem> +<listitem><para> <indexterm><primary>PJL</primary></indexterm> To not write a PJL-header.</para></listitem> -<listitem><para>to still read and support all PJL-options named in the -driver PPD with its own means</para></listitem> +<listitem><para>To still read and support all PJL-options named in the +driver PPD with its own means.</para></listitem> -<listitem><para> that the file will pass through the "pstops" filter -on the CUPS/Samba server</para></listitem> +<listitem><para>That the file will pass through the <command>pstops</command> filter +on the CUPS/Samba server.</para></listitem> -<listitem><para>to page-count correctly the -printfile</para></listitem> +<listitem><para>To page-count correctly the print file.</para></listitem> </itemizedlist> <para> -You can read more about the setup of this combination in the manpage -for "cupsaddsmb" (which is only present with CUPS installed, and only +You can read more about the setup of this combination in the man page +for <command>cupsaddsmb</command> (which is only present with CUPS installed, and only current from CUPS 1.1.16). </para> </sect2> @@ -4674,10 +4631,10 @@ current from CUPS 1.1.16). <sect2> <title>The page_log File Syntax</title> -<indexterm><primary>page_log</primary></indexterm> <para> -These are the items CUPS logs in the "page_log" for every -single <emphasis>page</emphasis> of a job: +<indexterm><primary>page_log</primary></indexterm> +These are the items CUPS logs in the <filename>page_log</filename> for every +page of a job: </para> <itemizedlist> @@ -4689,36 +4646,35 @@ single <emphasis>page</emphasis> of a job: <listitem><para>Time of printing</para></listitem> -<listitem><para>the page number</para></listitem> +<listitem><para>The page number</para></listitem> -<listitem><para>the number of copies</para></listitem> +<listitem><para>The number of copies</para></listitem> -<listitem><para>a billing information string -(optional)</para></listitem> +<listitem><para>A billing information string (optional)</para></listitem> -<listitem><para>the host which sent the job (included since version -1.1.19)</para></listitem> +<listitem><para>The host that sent the job (included since version 1.1.19)</para></listitem> </itemizedlist> <para> -Here is an extract of my CUPS server's page_log file to illustrate the +Here is an extract of my CUPS server's <filename>page_log</filename> file to illustrate the format and included items: </para> <para><screen> -infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 1 3 #marketing 10.160.50.13 -infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 2 3 #marketing 10.160.50.13 -infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 3 3 #marketing 10.160.50.13 -infotec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 4 3 #marketing 10.160.50.13 -DigiMaster9110 boss 402 [22/Apr/2003:10:33:22 +0100] 1 440 finance-dep 10.160.51.33 +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 1 3 #marketing 10.160.50.13 +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 2 3 #marketing 10.160.50.13 +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 3 3 #marketing 10.160.50.13 +tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 4 3 #marketing 10.160.50.13 +Dig9110 boss 402 [22/Apr/2003:10:33:22 +0100] 1 440 finance-dep 10.160.51.33 </screen></para> <para> -This was job ID "401", printed on "infotec_IS2027" by user "kurt", a -64-page job printed in 3 copies and billed to "#marketing", sent -from IP address 10.160.50.13. The next job had ID "402", was sent by -user "boss" from IP address 10.160.51.33,printed from one page 440 -copies and is set to be billed to "finance-dep". +This was job ID <parameter>401</parameter>, printed on <parameter>tec_IS2027</parameter> +by user <parameter>kurt</parameter>, a 64-page job printed in three copies and billed to +<parameter>#marketing</parameter>, sent from IP address <constant>10.160.50.13.</constant> + The next job had ID <parameter>402</parameter>, was sent by user <parameter>boss</parameter> +from IP address <constant>10.160.51.33</constant>, printed from one page 440 copies and +is set to be billed to <parameter>finance-dep</parameter>. </para> </sect2> @@ -4730,29 +4686,29 @@ What flaws or shortcomings are there with this quota system? </para> <itemizedlist> -<listitem><para>the ones named above (wrongly logged job in case of -printer hardware failure, etc.)</para></listitem> +<listitem><para>The ones named above (wrongly logged job in case of +printer hardware failure, and so on).</para></listitem> -<listitem><para>in reality, CUPS counts the job pages that are being +<listitem><para>In reality, CUPS counts the job pages that are being processed in <emphasis>software</emphasis> (that is, going through the -"RIP") rather than the physical sheets successfully leaving the -printing device. Thus if there is a jam while printing the 5th sheet out -of 1000 and the job is aborted by the printer, the "page count" will -still show the figure of 1000 for that job</para></listitem> +RIP) rather than the physical sheets successfully leaving the +printing device. Thus if there is a jam while printing the fifth sheet out +of a thousand and the job is aborted by the printer, the page count will +still show the figure of a thousand for that job.</para></listitem> -<listitem><para>all quotas are the same for all users (no flexibility -to give the boss a higher quota than the clerk), no support for -groups</para></listitem> +<listitem><para>All quotas are the same for all users (no flexibility +to give the boss a higher quota than the clerk) and no support for +groups.</para></listitem> -<listitem><para>no means to read out the current balance or the -"used-up" number of current quota</para></listitem> +<listitem><para>No means to read out the current balance or the +<quote>used-up</quote> number of current quota.</para></listitem> -<listitem><para>a user having used up 99 sheets of 100 quota will -still be able to send and print a 1,000 sheet job</para></listitem> +<listitem><para>A user having used up 99 sheets of a 100 quota will +still be able to send and print a thousand sheet job.</para></listitem> -<listitem><para>a user being denied a job because of a filled-up quota -doesn't get a meaningful error message from CUPS other than -"client-error-not-possible".</para></listitem> +<listitem><para>A user being denied a job because of a filled-up quota +does not get a meaningful error message from CUPS other than +<quote>client-error-not-possible</quote>.</para></listitem> </itemizedlist> </sect2> @@ -4765,21 +4721,22 @@ improvements under development for CUPS 1.2: </para> <itemizedlist> -<listitem><para>page counting will go into the "backends" (these talk +<listitem><para>Page counting will go into the backends (these talk directly to the printer and will increase the count in sync with the -actual printing process: thus a jam at the 5th sheet will lead to a -stop in the counting)</para></listitem> +actual printing process; thus, a jam at the fifth sheet will lead to a +stop in the counting).</para></listitem> -<listitem><para>quotas will be handled more flexibly</para></listitem> +<listitem><para>Quotas will be handled more flexibly.</para></listitem> -<listitem><para>probably there will be support for users to inquire -their "accounts" in advance</para></listitem> +<listitem><para>Probably there will be support for users to inquire +about their accounts in advance.</para></listitem> -<listitem><para>probably there will be support for some other tools -around this topic</para></listitem> +<listitem><para>Probably there will be support for some other tools +around this topic.</para></listitem> </itemizedlist> </sect2> +<!-- FIXME <sect2> <title>Other Accounting Tools</title> @@ -4787,6 +4744,7 @@ around this topic</para></listitem> PrintAnalyzer, pyKota, printbill, LogReport. </para> </sect2> +--> </sect1> <sect1> @@ -4794,39 +4752,37 @@ PrintAnalyzer, pyKota, printbill, LogReport. <para> A printer queue with <emphasis>no</emphasis> PPD associated to it is a -"raw" printer and all files will go directly there as received by the -spooler. The exceptions are file types "application/octet-stream" -which need "passthrough feature" enabled. "Raw" queues don't do any +<quote>raw</quote> printer and all files will go directly there as received by the +spooler. The exceptions are file types <parameter>application/octet-stream</parameter> +that need passthrough feature enabled. <quote>Raw</quote> queues do not do any filtering at all, they hand the file directly to the CUPS backend. -This backend is responsible for the sending of the data to the device -(as in the "device URI" notation: <filename>lpd://, socket://, -smb://, ipp://, http://, parallel:/, serial:/, usb:/</filename> etc.) +This backend is responsible for sending the data to the device +(as in the <quote>device URI</quote> notation: <filename>lpd://, socket://, +smb://, ipp://, http://, parallel:/, serial:/, usb:/</filename>, and so on). </para> <para> -"cupsomatic"/Foomatic are <emphasis>not</emphasis> native CUPS drivers -and they don't ship with CUPS. They are a Third Party add-on, +cupsomatic/Foomatic are <emphasis>not</emphasis> native CUPS drivers +and they do not ship with CUPS. They are a third party add-on developed at Linuxprinting.org. As such, they are a brilliant hack to make all models (driven by Ghostscript drivers/filters in traditional spoolers) also work via CUPS, with the same (good or bad!) quality as -in these other spoolers. "cupsomatic" is only a vehicle to execute a -ghostscript commandline at that stage in the CUPS filtering chain, -where "normally" the native CUPS "pstoraster" filter would kick -in. cupsomatic by-passes pstoraster, "kidnaps" the printfile from CUPS -away and re-directs it to go through Ghostscript. CUPS accepts this, -because the associated CUPS-O-Matic-/Foomatic-PPD specifies: -</para> - -<para><programlisting> +in these other spoolers. <parameter>cupsomatic</parameter> is only a vehicle to execute a +Ghostscript commandline at that stage in the CUPS filtering chain, +where normally the native CUPS <parameter>pstoraster</parameter> filter would kick +in. cupsomatic bypasses pstoraster, kidnaps the printfile from CUPS +away and redirects it to go through Ghostscript. CUPS accepts this, +because the associated cupsomatic/foomatic-PPD specifies: + +<filterline> *cupsFilter: "application/vnd.cups-postscript 0 cupsomatic" -</programlisting></para> +</filterline> -<para> This line persuades CUPS to hand the file to cupsomatic, once it has successfully converted it to the MIME type -"application/vnd.cups-postscript". This conversion will not happen for -Jobs arriving from Windows which are auto-typed -"application/octet-stream", with the according changes in +<parameter>application/vnd.cups-postscript</parameter>. This conversion will not happen for +Jobs arriving from Windows that are auto-typed +<parameter>application/octet-stream</parameter>, with the according changes in <filename>/etc/cups/mime.types</filename> in place. </para> @@ -4834,58 +4790,53 @@ Jobs arriving from Windows which are auto-typed CUPS is widely configurable and flexible, even regarding its filtering mechanism. Another workaround in some situations would be to have in <filename>/etc/cups/mime.types</filename> entries as follows: -</para> -<para><programlisting> +<filterline> application/postscript application/vnd.cups-raw 0 - application/vnd.cups-postscript application/vnd.cups-raw 0 - -</programlisting></para> +</filterline> -<para> -This would prevent all Postscript files from being filtered (rather, +This would prevent all PostScript files from being filtered (rather, they will through the virtual <emphasis>nullfilter</emphasis> -denoted with "-"). This could only be useful for PS printers. If you +denoted with <quote>-</quote>). This could only be useful for PS printers. If you want to print PS code on non-PS printers (provided they support ASCII -text printing) an entry as follows could be useful: -</para> +text printing), an entry as follows could be useful: -<para><programlisting> +<filterline> */* application/vnd.cups-raw 0 - -</programlisting></para> +</filterline> -<para> and would effectively send <emphasis>all</emphasis> files to the backend without further processing. </para> <para> -Lastly, you could have the following entry: -</para> +You could have the following entry: -<para><programlisting> -application/vnd.cups-postscript application/vnd.cups-raw 0 my_PJL_stripping_filter -</programlisting></para> +<filterline> +application/vnd.cups-postscript application/vnd.cups-raw 0 \ + my_PJL_stripping_filter +</filterline> -<para> -You will need to write a <emphasis>my_PJL_stripping_filter</emphasis> -(could be a shellscript) that parses the PostScript and removes the -unwanted PJL. This would need to conform to CUPS filter design +You will need to write a <parameter>my_PJL_stripping_filter</parameter> +(which could be a shell script) that parses the PostScript and removes the +unwanted PJL. This needs to conform to CUPS filter design (mainly, receive and pass the parameters printername, job-id, username, jobtitle, copies, print options and possibly the -filename). It would be installed as world executable into -<filename>/usr/lib/cups/filters/</filename> and will be called by CUPS -if it encounters a MIME type "application/vnd.cups-postscript". +filename). It is installed as world executable into +<filename>/usr/lib/cups/filters/</filename> and is called by CUPS +if it encounters a MIME type <parameter>application/vnd.cups-postscript</parameter>. </para> <para> -CUPS can handle <emphasis>-o job-hold-until=indefinite</emphasis>. -This keeps the job in the queue "on hold". It will only be printed +CUPS can handle <parameter>-o job-hold-until=indefinite</parameter>. +This keeps the job in the queue on hold. It will only be printed upon manual release by the printer operator. This is a requirement in -many "central reproduction departments", where a few operators manage +many central reproduction departments, where a few operators manage the jobs of hundreds of users on some big machine, where no user is allowed to have direct access (such as when the operators often need to load the proper paper type before running the 10,000 page job -requested by marketing for the mailing, etc.). +requested by marketing for the mailing, and so on). </para> </sect1> @@ -4893,17 +4844,18 @@ requested by marketing for the mailing, etc.). <title>Auto-Deletion or Preservation of CUPS Spool Files</title> <para> -Samba print files pass through two "spool" directories. One is the -incoming directory managed by Samba, (set in the <smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> directive in the -<smbconfsection>[printers]</smbconfsection> section of +Samba print files pass through two spool directories. One is the +incoming directory managed by Samba, (set in the +<smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption> +directive in the <smbconfsection>[printers]</smbconfsection> section of &smb.conf;). The other is the spool directory of your UNIX print subsystem. For CUPS it is normally -<filename>/var/spool/cups/</filename>, as set by the cupsd.conf +<filename>/var/spool/cups/</filename>, as set by the <filename>cupsd.conf</filename> directive <filename>RequestRoot /var/spool/cups</filename>. </para> <sect2> -<title>CUPS Configuration Settings explained</title> +<title>CUPS Configuration Settings Explained</title> <para> Some important parameter settings in the CUPS configuration file @@ -4915,39 +4867,39 @@ Some important parameter settings in the CUPS configuration file <varlistentry><term>PreserveJobHistory Yes</term> <listitem><para> This keeps some details of jobs in cupsd's mind (well it keeps the -"c12345", "c12346" etc. files in the CUPS spool directory, which do a +c12345, c12346, and so on, files in the CUPS spool directory, which do a similar job as the old-fashioned BSD-LPD control files). This is set -to "Yes" as a default. +to <quote>Yes</quote> as a default. </para></listitem></varlistentry> <varlistentry><term>PreserveJobFiles Yes</term> <listitem><para> This keeps the job files themselves in cupsd's mind -(well it keeps the "d12345", "d12346" etc. files in the CUPS spool -directory...). This is set to "No" as the CUPS +(it keeps the d12345, d12346 etc. files in the CUPS spool +directory). This is set to <quote>No</quote> as the CUPS default. </para></listitem></varlistentry> -<varlistentry><term><emphasis>"MaxJobs 500"</emphasis></term> +<varlistentry><term><emphasis><quote>MaxJobs 500</quote></emphasis></term> <listitem><para> This directive controls the maximum number of jobs that are kept in memory. Once the number of jobs reaches the limit, the oldest completed job is automatically purged from the system to make room for the new one. If all of the known jobs are still -pending or active then the new job will be rejected. Setting the +pending or active, then the new job will be rejected. Setting the maximum to 0 disables this functionality. The default setting is 0. </para></listitem></varlistentry> </variablelist> <para> -(There are also additional settings for "MaxJobsPerUser" and -"MaxJobsPerPrinter"...) +(There are also additional settings for <parameter>MaxJobsPerUser</parameter> and +<parameter>MaxJobsPerPrinter</parameter>...) </para> </sect2> <sect2> -<title>Pre-conditions</title> +<title>Pre-Conditions</title> <para> For everything to work as announced, you need to have three @@ -4955,24 +4907,24 @@ things: </para> <itemizedlist> -<listitem><para>a Samba-smbd which is compiled against "libcups" (Check -on Linux by running "ldd `which smbd`")</para></listitem> +<listitem><para>A Samba-smbd that is compiled against <filename>libcups</filename> (check +on Linux by running <userinput>ldd `which smbd'</userinput>).</para></listitem> -<listitem><para>a Samba-&smb.conf; setting of - <smbconfoption><name>printing</name><value>cups</value></smbconfoption></para></listitem> +<listitem><para>A Samba-&smb.conf; setting of + <smbconfoption><name>printing</name><value>cups</value></smbconfoption>.</para></listitem> -<listitem><para>another Samba-&smb.conf; setting of - <smbconfoption><name>printcap</name><value>cups</value></smbconfoption></para></listitem> +<listitem><para>Another Samba-&smb.conf; setting of + <smbconfoption><name>printcap</name><value>cups</value></smbconfoption>.</para></listitem> </itemizedlist> <note><para> -In this case all other manually set printing-related commands (like +In this case, all other manually set printing-related commands (like <smbconfoption><name>print command</name></smbconfoption>, <smbconfoption><name>lpq command</name></smbconfoption>, <smbconfoption><name>lprm command</name></smbconfoption>, <smbconfoption><name>lppause command</name></smbconfoption> or <smbconfoption><name>lpresume command</name></smbconfoption>) are ignored and they should normally have no -influence what-so-ever on your printing. +influence whatsoever on your printing. </para></note> </sect2> @@ -4982,82 +4934,56 @@ influence what-so-ever on your printing. <para> If you want to do things manually, replace the <smbconfoption><name>printing</name><value>cups</value></smbconfoption> by <smbconfoption><name>printing</name><value>bsd</value></smbconfoption>. Then your manually set commands may work -(haven't tested this), and a <smbconfoption><name>print command</name><value>lp -d %P %s; rm %s"</value></smbconfoption> +(I haven't tested this), and a <smbconfoption><name>print command</name><value>lp -d %P %s; rm %s"</value></smbconfoption> may do what you need. </para> </sect2> </sect1> <sect1> -<title>In Case of Trouble.....</title> - -<para> -If you have more problems, post the output of these commands -to the CUPS or Samba mailing lists (choose the one which seems more -relevant to your problem): -</para> - -<para><screen> -&prompt;<userinput>grep -v ^# /etc/cups/cupsd.conf | grep -v ^$</userinput> -&prompt;<userinput>grep -v ^# /etc/samba/smb.conf | grep -v ^$ | grep -v "^;"</userinput> -</screen></para> - -<para> -(adapt paths as needed). These commands leave out the empty -lines and lines with comments, providing the "naked settings" in a -compact way. Don't forget to name the CUPS and Samba versions you -are using! This saves bandwidth and makes for easier readability -for experts (and you are expecting experts to read them, right? -;-) -</para> - -</sect1> - -<sect1> -<title>Printing <emphasis>from</emphasis> CUPS to Windows attached -Printers</title> +<title>Printing from CUPS to Windows Attached Printers</title> <para> -From time to time the question arises, how you can print +>From time to time the question arises, how can you print <emphasis>to</emphasis> a Windows attached printer -<emphasis>from</emphasis> Samba. Normally the local connection +<emphasis>from</emphasis> Samba? Normally the local connection from Windows host to printer would be done by USB or parallel -cable, but this doesn't matter to Samba. From here only an SMB +cable, but this does not matter to Samba. From here only an SMB connection needs to be opened to the Windows host. Of course, this -printer must be "shared" first. As you have learned by now, CUPS uses +printer must be shared first. As you have learned by now, CUPS uses <emphasis>backends</emphasis> to talk to printers and other -servers. To talk to Windows shared printers you need to use the -<emphasis>smb</emphasis> (surprise, surprise!) backend. Check if this -is in the CUPS backend directory. This resides usually in -<filename>/usr/lib/cups/backend/</filename>. You need to find a "smb" +servers. To talk to Windows shared printers, you need to use the +<filename>smb</filename> (surprise, surprise!) backend. Check if this +is in the CUPS backend directory. This usually resides in +<filename>/usr/lib/cups/backend/</filename>. You need to find an <filename>smb</filename> file there. It should be a symlink to <filename>smbspool</filename> -which file must exist and be executable: +and the file must exist and be executable: </para> <para><screen> &rootprompt;<userinput>ls -l /usr/lib/cups/backend/</userinput> total 253 -drwxr-xr-x 3 root root 720 Apr 30 19:04 . -drwxr-xr-x 6 root root 125 Dec 19 17:13 .. --rwxr-xr-x 1 root root 10692 Feb 16 21:29 canon --rwxr-xr-x 1 root root 10692 Feb 16 21:29 epson -lrwxrwxrwx 1 root root 3 Apr 17 22:50 http -> ipp --rwxr-xr-x 1 root root 17316 Apr 17 22:50 ipp --rwxr-xr-x 1 root root 15420 Apr 20 17:01 lpd --rwxr-xr-x 1 root root 8656 Apr 20 17:01 parallel --rwxr-xr-x 1 root root 2162 Mar 31 23:15 pdfdistiller -lrwxrwxrwx 1 root root 25 Apr 30 19:04 ptal -> /usr/sbin/ptal-cups --rwxr-xr-x 1 root root 6284 Apr 20 17:01 scsi -lrwxrwxrwx 1 root root 17 Apr 2 03:11 smb -> /usr/bin/smbspool --rwxr-xr-x 1 root root 7912 Apr 20 17:01 socket --rwxr-xr-x 1 root root 9012 Apr 20 17:01 usb +drwxr-xr-x 3 root root 720 Apr 30 19:04 . +drwxr-xr-x 6 root root 125 Dec 19 17:13 .. +-rwxr-xr-x 1 root root 10692 Feb 16 21:29 canon +-rwxr-xr-x 1 root root 10692 Feb 16 21:29 epson +lrwxrwxrwx 1 root root 3 Apr 17 22:50 http -> ipp +-rwxr-xr-x 1 root root 17316 Apr 17 22:50 ipp +-rwxr-xr-x 1 root root 15420 Apr 20 17:01 lpd +-rwxr-xr-x 1 root root 8656 Apr 20 17:01 parallel +-rwxr-xr-x 1 root root 2162 Mar 31 23:15 pdfdistiller +lrwxrwxrwx 1 root root 25 Apr 30 19:04 ptal -> /usr/sbin/ptal-cups +-rwxr-xr-x 1 root root 6284 Apr 20 17:01 scsi +lrwxrwxrwx 1 root root 17 Apr 2 03:11 smb -> /usr/bin/smbspool +-rwxr-xr-x 1 root root 7912 Apr 20 17:01 socket +-rwxr-xr-x 1 root root 9012 Apr 20 17:01 usb &rootprompt;<userinput>ls -l `which smbspool`</userinput> --rwxr-xr-x 1 root root 563245 Dec 28 14:49 /usr/bin/smbspool +-rwxr-xr-x 1 root root 563245 Dec 28 14:49 /usr/bin/smbspool </screen></para> <para> -If this symlink doesn't exist, create it: +If this symlink does not exist, create it: </para> <para><screen> @@ -5065,22 +4991,22 @@ If this symlink doesn't exist, create it: </screen></para> <para> -smbspool has been written by Mike Sweet from the CUPS folks. It is +<command>smbspool</command> has been written by Mike Sweet from the CUPS folks. It is included and ships with Samba. It may also be used with print subsystems other than CUPS, to spool jobs to Windows printer shares. To -set up printer "winprinter" on CUPS, you need to have a "driver" for +set up printer <replaceable>winprinter</replaceable> on CUPS, you need to have a driver for it. Essentially this means to convert the print data on the CUPS/Samba host to a format that the printer can digest (the Windows host is -unable to convert any files you may send). This also means you should +unable to convert any files you may send). This also means you should be able to print to the printer if it were hooked directly at your Samba/CUPS host. For troubleshooting purposes, this is what you -should do, to determine if that part of the process chain is in +should do to determine if that part of the process chain is in order. Then proceed to fix the network connection/authentication to -the Windows host, etc. +the Windows host, and so on. </para> <para> -To install a printer with the smb backend on CUPS, use this command: +To install a printer with the <parameter>smb</parameter> backend on CUPS, use this command: </para> <para><screen> @@ -5089,299 +5015,101 @@ To install a printer with the smb backend on CUPS, use this command: </screen></para> <para> -The <emphasis>PPD</emphasis> must be able to direct CUPS to generate -the print data for the target model. For PostScript printers just use +The PPD must be able to direct CUPS to generate +the print data for the target model. For PostScript printers, just use the PPD that would be used with the Windows NT PostScript driver. But what can you do if the printer is only accessible with a password? Or if the printer's host is part of another workgroup? This is provided -for: you can include the required parameters as part of the -<filename>smb://</filename> device-URI. Like this: +for: You can include the required parameters as part of the +<filename>smb://</filename> device-URI like this: </para> <itemizedlist> - <listitem><para>smb://WORKGROUP/WINDOWSNETBIOSNAME/printersharename </para></listitem> - <listitem><para>smb://username:password@WORKGROUP/WINDOWSNETBIOSNAME/printersharename</para></listitem> - <listitem><para>smb://username:password@WINDOWSNETBIOSNAME/printersharename</para></listitem> + <listitem><filename>smb://WORKGROUP/WINDOWSNETBIOSNAME/printersharename</filename></listitem> + <listitem><filename>smb://username:password@WORKGROUP/WINDOWSNETBIOSNAME/printersharename</filename></listitem> + <listitem><filename>smb://username:password@WINDOWSNETBIOSNAME/printersharename</filename></listitem> </itemizedlist> <para> Note that the device-URI will be visible in the process list of the -Samba server (e.g. when someone uses the <command>ps -aux</command> +Samba server (e.g., when someone uses the <command>ps -aux</command> command on Linux), even if the username and passwords are sanitized -before they get written into the log files. So this is an inherently -insecure option. However it is the only one. Don't use it if you want +before they get written into the log files. So this is an inherently +insecure option, however, it is the only one. Don't use it if you want to protect your passwords. Better share the printer in a way that -doesn't require a password! Printing will only work if you have a +does not require a password! Printing will only work if you have a working netbios name resolution up and running. Note that this is a -feature of CUPS and you don't necessarily need to have smbd running -(but who wants that? :-). +feature of CUPS and you do not necessarily need to have smbd running. + </para> </sect1> <sect1> -<title>More CUPS filtering Chains</title> +<title>More CUPS-Filtering Chains</title> <para> The following diagrams reveal how CUPS handles print jobs. </para> -<image><imagefile>cups1</imagefile><imagedescription>Filtering chain 1</imagedescription></image> +<image id="cups1"><imagefile>cups1</imagefile><imagedescription>Filtering chain 1.</imagedescription></image> -<image><imagefile>cups2</imagefile><imagedescription>Filtering chain with cupsomatic</imagedescription></image> - -<note><para> -Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to -CUPS and ESP PrintPro plug-in where rastertosomething is noted. -</para></note> - -<!--FIXME: Put this into diagrams... ? - -######################################################################### -# -# And this is how it works for ESP PrintPro from 4.3: -# =================================================== -# -# SOMETHNG-FILEFORMAT -# | -# V -# somethingtops -# | -# V -# APPLICATION/POSTSCRIPT -# | -# V -# pstops -# | -# V -# APPLICATION/VND.CUPS-POSTSCRIPT -# | -# V -# gsrip -# | (= "postscipt interpreter") -# V -# APPLICATION/VND.CUPS-RASTER -# | -# V -# rastertosomething (e.g. Gimp-Print filters may be plugged in here) -# | (= "raster driver") -# V -# SOMETHING-DEVICE-SPECIFIC -# | -# V -# backend -# -# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to -# CUPS and ESP PrintPro plug-in where rastertosomething is noted. -# -######################################################################### -</screen> - -<screen> -######################################################################### -# -# This is how "cupsomatic" would come into play with ESP PrintPro: -# ================================================================ -# -# -# SOMETHNG-FILEFORMAT -# | -# V -# somethingtops -# | -# V -# APPLICATION/POSTSCRIPT -# | -# V -# pstops -# | -# V -# APPLICATION/VND.CUPS-POSTSCRIPT ================+ -# | V -# V cupsomatic -# gsrip (constructs complicated -# | (= "postscipt interpreter") Ghostscript commandline -# | to let the file be -# V processed by a -# APPLICATION/VND.CUPS-RASTER "-sDEVICE=s.th." -# | call...) -# V | -# rastertosomething V -# | (= "raster driver") +=========================+ -# | | Ghostscript at work.... | -# V | | -# SOMETHING-DEVICE-SPECIFIC *=========================+ -# | | -# V | -# backend <=================================+ -# | -# V -# THE PRINTER -# -# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to -# CUPS and ESP PrintPro plug-in where rastertosomething is noted. -# -######################################################################### -</screen> - -<screen> -######################################################################### -# -# And this is how it works for CUPS from 1.1.15: -# ============================================== -# -# SOMETHNG-FILEFORMAT -# | -# V -# somethingtops -# | -# V -# APPLICATION/POSTSCRIPT -# | -# V -# pstops -# | -# V -# APPLICATION/VND.CUPS-POSTSCRIPT=====+ -# +==================v==============================+ -# | Ghostscript | -# | at work... | -# | (with | -# | "-sDEVICE=cups") | -# | | -# | (= "postscipt interpreter") | -# | | -# +==================v==============================+ -# | -# APPLICATION/VND.CUPS-RASTER >====+ -# | -# V -# rastertosomething -# | (= "raster driver") -# V -# SOMETHING-DEVICE-SPECIFIC -# | -# V -# backend -# -# -# NOTE: since version 1.1.15 CUPS "outsourced" the pstoraster process to -# Ghostscript. GNU Ghostscript needs to be patched to handle the -# CUPS requirement; ESP Ghostscript has this builtin. In any case, -# "gs -h" needs to show up a "cups" device. pstoraster is now a -# calling an appropriate "gs -sDEVICE=cups..." commandline to do -# the job. It will output "application/vnd.cup-raster", which will -# be finally processed by a CUPS raster driver "rastertosomething" -# Note the difference to "cupsomatic", which will <emphasis>not</emphasis> output -# CUPS-raster, but a final version of the printfile, ready to be -# sent to the printer. cupsomatic also doesn't use the "cups" -# devicemode in Ghostscript, but one of the classical devicemodes.... -# -# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to -# CUPS and ESP PrintPro plug-in where rastertosomething is noted. -# -######################################################################### -</screen> +<image id="cups2"><imagefile>cups2</imagefile><imagedescription>Filtering chain with cupsomatic</imagedescription></image> -<screen> -######################################################################### -# -# And this is how it works for CUPS from 1.1.15, with cupsomatic included: -# ======================================================================== -# -# SOMETHNG-FILEFORMAT -# | -# V -# somethingtops -# | -# V -# APPLICATION/POSTSCRIPT -# | -# V -# pstops -# | -# V -# APPLICATION/VND.CUPS-POSTSCRIPT=====+ -# +==================v==============================+ -# | Ghostscript . Ghostscript at work.... | -# | at work... . (with "-sDEVICE= | -# | (with . s.th." | -# | "-sDEVICE=cups") . | -# | . | -# | (CUPS standard) . (cupsomatic) | -# | . | -# | (= "postscript interpreter") | -# | . | -# +==================v==============v===============+ -# | | -# APPLICATION/VND.CUPS-RASTER >=======+ | -# | | -# V | -# rastertosomething | -# | (= "raster driver") | -# V | -# SOMETHING-DEVICE-SPECIFIC >========================+ -# | -# V -# backend -# -# -# NOTE: Gimp-Print and some other 3rd-Party-Filters (like TurboPrint) to -# CUPS and ESP PrintPro plug-in where rastertosomething is noted. -# -########################################################################## -</screen>--> </sect1> <sect1> <title>Common Errors</title> <sect2> - <title>Win9x client can't install driver</title> + <title>Windows 9x/ME Client Can't Install Driver</title> - <para>For Win9x clients require the printer names to be 8 -chars (or "8 plus 3 chars suffix") max; otherwise the driver files -won't get transferred when you want to download them from + <para>For Windows 9x/ME, clients require the printer names to be eight +characters (or <quote>8 plus 3 chars suffix</quote>) max; otherwise, the driver files +will not get transferred when you want to download them from Samba.</para> </sect2> <sect2> - <title>"cupsaddsmb" keeps asking for root password in - neverending loop</title> + <title><quote>cupsaddsmb</quote> Keeps Asking for Root Password in Never-ending Loop</title> <para>Have you <smbconfoption><name>security</name><value>user</value></smbconfoption>? Have you used <command>smbpasswd</command> to give root a Samba account? -You can do 2 things: open another terminal and execute -<command>smbpasswd -a root</command> to create the account, and -continue with entering the password into the first terminal. Or break -out of the loop by hitting ENTER twice (without trying to type a +You can do two things: open another terminal and execute +<command>smbpasswd -a root</command> to create the account and +continue entering the password into the first terminal. Or break +out of the loop by pressing ENTER twice (without trying to type a password).</para> </sect2> <sect2> - <title>"cupsaddsmb" gives "No PPD file for printer..." - message while PPD file is present</title> + <title><quote>cupsaddsmb</quote> Errors</title> + + <para> + The use of <quote>cupsaddsmb</quote> gives <quote>No PPD file for printer...</quote> Message While PPD File Is Present. + What might the problem be? + </para> <para>Have you enabled printer sharing on CUPS? This means: -do you have a <parameter><Location +Do you have a <parameter><Location /printers>....</Location></parameter> section in CUPS -server's <filename>cupsd.conf</filename> which doesn't deny access to -the host you run "cupsaddsmb" from? It <emphasis>could</emphasis> be +server's <filename>cupsd.conf</filename> that does not deny access to +the host you run <quote>cupsaddsmb</quote> from? It <emphasis>could</emphasis> be an issue if you use cupsaddsmb remotely, or if you use it with a <option>-h</option> parameter: <userinput>cupsaddsmb -H sambaserver -h cupsserver -v printername</userinput>. </para> <para>Is your -"TempDir" directive in -<emphasis>cupsd.conf</emphasis> +<parameter>TempDir</parameter> directive in +<filename>cupsd.conf</filename> set to a valid value and is it writeable? </para> </sect2> <sect2> - <title>Client can't connect to Samba printer</title> + <title>Client Can't Connect to Samba Printer</title> <para>Use <command>smbstatus</command> to check which user you are from Samba's point of view. Do you have the privileges to write into the <smbconfsection>[print$]</smbconfsection> @@ -5390,127 +5118,130 @@ share?</para> </sect2> <sect2> - <title>Can't reconnect to Samba under new account - from Win2K/XP</title> - <para>Once you are connected as the "wrong" user (for -example as "nobody", which often occurs if you have + <title>New Account Reconnection from Windows 200x/XP Troubles</title> + +<para>Once you are connected as the wrong user (for +example, as <constant>nobody</constant>, which often occurs if you have <smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption>), Windows Explorer will not accept an -attempt to connect again as a different user. There won't be any byte +attempt to connect again as a different user. There will not be any byte transfered on the wire to Samba, but still you'll see a stupid error -message which makes you think that Samba has denied access. Use +message that makes you think Samba has denied access. Use <command>smbstatus</command> to check for active connections. Kill the -PIDs. You still can't re-connect and get the dreaded +PIDs. You still can't re-connect and you get the dreaded <computeroutput>You can't connect with a second account from the same -machine</computeroutput> message, as soon as you are trying? And you -don't see any single byte arriving at Samba (see logs; use "ethereal") -indicating a renewed connection attempt? Shut all Explorer Windows. +machine</computeroutput> message, as soon as you are trying. And you +do not see any single byte arriving at Samba (see logs; use <quote>ethereal</quote>) +indicating a renewed connection attempt. Shut all Explorer Windows. This makes Windows forget what it has cached in its memory as -established connections. Then re-connect as the right user. Best +established connections. Then reconnect as the right user. The best method is to use a DOS terminal window and <emphasis>first</emphasis> do <userinput>net use z: \\&example.server.samba;\print$ /user:root</userinput>. Check with <command>smbstatus</command> that you are connected under a -different account. Now open the "Printers" folder (on the Samba server -in the <emphasis>Network Neighbourhood</emphasis>), right-click the +different account. Now open the <guilabel>Printers</guilabel> folder (on the Samba server +in the <guilabel>Network Neighborhood</guilabel>), right-click on the printer in question and select -<emphasis>Connect...</emphasis></para></sect2> +<guibutton>Connect...</guibutton></para></sect2> <sect2> - <title>Avoid being connected to the Samba server as the - "wrong" user</title> +<title>Avoid Being Connected to the Samba Server as the Wrong User</title> - <para>You see per <command>smbstatus</command> that you are -connected as user "nobody"; while you wanted to be "root" or -"printeradmin"? This is probably due to -<smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption>, which silently connects you under the guest account, +<para>You see per <command>smbstatus</command> that you are +connected as user nobody; while you want to be root or +printeradmin. This is probably due to +<smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption>, which silently connects you under the guest account when you gave (maybe by accident) an incorrect username. Remove <smbconfoption><name>map to guest</name></smbconfoption>, if you want to prevent this.</para></sect2> -<sect2><title>Upgrading to CUPS drivers from Adobe drivers on - NT/2K/XP clients gives problems</title> +<sect2> +<title>Upgrading to CUPS Drivers from Adobe Drivers</title> + +<para> +This information came from a mailinglist posting regarding problems experienced when +upgrading from Adobe drivers to CUPS drivers on Microsoft Windows NT/200x/XP Clients. +</para> - <para>First delete all "old" Adobe-using printers. Then -delete all "old" Adobe drivers. (On Win2K/XP, right-click in -background of "Printers" folder, select "Server Properties...", select -tab "Drivers" and delete here).</para></sect2> +<para>First delete all old Adobe-using printers. Then +delete all old Adobe drivers. (On Windows 200x/XP, right-click in +the background of <guilabel>Printers</guilabel> folder, select <guimenuitem>Server Properties...</guimenuitem>, select +tab <guilabel>Drivers</guilabel> and delete here).</para></sect2> -<sect2><title>Can't use "cupsaddsmb" on Samba server which is - a PDC</title> -<para>Do you use the "naked" root user name? Try to do it +<sect2><title>Can't Use <quote>cupsaddsmb</quote> on Samba Server Which Is a PDC</title> +<para>Do you use the <quote>naked</quote> root user name? Try to do it this way: <userinput>cupsaddsmb -U <replaceable>DOMAINNAME</replaceable>\\root -v <replaceable>printername</replaceable></userinput>> (note the two backslashes: the first one is -required to "escape" the second one).</para></sect2> +required to <quote>escape</quote> the second one).</para></sect2> -<sect2><title>Deleted Win2K printer driver is still shown</title> -<para>Deleting a printer on the client won't delete the +<sect2><title>Deleted Windows 200x Printer Driver Is Still Shown</title> +<para>Deleting a printer on the client will not delete the driver too (to verify, right-click on the white background of the -"Printers" folder, select "Server Properties" and click on the -"Drivers" tab). These same old drivers will be re-used when you try to +<guilabel>Printers</guilabel> folder, select <guimenuitem>Server Properties</guimenuitem> and click on the +<guilabel>Drivers</guilabel> tab). These same old drivers will be re-used when you try to install a printer with the same name. If you want to update to a new driver, delete the old ones first. Deletion is only possible if no other printer uses the same driver.</para></sect2> -<sect2><title>Win2K/XP "Local Security - Policies"</title> -<para><emphasis>Local Security Policies</emphasis> may not -allow the installation of unsigned drivers. "Local Security Policies" +<sect2><title>Windows 200x/XP "Local Security Policies"</title> +<para>Local Security Policies may not +allow the installation of unsigned drivers. <quote>Local Security Policies</quote> may not allow the installation of printer drivers at all.</para></sect2> -<sect2><title>WinXP clients: "Administrator can not install - printers for all local users"</title> -<para>Windows XP handles SMB printers on a "per-user" basis. +<sect2><title>Administrator Cannot Install Printers for All Local Users</title> +<para>Windows XP handles SMB printers on a <quote>per-user</quote> basis. This means every user needs to install the printer himself. To have a printer available for everybody, you might want to use the built-in IPP client capabilities of WinXP. Add a printer with the print path of -<emphasis>http://cupsserver:631/printers/printername</emphasis>. -Still looking into this one: maybe a "logon script" could +<parameter>http://cupsserver:631/printers/printername</parameter>. +We're still looking into this one. Maybe a logon script could automatically install printers for all users.</para></sect2> -<sect2><title>"Print Change Notify" functions on - NT-clients</title> -<para>For "print change notify" functions on NT++ clients, -these need to run the "Server" service first (re-named to -<emphasis>File & Print Sharing for MS Networks</emphasis> in +<sect2><title>Print Change Notify Functions on NT-clients</title> +<para>For print change, notify functions on NT++ clients. +These need to run the <command>Server</command> service first (renamed to +<command>File & Print Sharing for MS Networks</command> in XP).</para></sect2> -<sect2><title>WinXP-SP1</title> -<para>WinXP-SP1 introduced a <emphasis>Point and Print -Restriction Policy</emphasis> (this restriction doesn't apply to -"Administrator" or "Power User" groups of users). In Group Policy -Object Editor: go to <emphasis>User Configuration, - Administrative Templates, Control Panel, -Printers</emphasis>. The policy is automatically set to -<emphasis>Enabled</emphasis> and the <emphasis>Users can only Point -and Print to machines in their Forest</emphasis> . You probably need -to change it to <emphasis>Disabled</emphasis> or <emphasis>Users can -only Point and Print to these servers</emphasis> in order to make -driver downloads from Samba possible.</para></sect2> - -<sect2><title>Print options for all users can't be set on Win2K/XP</title> +<sect2> +<title>WinXP-SP1</title> + +<para>WinXP-SP1 introduced a Point and Print Restriction Policy (this restriction does not apply to +<quote>Administrator</quote> or <quote>Power User</quote> groups of users). In Group Policy +Object Editor, go to <guimenu>User Configuration -> Administrative Templates -> + Control Panel -> Printers</guimenu>. The policy is automatically set to +<constant>Enabled</constant> and the <constant>Users can only Point +and Print to machines in their Forest</constant> . You probably need +to change it to <constant>Disabled</constant> or <constant>Users can +only Point and Print to these servers</constant> to make +driver downloads from Samba possible. +</para> +</sect2> + +<sect2> +<title>Print Options for All Users Can't Be Set on Windows 200x/XP</title> <para>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 +easy to find out, though). There are three different ways to bring you to a dialog that <emphasis>seems</emphasis> to set everything. All -three dialogs <emphasis>look</emphasis> the same. Only one of them -<emphasis>does</emphasis> what you intend. You need to be -Administrator or Print Administrator to do this for all users. Here +three dialogs <emphasis>look</emphasis> the same, yet only one of them +does what you intend. You need to be +Administrator or Print Administrator to do this for all users. Here is how I do in on XP: </para> <orderedlist numeration="upperalpha"> -<listitem><para>The first "wrong" way: +<listitem><para>The first wrong way: -<orderedlist numeration="arabic"> -<listitem><para>Open the <emphasis>Printers</emphasis> +<orderedlist> +<listitem><para>Open the <guilabel>Printers</guilabel> folder.</para></listitem> <listitem><para>Right-click on the printer -(<emphasis>remoteprinter on cupshost</emphasis>) and -select in context menu <emphasis>Printing -Preferences...</emphasis></para></listitem> +(<guilabel>remoteprinter on cupshost</guilabel>) and +select in context menu <guimenuitem>Printing +Preferences...</guimenuitem></para></listitem> <listitem><para>Look at this dialog closely and remember what it looks like.</para></listitem> @@ -5518,21 +5249,21 @@ like.</para></listitem> </para> </listitem> -<listitem><para>The second "wrong" way: +<listitem><para>The second wrong way: -<orderedlist numeration="arabic"> -<listitem><para>Open the <emphasis>Printers</emphasis> +<orderedlist> +<listitem><para>Open the <guilabel>Printers</guilabel> folder.</para></listitem> -<listitem><para>Right-click on the printer (<emphasis>remoteprinter on -cupshost</emphasis>) and select in the context menu -<emphasis>Properties</emphasis></para></listitem> +<listitem><para>Right-click on the printer (<guilabel>remoteprinter on +cupshost</guilabel>) and select the context menu +<guimenuitem>Properties</guimenuitem>.</para></listitem> -<listitem><para>Click on the <emphasis>General</emphasis> -tab</para></listitem> +<listitem><para>Click on the <guilabel>General</guilabel> +tab.</para></listitem> -<listitem><para>Click on the button <emphasis>Printing -Preferences...</emphasis></para></listitem> +<listitem><para>Click on the button <guibutton>Printing +Preferences...</guibutton></para></listitem> <listitem><para>A new dialog opens. Keep this dialog open and go back to the parent dialog.</para></listitem> @@ -5540,118 +5271,136 @@ to the parent dialog.</para></listitem> </para> </listitem> -<listitem><para>The third, the "correct" way: (should you do -this from the beginning, just carry out steps 1. and 2. from second -"way" above) +<listitem><para>The third, and the correct way: + +<orderedlist> + +<listitem><para>Open the <guilabel>Printers</guilabel> +folder.</para></listitem> -<orderedlist numeration="arabic"> -<listitem><para>Click on the <emphasis>Advanced</emphasis> -tab. (Hmmm... if everything is "Grayed Out", then you are not logged +<listitem><para>Click on the <guilabel>Advanced</guilabel> +tab. (If everything is <quote>grayed out,</quote> then you are not logged in as a user with enough privileges).</para></listitem> -<listitem><para>Click on the <emphasis>Printing -Defaults...</emphasis> button.</para></listitem> +<listitem><para>Click on the <guibutton>Printing +Defaults...</guibutton> button.</para></listitem> <listitem><para>On any of the two new tabs, click on the -<emphasis>Advanced...</emphasis> +<guibutton>Advanced...</guibutton> button.</para></listitem> -<listitem><para>A new dialog opens. Compare this one to the other, -identical looking one from "B.5" or A.3".</para></listitem> +<listitem><para>A new dialog opens. Compare this one to the other +identical looking one from <quote>B.5</quote> or A.3".</para></listitem> </orderedlist> </para> </listitem> </orderedlist> <para> -Do you see any difference? I don't either... However, only the last -one, which you arrived at with steps "C.1.-6." will save any settings +Do you see any difference? I don't either. However, only the last +one, which you arrived at with steps <quote>C.1.-6.</quote>, will save any settings permanently and be the defaults for new users. If you want all clients to get the same defaults, you need to conduct these steps <emphasis>as Administrator</emphasis> (<smbconfoption><name>printer admin</name></smbconfoption> in &smb.conf;) <emphasis>before</emphasis> a client downloads the driver (the clients can later set their own <emphasis>per-user defaults</emphasis> by following the -procedures <emphasis>A.</emphasis> or <emphasis>B.</emphasis> +procedures <emphasis>A</emphasis> or <emphasis>B</emphasis> above).</para></sect2> -<sect2><title>Most common blunders in driver - settings on Windows clients</title> - <para>Don't use <emphasis>Optimize for -Speed</emphasis>: use <emphasis>Optimize for -Portability</emphasis> instead (Adobe PS Driver) Don't use -<emphasis>Page Independence: No</emphasis>: always -settle with <emphasis>Page Independence: -Yes</emphasis> (Microsoft PS Driver and CUPS PS Driver for -WinNT/2K/XP) If there are problems with fonts: use -<emphasis>Download as Softfont into -printer</emphasis> (Adobe PS Driver). For -<emphasis>TrueType Download Options</emphasis> -choose <emphasis>Outline</emphasis>. Use PostScript -Level 2, if you are having trouble with a non-PS printer, and if +<sect2><title>Most Common Blunders in Driver Settings on Windows Clients</title> +<para>Don't use <parameter>Optimize for +Speed</parameter>, but use <parameter>Optimize for +Portability</parameter> instead (Adobe PS Driver). Don't use +<parameter>Page Independence: No</parameter>: always +settle with <parameter>Page Independence: +Yes</parameter> (Microsoft PS Driver and CUPS PS Driver for +Windows NT/200x/XP). If there are problems with fonts, use +<parameter>Download as Softfont into +printer</parameter> (Adobe PS Driver). For +<guilabel>TrueType Download Options</guilabel> +choose <constant>Outline</constant>. Use PostScript +Level 2, if you are having trouble with a non-PS printer and if there is a choice.</para></sect2> -<sect2><title><command>cupsaddsmb</command> does not work - with newly installed printer</title> -<para>Symptom: the last command of -<command>cupsaddsmb</command> doesn't complete successfully: +<sect2><title><command>cupsaddsmb</command> Does Not Work with Newly Installed Printer</title> +<para>Symptom: The last command of +<command>cupsaddsmb</command> does not complete successfully: <command>cmd = setdriver printername printername</command> result was NT_STATUS_UNSUCCESSFUL then possibly the printer was not yet -"recognized" by Samba. Did it show up in <emphasis>Network -Neighbourhood</emphasis>? Did it show up in <command>rpcclient -hostname -c 'enumprinters'</command>? Restart smbd (or send a +recognized by Samba. Did it show up in Network +Neighborhood? Did it show up i n <command>rpcclient +hostname -c `enumprinters'</command>? Restart smbd (or send a <command>kill -HUP</command> to all processes listed by <command>smbstatus</command> and try again.</para></sect2> -<sect2><title>Permissions on -<filename>/var/spool/samba/</filename> get reset after each -reboot</title> -<para>Have you by accident set the CUPS spool directory to -the same location? (<parameter>RequestRoot -/var/spool/samba/</parameter> in <filename>cupsd.conf</filename> or +<sect2> +<title>Permissions on <filename>/var/spool/samba/</filename> Get Reset After Each Reboot</title> +<para>Have you ever by accident set the CUPS spool directory to +the same location? (<parameter>RequestRoot /var/spool/samba/</parameter> in <filename>cupsd.conf</filename> or the other way round: <filename>/var/spool/cups/</filename> is set as <smbconfoption><name>path</name></smbconfoption>> in the <smbconfsection>[printers]</smbconfsection> -section). These <emphasis>must</emphasis> be different. Set +section). These <parameter>must</parameter> be different. Set +<!--FIXME--> <parameter>RequestRoot /var/spool/cups/</parameter> in <filename>cupsd.conf</filename> and <smbconfoption><name>path</name><value> /var/spool/samba</value></smbconfoption> in the <smbconfsection>[printers]</smbconfsection> section of &smb.conf;. Otherwise cupsd will -sanitize permissions to its spool directory with each restart, and +sanitize permissions to its spool directory with each restart and printing will not work reliably.</para></sect2> -<sect2><title>Printer named "lp" -intermittently swallows jobs and spits out completely different -ones</title> -<para>It is a very bad idea to name any printer "lp". This +<sect2> +<title>Print Queue Called <quote>lp</quote> Mis-handles Print Jobs</title> + +<para> +In this case a print queue called <quote>lp</quote> intermittently swallows jobs and +spits out completely different ones from what was sent. +</para> + +<para>It is a bad idea to name any printer <quote>lp</quote>. This is the traditional UNIX name for the default printer. CUPS may be set -up to do an automatic creation of "Implicit Classes". This means, to +up to do an automatic creation of Implicit Classes. This means, to group all printers with the same name to a pool of devices, and -loadbalancing the jobs across them in a round-robin fashion. Chances -are high that someone else has an "lp" named printer too. You may +load-balancing the jobs across them in a round-robin fashion. Chances +are high that someone else has a printer named <quote>lp</quote> too. You may receive his jobs and send your own to his device unwittingly. To have tight control over the printer names, set <parameter>BrowseShortNames -No</parameter>. It will present any printer as "printername@cupshost" -then, giving you a better control over what may happen in a large +No</parameter>. It will present any printer as <replaceable>printername@cupshost</replaceable> +and then gives you better control over what may happen in a large networked environment.</para></sect2> -<sect2><title>Location of Adobe PostScript driver files necessary for "cupsaddsmb"</title> +<sect2><title>Location of Adobe PostScript Driver Files for <quote>cupsaddsmb</quote></title> <para>Use <command>smbclient</command> to connect to any Windows box with a shared PostScript printer: <command>smbclient //windowsbox/print\$ -U guest</command>. You can navigate to the <filename>W32X86/2</filename> subdir to <command>mget ADOBE*</command> -and other files or to <filename>WIN40/0</filename> to do the same. -- +and other files or to <filename>WIN40/0</filename> to do the same. Another option is to download the <filename>*.exe</filename> packaged -files from the Adobe website.</para></sect2> +files from the Adobe Web site.</para></sect2> </sect1> <sect1> -<title>An Overview of the CUPS Printing Processes</title> +<title>Overview of the CUPS Printing Processes</title> + +<para>A complete overview of the CUPS printing processes can be found in <link linkend="a_small"/>.</para> -<image><imagedescription>CUPS Printing Overview</imagedescription> +<image id="a_small"><imagedescription>CUPS printing overview.</imagedescription> <imagefile>a_small</imagefile> </image> </sect1> </chapter> + + + + + + + + + + + + diff --git a/docs/docbook/projdoc/Compiling.xml b/docs/docbook/projdoc/Compiling.xml index ccb2f46f3f..da28e43859 100644 --- a/docs/docbook/projdoc/Compiling.xml +++ b/docs/docbook/projdoc/Compiling.xml @@ -1,32 +1,33 @@ <chapter id="compiling"> <chapterinfo> &author.jelmer; + &author.jht; &author.tridge; <pubdate> 22 May 2001 </pubdate> <pubdate> 18 March 2003 </pubdate> </chapterinfo> -<title>How to compile Samba</title> +<title>How to Compile Samba</title> <para> -You can obtain the samba source from the -<ulink url="http://samba.org/">samba website</ulink>. To obtain a development version, -you can download samba from CVS or using rsync. +You can obtain the Samba source from the +<ulink url="http://samba.org/">Samba Website.</ulink> To obtain a development version, +you can download Samba from CVS or using <command>rsync</command>. </para> <sect1> -<title>Access Samba source code via CVS</title> +<title>Access Samba Source Code via CVS</title> -<indexterm><primary>CVS</primary></indexterm> <sect2> <title>Introduction</title> <para> -Samba is developed in an open environment. Developers use CVS -(Concurrent Versioning System) to "checkin" (also known as -"commit") new source code. Samba's various CVS branches can +<indexterm><primary>CVS</primary></indexterm> +Samba is developed in an open environment. Developers use +Concurrent Versioning System (CVS) to <quote>checkin</quote> (also known as +<quote>commit</quote>) new source code. Samba's various CVS branches can be accessed via anonymous CVS using the instructions detailed in this chapter. </para> @@ -44,71 +45,70 @@ This chapter is a modified version of the instructions found at <para> The machine samba.org runs a publicly accessible CVS repository for access to the source code of several packages, -including samba, rsync, distcc, ccache and jitterbug. There are two main ways -of accessing the CVS server on this host. +including Samba, rsync, distcc, ccache, and jitterbug. There are two main ways +of accessing the CVS server on this host: </para> <sect3> <title>Access via CVSweb</title> -<indexterm><primary>CVS</primary><secondary>web</secondary></indexterm> <para> -You can access the source code via your -favourite WWW browser. This allows you to access the contents of -individual files in the repository and also to look at the revision +<indexterm><primary>CVS</primary><secondary>web</secondary></indexterm> +You can access the source code via your favorite WWW browser. This allows you to access +the contents of individual files in the repository and also to look at the revision history and commit logs of individual files. You can also ask for a diff listing between any two versions on the repository. </para> <para> -Use the URL : <ulink -noescape="1" url="http://samba.org/cgi-bin/cvsweb">http://samba.org/cgi-bin/cvsweb</ulink> +Use the URL: +<ulink noescape="1" url="http://samba.org/cgi-bin/CVSweb">http://samba.org/cgi-bin/CVSweb</ulink> </para> </sect3> <sect3> -<title>Access via cvs</title> +<title>Access via CVS</title> <para> You can also access the source code via a -normal cvs client. This gives you much more control over what you can +normal CVS client. This gives you much more control over what you can do with the repository and allows you to checkout whole source trees -and keep them up to date via normal cvs commands. This is the +and keep them up-to-date via normal CVS commands. This is the preferred method of access if you are a developer and not just a casual browser. </para> <para> -To download the latest cvs source code, point your +To download the latest CVS source code, point your browser at the URL : <ulink noescape="1" url="http://www.cyclic.com/">http://www.cyclic.com/</ulink>. -and click on the 'How to get cvs' link. CVS is free software under -the GNU GPL (as is Samba). Note that there are several graphical CVS clients -which provide a graphical interface to the sometimes mundane CVS commands. -Links to theses clients are also available from the Cyclic website. +and click on the <quote>How to get CVS</quote> link. CVS is free software under +the GNU GPL (as is Samba). Note that there are several graphical CVS clients +that provide a graphical interface to the sometimes mundane CVS commands. +Links to theses clients are also available from the Cyclic Web site. </para> <para> -To gain access via anonymous cvs use the following steps. +To gain access via anonymous CVS, use the following steps. For this example it is assumed that you want a copy of the -samba source code. For the other source code repositories -on this system just substitute the correct package name +Samba source code. For the other source code repositories +on this system just substitute the correct package name. </para> <procedure> - <title>Retrieving samba using CVS</title> + <title>Retrieving Samba using CVS</title> <step> <para> - Install a recent copy of cvs. All you really need is a - copy of the cvs client binary. + Install a recent copy of CVS. All you really need is a + copy of the CVS client binary. </para> </step> <step> <para> - Run the command + Run the command: </para> <para> @@ -119,7 +119,7 @@ on this system just substitute the correct package name <step> <para> - When it asks you for a password type <userinput>cvs</userinput>. + When it asks you for a password, type <userinput>cvs</userinput>. </para> </step> @@ -129,32 +129,32 @@ on this system just substitute the correct package name </para> <para> - <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</userinput> + <userinput>cvs -d :pserver:CVS@samba.org:/cvsroot co samba</userinput>. </para> <para> - This will create a directory called samba containing the - latest samba source code (i.e. the HEAD tagged cvs branch). This + This will create a directory called <filename>samba</filename> containing the + latest Samba source code (i.e., the HEAD tagged CVS branch). This currently corresponds to the 3.0 development tree. </para> <para> CVS branches other then HEAD can be obtained by using the - <option>-r</option> and defining a tag name. A list of branch tag names - can be found on the "Development" page of the samba web site. A common - request is to obtain the latest 3.0 release code. This could be done by + <option>-r</option> and defining a tag name. A list of branch tag names + can be found on the <quote>Development</quote> page of the Samba Web site. A common + request is to obtain the latest 3.0 release code. This could be done by using the following command: </para> <para> - <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_3_0 samba</userinput> + <userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_3_0 samba</userinput>. </para> </step> <step> <para> - Whenever you want to merge in the latest code changes use - the following command from within the samba directory: + Whenever you want to merge in the latest code changes, use + the following command from within the Samba directory: </para> <para> @@ -169,33 +169,34 @@ on this system just substitute the correct package name </sect1> <sect1> - <title>Accessing the samba sources via rsync and ftp</title> + <title>Accessing the Samba Sources via rsync and ftp</title> - <indexterm><primary>rsync</primary></indexterm> - <indexterm><primary>ftp</primary></indexterm> <para> - pserver.samba.org also exports unpacked copies of most parts of the CVS + <indexterm><primary>rsync</primary></indexterm> + <indexterm><primary>ftp</primary></indexterm> + <parameter>pserver.samba.org</parameter> also exports unpacked copies of most parts of the CVS tree at <ulink noescape="1" url="ftp://pserver.samba.org/pub/unpacked">ftp://pserver.samba.org/pub/unpacked</ulink> and also via anonymous rsync at <ulink noescape="1" url="rsync://pserver.samba.org/ftp/unpacked/">rsync://pserver.samba.org/ftp/unpacked/</ulink>. I recommend using rsync rather than ftp. - See <ulink noescape="1" url="http://rsync.samba.org/">the rsync homepage</ulink> for more info on rsync. + See <ulink noescape="1" url="http://rsync.samba.org/">the rsync homepage</ulink> for more info on rsync. </para> <para> The disadvantage of the unpacked trees is that they do not support automatic - merging of local changes like CVS does. rsync access is most convenient - for an initial install. + merging of local changes like CVS does. <command>rsync</command> access is most convenient + for an initial install. </para> </sect1> <sect1> -<title>Verifying Samba's PGP signature</title> +<title>Verifying Samba's PGP Signature</title> <para> -In these days of insecurity, it's strongly recommended that you verify the PGP -signature for any source file before installing it. Even if you're not -downloading from a mirror site, verifying PGP signatures should be a -standard reflex. +<indexterm><primary>GPG</primary></indexterm> +It is strongly recommended that you verify the PGP signature for any source file before +installing it. Even if you're not downloading from a mirror site, verifying PGP signatures +should be a standard reflex. Many people today use the GNU GPG toolset in place of PGP. +GPG can substitute for PGP. </para> @@ -210,7 +211,7 @@ With that said, go ahead and download the following files: <para> -<indexterm><primary>GPG</primary></indexterm> +<indexterm><primary>PGP</primary></indexterm> The first file is the PGP signature for the Samba source file; the other is the Samba public PGP key itself. Import the public PGP key with: </para> @@ -220,7 +221,7 @@ PGP key itself. Import the public PGP key with: </screen> <para> -And verify the Samba source code integrity with: +and verify the Samba source code integrity with: </para> <screen> @@ -229,43 +230,44 @@ And verify the Samba source code integrity with: </screen> <para> -If you receive a message like, "Good signature from Samba Distribution -Verification Key..." +If you receive a message like, <quote>Good signature from Samba Distribution Verification Key...</quote> then all is well. The warnings about trust relationships can be ignored. An example of what you would not want to see would be: </para> -<para> -<computeroutput> - gpg: BAD signature from "Samba Distribution Verification Key" - </computeroutput> - </para> +<para><screen> + gpg: BAD signature from <quote>Samba Distribution Verification Key</quote> +</screen></para> </sect1> <sect1> <title>Building the Binaries</title> -<indexterm><primary>configure</primary></indexterm> <para> - To do this, first run the program <userinput>./configure +<indexterm><primary>configure</primary></indexterm> + To build the binaries, first run the program <userinput>./configure </userinput> in the source directory. This should automatically configure Samba for your operating system. If you have unusual - needs then you may wish to run</para> + needs, then you may wish to run</para> <para><screen>&rootprompt;<userinput>./configure --help </userinput></screen></para> - <para>first to see what special options you can enable. - Then executing</para> +<para>first to see what special options you can enable. Now execute <userinput>./configure</userinput> with any arguments it might need:</para> -<indexterm><primary>make</primary></indexterm> +<para><screen>&rootprompt;<userinput>./configure <replaceable>[... arguments ...]</replaceable></userinput></screen></para> -<para><screen>&rootprompt;<userinput>make</userinput></screen></para> + <para>Executing</para> + - <para>will create the binaries. Once it's successfully - compiled you can use </para> + <para> +<indexterm><primary>make</primary></indexterm> + <screen>&rootprompt;<userinput>make</userinput></screen></para> + + <para>will create the binaries. Once it is successfully + compiled you can use</para> <para><screen>&rootprompt;<userinput>make install</userinput></screen></para> @@ -280,9 +282,9 @@ example of what you would not want to see would be: <para><screen>&rootprompt;<userinput>make installman </userinput></screen></para> - <para>Note that if you are upgrading for a previous version + <para>Note that if you are upgrading from 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 + the binaries will be renamed with an <quote>.old</quote> extension. You can go back to the previous version with</para> <para><screen>&rootprompt;<userinput>make revert @@ -291,26 +293,25 @@ example of what you would not want to see would be: <para>if you find this version a disaster!</para> <sect2> - <title>Compiling samba with Active Directory support</title> + <title>Compiling Samba with Active Directory Support</title> - <para>In order to compile samba with ADS support, you need to have installed + <para>In order to compile Samba with ADS support, you need to have installed on your system:</para> <itemizedlist> - <listitem><para>the MIT kerberos development libraries - (either install from the sources or use a package). The - Heimdal libraries will not work.</para></listitem> + <listitem><para>The MIT or Heimdal kerberos development libraries + (either install from the sources or use a package).</para></listitem> - <listitem><para>the OpenLDAP development libraries.</para></listitem> + <listitem><para>The OpenLDAP development libraries.</para></listitem> </itemizedlist> - <para>If your kerberos libraries are in a non-standard location then + <para>If your kerberos libraries are in a non-standard location, then remember to add the configure option <option>--with-krb5=<replaceable>DIR</replaceable></option>.</para> - <para>After you run configure make sure that - <filename>include/config.h</filename> it generates contains lines like + <para>After you run configure, make sure that + <filename>include/config.h</filename> it generates contain lines like this:</para> <para><programlisting> @@ -318,38 +319,56 @@ example of what you would not want to see would be: #define HAVE_LDAP 1 </programlisting></para> - <para>If it doesn't then configure did not find your krb5 libraries or - your ldap libraries. Look in <filename>config.log</filename> to figure + <para>If it does not, configure did not find your KRB5 libraries or + your LDAP libraries. Look in <filename>config.log</filename> to figure out why and fix it.</para> <sect3> - <title>Installing the required packages for Debian</title> + <title>Installing the Required Packages for Debian</title> - <para>On Debian you need to install the following packages:</para> + <para>On Debian, you need to install the following packages:</para> <para> <itemizedlist> - <listitem><para>libkrb5-dev</para></listitem> - <listitem><para>krb5-user</para></listitem> + <listitem>libkrb5-dev</listitem> + <listitem>krb5-user</listitem> </itemizedlist> </para> </sect3> <sect3> - <title>Installing the required packages for RedHat</title> + <title>Installing the Required Packages for Red Hat Linux</title> - <para>On RedHat this means you should have at least: </para> + <para>On Red Hat Linux, this means you should have at least: </para> <para> <itemizedlist> - <listitem><para>krb5-workstation (for kinit)</para></listitem> - <listitem><para>krb5-libs (for linking with)</para></listitem> - <listitem><para>krb5-devel (because you are compiling from source)</para></listitem> + <listitem>krb5-workstation (for kinit)</listitem> + <listitem>krb5-libs (for linking with)</listitem> + <listitem>krb5-devel (because you are compiling from source)</listitem> </itemizedlist> </para> <para>in addition to the standard development environment.</para> - <para>Note that these are not standard on a RedHat install, and you may need - to get them off CD2.</para> + <para>If these files are not installed on your system, you should check the installation + CDs to find which has them and install the files using your tool of choice. If in doubt + about what tool to use, refer to the Red Hat Linux documentation.</para> + + </sect3> + + <sect3> + <title>SuSE Linux Package Requirements</title> + + <para>SuSE Linux installs Heimdal packages that may be required to allow you to build + binary packages. You should verify that the development libraries have been installed on + your system. + </para> + + <para>SuSE Linux Samba RPMs support Kerberos. Please refer to the documentation for + your SuSE Linux system for information regading SuSE Linux specific configuration. + Additionally, SuSE are very active in the maintenance of Samba packages that provide + the maximum capabilities that are available. You should consider using SuSE provided + packages where they are available. + </para> </sect3> @@ -360,9 +379,10 @@ example of what you would not want to see would be: <sect1> <title>Starting the &smbd; and &nmbd;</title> - <indexterm><primary>inetd</primary></indexterm> - <para>You must choose to start &smbd; and &nmbd; either + <para> + <indexterm><primary>inetd</primary></indexterm> + You must choose to start &smbd; and &nmbd; either as daemons or from <application>inetd</application>. Don't try to do both! Either you can put them in <filename> inetd.conf</filename> and have them started on demand @@ -371,8 +391,8 @@ example of what you would not want to see would be: daemons either from the command line or in <filename> /etc/rc.local</filename>. See the man pages for details on the command line options. Take particular care to read - the bit about what user you need to be in order to start - Samba. In many cases you must be root.</para> + the bit about what user you need to have to start + Samba. In many cases, you must be root.</para> <para>The main advantage of starting &smbd; and &nmbd; using the recommended daemon method @@ -390,17 +410,17 @@ example of what you would not want to see would be: </note> <para>Look at your <filename>/etc/services</filename>. - What is defined at port 139/tcp. If nothing is defined + What is defined at port 139/tcp? If nothing is defined, then add a line like this:</para> <para><programlisting>netbios-ssn 139/tcp</programlisting></para> - <para>similarly for 137/udp you should have an entry like:</para> + <para>Similarly for 137/udp, you should have an entry like:</para> <para><programlisting>netbios-ns 137/udp</programlisting></para> - <para>Next edit your <filename>/etc/inetd.conf</filename> - and add two lines something like this:</para> + <para>Next, edit your <filename>/etc/inetd.conf</filename> + and add two lines like this:</para> <para><programlisting> netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd @@ -408,33 +428,35 @@ example of what you would not want to see would be: </programlisting></para> <para>The exact syntax of <filename>/etc/inetd.conf</filename> - varies between unixes. Look at the other entries in inetd.conf + varies between UNIXes. Look at the other entries in inetd.conf for a guide. </para> + <para> <indexterm><primary>xinetd</primary></indexterm> - <para>Some distributions use xinetd instead of inetd. Consult the + Some distributions use xinetd instead of inetd. Consult the xinetd manual for configuration information.</para> - <note><para>Some unixes already have entries like netbios_ns + <note><para>Some UNIXes already have entries like netbios_ns (note the underscore) in <filename>/etc/services</filename>. - You must either edit <filename>/etc/services</filename> or + You must edit <filename>/etc/services</filename> or <filename>/etc/inetd.conf</filename> to make them consistent. </para></note> + <note><para> <indexterm><primary>ifconfig</primary></indexterm> - <note><para>On many systems you may need to use the + On many systems you may need to use the <smbconfoption><name>interfaces</name></smbconfoption> option in &smb.conf; to specify the IP address and netmask of your interfaces. Run <application>ifconfig</application> - as root if you don't know what the broadcast is for your + as root if you do not know what the broadcast is for your net. &nmbd; tries to determine it at run - time, but fails on some unixes. + time, but fails on some UNIXes. </para></note> - <warning><para>Many unixes only accept around 5 + <warning><para>Many UNIXes only accept around five parameters on the command line in <filename>inetd.conf</filename>. This means you shouldn't use spaces between the options and - arguments, or you should use a script, and start the script + arguments, or you should use a script and start the script from <command>inetd</command>.</para></warning> <para>Restart <application>inetd</application>, perhaps just send @@ -447,11 +469,12 @@ example of what you would not want to see would be: </sect2> <sect2> - <title>Alternative: starting it as a daemon</title> + <title>Alternative: Starting &smbd; as a Daemon</title> - <indexterm><primary>daemon</primary></indexterm> - <para>To start the server as a daemon you should create + <para> + <indexterm><primary>daemon</primary></indexterm> + To start the server as a daemon, you should create a script something like this one, perhaps calling it <filename>startsmb</filename>.</para> @@ -461,17 +484,17 @@ example of what you would not want to see would be: /usr/local/samba/bin/nmbd -D </programlisting></para> - <para>then make it executable with <command>chmod + <para>Make it executable with <command>chmod +x startsmb</command></para> <para>You can then run <command>startsmb</command> by - hand or execute it from <filename>/etc/rc.local</filename> + hand or execute it from <filename>/etc/rc.local</filename>. </para> - <para>To kill it send a kill signal to the processes + <para>To kill it, send a kill signal to the processes &nmbd; and &smbd;.</para> - <note><para>If you use the SVR4 style init system then + <note><para>If you use the SVR4 style init system, you may like to look at the <filename>examples/svr4-startup</filename> script to make Samba fit into that system.</para></note> </sect2> diff --git a/docs/docbook/projdoc/DOMAIN_MEMBER.xml b/docs/docbook/projdoc/DOMAIN_MEMBER.xml index 8e0aa92861..b528fe9b61 100644 --- a/docs/docbook/projdoc/DOMAIN_MEMBER.xml +++ b/docs/docbook/projdoc/DOMAIN_MEMBER.xml @@ -6,24 +6,25 @@ &author.jerry; &author.tridge; &author.jelmer; + <author>&person.gd;<contrib>LDAP updates</contrib></author> </chapterinfo> <title>Domain Membership</title> <para> -Domain Membership is a subject of vital concern, Samba must be able to -participate as a member server in a Microsoft Domain security context, and +Domain Membership is a subject of vital concern. Samba must be able to +participate as a member server in a Microsoft Domain Security context, and Samba must be capable of providing Domain machine member trust accounts, -otherwise it would not be capable of offering a viable option for many users. +otherwise it would not be able to offer a viable option for many users. </para> <para> -This chapter covers background information pertaining to domain membership, -Samba configuration for it, and MS Windows client procedures for joining a -domain. Why is this necessary? Because both are areas in which there exists +This chapter covers background information pertaining to Domain Membership, +the Samba configuration for it, and MS Windows client procedures for joining a +domain. Why is this necessary? Because both are areas in which there exists within the current MS Windows networking world and particularly in the UNIX/Linux networking and administration world, a considerable level of -mis-information, incorrect understanding, and a lack of knowledge. Hopefully +misinformation, incorrect understanding and a lack of knowledge. Hopefully this chapter will fill the voids. </para> @@ -31,40 +32,37 @@ this chapter will fill the voids. <title>Features and Benefits</title> <para> -MS Windows workstations and servers that want to participate in domain security need to -be made Domain members. Participating in Domain security is often called +MS Windows workstations and servers that want to participate in Domain Security need to +be made Domain Members. Participating in Domain Security is often called <emphasis>Single Sign On</emphasis> or <acronym>SSO</acronym> for short. This chapter describes the process that must be followed to make a workstation -(or another server - be it an <application>MS Windows NT4 / 200x</application> -server) or a Samba server a member of an MS Windows Domain security context. +(or another server &smbmdash; be it an <application>MS Windows NT4 / 200x</application> +server) or a Samba server a member of an MS Windows Domain Security context. </para> <para> -Samba-3 can join an MS Windows NT4 style domain as a native member server, an +<indexterm><primary>Server Type</primary><secondary>Domain Member</secondary></indexterm> +Samba-3 can join an MS Windows NT4-style domain as a native member server, an MS Windows Active Directory Domain as a native member server, or a Samba Domain -Control network. -</para> - -<para> -Domain membership has many advantages: +Control network. Domain Membership has many advantages: </para> <itemizedlist> <listitem><para> - MS Windows workstation users get the benefit of SSO +<indexterm><primary>SAM</primary></indexterm> + MS Windows workstation users get the benefit of SSO. </para></listitem> <listitem><para> - Domain user access rights and file ownership / access controls can be set - from the single Domain SAM (Security Account Manager) database - (works with Domain member servers as well as with MS Windows workstations - that are domain members) + Domain user access rights and file ownership/access controls can be set + from the single Domain Security Account Manager (SAM) database + (works with Domain Member servers as well as with MS Windows workstations + that are Domain Members). </para></listitem> <listitem><para> - Only <application>MS Windows NT4 / 200x / XP Professional</application> - workstations that are Domain members - can use network logon facilities + Only <application>MS Windows NT4/200x/XP Professional</application> + workstations that are Domain Members can use network logon facilities. </para></listitem> <listitem><para> @@ -74,15 +72,15 @@ Domain membership has many advantages: <listitem><para> Through the use of logon scripts, users can be given transparent access to network - applications that run off application servers + applications that run off application servers. </para></listitem> <listitem><para> Network administrators gain better application and user access management abilities because there is no need to maintain user accounts on any network client or server, other than the central Domain database - (either NT4/Samba SAM style Domain, NT4 Domain that is back ended with an - LDAP directory, or via an Active Directory infrastructure) + (either NT4/Samba SAM style Domain, NT4 Domain that is backended with an + LDAP directory, or via an Active Directory infrastructure). </para></listitem> </itemizedlist> @@ -91,35 +89,32 @@ Domain membership has many advantages: <sect1 id="machine-trust-accounts"> <title>MS Windows Workstation/Server Machine Trust Accounts</title> -<indexterm><primary>machine trust accounts</primary></indexterm> - <para> -A machine trust account is an account that is used to authenticate a client -machine -(rather than a user) to the Domain Controller server. In Windows terminology, -this is known as a "Computer Account." +<indexterm><primary>Machine Trust Accounts</primary></indexterm> +A Machine Trust Account is an account that is used to authenticate a client +machine (rather than a user) to the Domain Controller server. In Windows terminology, +this is known as a <quote>Computer Account.</quote> The purpose of the machine account +is to prevent a rogue user and Domain Controller from colluding to gain access to a +domain member workstation. </para> <para> -The password of a machine trust account acts as the shared secret for -secure communication with the Domain Controller. This is a security +The password of a Machine Trust Account acts as the shared secret for +secure communication with the Domain Controller. This is a security feature to prevent an unauthorized machine with the same NetBIOS name from joining the domain and gaining access to domain user/group -accounts. Windows NT, 200x, XP Professional clients use machine trust -accounts, but Windows 9x / Me / XP Home clients do not. Hence, a -Windows 9x / Me / XP Home client is never a true member of a domain -because it does not possess a machine trust account, and thus has no -shared secret with the domain controller. +accounts. Windows NT/200x/XP Professional clients use machine trust +accounts, but Windows 9x/Me/XP Home clients do not. Hence, a +Windows 9x/Me/XP Home client is never a true member of a Domain +because it does not possess a Machine Trust Account, and, thus, has no +shared secret with the Domain Controller. </para> <para> -A Windows NT4 PDC stores each machine trust account in the Windows Registry. +A Windows NT4 PDC stores each Machine Trust Account in the Windows Registry. The introduction of MS Windows 2000 saw the introduction of Active Directory, -the new repository for machine trust accounts. -</para> - -<para> -A Samba PDC, however, stores each machine trust account in two parts, +the new repository for Machine Trust Accounts. A Samba PDC, however, stores +each Machine Trust Account in two parts, as follows: <itemizedlist> @@ -132,31 +127,30 @@ as follows: <para> The older format of this data is the <filename>smbpasswd</filename> database - which contains the UNIX login ID, the UNIX user identifier (UID), and the + that contains the UNIX login ID, the UNIX user identifier (UID), and the LanMan and NT encrypted passwords. There is also some other information in this file that we do not need to concern ourselves with here. </para> <para> - The two newer database types are called <emphasis>ldapsam</emphasis>, - <emphasis>tdbsam</emphasis>. Both store considerably more data than the + The two newer database types are called ldapsam, and + tdbsam. Both store considerably more data than the older <filename>smbpasswd</filename> file did. The extra information - enables new user account controls to be used. + enables new user account controls to be implemented. </para></listitem> <listitem><para> A corresponding UNIX account, typically stored in - <filename>/etc/passwd</filename>. Work is in progress to allow a + <filename>/etc/passwd</filename>. Work is in progress to allow a simplified mode of operation that does not require UNIX user accounts, but this may not be a feature of the early releases of Samba-3. </para></listitem> </itemizedlist> </para> -<indexterm><primary>machine trust accounts</primary><secondary>creating</secondary></indexterm> - <para> -There are three ways to create machine trust accounts: +<indexterm><primary>Machine Trust Accounts</primary><secondary>creating</secondary></indexterm> +There are three ways to create Machine Trust Accounts: </para> <itemizedlist> @@ -167,14 +161,14 @@ There are three ways to create machine trust accounts: <listitem><para> <indexterm><primary>Server Manager</primary></indexterm> - Using the MS Windows NT4 Server Manager (either from an NT4 Domain member - server, or using the Nexus toolkit available from the Microsoft web site. - This tool can be run from any MS Windows machine so long as the user is + Using the MS Windows NT4 Server Manager, either from an NT4 Domain Member + server, or using the Nexus toolkit available from the Microsoft Web site. + This tool can be run from any MS Windows machine as long as the user is logged on as the administrator account. </para></listitem> <listitem><para> - "On-the-fly" creation. The Samba machine trust account is automatically + <quote>On-the-fly</quote> 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. @@ -185,25 +179,27 @@ There are three ways to create machine trust accounts: <title>Manual Creation of Machine Trust Accounts</title> <para> -The first step in manually creating a machine trust account is to manually +The first step in manually creating a Machine Trust Account is to manually create the corresponding UNIX account in <filename>/etc/passwd</filename>. -This can be done using <command>vipw</command> or another 'add user' command -that is normally used to create new UNIX accounts. The following is an example for a Linux based Samba server: -<indexterm><primary>useradd</primary></indexterm> -<indexterm><primary>vipw</primary></indexterm> - - +This can be done using <command>vipw</command> or another <quote>add user</quote> command +that is normally used to create new UNIX accounts. The following is an example for +a Linux-based Samba server: </para> <para> +<indexterm><primary>useradd</primary></indexterm> +<indexterm><primary>vipw</primary></indexterm> <screen> -&rootprompt;<userinput>/usr/sbin/useradd -g 100 -d /dev/null -c <replaceable>"machine nickname"</replaceable> \ +&rootprompt;<userinput>/usr/sbin/useradd -g machines -d /dev/null -c <replaceable>"machine nickname"</replaceable> \ -s /bin/false <replaceable>machine_name</replaceable>$ </userinput> &rootprompt;<userinput>passwd -l <replaceable>machine_name</replaceable>$</userinput> </screen> </para> +<para>In the above example above there is an existing system group <quote>machines</quote> which is used +as the primary group for all machine accounts. In the following examples the <quote>machines</quote> group has +numeric GID equal 100.</para> <para> <indexterm><primary>chpass</primary></indexterm> @@ -213,14 +209,14 @@ On *BSD systems, this can be done using the <command>chpass</command> utility: <para> <screen> &rootprompt;<userinput>chpass -a \ - "<replaceable>machine_name</replaceable>$:*:101:100::0:0:Workstation <replaceable>machine_name</replaceable>:/dev/null:/sbin/nologin"</userinput> +'<replaceable>machine_name</replaceable>$:*:101:100::0:0:Windows <replaceable>machine_name</replaceable>:/dev/null:/sbin/nologin'</userinput> </screen> </para> <para> The <filename>/etc/passwd</filename> entry will list the machine name -with a "$" appended, won't have a password, will have a null shell and no -home directory. For example a machine named 'doppy' would have an +with a <quote>$</quote> appended, will not have a password, will have a null shell and no +home directory. For example, a machine named <quote>doppy</quote> would have an <filename>/etc/passwd</filename> entry like this: </para> @@ -232,15 +228,15 @@ doppy$:x:505:100:<replaceable>machine_nickname</replaceable>:/dev/null:/bin/fals Above, <replaceable>machine_nickname</replaceable> can be any descriptive name for the client, i.e., BasementComputer. <replaceable>machine_name</replaceable> absolutely must be the NetBIOS -name of the client to be joined to the domain. The "$" must be +name of the client to be joined to the domain. The <quote>$</quote> must be appended to the NetBIOS name of the client or Samba will not recognize -this as a machine trust account. +this as a Machine Trust Account. </para> <para> Now that the corresponding UNIX account has been created, the next step is to create the Samba account for the client containing the well-known initial -machine trust account password. This can be done using the +Machine Trust Account password. This can be done using the <command>smbpasswd</command> command as shown here: </para> @@ -253,39 +249,47 @@ as shown here: <para> where <replaceable>machine_name</replaceable> is the machine's NetBIOS -name. The RID of the new machine account is generated from the UID of +name. The RID of the new machine account is generated from the UID of the corresponding UNIX account. </para> <warning> - <title>Join the client to the domain immediately</title> +<title>Join the client to the domain immediately</title> - <para> - Manually creating a machine trust account using this method is the - equivalent of creating a machine trust account on a Windows NT PDC using - <indexterm><primary>Server Manager</primary></indexterm> - the <application>Server Manager</application>. From the time at which the - account is created to the time which the client joins the domain and - changes the password, your domain is vulnerable to an intruder joining - your domain using a machine with the same NetBIOS name. A PDC inherently - trusts members of the domain and will serve out a large degree of user - information to such clients. You have been warned! - </para> +<para> +Manually creating a Machine Trust Account using this method is the +equivalent of creating a Machine Trust Account on a Windows NT PDC using +<indexterm><primary>Server Manager</primary></indexterm> +the <application>Server Manager</application>. From the time at which the +account is created to the time the client joins the domain and +changes the password, your domain is vulnerable to an intruder joining +your domain using a machine with the same NetBIOS name. A PDC inherently +trusts members of the domain and will serve out a large degree of user +information to such clients. You have been warned! +</para> </warning> </sect2> <sect2> -<title>Using NT4 Server Manager to Add Machine Accounts to the Domain</title> +<title>Managing Domain Machine Accounts using NT4 Server Manager</title> <para> +A working <smbconfoption><name>add machine script</name></smbconfoption> script is essential +for machine trust accounts to be automatically created. This applies no matter whether +one uses automatic account creation, or if one wishes to use the NT4 Domain Server Manager. +</para> + +<para> +<indexterm><primary>SRVTOOLS.EXE</primary></indexterm> If the machine from which you are trying to manage the domain is an -<application>MS Windows NT4 workstation or MS Windows 200x / XP Professional</application> -then the tool of choice is the package called <command>SRVTOOLS.EXE</command>. -When executed in the target directory this will unpack <command>SrvMge.exe</command> +<application>MS Windows NT4 workstation or MS Windows 200x/XP Professional</application>, +the tool of choice is the package called <command>SRVTOOLS.EXE</command>. +When executed in the target directory it will unpack <command>SrvMgr.exe</command> and <command>UsrMgr.exe</command> (both are domain management tools for MS Windows NT4 workstation). </para> <para> +<indexterm><primary>Nexus.exe</primary></indexterm> If your workstation is a <application>Microsoft Windows 9x/Me</application> family product you should download the <command>Nexus.exe</command> package from the Microsoft web site. When executed from the target directory this will unpack the same tools but for use on @@ -294,8 +298,13 @@ this platform. <para> Further information about these tools may be obtained from the following locations: -<ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;173673"></ulink> -<ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;172540"></ulink> +</para> + +<para> +<simplelist> +<member><ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;173673"/></member> +<member><ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;172540"/></member> +</simplelist> </para> <para> @@ -305,31 +314,31 @@ Launch the <command>srvmgr.exe</command> (Server Manager for Domains) and follow <procedure> <title>Server Manager Account Machine Account Management</title> <step><para> - From the menu select <guimenu>Computer</guimenu> + From the menu select <guimenu>Computer</guimenu>. </para></step> <step><para> - Click on <guimenuitem>Select Domain</guimenuitem> + Click <guimenuitem>Select Domain</guimenuitem>. </para></step> <step><para> - Click on the name of the domain you wish to administer in the + Click the name of the domain you wish to administer in the <guilabel>Select Domain</guilabel> panel and then click <guibutton>OK</guibutton>. </para></step> <step><para> - Again from the menu select <guimenu>Computer</guimenu> + Again from the menu select <guimenu>Computer</guimenu>. </para></step> <step><para> - Select <guimenuitem>Add to Domain</guimenuitem> + Select <guimenuitem>Add to Domain</guimenuitem>. </para></step> <step><para> - In the dialog box, click on the radio button to + In the dialog box, click the radio button to <guilabel>Add NT Workstation of Server</guilabel>, then - enter the machine name in the field provided, then click the + enter the machine name in the field provided, and click the <guibutton>Add</guibutton> button. </para></step> </procedure> @@ -337,30 +346,30 @@ Launch the <command>srvmgr.exe</command> (Server Manager for Domains) and follow </sect2> <sect2> -<title>"On-the-Fly" Creation of Machine Trust Accounts</title> +<title>On-the-Fly Creation of Machine Trust Accounts</title> <para> -The second (and recommended) way of creating machine trust accounts is +The second (and recommended) way of creating Machine Trust Accounts is simply to allow the Samba server to create them as needed when the client is joined to the domain. </para> -<para>Since each Samba machine trust account requires a corresponding UNIX account, a method +<para>Since each Samba Machine Trust Account requires a corresponding UNIX account, a method for automatically creating the UNIX account is usually supplied; this requires configuration of the -add machine script option in -&smb.conf;. This method is not required, however; corresponding UNIX +add machine script option in &smb.conf;. This method is not required, however, corresponding UNIX accounts may also be created manually. </para> <para> -Below is an example for a RedHat Linux system. +Here is an example for a Red Hat Linux system. </para> <para><smbconfblock> <smbconfsection>[global]</smbconfsection> <smbconfcomment><...remainder of parameters...></smbconfcomment> -<smbconfoption><name>add machine script</name><value>/usr/sbin/useradd -d /dev/null -g 100 -s /bin/false -M %u </value></smbconfoption> +<smbconfoption><name>add machine script</name><value>/usr/sbin/useradd -d /dev/null -g 100 \</value></smbconfoption> +<member><parameter> -s /bin/false -M %u</parameter></member> </smbconfblock></para> @@ -371,67 +380,62 @@ Below is an example for a RedHat Linux system. <para> The procedure for making an MS Windows workstation or server a member of the domain varies -with the version of Windows: +with the version of Windows. </para> <sect3> - <title>Windows 200x XP Professional</title> + <title>Windows 200x/XP Professional Client</title> <para> - When the user elects to make the client a domain member, Windows 200x prompts for + When the user elects to make the client a Domain Member, Windows 200x prompts for an account and password that has privileges to create machine accounts in the domain. - A Samba administrative account (i.e., a Samba account that has root privileges on the + A Samba Administrator Account (i.e., a Samba account that has <constant>root</constant> privileges on the Samba server) must be entered here; the operation will fail if an ordinary user account is given. </para> <para> - Note: For security reasons the password for this administrative account should be set - to a password that is other than that used for the root user in the - <filename>/etc/passwd</filename>. + For security reasons, the password for this Administrator Account should be set + to a password that is other than that used for the root user in <filename>/etc/passwd</filename>. </para> <para> - The name of the account that is used to create domain member machine accounts can be - anything the network administrator may choose. If it is other than <emphasis>root</emphasis> - then this is easily mapped to root using the file pointed to be the &smb.conf; parameter + The name of the account that is used to create Domain Member machine accounts can be + anything the network administrator may choose. If it is other than <constant>root</constant> + then this is easily mapped to <constant>root</constant> in the file named in the &smb.conf; parameter <smbconfoption><name>username map</name><value>/etc/samba/smbusers</value></smbconfoption>. </para> <para> - The session key of the Samba administrative account acts as an - encryption key for setting the password of the machine trust - account. The machine trust account will be created on-the-fly, or - updated if it already exists. + The session key of the Samba Administrator Account acts as an encryption key for setting the password of the machine trust + account. The Machine Trust Account will be created on-the-fly, or updated if it already exists. </para> </sect3> <sect3> - <title>Windows NT4</title> + <title>Windows NT4 Client</title> <para> - If the machine trust account was created manually, on the + If the Machine Trust Account was created manually, on the Identification Changes menu enter the domain name, but do not check the box <guilabel>Create a Computer Account in the Domain</guilabel>. - In this case, the existing machine trust account is used to join the machine + In this case, the existing Machine Trust Account is used to join the machine to the domain. </para> <para> - If the machine trust account is to be created - on-the-fly, on the Identification Changes menu enter the domain - name, and check the box <guilabel>Create a Computer Account in the - Domain</guilabel>. In this case, joining the domain proceeds as above - for Windows 2000 (i.e., you must supply a Samba administrative account when + If the Machine Trust Account is to be created on-the-fly, on the Identification Changes menu enter the domain + name and check the box <guilabel>Create a Computer Account in the Domain</guilabel>. In this case, joining + the domain proceeds as above for Windows 2000 (i.e., you must supply a Samba Administrator Account when prompted). </para> </sect3> <sect3> - <title>Samba</title> + <title>Samba Client</title> <para>Joining a Samba client to a domain is documented in - <link linkend="domain-member-server">the domain member chapter</link>. + <link linkend="domain-member-server"></link>. </para> </sect3> @@ -445,47 +449,62 @@ with the version of Windows: This mode of server operation involves the Samba machine being made a member of a domain security context. This means by definition that all user authentication will be done from a centrally defined authentication regime. -The authentication regime may come from an NT3/4 style (old domain technology) +The authentication regime may come from an NT3/4-style (old domain technology) server, or it may be provided from an Active Directory server (ADS) running on MS Windows 2000 or later. </para> <para> <emphasis> -Of course it should be clear that the authentication back end itself could be +Of course it should be clear that the authentication backend itself could be from any distributed directory architecture server that is supported by Samba. -This can be LDAP (from OpenLDAP), or Sun's iPlanet, of NetWare Directory -Server, etc. +This can be LDAP (from OpenLDAP), or Sun's iPlanet, or NetWare Directory +Server, and so on. </emphasis> </para> +<para><note> +When Samba is configured to use an LDAP, or other identity management and/or +directory service, it is Samba that continues to perform user and machine +authentication. It should be noted that the LDAP server does not perform +authentication handling in place of what Samba is designed to do. +</note></para> + <para> -Please refer to <link linkend="samba-pdc">the chapter on setting up a PDC</link> -for more information regarding how to create a domain -machine account for a domain member server as well as for information -regarding how to enable the Samba domain member machine to join the domain and -to be fully trusted by it. +Please refer to <link linkend="samba-pdc"></link>, for more information regarding +how to create a domain machine account for a Domain Member server as well as for +information on how to enable the Samba Domain Member machine to join the domain +and be fully trusted by it. </para> <sect2> -<title>Joining an NT4 type Domain with Samba-3</title> +<title>Joining an NT4-type Domain with Samba-3</title> -<para> - <table frame="all"><title>Assumptions</title> -<tgroup align="left" cols="2"> +<para><link linkend="assumptions"/> lists names that have been used in the remainder of this chapter.</para> + +<table frame="all" id="assumptions"><title>Assumptions</title> + <tgroup cols="2"> + <colspec align="right"/> + <colspec align="left"/> <tbody> - <row><entry>NetBIOS name:</entry><entry>SERV1</entry></row> - <row><entry>Win2K/NT domain name:</entry><entry>&example.workgroup;</entry></row> - <row><entry>Domain's PDC NetBIOS name:</entry><entry>DOMPDC</entry></row> - <row><entry>Domain's BDC NetBIOS names:</entry><entry>DOMBDC1 and DOMBDC2</entry></row> -</tbody> -</tgroup> + <row> + <entry>NetBIOS name:</entry><entry>SERV1</entry> + </row> + <row> + <entry>Windows 200x/NT domain name:</entry><entry>&example.workgroup;</entry> + </row> + <row> + <entry>Domain's PDC NetBIOS name:</entry><entry>DOMPDC</entry> + </row> + <row> + <entry>Domain's BDC NetBIOS names:</entry><entry>DOMBDC1 and DOMBDC2</entry> + </row> + </tbody> + </tgroup> </table> -</para> <para> -First, you must edit your &smb.conf; file to tell Samba it should -now use domain security. +First, you must edit your &smb.conf; file to tell Samba it should now use domain security. </para> <para> @@ -512,13 +531,14 @@ section to read: </para> <para> -as this is the name of the domain we are joining. +This is the name of the domain we are joining. </para> <para> -You must also have the parameter -<smbconfoption><name>encrypt passwords</name></smbconfoption> set to <constant>yes -</constant> in order for your users to authenticate to the NT PDC. +You must also have the parameter <smbconfoption><name>encrypt passwords</name></smbconfoption> +set to <constant>yes</constant> in order for your users to authenticate to the NT PDC. +This is the defaulty setting if this parameter is not specified. There is no need to specify this +parameter, but if it is specified in the &smb.conf; file, it must be set to <constant>Yes</constant>. </para> <para> @@ -533,16 +553,16 @@ section to read: </para> <para> -These are the primary and backup domain controllers Samba +These are the primary and backup Domain Controllers Samba will attempt to contact in order to authenticate users. Samba will try to contact each of these servers in order, so you may want to rearrange this list in order to spread out the authentication load -among domain controllers. +among Domain Controllers. </para> <para> -Alternatively, if you want smbd to automatically determine -the list of Domain controllers to use for authentication, you may +Alternately, if you want smbd to automatically determine +the list of Domain Controllers to use for authentication, you may set this line to be: </para> @@ -553,44 +573,47 @@ set this line to be: </para> <para> -This method allows Samba to use exactly the same mechanism that NT does. This -method either broadcasts or uses a WINS database in order to -find domain controllers to authenticate against. +This method allows Samba to use exactly the same mechanism that NT does. The +method either uses broadcast-based name resolution, performs a WINS database +lookup in order to find a Domain Controller against which to authenticate, +or locates the Domain Controller using DNS name resolution. </para> <para> -In order to actually join the domain, you must run this command: +To join the domain, run this command: </para> <para> <screen> -&rootprompt;<userinput>net rpc join -S DOMPDC -U<replaceable>Administrator%password</replaceable></userinput> +&rootprompt;<userinput>net join -S DOMPDC -U<replaceable>Administrator%password</replaceable></userinput> </screen> </para> <para> -If the <option>-S DOMPDC</option> argument is not given then -the domain name will be obtained from &smb.conf;. +If the <option>-S DOMPDC</option> argument is not given, the domain name will be obtained from &smb.conf;. </para> <para> -As we are joining the domain DOM and the PDC for that domain -(the only machine that has write access to the domain SAM database) -is DOMPDC, we use it for the <option>-S</option> option. -The <replaceable>Administrator%password</replaceable> is -the login name and password for an account which has the necessary -privilege to add machines to the domain. If this is successful -you will see the message: +The machine is joining the domain DOM, and the PDC for that domain (the only machine +that has write access to the domain SAM database) is DOMPDC, therefore use the <option>-S</option> +option. The <replaceable>Administrator%password</replaceable> is the login name and +password for an account that has the necessary privilege to add machines to the +domain. If this is successful, you will see the message in your terminal window the +text shown below. Where the older NT4 style domain architecture is used: +<screen> +<computeroutput>Joined domain DOM.</computeroutput> +</screen> </para> <para> -<computeroutput>Joined domain DOM.</computeroutput> -or <computeroutput>Joined 'SERV1' to realm 'MYREALM'</computeroutput> +Where Active Directory is used: +<screen> +<computeroutput>Joined SERV1 to realm MYREALM.</computeroutput> +</screen> </para> <para> -in your terminal window. See the -<command>net</command> man page for more details. +Refer to the <command>net</command> man page for further information. </para> <para> @@ -599,58 +622,56 @@ trust account on the PDC beforehand. </para> <para> -This command goes through the machine account password -change protocol, then writes the new (random) machine account -password for this Samba server into a file in the same directory -in which an smbpasswd file would be stored - normally: -</para> - -<para> +This command goes through the machine account password change protocol, then writes +the new (random) machine account password for this Samba server into a file in the +same directory in which a smbpasswd file would be normally stored: +<screen> <filename>/usr/local/samba/private/secrets.tdb</filename> +or +<filename>/etc/samba/secrets.tdb</filename>. +</screen> </para> <para> -This file is created and owned by root and is not -readable by any other user. It is the key to the domain-level -security for your system, and should be treated as carefully +This file is created and owned by root and is not readable by any other user. It is +the key to the Domain-level security for your system, and should be treated as carefully as a shadow password file. </para> <para> -Finally, restart your Samba daemons and get ready for -clients to begin using domain security! The way you can restart your -samba daemons depends on your distribution, but in most cases running +Finally, restart your Samba daemons and get ready for clients to begin using domain +security. The way you can restart your Samba daemons depends on your distribution, +but in most cases the following will suffice: <screen> - &rootprompt;/etc/init.d/samba restart +&rootprompt;/etc/init.d/samba restart </screen> -does the job. </para> </sect2> <sect2> -<title>Why is this better than security = server?</title> +<title>Why Is This Better Than <parameter>security = server</parameter>?</title> <para> -Currently, domain security in Samba doesn't free you from +Currently, domain security in Samba does not free you from having to create local UNIX users to represent the users attaching -to your server. This means that if domain user <constant>DOM\fred -</constant> attaches to your domain security Samba server, there needs +to your server. This means that if Domain user <constant>DOM\fred +</constant> attaches to your Domain Security Samba server, there needs to be a local UNIX user fred to represent that user in the UNIX -filesystem. This is very similar to the older Samba security mode -security = server, +file system. This is similar to the older Samba security mode +<smbconfoption><name>security</name><value>server</value></smbconfoption>, where Samba would pass through the authentication request to a Windows NT server in the same way as a Windows 95 or Windows 98 server would. </para> <para> - Please refer to <link linkend="winbind">the chapter on winbind</link> for information on a system -to automatically assign UNIX uids and gids to Windows NT Domain users and groups. +Please refer to <link linkend="winbind"></link>, for information on a system +to automatically assign UNIX UIDs and GIDs to Windows NT Domain users and groups. </para> <para> -The advantage to domain-level security is that the -authentication in domain-level security is passed down the authenticated +The advantage to Domain-level security is that the +authentication in Domain-level security is passed down the authenticated RPC channel in exactly the same way that an NT server would do it. This means Samba servers now participate in domain trust relationships in exactly the same way NT servers do (i.e., you can add Samba servers into @@ -659,13 +680,13 @@ domain PDC to an account domain PDC). </para> <para> -In addition, with <smbconfoption><name>security</name><value>server</value></smbconfoption> every Samba +In addition, with <smbconfoption><name>security</name><value>server</value></smbconfoption>, every Samba daemon on a server has to keep a connection open to the authenticating server for as long as that daemon lasts. This can drain the connection resources on a Microsoft NT server and cause it to run out of available connections. With <smbconfoption><name>security</name><value>domain</value></smbconfoption>, however, the Samba daemons connect to the PDC/BDC only for as long -as is necessary to authenticate the user, and then drop the connection, +as is necessary to authenticate the user and then drop the connection, thus conserving PDC connection resources. </para> @@ -673,16 +694,15 @@ thus conserving PDC connection resources. And finally, acting in the same manner as an NT server authenticating to a PDC means that as part of the authentication reply, the Samba server gets the user identification information such -as the user SID, the list of NT groups the user belongs to, etc. +as the user SID, the list of NT groups the user belongs to, and so on. </para> <note> <para> -Much of the text of this document -was first published in the Web magazine +Much of the text of this document was first published in the Web magazine <ulink url="http://www.linuxworld.com">LinuxWorld</ulink> as the article <ulink -url="http://www.linuxworld.com/linuxworld/lw-1998-10/lw-10-samba.html">Doing -the NIS/NT Samba</ulink>. +url="http://www.linuxworld.com/linuxworld/lw-1998-10/lw-10-samba.html"/> +<emphasis>Doing the NIS/NT Samba</emphasis>. </para> </note> @@ -692,52 +712,62 @@ the NIS/NT Samba</ulink>. <sect1 id="ads-member"> <title>Samba ADS Domain Membership</title> +<para> <indexterm significance="preferred"><primary>Active Directory</primary></indexterm> <indexterm significance="preferred"><primary>ADS</primary><see>Active Directory</see></indexterm> - <indexterm><primary>KDC</primary></indexterm> <indexterm><primary>Kerberos</primary></indexterm> -<para> -This is a rough guide to setting up Samba 3.0 with Kerberos authentication against a -Windows2000 KDC. A familiarity with Kerberos is assumed. +This is a rough guide to setting up Samba-3 with Kerberos authentication against a +Windows 200x KDC. A familiarity with Kerberos is assumed. </para> <sect2> -<title>Setup your &smb.conf;</title> +<title>Configure &smb.conf;</title> <para> -You must use at least the following 3 options in &smb.conf;: +You must use at least the following three options in &smb.conf;: </para> <para><smbconfblock> <smbconfoption><name>realm</name><value>your.kerberos.REALM</value></smbconfoption> <smbconfoption><name>security</name><value>ADS</value></smbconfoption> +<smbconfcomment>The following parameter need only be specified if present.</smbconfcomment> +<smbconfcomment>The default setting is not present is Yes.</smbconfcomment> <smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> </smbconfblock></para> <para> -In case samba can't figure out your ads server using your realm name, use the -<smbconfoption><name>ads server</name></smbconfoption> option in &smb.conf;: +In case samba cannot correctly identify the appropriate ADS server using the realm name, use the +<smbconfoption><name>password server</name></smbconfoption> option in &smb.conf;: <smbconfblock> -<smbconfoption><name>ads server</name><value>your.kerberos.server</value></smbconfoption> +<smbconfoption><name>password server</name><value>your.kerberos.server</value></smbconfoption> </smbconfblock> </para> <note><para> You do <emphasis>not</emphasis> need a smbpasswd file, and older clients will be authenticated as -if <smbconfoption><name>security</name><value>domain</value></smbconfoption>, although it won't do any harm and -allows you to have local users not in the domain. It is expected that the above -required options will change soon when active directory integration will get -better. +if <smbconfoption><name>security</name><value>domain</value></smbconfoption>, although it will not do any harm and +allows you to have local users not in the domain. </para></note> </sect2> <sect2> -<title>Setup your <filename>/etc/krb5.conf</filename></title> +<title>Configure <filename>/etc/krb5.conf</filename></title> + +<para> +<indexterm><primary>/etc/krb5.conf</primary></indexterm> +<indexterm><primary>Kerberos</primary><secondary>/etc/krb5.conf</secondary></indexterm> +With both MIT and Heimdal Kerberos, this is unnecessary, and may be detrimental. All ADS +domains will automatically create SRV records in the DNS zone <?latex \linebreak ?><parameter>_kerberos.REALM.NAME</parameter> for +each KDC in the realm. MIT's, as well as Heimdal's, KRB5 libraries default to checking +for these records, so they will automatically find the KDCs. In addition, +<filename>krb5.conf</filename> only allows specifying a single KDC, even there if there is more +than one. Using the DNS lookup allows the KRB5 libraries to use whichever KDCs are available. +</para> <para> -The minimal configuration for <filename>krb5.conf</filename> is: +When manually configuring <filename>krb5.conf</filename>, the minimal configuration is: </para> <para><programlisting> @@ -750,77 +780,128 @@ The minimal configuration for <filename>krb5.conf</filename> is: } </programlisting></para> -<indexterm><primary>kinit</primary></indexterm> +<para> +When using Heimdal versions before 0.6 use the following configuration settings: +<screen> +[libdefaults] + default_realm = YOUR.KERBEROS.REALM + default_etypes = des-cbc-crc des-cbc-md5 + default_etypes_des = des-cbc-crc des-cbc-md5 + + [realms] + YOUR.KERBEROS.REALM = { + kdc = your.kerberos.server + } +</screen> +</para> <para> +<indexterm><primary>kinit</primary></indexterm> Test your config by doing a <userinput>kinit <replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput> and making sure that your password is accepted by the Win2000 KDC. </para> +<para> +With Heimdal versions earlier than 0.6.x you only can use newly created accounts +in ADS or accounts that have had the password changed once after migration, or +in case of <constant>Administrator</constant> after installation. At the +moment, a Windows 2003 KDC can only be used with a Heimdal releases later than 0.6 +(and no default etypes in krb5.conf). Unfortunatly this whole area is still +in a state of flux. +</para> + <note><para> -The realm must be uppercase or you will get <errorname>Cannot find KDC for -requested realm while getting initial credentials</errorname> error (Kerberos +The realm must be in uppercase or you will get <quote><errorname>Cannot find KDC for +requested realm while getting initial credentials</errorname></quote> error (Kerberos is case-sensitive!). </para></note> <note><para> -Time between the two servers must be synchronized. You will get a -<errorname>kinit(v5): Clock skew too great while getting initial credentials</errorname> +Time between the two servers must be synchronized. You will get a +<quote><errorname>kinit(v5): Clock skew too great while getting initial credentials</errorname></quote> if the time difference is more than five minutes. </para></note> <para> +Clock skew limits are configurable in the Kerberos protocols. The default setting is +five minutes. +</para> + +<para> You also must ensure that you can do a reverse DNS lookup on the IP address of your KDC. Also, the name that this reverse lookup maps to -must either be the NetBIOS name of the KDC (ie. the hostname with no -domain attached) or it can alternatively be the NetBIOS name -followed by the realm. +must either be the NetBIOS name of the KDC (i.e., the hostname with no +domain attached) or it can alternately be the NetBIOS name followed by the realm. </para> <para> The easiest way to ensure you get this right is to add a <filename>/etc/hosts</filename> entry mapping the IP address of your KDC to -its NetBIOS name. If you don't get this right then you will get a +its NetBIOS name. If you do not get this correct then you will get a <errorname>local error</errorname> when you try to join the realm. </para> <para> If all you want is Kerberos support in &smbclient; then you can skip -straight to <link linkend="ads-test-smbclient">Test with &smbclient;</link> now. -<link linkend="ads-create-machine-account">Creating a computer account</link> -and <link linkend="ads-test-server">testing your servers</link> -is only needed if you want Kerberos support for &smbd; and &winbindd;. +directly to <link linkend="ads-test-smbclient"/> now. +<link linkend="ads-create-machine-account"/> and <link linkend="ads-test-server"/> +are needed only if you want Kerberos support for &smbd; and &winbindd;. </para> </sect2> <sect2 id="ads-create-machine-account"> -<title>Create the computer account</title> +<title>Create the Computer Account</title> <para> -As a user that has write permission on the Samba private directory -(usually root) run: +As a user who has write permission on the Samba private directory (usually root), run: <screen> &rootprompt; <userinput>net ads join -U Administrator%password</userinput> </screen> </para> +<para> +When making a Windows client a member of an ADS domain within a complex organization, you +may want to create the machine account within a particular organizational unit. Samba-3 permits +this to be done using the following syntax: +<screen> +&rootprompt; <userinput>kinit Administrator@your.kerberos.REALM</userinput> +&rootprompt; <userinput>net ads join <quote>organizational_unit</quote></userinput> +</screen> +</para> + +<para> +For example, you may want to create the machine account in a container called <quote>Servers</quote> +under the organizational directory <quote>Computers\BusinessUnit\Department</quote> like this: +<screen> +&rootprompt; <userinput>net ads join "Computers\BusinessUnit\Department\Servers"</userinput> +</screen> +</para> + +<?latex \newpage ?> + <sect3> -<title>Possible errors</title> +<title>Possible Errors</title> <para> <variablelist> <varlistentry><term><errorname>ADS support not compiled in</errorname></term> <listitem><para>Samba must be reconfigured (remove config.cache) and recompiled - (make clean all install) after the Kerberos libs and headers are installed. + (make clean all install) after the Kerberos libiraries and headers files are installed. </para></listitem></varlistentry> <varlistentry><term><errorname>net ads join prompts for user name</errorname></term> <listitem><para>You need to login to the domain using <userinput>kinit <replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput>. <replaceable>USERNAME</replaceable> must be a user who has rights to add a machine - to the domain. </para></listitem></varlistentry> + to the domain. </para></listitem></varlistentry> + + <varlistentry><term>Unsupported encryption/or checksum types</term> + <listitem><para> + Make sure that the <filename>/etc/krb5.conf</filename> is correctly configured + for the type and version of Kerberos installed on the system. + </para></listitem></varlistentry> </variablelist> </para> @@ -829,29 +910,33 @@ As a user that has write permission on the Samba private directory </sect2> <sect2 id="ads-test-server"> -<title>Test your server setup</title> +<title>Testing Server Setup</title> <para> If the join was successful, you will see a new computer account with the -NetBIOS name of your Samba server in Active Directory (in the "Computers" +NetBIOS name of your Samba server in Active Directory (in the <quote>Computers</quote> folder under Users and Computers. </para> <para> -On a Windows 2000 client try <userinput>net use * \\server\share</userinput>. You should -be logged in with Kerberos without needing to know a password. If -this fails then run <userinput>klist tickets</userinput>. Did you get a ticket for the -server? Does it have an encoding type of DES-CBC-MD5 ? +On a Windows 2000 client, try <userinput>net use * \\server\share</userinput>. You should +be logged in with Kerberos without needing to know a password. If this fails then run +<userinput>klist tickets</userinput>. Did you get a ticket for the server? Does it have +an encryption type of DES-CBC-MD5? </para> +<para><note> +Samba can use both DES-CBC-MD5 encryption as well as ARCFOUR-HMAC-MD5 encoding. +</note></para> + </sect2> <sect2 id="ads-test-smbclient"> <title>Testing with &smbclient;</title> -<indexterm><primary>smbclient</primary></indexterm> <para> +<indexterm><primary>smbclient</primary></indexterm> On your Samba server try to login to a Win2000 server or your Samba server using &smbclient; and Kerberos. Use &smbclient; as usual, but specify the <option>-k</option> option to choose Kerberos authentication. @@ -864,44 +949,76 @@ specify the <option>-k</option> option to choose Kerberos authentication. <para> You must change administrator password at least once after DC -install, to create the right encoding types +install, to create the right encryption types. </para> <para> -W2k doesn't seem to create the _kerberos._udp and _ldap._tcp in -their defaults DNS setup. Maybe this will be fixed later in service packs. +Windows 200x does not seem to create the <parameter>_kerberos._udp</parameter> and <parameter>_ldap._tcp</parameter> in +the default DNS setup. Perhaps this will be fixed later in service packs. </para> </sect2> </sect1> <sect1> +<title>Sharing User ID Mappings between Samba Domain Members</title> + +<para> +Samba maps UNIX users and groups (identified by UIDs and GIDs) to Windows users and groups (identified by SIDs). +These mappings are done by the <parameter>idmap</parameter> subsystem of Samba. +</para> + +<para> +In some cases it is useful to share these mappings between Samba Domain Members, +so <emphasis>name->id</emphasis> mapping is identical on all machines. +This may be needed in particular when sharing files over both CIFS and NFS. +</para> + +<para>To use the <emphasis>LDAP</emphasis> <parameter>ldap idmap suffix</parameter>, set:</para> + +<smbconfblock> +<smbconfoption><name>ldap idmap suffix</name><value>ou=Idmap,dc=quenya,dc=org</value></smbconfoption> +</smbconfblock> + +<para>See the &smb.conf; man page entry for the <smbconfoption><name>ldap idmap suffix</name><value></value></smbconfoption> +parameter for further information.</para> + +<para> +Do not forget to specify also the <smbconfoption><name>ldap admin dn</name></smbconfoption> +and to make certain to set the LDAP administrative password into the <filename>secrets.tdb</filename> using: +<screen> +&rootprompt; smbpasswd -w ldap-admin-password +</screen></para> + +</sect1> + +<sect1> <title>Common Errors</title> <para> -In the process of adding / deleting / re-adding domain member machine accounts there are -many traps for the unwary player and there are many <quote>little</quote> things that can go wrong. -It is particularly interesting how often subscribers on the samba mailing list have concluded -after repeated failed attempts to add a machine account that it is necessary to "re-install" -MS Windows on t he machine. In truth, it is seldom necessary to reinstall because of this type -of problem. The real solution is often very simple, and with understanding of how MS Windows -networking functions easy to overcome. +In the process of adding/deleting/re-adding Domain Member machine accounts, there are +many traps for the unwary player and many <quote>little</quote> things that can go wrong. +It is particularly interesting how often subscribers on the Samba mailing list have concluded +after repeated failed attempts to add a machine account that it is necessary to <quote>re-install</quote> +MS Windows on the machine. In truth, it is seldom necessary to reinstall because of this type +of problem. The real solution is often quite simple and with an understanding of how MS Windows +networking functions, it is easy to overcome. </para> <sect2> -<title>Can Not Add Machine Back to Domain</title> +<title>Cannot Add Machine Back to Domain</title> <para> -<quote> A Windows workstation was reinstalled. The original domain machine +<quote>A Windows workstation was re-installed. The original domain machine account was deleted and added immediately. The workstation will not join the domain if I use the same machine name. Attempts to add the machine fail with a message that the machine already -exists on the network - I know it doesn't. Why is this failing?</quote> +exists on the network &smbmdash; I know it does not. Why is this failing?</quote> </para> <para> The original name is still in the NetBIOS name cache and must expire after machine account -deletion BEFORE adding that same name as a domain member again. The best advice is to delete -the old account and then to add the machine with a new name. +deletion before adding that same name as a Domain Member again. The best advice is to delete +the old account and then add the machine with a new name. </para> </sect2> @@ -910,15 +1027,15 @@ the old account and then to add the machine with a new name. <title>Adding Machine to Domain Fails</title> <para> - <quote>Adding a Windows 200x or XP Professional machine to the Samba PDC Domain fails with a -message that, <errorname>The machine could not be added at this time, there is a network problem. - Please try again later.</errorname> Why?</quote> +<quote>Adding a Windows 200x or XP Professional machine to the Samba PDC Domain fails with a +message that, <errorname>`The machine could not be added at this time, there is a network problem. +Please try again later.'</errorname> Why?</quote> </para> <para> You should check that there is an <smbconfoption><name>add machine script</name></smbconfoption> in your &smb.conf; file. If there is not, please add one that is appropriate for your OS platform. If a script -has been defined you will need to debug it's operation. Increase the <smbconfoption><name>log level</name></smbconfoption> +has been defined, you will need to debug its operation. Increase the <smbconfoption><name>log level</name><value></value></smbconfoption> in the &smb.conf; file to level 10, then try to rejoin the domain. Check the logs to see which operation is failing. </para> @@ -933,23 +1050,37 @@ Possible causes include: </para> <para> - <emphasis>Corrective Action:</emphasis> Fix it. Make sure that when run manually - that the script will add both the UNIX system account _and_ the Samba SAM account. + <emphasis>Corrective action:</emphasis> Fix it. Make sure when run manually + that the script will add both the UNIX system account and the Samba SAM account. </para></listitem> <listitem><para> - The machine could not be added to the UNIX system accounts file <filename>/etc/passwd</filename> + The machine could not be added to the UNIX system accounts file <filename>/etc/passwd</filename>. </para> <para> - <emphasis>Corrective Action:</emphasis> Check that the machine name is a legal UNIX - system account name. ie: If the UNIX utility <command>useradd</command> is called + <emphasis>Corrective action:</emphasis> Check that the machine name is a legal UNIX + system account name. If the UNIX utility <command>useradd</command> is called, then make sure that the machine name you are trying to add can be added using this tool. <command>Useradd</command> on some systems will not allow any upper case characters nor will it allow spaces in the name. </para></listitem> </itemizedlist> +<para> +The <smbconfoption><name>add machine script</name></smbconfoption> does not create the +machine account in the Samba backend database, it is there only to create a UNIX system +account to which the Samba backend database account can be mapped. +</para> + +</sect2> + +<sect2> + <title>I Can't Join a Windows 2003 PDC</title> + + <para>Windows 2003 requires SMB signing. Client side SMB signing has been implemented in Samba-3.0. + Set <smbconfoption><name>client use spnego</name><value>yes</value></smbconfoption> when communicating + with a Windows 2003 server.</para> </sect2> </sect1> diff --git a/docs/docbook/projdoc/Diagnosis.xml b/docs/docbook/projdoc/Diagnosis.xml index 76984f3076..4856e24a46 100644 --- a/docs/docbook/projdoc/Diagnosis.xml +++ b/docs/docbook/projdoc/Diagnosis.xml @@ -2,10 +2,11 @@ <chapterinfo> &author.tridge; &author.jelmer; + &author.danshearer; <pubdate>Wed Jan 15</pubdate> </chapterinfo> -<title>The Samba checklist</title> +<title>The Samba Checklist</title> <sect1> <title>Introduction</title> @@ -13,21 +14,21 @@ <para> This file contains a list of tests you can perform to validate your Samba server. It also tells you what the likely cause of the problem -is if it fails any one of these steps. If it passes all these tests +is if it fails any one of these steps. If it passes all these tests, then it is probably working fine. </para> <para> -You should do ALL the tests, in the order shown. We have tried to +You should do all the tests, in the order shown. We have tried to carefully choose them so later tests only use capabilities verified in -the earlier tests. However, do not stop at the first error as there +the earlier tests. However, do not stop at the first error as there have been some instances when continuing with the tests has helped to solve a problem. </para> <para> -If you send one of the samba mailing lists an email saying "it doesn't work" -and you have not followed this test procedure then you should not be surprised +If you send one of the Samba mailing lists an email saying, <quote>it does not work</quote> +and you have not followed this test procedure, you should not be surprised if your email is ignored. </para> @@ -37,7 +38,7 @@ if your email is ignored. <title>Assumptions</title> <para> -In all of the tests it is assumed you have a Samba server called +In all of the tests, it is assumed you have a Samba server called BIGSERVER and a PC called ACLIENT both in workgroup TESTGROUP. </para> @@ -47,13 +48,13 @@ The procedure is similar for other types of clients. <para> It is also assumed you know the name of an available share in your -&smb.conf;. I will assume this share is called <replaceable>tmp</replaceable>. -You can add a <replaceable>tmp</replaceable> share like this by adding the -following to &smb.conf;: +&smb.conf;. I will assume this share is called <smbconfsection>tmp</smbconfsection>. +You can add a <smbconfsection>tmp</smbconfsection> share like this by adding the +lines shown in <link linkend="tmpshare"/>. </para> -<para><smbconfexample> - <title>smb.conf with [tmp] share</title> +<para><smbconfexample id="tmpshare"> +<title>smb.conf with [tmp] share</title> <smbconfsection>[tmp]</smbconfsection> <smbconfoption><name>comment</name><value>temporary files </value></smbconfoption> <smbconfoption><name>path</name><value>/tmp</value></smbconfoption> @@ -62,80 +63,77 @@ following to &smb.conf;: </para> <note><para> -These tests assume version 3.0 or later of the samba suite. +These tests assume version 3.0.0 or later of the Samba suite. Some commands shown did not exist in earlier versions. </para></note> <para> Please pay attention to the error messages you receive. If any error message -reports that your server is being unfriendly you should first check that your -IP name resolution is correctly set up. eg: Make sure your <filename>/etc/resolv.conf</filename> +reports that your server is being unfriendly, you should first check that your +IP name resolution is correctly set up. Make sure your <filename>/etc/resolv.conf</filename> file points to name servers that really do exist. </para> <para> -Also, if you do not have DNS server access for name resolution please check +Also, if you do not have DNS server access for name resolution, please check that the settings for your &smb.conf; file results in <command>dns proxy = no</command>. The -best way to check this is with <userinput>testparm smb.conf</userinput>. +best way to check this is with <command>testparm smb.conf</command>. </para> -<indexterm><primary>log files</primary><secondary>monitoring</secondary></indexterm> <para> +<indexterm><primary>log files</primary><secondary>monitoring</secondary></indexterm> It is helpful to monitor the log files during testing by using the -<command>tail -F <replaceable>log_file_name</replaceable></command> in a separate +<command>tail -F log_file_name</command> in a separate terminal console (use ctrl-alt-F1 through F6 or multiple terminals in X). Relevant log files can be found (for default installations) in -<filename>/usr/local/samba/var</filename>. Also, connection logs from -machines can be found here or possibly in <filename>/var/log/samba</filename> +<filename>/usr/local/samba/var</filename>. Also, connection logs from +machines can be found here or possibly in <filename>/var/log/samba</filename>, depending on how or if you specified logging in your &smb.conf; file. </para> <para> If you make changes to your &smb.conf; file while going through these test, -don't forget to restart &smbd; and &nmbd;. +remember to restart &smbd; and &nmbd;. </para> </sect1> <sect1> -<title>The tests</title> +<title>The Tests</title> <procedure> -<title>Diagnosing your samba server</title> +<title>Diagnosing your Samba server</title> -<indexterm><primary>testparm</primary></indexterm> <step performance="required"> <para> +<indexterm><primary>testparm</primary></indexterm> In the directory in which you store your &smb.conf; file, run the command -<userinput>testparm smb.conf</userinput>. If it reports any errors then your &smb.conf; +<command>testparm smb.conf</command>. If it reports any errors, then your &smb.conf; configuration file is faulty. </para> <note><para> Your &smb.conf; file may be located in: <filename>/etc/samba</filename> -Or in: <filename>/usr/local/samba/lib</filename> +or in <filename>/usr/local/samba/lib</filename>. </para></note> </step> <step performance="required"> <para> -Run the command <userinput>ping BIGSERVER</userinput> from the PC and -<userinput>ping ACLIENT</userinput> from -the unix box. If you don't get a valid response then your TCP/IP -software is not correctly installed. +Run the command <command>ping BIGSERVER</command> from the PC and +<command>ping ACLIENT</command> from the UNIX box. If you do not get a valid response, +then your TCP/IP software is not correctly installed. </para> <para> -Note that you will need to start a "dos prompt" window on the PC to -run ping. +You will need to start a <quote>dos prompt</quote> window on the PC to run ping. </para> <para> -If you get a message saying <errorname>host not found</errorname> or similar then your DNS +If you get a message saying <quote><errorname>host not found</errorname></quote> or similar, then your DNS software or <filename>/etc/hosts</filename> file is not correctly setup. -It is possible to -run samba without DNS entries for the server and client, but I assume +It is possible to run Samba without DNS entries for the server and client, but it is assumed you do have correct entries for the remainder of these tests. </para> @@ -143,7 +141,8 @@ 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 <application>ipfwadm</application> program.) +this is done via the appropriate firewall maintenance commands <command>ipchains</command> +or <command>iptables</command>). </para> <note> @@ -152,96 +151,136 @@ Modern Linux distributions install ipchains/iptables by default. This is a common problem that is often overlooked. </para> </note> + +<para> +If you wish to check what firewall rules may be present in a system under test, simply run +<command>iptables -L -v</command> or if <parameter>ipchains</parameter>-based firewall rules are in use, +<command>ipchains -L -v</command>. +</para> + +<para> +Here is a sample listing from a system that has an external ethernet interface (eth1) on which Samba +is not active, and an internal (private network) interface (eth0) on which Samba is active: +<screen> +frodo:~ # iptables -L -v +Chain INPUT (policy DROP 98496 packets, 12M bytes) + pkts bytes target prot opt in out source destination + 187K 109M ACCEPT all -- lo any anywhere anywhere + 892K 125M ACCEPT all -- eth0 any anywhere anywhere +1399K 1380M ACCEPT all -- eth1 any anywhere anywhere \ + state RELATED,ESTABLISHED + +Chain FORWARD (policy DROP 0 packets, 0 bytes) + pkts bytes target prot opt in out source destination + 978K 1177M ACCEPT all -- eth1 eth0 anywhere anywhere \ + state RELATED,ESTABLISHED + 658K 40M ACCEPT all -- eth0 eth1 anywhere anywhere + 0 0 LOG all -- any any anywhere anywhere \ + LOG level warning + +Chain OUTPUT (policy ACCEPT 2875K packets, 1508M bytes) + pkts bytes target prot opt in out source destination + +Chain reject_func (0 references) + pkts bytes target prot opt in out source destinat +</screen> +</para> + </step> <step performance="required"> <para> -Run the command <userinput>smbclient -L BIGSERVER</userinput> on the unix box. You -should get a list of available shares back. +Run the command: <command>smbclient -L BIGSERVER</command> +on the UNIX box. You should get back a list of available shares. </para> <para> -If you get a error message containing the string "Bad password" then -you probably have either an incorrect <command>hosts allow</command>, -<command>hosts deny</command> or <command>valid users</command> line in your -&smb.conf;, or your guest account is not -valid. Check what your guest account is using &testparm; and -temporarily remove any <command>hosts allow</command>, <command>hosts deny</command>, <command>valid users</command> or <command>invalid users</command> lines. +If you get an error message containing the string <quote>Bad password</quote>, then +you probably have either an incorrect <parameter>hosts allow</parameter>, +<parameter>hosts deny</parameter> or <parameter>valid users</parameter> line in your +&smb.conf;, or your guest account is not valid. Check what your guest account is using &testparm; and +temporarily remove any <parameter>hosts allow</parameter>, <parameter>hosts deny</parameter>, +<parameter>valid users</parameter> or <parameter>invalid users</parameter> lines. </para> <para> -If you get a <errorname>connection refused</errorname> 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 +If you get a message <quote><errorname>connection refused</errorname></quote> response, then the <command>smbd</command> server may +not be running. If you installed it in <filename>inetd.conf</filename>, then you probably edited +that file incorrectly. If you installed it as a daemon, then check that it is running, and check that the netbios-ssn port is in a LISTEN -state using <userinput>netstat -a</userinput>. +state using <command>netstat -a</command>. </para> <note><para> <indexterm><primary>inetd</primary></indexterm> <indexterm><primary>xinetd</primary><see>inetd</see></indexterm> -Some Unix / Linux systems use <command>xinetd</command> in place of +Some UNIX/Linux systems use <command>xinetd</command> in place of <command>inetd</command>. Check your system documentation for the location -of the control file/s for your particular system implementation of -this network super daemon. +of the control files for your particular system implementation of +the network super daemon. </para></note> <para> -If you get a <errorname>session request failed</errorname> 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;, +If you get a message saying <quote><errorname>session request failed</errorname></quote>, the server refused the +connection. If it says <quote>Your server software is being unfriendly</quote>, then +it's probably because you have invalid command line parameters to &smbd;, or a similar fatal problem with the initial startup of &smbd;. Also check your config file (&smb.conf;) for syntax errors with &testparm; -and that the various directories where samba keeps its log and lock +and that the various directories where Samba keeps its log and lock files exist. </para> <para> There are a number of reasons for which smbd may refuse or decline a session request. The most common of these involve one or more of -the following &smb.conf; file entries: +the &smb.conf; file entries as shown in <link linkend="modif1"/>. </para> -<para><smbconfblock> + +<para> +<smbconfexample id="modif1"> + <title>Configuration for only allowing connections from a certain subnet</title> +<smbconfsection>[globals]</smbconfsection> +<member>...</member> <smbconfoption><name>hosts deny</name><value>ALL</value></smbconfoption> <smbconfoption><name>hosts allow</name><value>xxx.xxx.xxx.xxx/yy</value></smbconfoption> +<smbconfoption><name>interfaces</name><value>eth0</value></smbconfoption> <smbconfoption><name>bind interfaces only</name><value>Yes</value></smbconfoption> -</smbconfblock></para> +<member>...</member> +</smbconfexample> +</para> <para> In the above, no allowance has been made for any session requests that will automatically translate to the loopback adapter address 127.0.0.1. -To solve this problem change these lines to: +To solve this problem, change these lines as shown in <link linkend="modif2"/>. </para> -<para><smbconfblock> +<para> +<smbconfexample id="modif2"> + <title>Configuration for allowing connections from a certain subnet and localhost</title> +<smbconfsection>[globals]</smbconfsection> +<member>...</member> <smbconfoption><name>hosts deny</name><value>ALL</value></smbconfoption> <smbconfoption><name>hosts allow</name><value>xxx.xxx.xxx.xxx/yy 127.</value></smbconfoption> -</smbconfblock></para> - -<para> -Do <emphasis>not</emphasis> use the <smbconfoption><name>bind interfaces only</name></smbconfoption> 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 <smbconfoption><name>bind interfaces only</name></smbconfoption> parameter deficiency -where it will not allow connections to the loopback address will be -fixed soon). +<smbconfoption><name>interfaces</name><value>eth0 lo</value></smbconfoption> +<member>...</member> +</smbconfexample> </para> <para> <indexterm><primary>inetd</primary></indexterm> Another common cause of these two errors is having something already running -on port <constant>139</constant>, such as Samba -(ie: &smbd; is running from <application>inetd</application> already) or +<indexterm><primary>smbclient</primary></indexterm> +on port <constant>139</constant>, such as Samba (&smbd; is running from <application>inetd</application> already) or something like Digital's Pathworks. Check your <filename>inetd.conf</filename> file before trying -to start &smbd; as a daemon, it can avoid a lot of frustration! +to start &smbd; as a daemon &smbmdash; it can avoid a lot of frustration! </para> <para> And yet another possible cause for failure of this test is when the subnet mask -and / or broadcast address settings are incorrect. Please check that the -network interface IP Address / Broadcast Address / Subnet Mask settings are +and/or broadcast address settings are incorrect. Please check that the +network interface IP Address/Broadcast Address/Subnet Mask settings are correct and that Samba has correctly noted these in the <filename>log.nmbd</filename> file. </para> @@ -250,19 +289,18 @@ correct and that Samba has correctly noted these in the <filename>log.nmbd</file <step performance="required"> <para> -Run the command <userinput>nmblookup -B BIGSERVER __SAMBA__</userinput>. You should get the -IP address of your Samba server back. +Run the command: <command>nmblookup -B BIGSERVER __SAMBA__</command>. +You should get back the IP address of your Samba server. </para> <para> -If you don't then nmbd is incorrectly installed. Check your <filename>inetd.conf</filename> -if you run it from there, or that the daemon is running and listening -to udp port 137. +If you do not, then nmbd is incorrectly installed. Check your <filename>inetd.conf</filename> +if you run it from there, or that the daemon is running and listening to udp port 137. </para> <para> One common problem is that many inetd implementations can't take many -parameters on the command line. If this is the case then create a +parameters on the command line. If this is the case, then create a one-line script that contains the right parameters and run that from inetd. </para> @@ -271,16 +309,18 @@ inetd. <step performance="required"> -<para>run the command <userinput>nmblookup -B ACLIENT '*'</userinput></para> +<para> +Run the command: <command>nmblookup -B ACLIENT `*'</command> +</para> <para> -You should get the PCs IP address back. If you don't then the client +You should get the PC's IP address back. If you do not then the client software on the PC isn't installed correctly, or isn't started, or you got the name of the PC wrong. </para> <para> -If ACLIENT doesn't resolve via DNS then use the IP address of the +If ACLIENT does not resolve via DNS then use the IP address of the client in the above test. </para> @@ -289,20 +329,20 @@ client in the above test. <step performance="required"> <para> -Run the command <userinput>nmblookup -d 2 '*'</userinput> +Run the command: <command>nmblookup -d 2 '*'</command> </para> <para> This time we are trying the same as the previous test but are trying it via a broadcast to the default broadcast address. A number of -NetBIOS / TCP/IP hosts on the network should respond, although Samba may +NetBIOS/TCP/IP hosts on the network should respond, although Samba may not catch all of the responses in the short time it listens. You -should see <errorname>got a positive name query response</errorname> +should see the <quote><errorname>got a positive name query response</errorname></quote> messages from several hosts. </para> <para> -If this doesn't give a similar result to the previous test then +If this does not give a similar result to the previous test, then nmblookup isn't correctly getting your broadcast address through its automatic mechanism. In this case you should experiment with the <smbconfoption><name>interfaces</name></smbconfoption> option in &smb.conf; to manually configure your IP @@ -310,9 +350,8 @@ address, broadcast and netmask. </para> <para> -If your PC and server aren't on the same subnet then you will need to -use the <option>-B</option> option to set the broadcast address to that of the PCs -subnet. +If your PC and server aren't on the same subnet, then you will need to use the +<option>-B</option> option to set the broadcast address to that of the PCs subnet. </para> <para> @@ -324,72 +363,69 @@ not correct. (Refer to TEST 3 notes above). <step performance="required"> -<indexterm><primary>smbclient</primary></indexterm> <para> -Run the command <userinput>smbclient //BIGSERVER/TMP</userinput>. You should +<indexterm><primary>smbclient</primary></indexterm> +Run the command: <command>smbclient //BIGSERVER/TMP</command>. 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 <option>-U <replaceable>accountname</replaceable></option> option to the end of -the command line. eg: -<userinput>smbclient //bigserver/tmp -Ujohndoe</userinput> +with which you are logged into the UNIX box. If you want to test with +another account, then add the <option>-U accountname</option> option to the end of +the command line. For example, <command>smbclient //bigserver/tmp -Ujohndoe</command>. </para> <note><para> -It is possible to specify the password along with the username -as follows: -<userinput>smbclient //bigserver/tmp -Ujohndoe%secret</userinput> +It is possible to specify the password along with the username as follows: +<command>smbclient //bigserver/tmp -Ujohndoe%secret</command>. </para></note> <para> -Once you enter the password you should get the <prompt>smb></prompt> prompt. If you -don't then look at the error message. If it says <errorname>invalid network -name</errorname> then the service <emphasis>"tmp"</emphasis> is not correctly setup in your &smb.conf;. +Once you enter the password, you should get the <prompt>smb></prompt> prompt. If you +do not, then look at the error message. If it says <quote><errorname>invalid network +name</errorname></quote>, then the service <smbconfsection>tmp</smbconfsection> is not correctly setup in your &smb.conf;. </para> <para> -If it says <errorname>bad password</errorname> then the likely causes are: +If it says <quote><errorname>bad password</errorname></quote>, then the likely causes are: </para> <orderedlist> <listitem> <para> - you have shadow passwords (or some other password system) but didn't - compile in support for them in &smbd; + You have shadow passwords (or some other password system) but didn't + compile in support for them in &smbd;. </para> </listitem> <listitem> <para> - your <smbconfoption><name>valid users</name></smbconfoption> configuration is incorrect + Your <smbconfoption><name>valid users</name></smbconfoption> configuration is incorrect. </para> </listitem> <listitem> <para> - you have a mixed case password and you haven't enabled the <smbconfoption><name>password level</name></smbconfoption> option at a high enough level + You have a mixed case password and you haven't enabled the <smbconfoption><name>password level</name></smbconfoption> option at a high enough level. </para> </listitem> <listitem> <para> - the <smbconfoption><name>path</name></smbconfoption> line in &smb.conf; is incorrect. Check it with &testparm; + The <smbconfoption><name>path</name></smbconfoption> line in &smb.conf; is incorrect. Check it with &testparm;. </para> </listitem> <listitem> <para> - you enabled password encryption but didn't map unix to samba users. Run <screen><userinput>smbpasswd -a <replaceable>username</replaceable></userinput></screen>. + You enabled password encryption but didn't map UNIX to Samba users. Run: + <command>smbpasswd -a username</command> </para> </listitem> </orderedlist> <para> -Once connected you should be able to use the commands -<command>dir</command> <command>get</command> <command>put</command> etc. -Type <command>help <replaceable>command</replaceable></command> for instructions. You should -especially check that the amount of free disk space shown is correct -when you type <command>dir</command>. +Once connected, you should be able to use the commands <command>dir</command>, <command>get</command>, +<command>put</command> and so on. Type <command>help command</command> for instructions. You should +especially check that the amount of free disk space shown is correct when you type <command>dir</command>. </para> </step> @@ -397,58 +433,56 @@ when you type <command>dir</command>. <step performance="required"> <para> -On the PC, type the command <userinput>net view \\BIGSERVER</userinput>. You will -need to do this from within a "dos prompt" window. You should get back a -list of available shares on the server. +On the PC, type the command <command>net view \\BIGSERVER</command>. You will +need to do this from within a dos prompt window. You should get back a +list of shares available on the server. </para> <para> -If you get a <errorname>network name not found</errorname> 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): +If you get a message <quote><errorname>network name not found</errorname></quote> or similar error, then netbios +name resolution is not working. This is usually caused by a problem in <command>nmbd</command>. +To overcome it, you could do one of the following (you only need to choose one of them): </para> <orderedlist> <listitem><para> - fixup the &nmbd; installation + Fixup the &nmbd; installation. </para></listitem> <listitem><para> - add the IP address of BIGSERVER to the <command>wins server</command> box in the + Add the IP address of BIGSERVER to the <command>wins server</command> box in the advanced TCP/IP setup on the PC. </para></listitem> <listitem><para> - enable windows name resolution via DNS in the advanced section of - the TCP/IP setup + Enable Windows name resolution via DNS in the advanced section of the TCP/IP setup. </para></listitem> <listitem><para> - add BIGSERVER to your lmhosts file on the PC. + Add BIGSERVER to your lmhosts file on the PC. </para></listitem> </orderedlist> <para> -If you get a <errorname>invalid network name</errorname> or <errorname>bad password error</errorname> then the -same fixes apply as they did for the <userinput>smbclient -L</userinput> test above. In -particular, make sure your <command>hosts allow</command> line is correct (see the man -pages) +If you get a message <quote><errorname>invalid network name</errorname></quote> or +<quote><errorname>bad password error</errorname></quote>, then apply the +same fixes as for the <command>smbclient -L</command> test above. In +particular, make sure your <command>hosts allow</command> line is correct (see the man pages). </para> <para> Also, do not overlook that fact that when the workstation requests the -connection to the samba server it will attempt to connect using the +connection to the Samba server, it will attempt to connect using the name with which you logged onto your Windows machine. You need to make sure that an account exists on your Samba server with that exact same name and password. </para> <para> -If you get <errorname>specified computer is not receiving requests</errorname> or similar -it probably means that the host is not contactable via tcp services. -Check to see if the host is running tcp wrappers, and if so add an entry in -the <filename>hosts.allow</filename> file for your client (or subnet, etc.) +If you get a message <quote><errorname>specified computer is not receiving requests</errorname></quote> or similar, +it probably means that the host is not contactable via TCP services. +Check to see if the host is running TCP wrappers, and if so add an entry in +the <filename>hosts.allow</filename> file for your client (or subnet, and so on.) </para> </step> @@ -456,25 +490,27 @@ the <filename>hosts.allow</filename> file for your client (or subnet, etc.) <step performance="required"> <para> -Run the command <userinput>net use x: \\BIGSERVER\TMP</userinput>. You should -be prompted for a password then you should get a <computeroutput>command completed -successfully</computeroutput> message. If not then your PC software is incorrectly -installed or your smb.conf is incorrect. make sure your <command>hosts allow</command> +Run the command <command>net use x: \\BIGSERVER\TMP</command>. You should +be prompted for a password, then you should get a <computeroutput>command completed +successfully</computeroutput> message. If not, then your PC software is incorrectly +installed or your &smb.conf; is incorrect. Make sure your <parameter>hosts allow</parameter> and other config lines in &smb.conf; are correct. </para> <para> -It's also possible that the server can't work out what user name to -connect you as. To see if this is the problem add the line <smbconfoption><name>user</name><value>username</value></smbconfoption> to the <smbconfsection>[tmp]</smbconfsection> section of -&smb.conf; where <replaceable>username</replaceable> is the +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 +<smbconfoption><name>user</name><value>username</value></smbconfoption> to the +<smbconfsection>[tmp]</smbconfsection> section of +&smb.conf; where <parameter>username</parameter> is the username corresponding to the password you typed. If you find this -fixes things you may need the username mapping option. +fixes things, you may need the username mapping option. </para> <para> It might also be the case that your client only sends encrypted passwords -and you have <smbconfoption><name>encrypt passwords</name><value>no</value></smbconfoption> in &smb.conf; -Turn it back on to fix. +and you have <smbconfoption><name>encrypt passwords</name><value>no</value></smbconfoption> in &smb.conf;. +Change this to "yes" to fix this. </para> </step> @@ -482,16 +518,16 @@ Turn it back on to fix. <step performance="required"> <para> -Run the command <userinput>nmblookup -M <replaceable>testgroup</replaceable></userinput> where -<replaceable>testgroup</replaceable> is the name of the workgroup that your Samba server and +Run the command <command>nmblookup -M <parameter>testgroup</parameter></command> where +<parameter>testgroup</parameter> is the name of the workgroup that your Samba server and Windows PCs belong to. You should get back the IP address of the master browser for that workgroup. </para> <para> -If you don't then the election process has failed. Wait a minute to -see if it is just being slow then try again. If it still fails after -that then look at the browsing options you have set in &smb.conf;. Make +If you do not, then the election process has failed. Wait a minute to +see if it is just being slow, then try again. If it still fails after +that, then look at the browsing options you have set in &smb.conf;. Make sure you have <smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> to ensure that an election is held at startup. </para> @@ -501,17 +537,17 @@ an election is held at startup. <step performance="required"> <para> -From file manager try to browse the server. Your samba server should +>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 the error message <quote>invalid password</quote>, + you are probably running Windows NT and it is refusing to browse a server that has no encrypted password -capability and is in user level security mode. In this case either set -<smbconfoption><name>security</name><value>server</value></smbconfoption> AND +capability and is in User Level Security mode. In this case, either set +<smbconfoption><name>security</name><value>server</value></smbconfoption> and <smbconfoption><name>password server</name><value>Windows_NT_Machine</value></smbconfoption> in your &smb.conf; file, or make sure <smbconfoption><name>encrypt passwords</name></smbconfoption> is -set to "yes". +set to <quote>yes</quote>. </para> </step> diff --git a/docs/docbook/projdoc/Further-Resources.xml b/docs/docbook/projdoc/Further-Resources.xml index d8905cc659..8d73028e16 100644 --- a/docs/docbook/projdoc/Further-Resources.xml +++ b/docs/docbook/projdoc/Further-Resources.xml @@ -13,7 +13,7 @@ <listitem><para> <ulink url="http://hr.uoregon.edu/davidrl/cifs.txt"> - <emphasis>CIFS: Common Insecurities Fail Scrutiny</emphasis> by "Hobbit"</ulink> + <emphasis>CIFS: Common Insecurities Fail Scrutiny</emphasis> by <quote>Hobbit</quote></ulink> </para></listitem> <listitem><para> @@ -48,7 +48,7 @@ <listitem><para> <ulink url="http://www.phrack.org/phrack/60/p60-0x0b.txt"> - <emphasis>SMB/CIFS by The Root</emphasis> by "ledin" + <emphasis>SMB/CIFS by The Root</emphasis> by <quote>ledin</quote> </ulink> </para></listitem> @@ -91,7 +91,7 @@ <listitem><para> <ulink url="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html"> - <emphasis>Introduction to Samba 3.0</emphasis> by Motonobu Takahashi + <emphasis>Introduction to Samba-3.0</emphasis> by Motonobu Takahashi (written in Japanese). </ulink> </para></listitem> @@ -140,13 +140,6 @@ </ulink> </para></listitem> - <listitem><para> - <ulink url="http://www2.sphaero.org/docs/#W2K"> - <emphasis>W2K Samba deploy HOWTO</emphasis> - by Arnaud Loonstra - </ulink> - </para></listitem> - </itemizedlist> </sect1> diff --git a/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml index 076b870609..3e7dca6358 100644 --- a/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml +++ b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml @@ -1,29 +1,35 @@ <?xml version="1.0" encoding="iso8859-1"?> <chapter id="groupmapping"> <chapterinfo> + &author.jht; <author> <firstname>Jean François</firstname><surname>Micouleau</surname> </author> &author.jerry; - &author.jht; </chapterinfo> -<title>Mapping MS Windows and UNIX Groups</title> +<title>Group Mapping &smbmdash; MS Windows and UNIX</title> -<indexterm significance="preferred"><primary>groups</primary><secondary>mapping</secondary></indexterm> <para> +<indexterm significance="preferred"><primary>groups</primary><secondary>mapping</secondary></indexterm> Starting with Samba-3, new group mapping functionality is available to create associations between Windows group SIDs and UNIX groups. The <command>groupmap</command> subcommand included with the &net; tool can be used to manage these associations. </para> + <para> + The new facility for mapping NT Groups to UNIX system groups allows the administrator to decide + which NT Domain Groups are to be exposed to MS Windows clients. Only those NT Groups that map + to a UNIX group that has a value other than the default (<constant>-1</constant>) will be exposed + in group selection lists in tools that access domain users and groups. + </para> + <warning> <para> - The first immediate reason to use the group mapping on a Samba PDC, is that <indexterm><primary>domain admin group</primary></indexterm> - the <parameter>domain admin group</parameter> has been removed and should no longer - be specified in &smb.conf;. This parameter was used to give the listed users membership - in the <constant>Domain Admins</constant> Windows group which gave local admin rights on their workstations + The <parameter>domain admin group</parameter> parameter has been removed in Samba-3 and should no longer + be specified in &smb.conf;. This parameter was used to give the listed users membership in the + <constant>Domain Admins</constant> Windows group which gave local admin rights on their workstations (in default configurations). </para> </warning> @@ -32,56 +38,76 @@ <title>Features and Benefits</title> <para> - Samba allows the administrator to create MS Windows NT4 / 200x group accounts and to + Samba allows the administrator to create MS Windows NT4/200x group accounts and to arbitrarily associate them with UNIX/Linux group accounts. </para> + <para> <indexterm><primary>UID</primary></indexterm> <indexterm><primary>GID</primary></indexterm> - <para> - Group accounts can be managed using the MS Windows NT4 or MS Windows 200x / XP Professional MMC tools. - Appropriate interface scripts should be provided in &smb.conf; if it is desired that UNIX / Linux system + Group accounts can be managed using the MS Windows NT4 or MS Windows 200x/XP Professional MMC tools. + Appropriate interface scripts should be provided in &smb.conf; if it is desired that UNIX/Linux system accounts should be automatically created when these tools are used. In the absence of these scripts, and - so long as winbind is running, Samba accounts group accounts that are created using these tools will be - allocated UNIX UIDs/GIDs from the parameters set by the <smbconfoption><name>idmap uid</name></smbconfoption>/<smbconfoption><name>idmap gid</name></smbconfoption> settings - in the &smb.conf; file. + so long as <command>winbindd</command> is running, Samba group accounts that are created using these + tools will be allocated UNIX UIDs/GIDs from the ID range specified by the + <smbconfoption><name>idmap uid</name></smbconfoption>/<smbconfoption><name>idmap gid</name></smbconfoption> + parameters in the &smb.conf; file. </para> + <figure id="idmap-sid2gid"><title>IDMAP: group SID to GID resolution.</title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-sid2gid" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap-sid2gid.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> + </figure> - <figure id="idmap-group-diag"><title>IDMAP groups</title> + <figure id="idmap-gid2sid"><title>IDMAP: GID resolution to matching SID.</title> <mediaobject> - <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-groups" scale="50" scalefit="1"/></imageobject> - <imageobject><imagedata fileref="projdoc/imagefiles/idmap-groups.png" scale="50" scalefit="1"/></imageobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-gid2sid" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap-gid2sid.png" scale="50" scalefit="1"/></imageobject> + </mediaobject> + </figure> + + <para> + In both cases, when winbindd is not running, only locally resolvable groups can be recognized. Please refer to + <link linkend="idmap-sid2gid"></link> and <link linkend="idmap-gid2sid"></link>. The <command>net groupmap</command> is + used to establish UNIX group to NT SID mappings as shown in <link linkend="idmap-store-gid2sid"></link>. + </para> + + <figure id="idmap-store-gid2sid"><title>IDMAP storing group mappings.</title> + <mediaobject> + <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap-store-gid2sid" scale="50" scalefit="1"/></imageobject> + <imageobject><imagedata fileref="projdoc/imagefiles/idmap-store-gid2sid.png" scale="50" scalefit="1"/></imageobject> </mediaobject> </figure> - <indexterm><primary>groupadd</primary></indexterm> - <indexterm><primary>groupdel</primary></indexterm> <para> + <indexterm><primary>groupadd</primary></indexterm> + <indexterm><primary>groupdel</primary></indexterm> Administrators should be aware that where &smb.conf; group interface scripts make - direct calls to the UNIX/Linux system tools (eg: the shadow utilities, <command>groupadd</command>, - <command>groupdel</command>, <command>groupmod</command>) 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 + direct calls to the UNIX/Linux system tools (the shadow utilities, <command>groupadd</command>, + <command>groupdel</command>, and <command>groupmod</command>), 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 <ntgroup>Engineering Managers</ntgroup> will attempt to create an identically named - UNIX/Linux group, an attempt that will of course fail! + UNIX/Linux group, an attempt that will of course fail. </para> - <indexterm><primary>GID</primary></indexterm> - <indexterm><primary>SID</primary></indexterm> <para> + <indexterm><primary>GID</primary></indexterm> + <indexterm><primary>SID</primary></indexterm> 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) + 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. </para> <para> 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 <command>net groupmap</command> + MS Windows NT4/200x group on the Samba server and then use the <command>net groupmap</command> tool to connect the two to each other. </para> @@ -91,39 +117,41 @@ <title>Discussion</title> <para> - When installing <application>MS Windows NT4 / 200x</application> on a computer, the installation + When installing <application>MS Windows NT4/200x</application> on a computer, the installation program creates default users and groups, notably the <constant>Administrators</constant> group, - and gives that group privileges necessary privileges to perform essential system tasks. - eg: Ability to change the date and time or to kill (or close) any process running on the + and gives that group privileges necessary privileges to perform essential system tasks, + such as the ability to change the date and time or to kill (or close) any process running on the local machine. </para> - <indexterm><primary>Administrator</primary></indexterm> <para> - 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'. + <indexterm><primary>Administrator</primary></indexterm> + The <constant>Administrator</constant> user is a member of the <constant>Administrators</constant> group, and thus inherits + <constant>Administrators</constant> group privileges. If a <constant>joe</constant> user is created to be a member of the + <constant>Administrators</constant> group, <constant>joe</constant> has exactly the same rights as the user, + <constant>Administrator</constant>. </para> <para> - When an MS Windows NT4 / W200x is made a domain member, the "Domain Admins" 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 + When an MS Windows NT4/200x/XP machine is made a Domain Member, the <quote>Domain Admins</quote> group of the + PDC is added to the local <constant>Administrators</constant> group of the workstation. Every member of the + <constant>Domain Administrators</constant> group inherits the rights of the local <constant>Administrators</constant> group when logging on the workstation. </para> <para> - The following steps describe how to make Samba PDC users members of the 'Domain Admins' group? + The following steps describe how to make Samba PDC users members of the <constant>Domain Admins</constant> group? </para> <orderedlist> <listitem><para> - create a unix group (usually in <filename>/etc/group</filename>), let's call it domadm + Create a UNIX group (usually in <filename>/etc/group</filename>), let's call it <constant>domadm</constant>. </para></listitem> - <listitem><para>add to this group the users that must be Administrators. For example - if you want joe, john and mary, your entry in <filename>/etc/group</filename> will - look like: + <listitem><para> + Add to this group the users that must be <quote>Administrators</quote>. For example, + if you want <constant>joe, john</constant> and <constant>mary</constant> to be administrators, + your entry in <filename>/etc/group</filename> will look like this: </para> <para><programlisting> @@ -132,60 +160,252 @@ </para></listitem> <listitem><para> - Map this domadm group to the "Domain Admins" group by running the command: + Map this domadm group to the <quote>Domain Admins</quote> group by running the command: </para> <para> -<screen> -&rootprompt;<userinput>net groupmap add ntgroup="Domain Admins" unixgroup=domadm</userinput> -</screen> - </para> + <screen> + &rootprompt;<userinput>net groupmap add ntgroup=<quote>Domain Admins</quote> UNIXgroup=domadm</userinput> + </screen> + </para> - <indexterm><primary>"Domain Admins" group</primary></indexterm> <para> - The quotes around "Domain Admins" are necessary due to the space in the group name. - Also make sure to leave no whitespace surrounding the equal character (=). + <indexterm><primary>Domain Admins group</primary></indexterm> + The quotes around <quote>Domain Admins</quote> are necessary due to the space in the group name. + Also make sure to leave no white-space surrounding the equal character (=). </para></listitem> </orderedlist> <para> - Now joe, john and mary are domain administrators! + Now <constant>joe, john</constant> and <constant>mary</constant> are domain administrators. </para> - <indexterm><primary>groups</primary><secondary>domain</secondary></indexterm> <para> - 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, + <indexterm><primary>groups</primary><secondary>domain</secondary></indexterm> + 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 an ACL on a local file or printer on a Domain Member machine, you would flag that group as a domain group by running the following on the Samba PDC: </para> <para> <screen> -&rootprompt;<userinput>net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct</userinput> +&rootprompt;<userinput>net groupmap add rid=1000 ntgroup="Accounting" UNIXgroup=acct</userinput> </screen> </para> <para> - Be aware that the RID parameter 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 the passdb backend - you are using. Future versions of the tools may perform the verification automatically, + Be aware that the RID parameter 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. Verification for this is done differently depending on the passdb backend + you are using. Future versions of the tools may perform the verification automatically, but for now the burden is on you. </para> <sect2> + <title>Default Users, Groups and Relative Identifiers</title> + + <para> +<indexterm><primary>Relative Identifier</primary><see>RID</see></indexterm> +<indexterm><primary>RID</primary></indexterm> + When first installed, Microsoft Windows NT4/200x/XP are preconfigured with certain User, Group, and + Alias entities. Each has a well-known Relative Identifier (RID). These must be preserved for continued + integrity of operation. Samba must be provisioned with certain essential Domain Groups that require + the appropriate RID value. When Samba-3 is configured to use <constant>tdbsam</constant> the essential + Domain Groups are automatically created. It is the LDAP administrators' responsibility to create + (provision) the default NT Groups. + </para> + + <para> + Each essential Domain Group must be assigned its respective well-kown RID. The default Users, Groups, + Aliases, and RIDs are shown in <link linkend="WKURIDS"/>. + </para> + + <para><note> + When the <parameter>passdb backend</parameter> uses LDAP (<constant>ldapsam</constant>) it is the + admininstrators' responsibility to create the essential Domain Groups, and to assign each its default RID. + </note></para> + + <para> + It is permissible to create any Domain Group that may be necessary, just make certain that the essential + Domain Groups (well known) have been created and assigned its default RID. Other groups you create may + be assigned any arbitrary RID you care to use. + </para> + + <para> + Be sure to map each Domain Group to a UNIX system group. That is the only way to ensure that the group + will be available for use as an NT Domain Group. + </para> + + <para> + <table frame="all" id="WKURIDS"> + <title>Well-Known User Default RIDs</title> + <tgroup cols="4" align="left"> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="left"/> + <colspec align="center"/> + <thead> + <row> + <entry>Well-Known Entity</entry> + <entry>RID</entry> + <entry>Type</entry> + <entry>Essential</entry> + </row> + </thead> + <tbody> + <row> + <entry>Domain Administrator</entry> + <entry>500</entry> + <entry>User</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Guest</entry> + <entry>501</entry> + <entry>User</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain KRBTGT</entry> + <entry>502</entry> + <entry>User</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Admins</entry> + <entry>512</entry> + <entry>Group</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Domain Users</entry> + <entry>513</entry> + <entry>Group</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Domain Guests</entry> + <entry>514</entry> + <entry>Group</entry> + <entry>Yes</entry> + </row> + <row> + <entry>Domain Computers</entry> + <entry>515</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Controllers</entry> + <entry>516</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Certificate Admins</entry> + <entry>517</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Schema Admins</entry> + <entry>518</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Enterprise Admins</entry> + <entry>519</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Domain Policy Admins</entry> + <entry>520</entry> + <entry>Group</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Admins</entry> + <entry>544</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin users</entry> + <entry>545</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Guests</entry> + <entry>546</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Power Users</entry> + <entry>547</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Account Operators</entry> + <entry>548</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin System Operators</entry> + <entry>549</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Print Operators</entry> + <entry>550</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Backup Operators</entry> + <entry>551</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin Replicator</entry> + <entry>552</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + <row> + <entry>Builtin RAS Servers</entry> + <entry>553</entry> + <entry>Alias</entry> + <entry>No</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + + </sect2> + + <sect2> <title>Example Configuration</title> <para> - You can list the various groups in the mapping database by executing - <command>net groupmap list</command>. Here is an example: + You can list the various groups in the mapping database by executing + <command>net groupmap list</command>. Here is an example: </para> +<indexterm><primary>net</primary><secondary>groupmap</secondary></indexterm> + <para> <screen> &rootprompt; <userinput>net groupmap list</userinput> -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 @@ -205,18 +425,20 @@ Domain Guests (S-1-5-21-2547222302-1596225915-2414751004-514) -> domguest <para> 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). + (i.e., prepared by someone else for general use). </para> <sect2> - <title>Sample &smb.conf; add group script</title> + <title>Sample &smb.conf; Add Group Script</title> <para> - A script to create complying group names for use by the Samba group interfaces: + A script to create complying group names for use by the Samba group interfaces + is provided in <link linkend="smbgrpadd.sh"></link>. </para> +<indexterm><primary>smbgrpadd.sh</primary></indexterm> <para> -<example> +<example id="smbgrpadd.sh"> <title>smbgrpadd.sh</title> <programlisting> @@ -239,47 +461,49 @@ exit 0 </para> <para> - The &smb.conf; entry for the above script would look like: - <smbconfblock> + The &smb.conf; entry for the above script would be something like that in <link linkend="smbgrpadd"/>. +<smbconfexample id="smbgrpadd"> +<title>Configuration of &smb.conf; for the add group script.</title> +<smbconfsection>[global]</smbconfsection> +<member>...</member> <smbconfoption><name>add group script</name><value>/path_to_tool/smbgrpadd.sh %g</value></smbconfoption> - </smbconfblock> +<member>...</member> +</smbconfexample> </para> </sect2> <sect2> - <title>Script to configure Group Mapping</title> + <title>Script to Configure Group Mapping</title> <para> In our example we have created a UNIX/Linux group called <ntgroup>ntadmin</ntgroup>. - Our script will create the additional groups <ntgroup>Orks</ntgroup>, <ntgroup>Elves</ntgroup>, <ntgroup>Gnomes</ntgroup>: + Our script will create the additional groups <ntgroup>Orks</ntgroup>, <ntgroup>Elves</ntgroup>, and <ntgroup>Gnomes</ntgroup>. + It is a good idea to save this shell script for later re-use just in case you ever need to rebuild your mapping database. + For the sake of concenience we elect to save this script as a file called <filename>initGroups.sh</filename>. + This script is given in <link linkend="set-group-map"></link>. </para> <para> +<indexterm><primary>initGroups.sh</primary></indexterm> +<example id="set-group-map"> + <title>Script to Set Group Mapping</title> <programlisting> #!/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 Orks groupadd Elves groupadd Gnomes -net groupmap add ntgroup="Orks" unixgroup=Orks type=d -net groupmap add ntgroup="Elves" unixgroup=Elves type=d -net groupmap add ntgroup="Gnomes" unixgroup=Gnomes type=d +net groupmap add ntgroup="Orks" unixgroup=Orks type=d +net groupmap add ntgroup="Elves" unixgroup=Elves type=d +net groupmap add ntgroup="Gnomes" unixgroup=Gnomes type=d </programlisting> +</example> </para> <para> @@ -316,10 +540,10 @@ manually before putting them into active service. </para> <para> - There are three possible work-arounds. Firstly, use only group names that comply + There are three possible work-arounds. First, use only group names that comply with the limitations of the UNIX/Linux <command>groupadd</command> 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 + Second, it involves the use of the script mentioned earlier in this chapter, and + third is the option is to manually create a UNIX/Linux group account that can substitute for the MS Windows group name, then use the procedure listed above to map that group to the MS Windows group. </para> @@ -332,35 +556,68 @@ manually before putting them into active service. <indexterm><primary>groups</primary><secondary>nested</secondary></indexterm> <para> - Samba-3 does NOT support nested groups from the MS Windows control environment. + Samba-3 does not support nested groups from the MS Windows control environment. </para> </sect2> <sect2> - <title>Adding <emphasis>Domain Users</emphasis> to the <emphasis>Power Users</emphasis> group</title> + <title>Adding <emphasis>Domain Users</emphasis> to the <emphasis>Power Users</emphasis> Group</title> <para><quote> What must I do to add Domain Users to the Power Users group? </quote></para> +<indexterm><primary>Domain Users group</primary></indexterm> + <para> - The Power Users group is a group that is local to each Windows - 200x / XP Professional workstation. You can not add the Domain Users group to the Power Users - group automatically, this must be done on each workstation by logging in as the local workstation - <emphasis>administrator</emphasis> and then using click on Start / Control Panel / Users and Passwords - now click on the 'Advanced' tab, then on the 'Advanced' Button. + The Power Users group is a group that is local to each Windows 200x/XP Professional workstation. + You cannot add the Domain Users group to the Power Users group automatically, it must be done on + each workstation by logging in as the local workstation <emphasis>administrator</emphasis> and + then using the following procedure: </para> -<indexterm><primary>"Domain Users" group</primary></indexterm> - <para> - Now click on 'Groups', then double click on 'Power Users'. This will launch the panel to add users - or groups to the local machine 'Power Uses' group. Click on the 'Add' button, select the domain - from which the 'Domain Users' group is to be added, double click on the 'Domain Users' group, then - click on the 'Ok' button. Note: If a logon box is presented during this process please remember to - enter the connect as DOMAIN\UserName. ie: For the domain MIDEARTH and the user 'root' enter - MIDEARTH\root. - </para> + <procedure> + <step><para> + Click <guimenu>Start -> Control Panel -> Users and Passwords</guimenu>. + </para></step> + + <step><para> + Click the <guimenuitem>Advanced</guimenuitem> tab. + </para></step> + + <step><para> + Click the <guibutton>Advanced</guibutton> button. + </para></step> + + <step><para> + Click <constant>Groups</constant>. + </para></step> + + <step><para> + Double click <constant>Power Users</constant>. This will launch the panel to add users or groups + to the local machine <constant>Power Uses</constant> group. + </para></step> + + <step><para> + Click the <guibutton>Add</guibutton> button. + </para></step> + + <step><para> + Select the domain from which the <constant>Domain Users</constant> group is to be added. + </para></step> + + <step><para> + Double click the <constant>Domain Users</constant> group. + </para></step> + + <step><para> + Click the <guibutton>Ok</guibutton> button. If a logon box is presented during this process + please remember to enter the connect as <constant>DOMAIN\UserName</constant>. i.e., For the + domain <constant>MIDEARTH</constant> and the user <constant>root</constant> enter + <constant>MIDEARTH\root</constant>. + </para></step> + </procedure> </sect2> </sect1> diff --git a/docs/docbook/projdoc/Integrating-with-Windows.xml b/docs/docbook/projdoc/Integrating-with-Windows.xml index 6beebfb892..ae78e20276 100644 --- a/docs/docbook/projdoc/Integrating-with-Windows.xml +++ b/docs/docbook/projdoc/Integrating-with-Windows.xml @@ -5,23 +5,24 @@ <pubdate> (Jan 01 2001) </pubdate> </chapterinfo> -<title>Integrating MS Windows networks with Samba</title> +<title>Integrating MS Windows Networks with Samba</title> -<indexterm><primary>NetBIOS</primary></indexterm> <para> +<indexterm><primary>NetBIOS</primary></indexterm> 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 +your MS Windows clients are not configured to use NetBIOS over TCP/IP, then this +section does not apply to your installation. If your installation +involves the use of NetBIOS over TCP/IP then this section may help you to resolve networking problems. </para> <note> <para> - NetBIOS over TCP/IP has nothing to do with NetBEUI. NetBEUI is NetBIOS - over Logical Link Control (LLC). On modern networks it is highly advised - to NOT run NetBEUI at all. Note also that there is NO such thing as - NetBEUI over TCP/IP - the existence of such a protocol is a complete - and utter mis-apprehension. +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 there is no such thing as +NetBEUI over TCP/IP &smbmdash; the existence of such a protocol is a complete +and utter misapprehension. </para> </note> @@ -31,13 +32,13 @@ NetBIOS over TCP/IP then this section may help you to resolve networking problem <para> Many MS Windows network administrators have never been exposed to basic TCP/IP networking as it is implemented in a UNIX/Linux operating system. Likewise, many UNIX and -Linux administrators have not been exposed to the intricacies of MS Windows TCP/IP based +Linux administrators have not been exposed to the intricacies of MS Windows TCP/IP-based networking (and may have no desire to be either). </para> <para> 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. +its IP address for each operating system environment. </para> </sect1> @@ -46,35 +47,35 @@ it's IP address for each operating system environment. <title>Background Information</title> <para> -Since the introduction of MS Windows 2000 it is possible to run MS Windows networking +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. +TCP/IP is disabled on MS Windows 2000 and later clients, then only the TCP port 445 will be +used and the UDP port 137 and TCP port 139 will not. </para> <note> <para> -When using Windows 2000 or later clients, if NetBIOS over TCP/IP is NOT disabled, then +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). +Name Service or WINS), TCP port 139 and TCP port 445 (for actual file and print traffic). </para> </note> <para> -When NetBIOS over TCP/IP is disabled the use of DNS is essential. Most installations that +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 <indexterm><primary>DNS</primary><secondary>Dynamic</secondary></indexterm> Dynamic DNS with Service Resource Records (SRV RR) and with Incremental Zone Transfers (IXFR). <indexterm><primary>DHCP</primary></indexterm> Use of DHCP with ADS is recommended as a further means of maintaining central control -over client workstation network configuration. +over the client workstation network configuration. </para> </sect1> <sect1> -<title>Name Resolution in a pure UNIX/Linux world</title> +<title>Name Resolution in a Pure UNIX/Linux World</title> <para> The key configuration files covered in this section are: @@ -91,64 +92,62 @@ The key configuration files covered in this section are: <title><filename>/etc/hosts</filename></title> <para> -Contains a static list of IP addresses and names. -eg: +This file contains a static list of IP addresses and names. </para> <para><programlisting> 127.0.0.1 localhost localhost.localdomain -192.168.1.1 bigbox.caldera.com bigbox alias4box +192.168.1.1 bigbox.quenya.org bigbox alias4box </programlisting></para> <para> The purpose of <filename>/etc/hosts</filename> is to provide a -name resolution mechanism so that uses do not need to remember +name resolution mechanism so uses do not need to remember IP addresses. </para> - <para> Network packets that are sent over the physical network transport layer communicate not via IP addresses but rather using the Media Access Control address, or MAC address. IP addresses are currently 32 bits in length and are typically presented as four (4) decimal -numbers that are separated by a dot (or period). eg: 168.192.1.1. +numbers that are separated by a dot (or period). For example, 168.192.1.1. </para> -<indexterm><primary>MAC Addresses</primary></indexterm> <para> +<indexterm><primary>MAC Addresses</primary></indexterm> 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 +as two-digit hexadecimal numbers separated by colons: 40:8e:0a:12:34:56. </para> <para> -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 arbitrary or discretionary in nature. At the most basic level all -network communications takes place using MAC addressing. Since MAC -addresses must be globally unique, and generally remains fixed for +Every network interface must have a MAC address. Associated with +a MAC address may be one or more IP addresses. There is no +relationship between an IP address and a MAC address; all such assignments +are arbitrary or discretionary in nature. At the most basic level, all +network communications take place using MAC addressing. Since MAC +addresses must be globally unique and generally remain fixed for any particular interface, the assignment of an IP address makes sense from a network management perspective. More than one IP address can -be assigned per MAC address. One address must be the primary IP address, +be assigned per MAC address. One address must be the primary IP +address &smbmdash; this is the address that will be returned in the ARP reply. </para> <para> -When a user or a process wants to communicate with another machine -the protocol implementation ensures that the "machine name" or "host -name" is resolved to an IP address in a manner that is controlled +When a user or a process wants to communicate with another machine, +the protocol implementation ensures that the <quote>machine name</quote> or <quote>host +name</quote> is resolved to an IP address in a manner that is controlled by the TCP/IP configuration control files. The file <filename>/etc/hosts</filename> is one such file. </para> <para> When the IP address of the destination interface has been -determined a protocol called ARP/RARP is used to identify +determined, a protocol called ARP/RARP is used to identify the MAC address of the target interface. ARP stands for Address -Resolution Protocol, and is a broadcast oriented method that -uses UDP (User Datagram Protocol) to send a request to all -interfaces on the local network segment using the all 1's MAC +Resolution Protocol and is a broadcast-oriented method that +uses User Datagram Protocol (UDP) to send a request to all +interfaces on the local network segment using the all 1s MAC address. Network interfaces are programmed to respond to two MAC addresses only; their own unique address and the address ff:ff:ff:ff:ff:ff. The reply packet from an ARP request will @@ -156,13 +155,13 @@ contain the MAC address and the primary IP address for each interface. </para> -<indexterm><primary>/etc/hosts</primary></indexterm> <para> +<indexterm><primary>/etc/hosts</primary></indexterm> The <filename>/etc/hosts</filename> file is foundational to all UNIX/Linux TCP/IP installations and as a minimum will contain the localhost and local network interface IP addresses and the primary names by which they are known within the local machine. -This file helps to prime the pump so that a basic level of name +This file helps to prime the pump so a basic level of name resolution can exist before any other method of name resolution becomes available. </para> @@ -179,17 +178,17 @@ This file tells the name resolution libraries: <itemizedlist> <listitem><para>The name of the domain to which the machine - belongs + belongs. </para></listitem> <listitem><para>The name(s) of any domains that should be automatically searched when trying to resolve unqualified - host names to their IP address + host names to their IP address. </para></listitem> <listitem><para>The name or IP address of available Domain - Name Servers that may be asked to perform name to address - translation lookups + Name Servers that may be asked to perform name-to-address + translation lookups. </para></listitem> </itemizedlist> @@ -200,11 +199,11 @@ This file tells the name resolution libraries: <title><filename>/etc/host.conf</filename></title> -<indexterm><primary>/etc/host.conf</primary></indexterm> <para> +<indexterm><primary>/etc/host.conf</primary></indexterm> <filename>/etc/host.conf</filename> is the primary means by -which the setting in /etc/resolv.conf may be affected. It is a -critical configuration file. This file controls the order by +which the setting in <filename>/etc/resolv.conf</filename> may be effected. It is a +critical configuration file. This file controls the order by which name resolution may proceed. The typical structure is: </para> @@ -215,7 +214,7 @@ multi on <para> then both addresses should be returned. Please refer to the -man page for host.conf for further details. +man page for <filename>host.conf</filename> for further details. </para> @@ -226,9 +225,9 @@ man page for host.conf for further details. <sect2> <title><filename>/etc/nsswitch.conf</filename></title> -<indexterm><primary>/etc/nsswitch.conf</primary></indexterm> <para> +<indexterm><primary>/etc/nsswitch.conf</primary></indexterm> This file controls the actual name resolution targets. The file typically has resolver object specifications as follows: </para> @@ -264,25 +263,25 @@ facilities and/or services are correctly configured. <para> It should be noted that unless a network request/message must be -sent, TCP/IP networks are silent. All TCP/IP communications assumes a +sent, TCP/IP networks are silent. All TCP/IP communications assume a principal of speaking only when necessary. </para> -<indexterm><primary>libnss_wins.so</primary></indexterm> <para> -Starting with version 2.2.0 samba has Linux support for extensions to -the name service switch infrastructure so that linux clients will +<indexterm><primary>libnss_wins.so</primary></indexterm> +Starting with version 2.2.0, Samba has Linux support for extensions to +the name service switch infrastructure so Linux clients will be able to obtain resolution of MS Windows NetBIOS names to IP -Addresses. To gain this functionality Samba needs to be compiled -with appropriate arguments to the make command (i.e.: <userinput>make +Addresses. To gain this functionality, Samba needs to be compiled +with appropriate arguments to the make command (i.e., <userinput>make nsswitch/libnss_wins.so</userinput>). The resulting library should then be installed in the <filename>/lib</filename> directory and -the "wins" parameter needs to be added to the "hosts:" line in -the <filename>/etc/nsswitch.conf</filename> file. At this point it +the <parameter>wins</parameter> parameter needs to be added to the <quote>hosts:</quote> line in +the <filename>/etc/nsswitch.conf</filename> file. At this point, it will be possible to ping any MS Windows machine by its NetBIOS -machine name, so long as that machine is within the workgroup to -which both the samba machine and the MS Windows machine belong. +machine name, as long as that machine is within the workgroup to +which both the Samba machine and the MS Windows machine belong. </para> </sect2> @@ -290,29 +289,29 @@ which both the samba machine and the MS Windows machine belong. <sect1> -<title>Name resolution as used within MS Windows networking</title> +<title>Name Resolution as Used within MS Windows Networking</title> <para> MS Windows networking is predicated about the name each machine is given. This name is known variously (and inconsistently) as -the "computer name", "machine name", "networking name", "netbios name", -or "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 <quote>computer name,</quote> <quote>machine name,</quote> <quote>networking name,</quote> <quote>netbios name,</quote> +or <quote>SMB name.</quote> All terms mean the same thing with the exception of +<quote>netbios name</quote> that can also apply to the name of the workgroup or the +domain name. The terms <quote>workgroup</quote> and <quote>domain</quote> are really just a simple 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 +are exactly 16 characters in length. The 16<superscript>th</superscript> 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 +name is, therefore, registered for each service type that is provided by the client/server. </para> <para> -The following are typical NetBIOS name/service type registrations: +<link linkend="uniqnetbiosnames"/> and <link linkend="netbiosnamesgrp"/> list typical NetBIOS name/service type registrations. </para> -<table frame="all"> -<title>Unique NetBIOS names</title> +<table frame="all" id="uniqnetbiosnames"> +<title>Unique NetBIOS Names</title> <tgroup cols="2"> <colspec align="left"/> <colspec align="justify"/> @@ -325,7 +324,7 @@ The following are typical NetBIOS name/service type registrations: </tgroup> </table> -<table frame="all"> +<table frame="all" id="netbiosnamesgrp"> <title>Group Names</title> <tgroup cols="2"> <colspec align="left"/> @@ -344,13 +343,13 @@ The following are typical NetBIOS name/service type registrations: 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 +determine in the <filename>/etc/hosts</filename> or in the DNS database what names are associated with each IP address. </para> -<indexterm><primary>NetBIOS</primary></indexterm> <para> -One further point of clarification should be noted, the <filename>/etc/hosts</filename> +<indexterm><primary>NetBIOS</primary></indexterm> +One further point of clarification should be noted. The <filename>/etc/hosts</filename> file and the DNS records do not provide the NetBIOS name type information that MS Windows clients depend on to locate the type of service that may be needed. An example of this is what happens when an MS Windows client @@ -359,20 +358,20 @@ 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 IP address that is returned in the enumerated list of IP addresses. -Whichever machine first replies then ends up providing the logon services. +Whichever machine first replies, it then ends up providing the logon services. </para> <para> -The name "workgroup" or "domain" really can be confusing since these +The name <quote>workgroup</quote> or <quote>domain</quote> 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 <quote>workgroup</quote> indicates that the primary nature of the network environment is that of a -peer-to-peer design. In a WORKGROUP all machines are responsible for -their own security, and generally such security is limited to use of -just a password (known as SHARE MODE security). In most situations -with peer-to-peer networking the users who control their own machines +peer-to-peer design. In a WORKGROUP, all machines are responsible for +their own security, and generally such security is limited to the use of +just a password (known as Share Level security). In most situations +with peer-to-peer networking, the users who control their own machines will simply opt to have no security at all. It is possible to have -USER MODE security in a WORKGROUP environment, thus requiring use +User Level Security in a WORKGROUP environment, thus requiring the use of a user name and a matching password. </para> @@ -381,17 +380,17 @@ MS Windows networking is thus predetermined to use machine names for all local and remote machine message passing. The protocol used is called Server Message Block (SMB) and this is implemented using the NetBIOS protocol (Network Basic Input Output System). NetBIOS can -be encapsulated using LLC (Logical Link Control) protocol - in which case +be encapsulated using LLC (Logical Link Control) protocol &smbmdash; in which case the resulting protocol is called NetBEUI (Network Basic Extended User Interface). NetBIOS can also be run over IPX (Internetworking Packet Exchange) protocol as used by Novell NetWare, and it can be run -over TCP/IP protocols - in which case the resulting protocol is called +over TCP/IP protocols &smbmdash; in which case the resulting protocol is called NBT or NetBT, the NetBIOS over TCP/IP. </para> <para> MS Windows machines use a complex array of name resolution mechanisms. -Since we are primarily concerned with TCP/IP this demonstration is +Since we are primarily concerned with TCP/IP, this demonstration is limited to this area. </para> @@ -399,9 +398,9 @@ limited to this area. <title>The NetBIOS Name Cache</title> <para> -All MS Windows machines employ an in memory buffer in which is +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 +machines 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. @@ -411,35 +410,34 @@ 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. +to time-out delays. Its name is in the cache, so a name resolution +lookup will succeed, but the machine cannot respond. This can be +frustrating for users but is a characteristic of the protocol. </para> +<para> <indexterm><primary>nbtstat</primary></indexterm> <indexterm><primary>nmblookup</primary></indexterm> -<para> The MS Windows utility that allows examination of the NetBIOS -name cache is called "nbtstat". The Samba equivalent of this +name cache is called <quote>nbtstat</quote>. The Samba equivalent of this is called <command>nmblookup</command>. </para> </sect2> <sect2> -<title>The LMHOSTS file</title> +<title>The LMHOSTS File</title> -<indexterm><primary>LMHOSTS</primary></indexterm> <para> -This file is usually located in MS Windows NT 4.0 or -2000 in <filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains -the IP Address and the machine name in matched pairs. The -<filename>LMHOSTS</filename> file performs NetBIOS name -to IP address mapping. +<indexterm><primary>LMHOSTS</primary></indexterm> +This file is usually located in MS Windows NT 4.0 or Windows 200x/XP in the directory +<filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains the IP Address +and the machine name in matched pairs. The <filename>LMHOSTS</filename> file +performs NetBIOS name to IP address mapping. </para> <para> -It typically looks like: +It typically looks like this: </para> <para><programlisting> @@ -449,7 +447,7 @@ It typically looks like: # over TCP/IP) stack for Windows98 # # This file contains the mappings of IP addresses to NT computernames -# (NetBIOS) names. Each entry should be kept on an individual line. +# (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 computername # should be separated by at least one space or tab. The "#" character @@ -471,7 +469,7 @@ It typically looks like: # not preloaded, but are parsed only after dynamic name resolution fails. # # Following an entry with the "#DOM:<domain>" tag will associate the -# entry with the domain specified by <domain>. This affects how the +# entry with the domain specified by <domain>. This effects how the # browser and logon services behave in TCP/IP environments. To preload # the host name associated with #DOM entry, it is necessary to also add a # #PRE to the line. The <domain> is always preloaded although it will not @@ -500,10 +498,10 @@ It typically looks like: # # The following example illustrates all of these extensions: # -# 102.54.94.97 rhino #PRE #DOM:networking #net group's DC -# 102.54.94.102 "appname \0x14" #special app server -# 102.54.94.123 popular #PRE #source server -# 102.54.94.117 localsrv #PRE #needed for the include +# 102.54.94.97 rhino #PRE #DOM:networking #net group's DC +# 102.54.94.102 "appname \0x14" #special app server +# 102.54.94.123 popular #PRE #source server +# 102.54.94.117 localsrv #PRE #needed for the include # # #BEGIN_ALTERNATE # #INCLUDE \\localsrv\public\lmhosts @@ -525,11 +523,11 @@ It typically looks like: </sect2> <sect2> -<title>HOSTS file</title> +<title>HOSTS File</title> <para> -This file is usually located in MS Windows NT 4.0 or 2000 in -<filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains +This file is usually located in MS Windows NT 4.0 or Windows 200x/XP in +the directory <filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains the IP Address and the IP hostname in matched pairs. It can be used by the name resolution infrastructure in MS Windows, depending on how the TCP/IP environment is configured. This file is in @@ -541,12 +539,12 @@ every way the equivalent of the UNIX/Linux <filename>/etc/hosts</filename> file. <sect2> <title>DNS Lookup</title> -<indexterm><primary>DNS</primary></indexterm> <para> +<indexterm><primary>DNS</primary></indexterm> This capability is configured in the TCP/IP setup area in the network configuration facility. If enabled, an elaborate name resolution sequence -is followed the precise nature of which is dependant on how the NetBIOS +is followed, the precise nature of which is dependant on how the NetBIOS Node Type parameter is configured. A Node Type of 0 means that NetBIOS broadcast (over UDP broadcast) is used if the name that is the subject of a name lookup is not found in the NetBIOS name @@ -561,9 +559,9 @@ lookup is used. <sect2> <title>WINS Lookup</title> -<indexterm><primary>WINS</primary></indexterm> <para> +<indexterm><primary>WINS</primary></indexterm> A WINS (Windows Internet Name Server) service is the equivalent of the rfc1001/1002 specified NBNS (NetBIOS Name Server). A WINS server stores the names and IP addresses that are registered by a Windows client @@ -571,7 +569,7 @@ if the TCP/IP setup has been given at least one WINS Server IP Address. </para> <para> -To configure Samba to be a WINS server the following parameter needs +To configure Samba to be a WINS server, the following parameter needs to be added to the &smb.conf; file: </para> @@ -580,7 +578,7 @@ to be added to the &smb.conf; file: </smbconfblock></para> <para> -To configure Samba to use a WINS server the following parameters are +To configure Samba to use a WINS server, the following parameters are needed in the &smb.conf; file: </para> @@ -595,7 +593,7 @@ of the WINS server. </para> <para>For information about setting up Samba as a WINS server, read - <link linkend="NetworkBrowsing">the chapter on network browsing</link>.</para> +<link linkend="NetworkBrowsing"/>.</para> </sect2> </sect1> @@ -606,26 +604,26 @@ of the WINS server. <para> TCP/IP network configuration problems find every network administrator sooner or later. The cause can be anything from keyboard mishaps, forgetfulness, simple mistakes, and -carelessness. Of course, no one is every deliberately careless! +carelessness. Of course, no one is ever deliberately careless! </para> <sect2> - <title>Pinging works only in one way</title> + <title>Pinging Works Only in One Way</title> <para> - <quote>I can ping my samba server from Windows, but I can - not ping my Windows machine from the samba server.</quote> + <quote>I can ping my Samba server from Windows, but I cannot ping my Windows + machine from the Samba server.</quote> </para> <para> - The Windows machine was at IP Address 192.168.1.2 with netmask 255.255.255.0, the + <emphasis>Answer:</emphasis> The Windows machine was at IP Address 192.168.1.2 with netmask 255.255.255.0, the Samba server (Linux) was at IP Address 192.168.1.130 with netmask 255.255.255.128. The machines were on a local network with no external connections. </para> <para> 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. + the Samba server was on network 192.168.1.128/25 &smbmdash; logically a different network. </para> </sect2> @@ -634,41 +632,42 @@ carelessness. Of course, no one is every deliberately careless! <title>Very Slow Network Connections</title> <para> - A common causes of slow network response includes: + A common cause of slow network response includes: </para> <itemizedlist> - <listitem><para>Client is configured to use DNS and DNS server is down</para></listitem> - <listitem><para>Client is configured to use remote DNS server, but remote connection is down</para></listitem> - <listitem><para>Client is configured to use a WINS server, but there is no WINS server</para></listitem> - <listitem><para>Client is NOT configured to use a WINS server, but there is a WINS server</para></listitem> - <listitem><para>Firewall is filtering our DNS or WINS traffic</para></listitem> + <listitem><para>Client is configured to use DNS and the DNS server is down.</para></listitem> + <listitem><para>Client is configured to use remote DNS server, but the + remote connection is down.</para></listitem> + <listitem><para>Client is configured to use a WINS server, but there is no WINS server.</para></listitem> + <listitem><para>Client is not configured to use a WINS server, but there is a WINS server.</para></listitem> + <listitem><para>Firewall is filtering our DNS or WINS traffic.</para></listitem> </itemizedlist> </sect2> <sect2> - <title>Samba server name change problem</title> + <title>Samba Server Name Change Problem</title> <para> - <quote>The name of the samba server was changed, samba was restarted, samba server can not be + <quote>The name of the Samba server was changed, Samba was restarted, Samba server cannot be pinged by new name from MS Windows NT4 Workstation, but it does still respond to ping using the old name. Why?</quote> </para> <para> - From this description three (3) things are rather obvious: + From this description, three things are obvious: </para> <itemizedlist> - <listitem><para>WINS is NOT in use, only broadcast based name resolution is used</para></listitem> - <listitem><para>The samba server was renamed and restarted within the last 10-15 minutes</para></listitem> - <listitem><para>The old samba server name is still in the NetBIOS name cache on the MS Windows NT4 Workstation</para></listitem> + <listitem><para>WINS is not in use, only broadcast-based name resolution is used.</para></listitem> + <listitem><para>The Samba server was renamed and restarted within the last 10-15 minutes.</para></listitem> + <listitem><para>The old Samba server name is still in the NetBIOS name cache on the MS Windows NT4 Workstation.</para></listitem> </itemizedlist> <para> To find what names are present in the NetBIOS name cache on the MS Windows NT4 machine, - open a cmd shell, then: + open a <command>cmd</command> shell and then: </para> <para> @@ -701,8 +700,8 @@ SARDON <00> GROUP Registered <para> In the above example, &example.server.samba; is the Samba server and &example.workstation.windows; is the MS Windows NT4 Workstation. - The first listing shows the contents of the Local Name Table (i.e.: Identity information on - the MS Windows workstation), the second shows the NetBIOS name in the NetBIOS name cache. + The first listing shows the contents of the Local Name Table (i.e., Identity information on + the MS Windows workstation) and the second shows the NetBIOS name in the NetBIOS name cache. The name cache contains the remote machines known to this workstation. </para> diff --git a/docs/docbook/projdoc/InterdomainTrusts.xml b/docs/docbook/projdoc/InterdomainTrusts.xml index 04efc6fda6..7cbd673643 100644 --- a/docs/docbook/projdoc/InterdomainTrusts.xml +++ b/docs/docbook/projdoc/InterdomainTrusts.xml @@ -14,14 +14,14 @@ <title>Interdomain Trust Relationships</title> -<indexterm><primary>Interdomain Trusts</primary></indexterm> <para> -Samba-3 supports NT4 style domain trust relationships. This is feature that many sites -will want to use if they migrate to Samba-3 from and NT4 style domain and do NOT want to -adopt Active Directory or an LDAP based authentication back end. This section explains +<indexterm><primary>Interdomain Trusts</primary></indexterm> +Samba-3 supports NT4-style domain trust relationships. This is a feature that many sites +will want to use if they migrate to Samba-3 from an NT4-style domain and do not want to +adopt Active Directory or an LDAP-based authentication backend. This section explains some background information regarding trust relationships and how to create them. It is now -possible for Samba-3 to trust NT4 (and vice versa), as well as to create Samba3-to-Samba3 +possible for Samba-3 to trust NT4 (and vice versa), as well as to create Samba-to-Samba trusts. </para> @@ -29,14 +29,13 @@ trusts. <title>Features and Benefits</title> <para> -Samba-3 can participate in Samba-to-Samba as well as in Samba-to-MS Windows NT4 style -trust relationships. This imparts to Samba similar scalability as is possible with -MS Windows NT4. +Samba-3 can participate in Samba-to-Samba as well as in Samba-to-MS Windows NT4-style +trust relationships. This imparts to Samba similar scalability as with MS Windows NT4. </para> <para> Given that Samba-3 has the capability to function with a scalable backend authentication -database such as LDAP, and given it's ability to run in Primary as well as Backup Domain control +database such as LDAP, and given its ability to run in Primary as well as Backup Domain Control modes, the administrator would be well advised to consider alternatives to the use of Interdomain trusts simply because by the very nature of how this works it is fragile. That was, after all, a key reason for the development and adoption of Microsoft Active Directory. @@ -48,49 +47,47 @@ That was, after all, a key reason for the development and adoption of Microsoft <title>Trust Relationship Background</title> <para> -MS Windows NT3.x/4.0 type security domains employ a non-hierarchical security structure. -The limitations of this architecture as it affects the scalability of MS Windows networking -in large organisations is well known. Additionally, the flat namespace that results from +MS Windows NT3/4 type security domains employ a non-hierarchical security structure. +The limitations of this architecture as it effects the scalability of MS Windows networking +in large organizations is well known. Additionally, the flat namespace that results from this design significantly impacts the delegation of administrative responsibilities in -large and diverse organisations. +large and diverse organizations. </para> <para> Microsoft developed Active Directory Service (ADS), based on Kerberos and LDAP, as a means -of circumventing the limitations of the older technologies. Not every organisation is ready -or willing to embrace ADS. For small companies the older NT4 style domain security paradigm -is quite adequate, there thus remains an entrenched user base for whom there is no direct +of circumventing the limitations of the older technologies. Not every organization is ready +or willing to embrace ADS. For small companies the older NT4-style domain security paradigm +is quite adequate, there remains an entrenched user base for whom there is no direct desire to go through a disruptive change to adopt ADS. </para> <para> -Microsoft introduced with MS Windows NT the ability to allow differing security domains -to affect a mechanism so that users from one domain may be given access rights and privileges +With MS Windows NT, Microsoft introduced the ability to allow differing security domains +to effect a mechanism so users from one domain may be given access rights and privileges in another domain. The language that describes this capability is couched in terms of <emphasis>Trusts</emphasis>. Specifically, one domain will <emphasis>trust</emphasis> the users from another domain. The domain from which users are available to another security domain is said to be a trusted domain. The domain in which those users have assigned rights and privileges is the trusting domain. With NT3.x/4.0 all trust relationships are always in one direction only, thus if users in both domains are to have privileges and rights in each others' domain, then it is -necessary to establish two (2) relationships, one in each direction. +necessary to establish two relationships, one in each direction. </para> <para> -In an NT4 style MS security domain, all trusts are non-transitive. This means that if there -are three (3) domains (let's call them RED, WHITE, and BLUE) where RED and WHITE have a trust +In an NT4-style MS security domain, all trusts are non-transitive. This means that if there +are three domains (let's call them RED, WHITE and BLUE) where RED and WHITE have a trust relationship, and WHITE and BLUE have a trust relationship, then it holds that there is no -implied trust between the RED and BLUE domains. ie: Relationships are explicit and not +implied trust between the RED and BLUE domains. Relationships are explicit and not transitive. </para> <para> -<!-- FIXME: What are these colors doing here - I can't find them ... Jelmer --> New to MS Windows 2000 ADS security contexts is the fact that trust relationships are two-way by default. Also, all inter-ADS domain trusts are transitive. In the case of the RED, WHITE and BLUE -domains above, with Windows 2000 and ADS the RED and BLUE domains CAN trust each other. This is -an inherent feature of ADS domains. Samba-3 implements MS Windows NT4 -style Interdomain trusts and interoperates with MS Windows 200x ADS -security domains in similar manner to MS Windows NT4 style domains. +domains above, with Windows 2000 and ADS the RED and BLUE domains can trust each other. This is +an inherent feature of ADS domains. Samba-3 implements MS Windows NT4-style Interdomain trusts +and interoperates with MS Windows 200x ADS security domains in similar manner to MS Windows NT4-style domains. </para> </sect1> @@ -99,13 +96,13 @@ security domains in similar manner to MS Windows NT4 style domains. <title>Native MS Windows NT4 Trusts Configuration</title> <para> -There are two steps to creating an interdomain trust relationship. To effect a two-way trust -relationship it is necessary for each domain administrator to create a trust account for the +There are two steps to creating an interdomain trust relationship. To effect a two-way trust +relationship, it is necessary for each domain administrator to create a trust account for the other domain to use in verifying security credentials. - <indexterm><primary>Interdomain Trusts</primary><secondary>creating</secondary></indexterm> </para> + <sect2> <title>Creating an NT4 Domain Trust</title> @@ -113,11 +110,11 @@ other domain to use in verifying security credentials. For MS Windows NT4, all domain trust relationships are configured using the <application>Domain User Manager</application>. This is done from the Domain User Manager Policies entry on the menu bar. From the <guimenu>Policy</guimenu> menu, select -<guimenuitem>Trust Relationships</guimenuitem>. Next to the lower box labelled +<guimenuitem>Trust Relationships</guimenuitem>. Next to the lower box labeled <guilabel>Permitted to Trust this Domain</guilabel> are two buttons, <guibutton>Add</guibutton> and <guibutton>Remove</guibutton>. The <guibutton>Add</guibutton> button will open a panel in which to enter the name of the remote domain that will be able to assign access rights to users in -your domain. You will also need to enter a password for this trust relationship, which the +your domain. You will also need to enter a password for this trust relationship, which the trusting domain will use when authenticating users from the trusted domain. The password needs to be typed twice (for standard confirmation). </para> @@ -129,13 +126,13 @@ The password needs to be typed twice (for standard confirmation). <title>Completing an NT4 Domain Trust</title> <para> -<indexterm><primary>Interdomain Trusts</primary><secondary>completing</secondary></indexterm> +<indexterm><primary>Interdomain Trusts</primary><secondary>Completing</secondary></indexterm> A trust relationship will work only when the other (trusting) domain makes the appropriate connections -with the trusted domain. To consummate the trust relationship the administrator will launch the -Domain User Manager, from the menu select Policies, then select Trust Relationships, then click on the -<guibutton>Add</guibutton> button that is next to the box that is labelled -<guilabel>Trusted Domains</guilabel>. A panel will open in which must be entered the name of the remote -domain as well as the password assigned to that trust. +with the trusted domain. To consummate the trust relationship, the administrator will launch the +Domain User Manager from the menu select <guilabel>Policies</guilabel>, then select +<guilabel>Trust Relationships</guilabel>, click on the <guibutton>Add</guibutton> button +next to the box that is labeled <guilabel>Trusted Domains</guilabel>. A panel will open in which +must be entered the name of the remote domain as well as the password assigned to that trust. </para> </sect2> @@ -143,83 +140,83 @@ domain as well as the password assigned to that trust. <sect2> <title>Inter-Domain Trust Facilities</title> -<indexterm><primary>Interdomain Trusts</primary><secondary>Facilities</secondary></indexterm> <para> +<indexterm><primary>Interdomain Trusts</primary><secondary>Facilities</secondary></indexterm> A two-way trust relationship is created when two one-way trusts are created, one in each direction. Where a one-way trust has been established between two MS Windows NT4 domains (let's call them -DomA and DomB) the following facilities are created: +DomA and DomB), the following facilities are created: </para> -<image><imagefile>trusts1</imagefile><imagedescription>Trusts overview</imagedescription></image> +<image id="trusts1"><imagefile>trusts1</imagefile><imagedescription>Trusts overview.</imagedescription></image> <itemizedlist> <listitem><para> - DomA (completes the trust connection) Trusts DomB + DomA (completes the trust connection) <parameter>Trusts</parameter> DomB. </para></listitem> <listitem><para> - DomA is the Trusting domain + DomA is the <parameter>Trusting</parameter> domain. </para></listitem> <listitem><para> - DomB is the Trusted domain (originates the trust account) + DomB is the <parameter>Trusted</parameter> domain (originates the trust account). </para></listitem> <listitem><para> - Users in DomB can access resources in DomA + Users in DomB can access resources in DomA. </para></listitem> <listitem><para> - Users in DomA can NOT access resources in DomB + Users in DomA cannot access resources in DomB. </para></listitem> <listitem><para> - Global groups from DomB CAN be used in DomA + Global groups from DomB can be used in DomA. </para></listitem> <listitem><para> - Global groups from DomA can NOT be used in DomB + Global groups from DomA cannot be used in DomB. </para></listitem> <listitem><para> - DomB DOES appear in the logon dialog box on client workstations in DomA + DomB does appear in the logon dialog box on client workstations in DomA. </para></listitem> <listitem><para> - DomA does NOT appear in the logon dialog box on client workstations in DomB + DomA does not appear in the logon dialog box on client workstations in DomB. </para></listitem> </itemizedlist> <itemizedlist> <listitem><para> - Users / Groups in a trusting domain can NOT be granted rights, permissions or access + Users/Groups in a trusting domain cannot be granted rights, permissions or access to a trusted domain. </para></listitem> <listitem><para> - The trusting domain CAN access and use accounts (Users / Global Groups) in the + The trusting domain can access and use accounts (Users/Global Groups) in the trusted domain. </para></listitem> <listitem><para> - Administrators of the trusted domain CAN be granted admininstrative rights in the + Administrators of the trusted domain can be granted admininstrative rights in the trusting domain. </para></listitem> <listitem><para> - Users in a trusted domain CAN be given rights and privileges in the trusting + Users in a trusted domain can be given rights and privileges in the trusting domain. </para></listitem> <listitem><para> - Trusted domain Global Groups CAN be given rights and permissions in the trusting + Trusted domain Global Groups can be given rights and permissions in the trusting domain. </para></listitem> <listitem><para> - Global Groups from the trusted domain CAN be made members in Local Groups on - MS Windows domain member machines. + Global Groups from the trusted domain can be made members in Local Groups on + MS Windows Domain Member machines. </para></listitem> </itemizedlist> @@ -228,17 +225,17 @@ DomA and DomB) the following facilities are created: </sect1> <sect1> -<title>Configuring Samba NT-style Domain Trusts</title> +<title>Configuring Samba NT-Style Domain Trusts</title> <para> This description is meant to be a fairly short introduction about how to set up a Samba server so -that it could participate in interdomain trust relationships. Trust relationship support in Samba -is in its early stage, so lot of things don't work yet. +that it can participate in interdomain trust relationships. Trust relationship support in Samba +is at an early stage, so do not be surprised if something does not function as it should. </para> <para> Each of the procedures described below assumes the peer domain in the trust relationship is -controlled by a Windows NT4 server. However, the remote end could just as well be another +controlled by a Windows NT4 server. However, the remote end could just as well be another Samba-3 domain. It can be clearly seen, after reading this document, that combining Samba-specific parts of what's written below leads to trust between domains in a purely Samba environment. @@ -248,12 +245,12 @@ environment. <title>Samba as the Trusted Domain</title> <para> -In order to set the Samba PDC to be the trusted party of the relationship you first need +In order to set the Samba PDC to be the trusted party of the relationship, you first need to create a special account for the domain that will be the trusting party. To do that, -you can use the 'smbpasswd' utility. Creating the trusted domain account is very +you can use the <command>smbpasswd</command> utility. Creating the trusted domain account is similar to creating a trusted machine account. Suppose, your domain is called SAMBA, and the remote domain is called RUMBA. The first step -will be to issue this command from your favourite shell: +will be to issue this command from your favorite shell: </para> <para> @@ -265,35 +262,35 @@ Added user rumba$ </screen> where <option>-a</option> means to add a new account into the -passdb database and <option>-i</option> means: ''create this -account with the InterDomain trust flag'' +passdb database and <option>-i</option> means: <quote>create this +account with the InterDomain trust flag</quote>. </para> <para> -The account name will be 'rumba$' (the name of the remote domain) +The account name will be <quote>rumba$</quote> (the name of the remote domain). </para> <para> -After issuing this command you'll be asked to enter the password for +After issuing this command, you will be asked to enter the password for the account. You can use any password you want, but be aware that Windows NT will -not change this password until 7 days following account creation. +not change this password until seven days following account creation. After the command returns successfully, you can look at the entry for the new account (in the standard way as appropriate for your configuration) and see that account's name is -really RUMBA$ and it has the 'I' flag set in the flags field. Now you're ready to confirm +really RUMBA$ and it has the <quote>I</quote> flag set in the flags field. Now you are ready to confirm the trust by establishing it from Windows NT Server. </para> -<indexterm><primary>User Manager</primary></indexterm> <para> +<indexterm><primary>User Manager</primary></indexterm> Open <application>User Manager for Domains</application> and from the <guimenu>Policies</guimenu> menu, select <guimenuitem>Trust Relationships...</guimenuitem>. -Right beside the <guilabel>Trusted domains</guilabel> list box press the +Beside the <guilabel>Trusted domains</guilabel> list box click the <guimenu>Add...</guimenu> button. You will be prompted for the trusted domain name and the relationship password. Type in SAMBA, as this is -the name of the remote domain, and the password used at the time of account creation. -Press OK and, if everything went without incident, you will see -<computeroutput>Trusted domain relationship successfully +the name of the remote domain and the password used at the time of account creation. +Click on <guibutton>OK</guibutton> and, if everything went without incident, you will see +the <computeroutput>Trusted domain relationship successfully established</computeroutput> message. </para> @@ -303,31 +300,31 @@ established</computeroutput> message. <para> This time activities are somewhat reversed. Again, we'll assume that your domain -controlled by the Samba PDC is called SAMBA and NT-controlled domain is called RUMBA. +controlled by the Samba PDC is called SAMBA and the NT-controlled domain is called RUMBA. </para> <para> The very first step is to add an account for the SAMBA domain on RUMBA's PDC. </para> -<indexterm><primary>User Manager</primary></indexterm> <para> +<indexterm><primary>User Manager</primary></indexterm> Launch the <application>Domain User Manager</application>, then from the menu select <guimenu>Policies</guimenu>, <guimenuitem>Trust Relationships</guimenuitem>. Now, next to the <guilabel>Trusted Domains</guilabel> box press the <guibutton>Add</guibutton> -button, and type in the name of the trusted domain (SAMBA) and the password to use in securing +button and type in the name of the trusted domain (SAMBA) and the password to use in securing the relationship. </para> <para> The password can be arbitrarily chosen. It is easy to change the password from the Samba server whenever you want. After confirming the password your account is -ready for use. Now it's Samba's turn. +ready for use. Now its Samba's turn. </para> <para> -Using your favourite shell while being logged in as root, issue this command: +Using your favorite shell while being logged in as root, issue this command: </para> <para> @@ -336,17 +333,17 @@ Using your favourite shell while being logged in as root, issue this command: <para> You will be prompted for the password you just typed on your Windows NT4 Server box. -Do not worry if you see an error message that mentions a return code of -NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT. It means the -password you gave is correct and the NT4 Server says the account is -ready for interdomain connection and not for ordinary -connection. After that, be patient; it can take a while (especially -in large networks), but eventually you should see the <computeroutput>Success</computeroutput> message. -Congratulations! Your trust relationship has just been established. +An error message <errorname>`NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT'</errorname> +that may be reported periodically is of no concern and may safely be ignored. +It means the password you gave is correct and the NT4 Server says the account is ready for +interdomain connection and not for ordinary connection. After that, be patient; +it can take a while (especially in large networks), but eventually you should see +the <computeroutput>Success</computeroutput> message. Congratulations! Your trust +relationship has just been established. </para> <note><para> -Note that you have to run this command as root because you must have write access to +You have to run this command as root because you must have write access to the <filename>secrets.tdb</filename> file. </para></note> @@ -354,11 +351,11 @@ the <filename>secrets.tdb</filename> file. </sect1> <sect1> -<title>NT4-style Domain Trusts with Windows 2000</title> +<title>NT4-Style Domain Trusts with Windows 2000</title> <para> Although <application>Domain User Manager</application> is not present in Windows 2000, it is also possible to establish an NT4-style trust relationship with a Windows 2000 domain -controller running in mixed mode as the trusting server. It should also be possible for +controller running in mixed mode as the trusting server. It should also be possible for Samba to trust a Windows 2000 server, however, more testing is still needed in this area. </para> @@ -366,15 +363,15 @@ Samba to trust a Windows 2000 server, however, more testing is still needed in t After <link linkend="samba-trusted-domain">creating the interdomain trust account on the Samba server</link> as described above, open <application>Active Directory Domains and Trusts</application> on the AD controller of the domain whose resources you wish Samba users -to have access to. Remember that since NT4-style trusts are not transitive, if you want +to have access to. Remember that since NT4-style trusts are not transitive, if you want your users to have access to multiple mixed-mode domains in your AD forest, you will need to -repeat this process for each of those domains. With <application>Active Directory Domains +repeat this process for each of those domains. With <application>Active Directory Domains and Trusts</application> open, right-click on the name of the Active Directory domain that -will trust our Samba domain and choose <guimenuitem>Properties</guimenuitem>, then click on -the <guilabel>Trusts</guilabel> tab. In the upper part of the panel, you will see a list box -labelled <guilabel>Domains trusted by this domain:</guilabel>, and an -<guilabel>Add...</guilabel> button next to it. Press this button, and just as with NT4, you -will be prompted for the trusted domain name and the relationship password. Press OK, and +will trust our Samba domain and choose <guimenuitem>Properties</guimenuitem>, then click on +the <guilabel>Trusts</guilabel> tab. In the upper part of the panel, you will see a list box +labeled <guilabel>Domains trusted by this domain:</guilabel>, and an +<guilabel>Add...</guilabel> button next to it. Press this button and just as with NT4, you +will be prompted for the trusted domain name and the relationship password. Press OK and after a moment, Active Directory will respond with <computeroutput>The trusted domain has been added and the trust has been verified.</computeroutput> Your Samba users can now be granted acess to resources in the AD domain. @@ -385,7 +382,7 @@ granted acess to resources in the AD domain. <title>Common Errors</title> <para> -Interdomain trust relationships should NOT be attempted on networks that are unstable +Interdomain trust relationships should not be attempted on networks that are unstable or that suffer regular outages. Network stability and integrity are key concerns with distributed trusted domains. </para> diff --git a/docs/docbook/projdoc/NT4Migration.xml b/docs/docbook/projdoc/NT4Migration.xml index 36bafee2af..b5ba7c1ced 100644 --- a/docs/docbook/projdoc/NT4Migration.xml +++ b/docs/docbook/projdoc/NT4Migration.xml @@ -7,8 +7,8 @@ <title>Migration from NT4 PDC to Samba-3 PDC</title> <para> -This is a rough guide to assist those wishing to migrate from NT4 domain control to -Samba-3 based domain control. +This is a rough guide to assist those wishing to migrate from NT4 Domain Control to +Samba-3-based Domain Control. </para> <sect1> @@ -17,11 +17,11 @@ Samba-3 based domain control. <para> In the IT world there is often a saying that all problems are encountered because of poor planning. The corollary to this saying is that not all problems can be anticipated -and planned for. Then again, good planning will anticipate most show stopper type situations. +and planned for. Then again, good planning will anticipate most show-stopper-type situations. </para> <para> -Those wishing to migrate from MS Windows NT4 domain control to a Samba-3 domain control +Those wishing to migrate from MS Windows NT4 Domain Control to a Samba-3 Domain Control environment would do well to develop a detailed migration plan. So here are a few pointers to help migration get under way. </para> @@ -30,69 +30,69 @@ help migration get under way. <title>Objectives</title> <para> -The key objective for most organisations will be to make the migration from MS Windows NT4 -to Samba-3 domain control as painless as possible. One of the challenges you may experience +The key objective for most organizations will be to make the migration from MS Windows NT4 +to Samba-3 Domain Control as painless as possible. One of the challenges you may experience in your migration process may well be one of convincing management that the new environment should remain in place. Many who have introduced open source technologies have experienced -pressure to return to a Microsoft based platform solution at the first sign of trouble. +pressure to return to a Microsoft-based platform solution at the first sign of trouble. </para> <para> -Before attempting a migration to a Samba-3 controlled network make every possible effort to -gain all-round commitment to the change. Know precisely <emphasis>why</emphasis> the change -is important for the organisation. Possible motivations to make a change include: +Before attempting a migration to a Samba-3 controlled network, make every possible effort to +gain all-round commitment to the change. Know precisely <emphasis>why</emphasis> the change +is important for the organization. Possible motivations to make a change include: </para> <itemizedlist> - <listitem><para>Improve network manageability</para></listitem> - <listitem><para>Obtain better user level functionality</para></listitem> - <listitem><para>Reduce network operating costs</para></listitem> - <listitem><para>Reduce exposure caused by Microsoft withdrawal of NT4 support</para></listitem> - <listitem><para>Avoid MS License 6 implications</para></listitem> - <listitem><para>Reduce organisation's dependency on Microsoft</para></listitem> + <listitem><para>Improve network manageability.</para></listitem> + <listitem><para>Obtain better user level functionality.</para></listitem> + <listitem><para>Reduce network operating costs.</para></listitem> + <listitem><para>Reduce exposure caused by Microsoft withdrawal of NT4 support.</para></listitem> + <listitem><para>Avoid MS License 6 implications.</para></listitem> + <listitem><para>Reduce organization's dependency on Microsoft.</para></listitem> </itemizedlist> <para> -Make sure that everyone knows that Samba-3 is NOT MS Windows NT4. Samba-3 offers -an alternative solution that is both different from MS Windows NT4 and that offers +Make sure everyone knows that Samba-3 is not MS Windows NT4. Samba-3 offers +an alternative solution that is both different from MS Windows NT4 and offers advantages compared with it. Gain recognition that Samba-3 lacks many of the features that Microsoft has promoted as core values in migration from MS Windows NT4 to MS Windows 2000 and beyond (with or without Active Directory services). </para> <para> -What are the features that Samba-3 can NOT provide? +What are the features that Samba-3 cannot provide? </para> <itemizedlist> - <listitem><para>Active Directory Server</para></listitem> - <listitem><para>Group Policy Objects (in Active Directory)</para></listitem> - <listitem><para>Machine Policy objects</para></listitem> - <listitem><para>Logon Scripts in Active Directory</para></listitem> - <listitem><para>Software Application and Access Controls in Active Directory</para></listitem> + <listitem><para>Active Directory Server.</para></listitem> + <listitem><para>Group Policy Objects (in Active Directory).</para></listitem> + <listitem><para>Machine Policy Objects.</para></listitem> + <listitem><para>Logon Scripts in Active Directory.</para></listitem> + <listitem><para>Software Application and Access Controls in Active Directory.</para></listitem> </itemizedlist> <para> -The features that Samba-3 DOES provide and that may be of compelling interest to your site -includes: +The features that Samba-3 does provide and that may be of compelling interest to your site +include: </para> <itemizedlist> - <listitem><para>Lower Cost of Ownership</para></listitem> - <listitem><para>Global availability of support with no strings attached</para></listitem> - <listitem><para>Dynamic SMB Servers (ie:Can run more than one server per Unix/Linux system)</para></listitem> - <listitem><para>Creation of on-the-fly logon scripts</para></listitem> - <listitem><para>Creation of on-the-fly Policy Files</para></listitem> - <listitem><para>Greater Stability, Reliability, Performance and Availability</para></listitem> - <listitem><para>Manageability via an ssh connection</para></listitem> - <listitem><para>Flexible choices of back-end authentication technologies (tdbsam, ldapsam, mysqlsam)</para></listitem> - <listitem><para>Ability to implement a full single-sign-on architecture</para></listitem> - <listitem><para>Ability to distribute authentication systems for absolute minimum wide area network bandwidth demand</para></listitem> + <listitem><para>Lower cost of ownership.</para></listitem> + <listitem><para>Global availability of support with no strings attached.</para></listitem> + <listitem><para>Dynamic SMB Servers (can run more than one SMB/CIFS server per UNIX/Linux system).</para></listitem> + <listitem><para>Creation of on-the-fly logon scripts.</para></listitem> + <listitem><para>Creation of on-the-fly Policy Files.</para></listitem> + <listitem><para>Greater stability, reliability, performance and availability.</para></listitem> + <listitem><para>Manageability via an ssh connection.</para></listitem> + <listitem><para>Flexible choices of back-end authentication technologies (tdbsam, ldapsam, mysqlsam).</para></listitem> + <listitem><para>Ability to implement a full single-sign-on architecture.</para></listitem> + <listitem><para>Ability to distribute authentication systems for absolute minimum wide area network bandwidth demand.</para></listitem> </itemizedlist> <para> -Before migrating a network from MS Windows NT4 to Samba-3 consider all necessary factors. Users -should be educated about changes they may experience so that the change will be a welcome one +Before migrating a network from MS Windows NT4 to Samba-3, consider all necessary factors. Users +should be educated about changes they may experience so the change will be a welcome one and not become an obstacle to the work they need to do. The following are factors that will help ensure a successful migration: </para> @@ -101,28 +101,29 @@ help ensure a successful migration: <title>Domain Layout</title> <para> -Samba-3 can be configured as a domain controller, a back-up domain controller (probably best called -a secondary controller), a domain member, or as a stand-alone server. The Windows network security +Samba-3 can be configured as a Domain Controller, a back-up Domain Controller (probably best called +a secondary controller), a Domain Member, or as a stand-alone Server. The Windows network security domain context should be sized and scoped before implementation. Particular attention needs to be -paid to the location of the primary domain controller (PDC) as well as backup controllers (BDCs). +paid to the location of the primary Domain Controller (PDC) as well as backup controllers (BDCs). One way in which Samba-3 differs from Microsoft technology is that if one chooses to use an LDAP -authentication backend then the same database can be used by several different domains. In a -complex organisation there can be a single LDAP database, which itself can be distributed (ie: Have +authentication backend, then the same database can be used by several different domains. In a +complex organization, there can be a single LDAP database, which itself can be distributed (have a master server and multiple slave servers) that can simultaneously serve multiple domains. </para> <para> -From a design perspective, the number of users per server, as well as the number of servers, per +>From a design perspective, the number of users per server as well as the number of servers per domain should be scaled taking into consideration server capacity and network bandwidth. </para> <para> A physical network segment may house several domains. Each may span multiple network segments. Where domains span routed network segments, consider and test the performance implications of -the design and layout of a network. A Centrally located domain controller that is designed to +the design and layout of a network. A centrally located Domain Controller that is designed to serve multiple routed network segments may result in severe performance problems. Check the -response time (eg: ping timing) between the remote segment and the PDC. If long (more than 100 ms) -locate a backup controller (BDC) on the remote segmanet to serve as the local authentication and +response time (ping timing) between the remote segment and the PDC. If +it's long (more than 100 ms), +locate a backup controller (BDC) on the remote segment to serve as the local authentication and access control server. </para> </sect3> @@ -131,25 +132,25 @@ access control server. <title>Server Share and Directory Layout</title> <para> -There are cardinal rules to effective network design. These can not be broken with impunity. -The most important rule: Simplicity is king in every well controlled network. Every part of -the infrastructure must be managed, the more complex it is, the greater will be the demand +There are cardinal rules to effective network design that cannot be broken with impunity. +The most important rule: Simplicity is king in every well-controlled network. Every part of +the infrastructure must be managed; the more complex it is, the greater will be the demand of keeping systems secure and functional. </para> <para> -Keep in mind the nature of how data must be share. Physical disk space layout should be considered +Keep in mind the nature of how data must be shared. Physical disk space layout should be considered carefully. Some data must be backed up. The simpler the disk layout the easier it will be to -keep track of backed needs. Identify what back media will be meet needs, consider backup to tape -, CD-ROM or (DVD-ROM), or other off-line storage medium. Plan and implement for minimum -maintenance. Leave nothing to chance in your design, above all, do not leave backups to chance: -Backup and test, validate every backup, create a disaster recovery plan and prove that it works. +keep track of backup needs. Identify what backup media will meet your needs; consider backup to tape, +CD-ROM or (DVD-ROM), or other offline storage medium. Plan and implement for minimum +maintenance. Leave nothing to chance in your design; above all, do not leave backups to chance: +Backup, test, and validate every backup, create a disaster recovery plan and prove that it works. </para> <para> Users should be grouped according to data access control needs. File and directory access -is best controlled via group permissions and the use of the "sticky bit" on group controlled -directories may substantially avoid file access complaints from samba share users. +is best controlled via group permissions and the use of the <quote>sticky bit</quote> on group controlled +directories may substantially avoid file access complaints from Samba share users. </para> <para> @@ -159,7 +160,7 @@ Keep your design and implementation simple and document your design extensively. audit your documentation. Do not create a complex mess that your successor will not understand. Remember, job security through complex design and implementation may cause loss of operations and downtime to users as the new administrator learns to untangle your knots. Keep access -controls simple and effective and make sure that users will never be interrupted by stupid +controls simple and effective and make sure that users will never be interrupted by obtuse complexity. </para> </sect3> @@ -168,20 +169,20 @@ complexity. <title>Logon Scripts</title> <para> -Logon scripts can help to ensure that all users gain share and printer connections they need. +Logon scripts can help to ensure that all users gain the share and printer connections they need. </para> <para> -Logon scripts can be created 'on-the-fly' so that all commands executed are specific to the -rights and priviliges granted to the user. The preferred controls should be affected through -group membership so that group information can be used to custom create a logon script using +Logon scripts can be created on-the-fly so all commands executed are specific to the +rights and privileges granted to the user. The preferred controls should be affected through +group membership so group information can be used to create a custom logon script using the <smbconfoption><name>root preexec</name></smbconfoption> parameters to the <smbconfsection>NETLOGON</smbconfsection> share. </para> <para> Some sites prefer to use a tool such as <command>kixstart</command> to establish a controlled -user environment. In any case you may wish to do a google search for logon script process controls. -In particular, you may wish to explore the use of the Microsoft knowledgebase article KB189105 that +user environment. In any case, you may wish to do a Google search for logon script process controls. +In particular, you may wish to explore the use of the Microsoft KnowledgeBase article KB189105 that deals with how to add printers without user intervention via the logon script process. </para> </sect3> @@ -194,9 +195,11 @@ User and Group Profiles may be migrated using the tools described in the section Management. </para> + <para> +<indexterm><primary>SID</primary></indexterm> Profiles may also be managed using the Samba-3 tool <command>profiles</command>. This tool allows -the MS Windows NT style security identifiers (SIDs) that are stored inside the profile NTuser.DAT file +the MS Windows NT-style security identifiers (SIDs) that are stored inside the profile <filename>NTuser.DAT</filename> file to be changed to the SID of the Samba-3 domain. </para> </sect3> @@ -206,9 +209,9 @@ to be changed to the SID of the Samba-3 domain. <para> It is possible to migrate all account settings from an MS Windows NT4 domain to Samba-3. Before -attempting to migrate user and group accounts it is STRONGLY advised to create in Samba-3 the -groups that are present on the MS Windows NT4 domain <emphasis>AND</emphasis> to map these to -suitable Unix/Linux groups. By following this simple advice all user and group attributes +attempting to migrate user and group accounts, it is STRONGLY advised to create in Samba-3 the +groups that are present on the MS Windows NT4 domain <emphasis>AND</emphasis> to map them to +suitable UNIX/Linux groups. By following this simple advice, all user and group attributes should migrate painlessly. </para> </sect3> @@ -216,7 +219,7 @@ should migrate painlessly. </sect2> <sect2> -<title>Steps In Migration Process</title> +<title>Steps in Migration Process</title> <para> The approximate migration process is described below. @@ -224,39 +227,46 @@ The approximate migration process is described below. <itemizedlist> <listitem><para> -You will have an NT4 PDC that has the users, groups, policies and profiles to be migrated +You have an NT4 PDC that has the users, groups, policies and profiles to be migrated. </para></listitem> <listitem><para> -Samba-3 set up as a DC with netlogon share, profile share, etc. Configure the &smb.conf; file -to fucntion as a BDC. ie: <parameter>domain master = No</parameter>. +Samba-3 set up as a DC with netlogon share, profile share, and so on. Configure the &smb.conf; file +to fucntion as a BDC, i.e., <parameter>domain master = No</parameter>. </para></listitem> </itemizedlist> <procedure><title>The Account Migration Process</title> - <step><para>Create a BDC account for the samba server using NT Server Manager</para> - <substeps><step><para>Samba must NOT be running</para></step></substeps></step> + <step><para> +<indexterm><primary>pdbedit</primary></indexterm> + Create a BDC account in the old NT4 domain for the Samba server using NT Server Manager.</para> + <substeps><step><para>Samba must not be running.</para></step></substeps></step> - <step><para><userinput>net rpc join -S <replaceable>NT4PDC</replaceable> -w <replaceable>DOMNAME</replaceable> -U Administrator%<replaceable>passwd</replaceable></userinput></para></step> + + <step><para> +<indexterm><primary>net</primary><secondary>rpc</secondary></indexterm> + <userinput>net rpc join -S <replaceable>NT4PDC</replaceable> -w <replaceable>DOMNAME</replaceable> -U Administrator%<replaceable>passwd</replaceable></userinput></para></step> <step><para><userinput>net rpc vampire -S <replaceable>NT4PDC</replaceable> -U administrator%<replaceable>passwd</replaceable></userinput></para></step> <step><para><userinput>pdbedit -L</userinput></para> - <substeps><step><para>Note - did the users migrate?</para></step></substeps> + <substeps><step><para>Note &smbmdash; did the users migrate?</para></step></substeps> </step> + <step><para> +<indexterm><primary>net</primary><secondary>groupmap</secondary></indexterm> +<indexterm><primary>initGroups.sh</primary></indexterm> Now assign each of the UNIX groups to NT groups: - (Note: It may be useful to copy this text to a script called - <filename>initGroups.sh</filename>) + (It may be useful to copy this text to a script called <filename>initGroups.sh</filename>) <programlisting> #!/bin/bash #### Keep this as a shell script for future re-use # First assign well known domain global groups -net groupmap modify ntgroup="Domain Admins" unixgroup=ntadmins -net groupmap modify ntgroup="Domain Guests" unixgroup=nobody -net groupmap modify ntgroup="Domain Users" unixgroup=users +net groupmap modify ntgroup="Domain Admins" unixgroup=root rid=512 +net groupmap modify ntgroup="Domain Users" unixgroup=users rid=513 +net groupmap modify ntgroup="Domain Guests" unixgroup=nobody rid=514 # Now for our added domain global groups net groupmap add ntgroup="Designers" unixgroup=designers type=d rid=3200 @@ -266,12 +276,12 @@ net groupmap add ntgroup="QA Team" unixgroup=qateam type=d rid=3220 </para></step> <step><para><userinput>net groupmap list</userinput></para> - <substeps><step><para>Now check that all groups are recognised</para></step></substeps> + <substeps><step><para>Check that all groups are recognized.</para></step></substeps> </step> </procedure> <para> -Now migrate all the profiles, then migrate all policy files. +Migrate all the profiles, then migrate all policy files. </para> </sect2> @@ -281,21 +291,21 @@ Now migrate all the profiles, then migrate all policy files. <title>Migration Options</title> <para> -Sites that wish to migrate from MS Windows NT4 Domain Control to a Samba based solution -generally fit into three basic categories. +Sites that wish to migrate from MS Windows NT4 Domain Control to a Samba-based solution +generally fit into three basic categories. <link linkend="majtypes"/> shows the possibilities. </para> -<table frame="all"><title>The 3 Major Site Types</title> +<table frame="all" id="majtypes"><title>The Three Major Site Types</title> <tgroup cols="2"> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" colspec="1*"/> <thead> <row><entry>Number of Users</entry><entry>Description</entry></row> </thead> <tbody> - <row><entry>< 50</entry><entry><para>Want simple conversion with NO pain</para></entry></row> - <row><entry>50 - 250</entry><entry><para>Want new features, can manage some in-house complexity</para></entry></row> - <row><entry>> 250</entry><entry><para>Solution/Implementation MUST scale well, complex needs. Cross departmental decision process. Local expertise in most areas</para></entry></row> + <row><entry>< 50</entry><entry><para>Want simple conversion with no pain.</para></entry></row> + <row><entry>50 - 250</entry><entry><para>Want new features, can manage some in-house complexity.</para></entry></row> + <row><entry>> 250</entry><entry><para>Solution/Implementation must scale well, complex needs. Cross-departmental decision process. Local expertise in most areas.</para></entry></row> </tbody> </tgroup> </table> @@ -305,81 +315,85 @@ generally fit into three basic categories. <para> There are three basic choices for sites that intend to migrate from MS Windows NT4 -to Samba-3. +to Samba-3: </para> <itemizedlist> <listitem><para> - Simple Conversion (total replacement) + Simple conversion (total replacement). </para></listitem> <listitem><para> - Upgraded Conversion (could be one of integration) + Upgraded conversion (could be one of integration). </para></listitem> <listitem><para> - Complete Redesign (completely new solution) + Complete redesign (completely new solution). </para></listitem> </itemizedlist> <para> -Minimise down-stream problems by: +Minimize down-stream problems by: </para> <itemizedlist> <listitem><para> - Take sufficient time + Taking sufficient time. </para></listitem> <listitem><para> - Avoid Panic + Avoiding Panic. </para></listitem> <listitem><para> - Test ALL assumptions + Testing all assumptions. </para></listitem> <listitem><para> - Test full roll-out program, including workstation deployment + Testing the full roll-out program, including workstation deployment. </para></listitem> </itemizedlist> -<table frame="all"><title>Nature of the Conversion Choices</title> +<para><link linkend="natconchoices"/> lists the conversion choices given the type of migration +being contemplated. +</para> + +<table frame="all" id="natconchoices"><title>Nature of the Conversion Choices</title> <tgroup cols="3"> - <colspec align="justify"/> - <colspec align="justify"/> - <colspec align="justify"/> + <colspec align="justify" colwidth="1*"/> + <colspec align="justify" colwidth="1*"/> + <colspec align="justify" colwidth="1*"/> <thead> <row><entry>Simple</entry><entry>Upgraded</entry><entry>Redesign</entry></row> </thead> <tbody> <row> - <entry><para>Make use of minimal OS specific features</para></entry> - <entry><para>Translate NT4 features to new host OS features</para></entry> + <entry><para>Make use of minimal OS specific features.</para></entry> + <entry><para>Translate NT4 features to new host OS features.</para></entry> <entry><para>Decide:</para></entry> </row> <row> - <entry><para>Suck all accounts from NT4 into Samba-3</para></entry> - <entry><para>Copy and improve:</para></entry> - <entry><para>Authentication Regime (database location and access)</para></entry> + <entry><para>Move all accounts from NT4 into Samba-3</para></entry> + <entry><para>Copy and improve</para></entry> + <entry><para>Authentication regime (database location and access)</para></entry> </row> <row> <entry><para>Make least number of operational changes</para></entry> <entry><para>Make progressive improvements</para></entry> - <entry><para>Desktop Management Methods</para></entry> + <entry><para>Desktop management methods</para></entry> </row> <row> <entry><para>Take least amount of time to migrate</para></entry> - <entry><para>Minimise user impact</para></entry> - <entry><para>Better Control of Desktops / Users</para></entry> + <entry><para>Minimize user impact</para></entry> + <entry><para>Better control of Desktops/Users</para></entry> </row> <row> - <entry><para>Live versus Isolated Conversion</para></entry> - <entry><para>Maximise functionality</para></entry> - <entry><para>Identify Needs for: Manageability, Scalability, Security, Availability</para></entry> + <entry><para>Live versus isolated conversion</para></entry> + <entry><para>Maximize functionality</para></entry> + <entry><para>Identify Needs for: <emphasis>Manageability, Scalability, Security, Availability</emphasis></para></entry> </row> <row> - <entry><para>Integrate Samba-3 then migrate while users are active, then Change of control (ie: swap out)</para></entry> + <entry><para>Integrate Samba-3 then migrate while users are active, then change of control (swap out)</para></entry> <entry><para>Take advantage of lower maintenance opportunity</para></entry> <entry><para></para></entry> </row> @@ -392,97 +406,112 @@ Minimise down-stream problems by: <title>Samba-3 Implementation Choices</title> <variablelist> - <varlistentry><term>Authentication database/back end:</term><listitem> + <varlistentry><term>Authentication Database/Backend</term><listitem> <para> Samba-3 can use an external authentication backend: </para> <para> <itemizedlist> - <listitem><para>Winbind (external Samba or NT4/200x server)</para></listitem> - <listitem><para>External server could use Active Directory or NT4 Domain</para></listitem> - <listitem><para>Can use pam_mkhomedir.so to auto-create home dirs</para></listitem> - </itemizedlist> + <listitem><para>Winbind (external Samba or NT4/200x server).</para></listitem> + <listitem><para>External server could use Active Directory or NT4 Domain.</para></listitem> + <listitem><para>Can use pam_mkhomedir.so to auto-create home dirs.</para></listitem> + <listitem><para> + Samba-3 can use a local authentication backend: <parameter>smbpasswd, tdbsam, ldapsam, mysqlsam</parameter></para></listitem> + </itemizedlist> </para> + </listitem></varlistentry> + <varlistentry><term>Access Control Points</term><listitem> <para> - Samba-3 can use a local authentication backend: - <itemizedlist> - <listitem><para>smbpasswd, tdbsam, ldapsam, mysqlsam</para></listitem> - </itemizedlist> + Samba permits Access Control Points to be set: </para> - </listitem> - </varlistentry> - - <varlistentry><term>Access Control Points:</term><listitem> <itemizedlist> - <listitem><para>On the Share itself - using Share ACLs</para></listitem> - <listitem><para>On the file system - using UNIX permissions on files and directories</para> - <para>Note: Can Enable Posix ACLs in file system also</para></listitem> - <listitem><para>Through Samba share parameters - Not recommended - except as last resort</para></listitem> + <listitem><para>On the share itself &smbmdash; using Share ACLs.</para></listitem> + <listitem><para>On the file system &smbmdash; using UNIX permissions on files and directories.</para> + <para>Note: Can enable Posix ACLs in file system also.</para></listitem> + <listitem><para>Through Samba share parameters &smbmdash; not recommended except as last resort.</para></listitem> </itemizedlist> </listitem> </varlistentry> - <varlistentry><term>Policies (migrate or create new ones):</term><listitem> + <varlistentry><term>Policies (migrate or create new ones)</term><listitem> + <para> + Exercise great caution when affecting registry changes, use the right tool and be aware + that changes made through NT4-style <filename>NTConfig.POL</filename> files can leave + permanent changes. + </para> <itemizedlist> - <listitem><para>Using Group Policy Editor (NT4)</para></listitem> - <listitem><para>- Watch out for Tattoo effect</para></listitem> + <listitem><para>Using Group Policy Editor (NT4).</para></listitem> + <listitem><para>Watch out for Tattoo effect.</para></listitem> </itemizedlist> </listitem> </varlistentry> - <varlistentry><term>User and Group Profiles:</term><listitem> + <varlistentry><term>User and Group Profiles</term><listitem> <para> - Platform specific so use platform tool to change from a Local to a Roaming profile - Can use new profiles tool to change SIDs (NTUser.DAT) + Platform-specific so use platform tool to change from a Local to a Roaming profile. + Can use new profiles tool to change SIDs (<filename>NTUser.DAT</filename>). </para> </listitem> </varlistentry> - <varlistentry><term>Logon Scripts:</term><listitem> + <varlistentry><term>Logon Scripts</term><listitem> <para> - Know how they work + Know how they work. </para> </listitem> </varlistentry> - <varlistentry><term>User and Group mapping to Unix/Linux:</term><listitem> + + <varlistentry><term>User and Group Mapping to UNIX/Linux</term><listitem> + <para> +<indexterm><primary>pdbedit</primary></indexterm> + User and Group mapping code is new. Many problems have been experienced as network administrators + who are familiar with Samba-2.2.x migrate to Samba-3. Carefully study the chapters that document + the new password backend behavior and the new group mapping functionality. + </para> <itemizedlist> - <listitem><para>username map facility may be needed</para></listitem> - <listitem><para>Use 'net groupmap' to connect NT4 groups to Unix groups</para></listitem> - <listitem><para>Use pdbedit to set/change user configuration</para> + <listitem><para>The <parameter>username map</parameter> facility may be needed.</para></listitem> + <listitem><para>Use <command>net groupmap</command> to connect NT4 groups to UNIX groups.</para></listitem> + <listitem><para>Use <command>pdbedit</command> to set/change user configuration.</para> <para> - NOTE: When migrating to LDAP back, end it may be easier to dump initial - LDAP database to LDIF, then edit, then reload into LDAP + When migrating to LDAP backend, it may be easier to dump the initial + LDAP database to LDIF, edit, then reload into LDAP. </para> </listitem> </itemizedlist> </listitem> </varlistentry> - <varlistentry><term>OS specific scripts/programs may be needed:</term><listitem> + <varlistentry><term>OS Specific Scripts/Programs may be Needed</term><listitem> + <para> + Every operating system has its peculiarities. These are the result of engineering decisions + that were based on the experience of the designer, and may have side-effects that were not + anticipated. Limitations that may bite the Windows network administrator include: + </para> <itemizedlist> <listitem><para>Add/Delete Users: Note OS limits on size of name - (Linux 8 chars) NT4 up to 254 chars</para></listitem> - <listitem><para>Add/Delete Machines: Applied only to domain members - (Note: Machine names may be limited to 16 characters)</para></listitem> - <listitem><para>Use 'net groupmap' to connect NT4 groups to Unix groups</para></listitem> + (Linux 8 chars) NT4 up to 254 chars.</para></listitem> + <listitem><para>Add/Delete Machines: Applied only to Domain Members + (Note: machine names may be limited to 16 characters).</para></listitem> + <listitem><para>Use <command>net groupmap</command> to connect NT4 groups to UNIX groups.</para></listitem> <listitem><para>Add/Delete Groups: Note OS limits on size and nature. - Linux limit is 16 char, no spaces and no upper case chars (groupadd)</para></listitem> + Linux limit is 16 char, no spaces and no upper case chars (<command>groupadd</command>).</para></listitem> </itemizedlist> </listitem> </varlistentry> - <varlistentry><term>Migration Tools:</term><listitem> + <varlistentry><term>Migration Tools</term><listitem> <para> +<indexterm><primary>pdbedit</primary></indexterm> Domain Control (NT4 Style) Profiles, Policies, Access Controls, Security <itemizedlist> - <listitem><para>Samba: net, rpcclient, smbpasswd, pdbedit, profiles</para></listitem> - <listitem><para>Windows: NT4 Domain User Manager, Server Manager (NEXUS)</para></listitem> + <listitem><para>Samba: <command>net, rpcclient, smbpasswd, pdbedit, profiles.</command></para></listitem> + <listitem><para>Windows: <command>NT4 Domain User Manager, Server Manager (NEXUS)</command></para></listitem> </itemizedlist> - </para> + </para> </listitem> </varlistentry> </variablelist> diff --git a/docs/docbook/projdoc/NetworkBrowsing.xml b/docs/docbook/projdoc/NetworkBrowsing.xml index 2db154be33..251b387a05 100644 --- a/docs/docbook/projdoc/NetworkBrowsing.xml +++ b/docs/docbook/projdoc/NetworkBrowsing.xml @@ -6,19 +6,19 @@ <pubdate>Updated: April 21, 2003</pubdate> </chapterinfo> -<title>Samba / MS Windows Network Browsing Guide</title> +<title>Network Browsing</title> <para> This document contains detailed information as well as a fast track guide to -implementing browsing across subnets and / or across workgroups (or domains). +implementing browsing across subnets and/or across workgroups (or domains). WINS is the best tool for resolution of NetBIOS names to IP addresses. WINS is -NOT involved in browse list handling except by way of name to address resolution. +not involved in browse list handling except by way of name to address resolution. </para> <note><para> -MS Windows 2000 and later can be configured to operate with NO NetBIOS -over TCP/IP. Samba-3 and later also supports this mode of operation. -When the use of NetBIOS over TCP/IP has been disabled then the primary +MS Windows 2000 and later versions can be configured to operate with no NetBIOS +over TCP/IP. Samba-3 and later versions also support this mode of operation. +When the use of NetBIOS over TCP/IP has been disabled, the primary means for resolution of MS Windows machine names is via DNS and Active Directory. The following information assumes that your site is running NetBIOS over TCP/IP. </para></note> @@ -27,14 +27,14 @@ The following information assumes that your site is running NetBIOS over TCP/IP. <title>Features and Benefits</title> <para> -Someone once referred to the past in terms of: <emphasis>They were the worst of times, -they were the best of times. The more we look back, them more we long for what was and -hope it never returns!</emphasis>. +Someone once referred to the past in these words <quote><emphasis>It was the best of times, +it was the worst of times.</emphasis></quote> The more we look back, the more we long for what was and +hope it never returns. </para> -<indexterm><primary>NetBIOS</primary></indexterm> <para> +<indexterm><primary>NetBIOS</primary></indexterm> For many MS Windows network administrators, that statement sums up their feelings about NetBIOS networking precisely. For those who mastered NetBIOS networking, its fickle nature was just par for the course. For those who never quite managed to tame its @@ -42,62 +42,62 @@ lusty features, NetBIOS is like Paterson's Curse. </para> <para> -For those not familiar with botanical problems in Australia: Paterson's curse, -Echium plantagineum, was introduced to Australia from Europe during the mid-nineteenth +For those not familiar with botanical problems in Australia, Paterson's Curse, +<emphasis>Echium plantagineum</emphasis>, was introduced to Australia from Europe during the mid-nineteenth century. Since then it has spread rapidly. The high seed production, with densities of -thousands of seeds per square metre, a seed longevity of more than seven years, and an +thousands of seeds per square meter, a seed longevity of more than seven years, and an ability to germinate at any time of year, given the right conditions, are some of the features which make it such a persistent weed. </para> <para> -In this chapter we explore vital aspects of SMB (Server Message Block) networking with +In this chapter we explore vital aspects of Server Message Block (SMB) networking with a particular focus on SMB as implemented through running NetBIOS (Network Basic -Input / Output System) over TCP/IP. Since Samba does NOT implement SMB or NetBIOS over -any other protocols we need to know how to configure our network environment and simply +Input/Output System) over TCP/IP. Since Samba does not implement SMB or NetBIOS over +any other protocols, we need to know how to configure our network environment and simply remember to use nothing but TCP/IP on all our MS Windows network clients. </para> <para> Samba provides the ability to implement a WINS (Windows Internetworking Name Server) and implements extensions to Microsoft's implementation of WINS. These extensions -help Samba to affect stable WINS operations beyond the normal scope of MS WINS. +help Samba to effect stable WINS operations beyond the normal scope of MS WINS. </para> <para> -Please note that WINS is exclusively a service that applies only to those systems -that run NetBIOS over TCP/IP. MS Windows 200x / XP have the capacity to turn off -support for NetBIOS, in which case WINS is of no relevance. Samba supports this also. +WINS is exclusively a service that applies only to those systems +that run NetBIOS over TCP/IP. MS Windows 200x/XP have the capacity to operate with +support for NetBIOS disabled, in which case WINS is of no relevance. Samba supports this also. </para> <para> -For those networks on which NetBIOS has been disabled (ie: WINS is NOT required) +For those networks on which NetBIOS has been disabled (i.e., WINS is not required) the use of DNS is necessary for host name resolution. </para> </sect1> <sect1> -<title>What is Browsing?</title> +<title>What Is Browsing?</title> <para> -To most people browsing means that they can see the MS Windows and Samba servers +To most people browsing means they can see the MS Windows and Samba servers in the Network Neighborhood, and when the computer icon for a particular server is clicked, it opens up and shows the shares and printers available on the target server. </para> <para> -What seems so simple is in fact a very complex interaction of different technologies. -The technologies (or methods) employed in making all of this work includes: +What seems so simple is in fact a complex interaction of different technologies. +The technologies (or methods) employed in making all of this work include: </para> <itemizedlist> - <listitem><para>MS Windows machines register their presence to the network</para></listitem> - <listitem><para>Machines announce themselves to other machines on the network</para></listitem> - <listitem><para>One or more machine on the network collates the local announcements</para></listitem> - <listitem><para>The client machine finds the machine that has the collated list of machines</para></listitem> - <listitem><para>The client machine is able to resolve the machine names to IP addresses</para></listitem> - <listitem><para>The client machine is able to connect to a target machine</para></listitem> + <listitem>MS Windows machines register their presence to the network.</listitem> + <listitem>Machines announce themselves to other machines on the network.</listitem> + <listitem>One or more machine on the network collates the local announcements.</listitem> + <listitem>The client machine finds the machine that has the collated list of machines.</listitem> + <listitem>The client machine is able to resolve the machine names to IP addresses.</listitem> + <listitem>The client machine is able to connect to a target machine.</listitem> </itemizedlist> <para> @@ -127,38 +127,37 @@ called <filename>nmbd</filename>. The configuration parameters involved in nmbd' <smbconfoption><name>wins hook</name></smbconfoption>. </para> -<indexterm><primary>WINS</primary></indexterm> <para> +<indexterm><primary>WINS</primary></indexterm> For Samba, the WINS Server and WINS Support are mutually exclusive options. Those marked with -an '*' are the only options that commonly MAY need to be modified. Even if not one of these -parameters is set <filename>nmbd</filename> will still do it's job. +an (*) are the only options that commonly may need to be modified. Even if none of these +parameters is set, <filename>nmbd</filename> will still do its job. </para> </sect1> -<sect1> +<sect1 id="netdiscuss"> <title>Discussion</title> <para> -Firstly, all MS Windows networking uses SMB (Server Message Block) based messaging. -SMB messaging may be implemented with or without NetBIOS. MS Windows 200x supports -NetBIOS over TCP/IP for backwards compatibility. Microsoft is intent on phasing out NetBIOS -support. +All MS Windows networking uses SMB-based messaging. SMB messaging may be implemented with or without NetBIOS. +MS Windows 200x supports NetBIOS over TCP/IP for backwards compatibility. Microsoft appears intent on phasing +out NetBIOS support. </para> <sect2> <title>NetBIOS over TCP/IP</title> <para> -Samba implements NetBIOS, as does MS Windows NT / 200x / XP, by encapsulating it over TCP/IP. -MS Windows products can do likewise. NetBIOS based networking uses broadcast messaging to -affect browse list management. When running NetBIOS over TCP/IP, this uses UDP based messaging. +Samba implements NetBIOS, as does MS Windows NT/200x/XP, by encapsulating it over TCP/IP. +MS Windows products can do likewise. NetBIOS-based networking uses broadcast messaging to +effect browse list management. When running NetBIOS over TCP/IP, this uses UDP-based messaging. UDP messages can be broadcast or unicast. </para> -<indexterm><primary>UDP</primary></indexterm> <para> +<indexterm><primary>UDP</primary></indexterm> Normally, only unicast UDP messaging can be forwarded by routers. The <smbconfoption><name>remote announce</name></smbconfoption> parameter to smb.conf helps to project browse announcements to remote network segments via unicast UDP. Similarly, the @@ -168,177 +167,187 @@ implements browse list collation using unicast UDP. <para> Secondly, in those networks where Samba is the only SMB server technology, -wherever possible <filename>nmbd</filename> should be configured on one (1) machine as the WINS +wherever possible <filename>nmbd</filename> should be configured on one machine as the WINS server. This makes it easy to manage the browsing environment. If each network -segment is configured with it's own Samba WINS server, then the only way to -get cross segment browsing to work is by using the +segment is configured with its own Samba WINS server, then the only way to +get cross-segment browsing to work is by using the +<indexterm><primary>LMB</primary><see>Local Master Browser</see></indexterm> +<indexterm><primary>Local Master Browser</primary></indexterm> <smbconfoption><name>remote announce</name></smbconfoption> and the <smbconfoption><name>remote browse sync</name></smbconfoption> parameters to your &smb.conf; file. </para> <para> <indexterm><primary>WINS</primary></indexterm> -If only one WINS server is used for an entire multi-segment network then +If only one WINS server is used for an entire multi-segment network, then the use of the <smbconfoption><name>remote announce</name></smbconfoption> and the -<smbconfoption><name>remote browse sync</name></smbconfoption> parameters should NOT be necessary. +<smbconfoption><name>remote browse sync</name></smbconfoption> parameters should not be necessary. </para> <para> -As of Samba 3 WINS replication is being worked on. The bulk of the code has -been committed, but it still needs maturation. This is NOT a supported feature +<indexterm><primary>replication</primary><secondary>WINS</secondary></indexterm> +As of Samba-3 WINS replication is being worked on. The bulk of the code has +been committed, but it still needs maturation. This is not a supported feature of the Samba-3.0.0 release. Hopefully, this will become a supported feature of one of the Samba-3 release series. </para> <para> Right now Samba WINS does not support MS-WINS replication. This means that -when setting up Samba as a WINS server there must only be one <filename>nmbd</filename> +when setting up Samba as a WINS server, there must only be one <filename>nmbd</filename> configured as a WINS server on the network. Some sites have used multiple Samba WINS servers for redundancy (one server per subnet) and then used <smbconfoption><name>remote browse sync</name></smbconfoption> and <smbconfoption><name>remote announce</name></smbconfoption> -to affect browse list collation across all segments. Note that this means clients +to effect browse list collation across all segments. Note that this means clients will only resolve local names, and must be configured to use DNS to resolve names on other subnets in order to resolve the IP addresses of the servers they can see on other subnets. This setup is not recommended, but is mentioned as a practical -consideration (ie: an 'if all else fails' scenario). +consideration (i.e., an <quote>if all else fails</quote> scenario). </para> <para> Lastly, take note that browse lists are a collection of unreliable broadcast messages that are repeated at intervals of not more than 15 minutes. This means that it will take time to establish a browse list and it can take up to 45 -minutes to stabilise, particularly across network segments. +minutes to stabilize, particularly across network segments. </para> </sect2> <sect2> -<title>TCP/IP - without NetBIOS</title> +<title>TCP/IP without NetBIOS</title> <para> <indexterm><primary>NetBIOS</primary></indexterm> <indexterm><primary>NetBIOS-less</primary></indexterm> <indexterm><primary>DNS</primary></indexterm> -All TCP/IP using systems use various forms of host name resolution. The primary -methods for TCP/IP hostname resolutions involves either a static file (<filename>/etc/hosts -</filename>) or DNS (the Domain Name System). DNS is the technology that makes -the Internet usable. DNS based host name resolution is supported by nearly all TCP/IP -enabled systems. Only a few embedded TCP/IP systems do not support DNS. +All TCP/IP-enabled systems use various forms of host name resolution. The primary +methods for TCP/IP hostname resolution involve either a static file (<filename>/etc/hosts</filename>) +or the Domain Name System (DNS). DNS is the technology that makes +the Internet usable. DNS-based host name resolution is supported by nearly all +TCP/IP-enabled systems. Only a few embedded TCP/IP systems do not support DNS. </para> <para> -When an MS Windows 200x / XP system attempts to resolve a host name to an IP address +When an MS Windows 200x/XP system attempts to resolve a host name to an IP address it follows a defined path: </para> <orderedlist> <listitem><para> Checks the <filename>hosts</filename> file. It is located in - <filename>C:\WinNT\System32\Drivers\etc</filename>. + <filename>C:\Windows NT\System32\Drivers\etc</filename>. </para></listitem> <listitem><para> - Does a DNS lookup + Does a DNS lookup. </para></listitem> <listitem><para> - Checks the NetBIOS name cache + Checks the NetBIOS name cache. </para></listitem> <listitem><para> - Queries the WINS server + Queries the WINS server. </para></listitem> <listitem><para> - Does a broadcast name lookup over UDP + Does a broadcast name lookup over UDP. </para></listitem> <listitem><para> - Looks up entries in LMHOSTS. It is located in - <filename>C:\WinNT\System32\Drivers\etc</filename>. + Looks up entries in LMHOSTS. It is located in <?latex \linebreak ?> + <filename>C:\Windows NT\System32\Drivers\etc</filename>. </para></listitem> </orderedlist> -<indexterm><primary>DNS</primary></indexterm> <para> -Windows 200x / XP can register it's host name with a Dynamic DNS server. You can -force register with a Dynamic DNS server in Windows 200x / XP using: -<command>ipconfig /registerdns</command> +<indexterm><primary>DNS</primary></indexterm> +Windows 200x/XP can register its host name with a Dynamic DNS server. You can +force register with a Dynamic DNS server in Windows 200x/XP using: +<command>ipconfig /registerdns</command>. </para> <para> With Active Directory (ADS), a correctly functioning DNS server is absolutely essential. In the absence of a working DNS server that has been correctly configured, -MS Windows clients and servers will be totally unable to locate each other, +MS Windows clients and servers will be unable to locate each other, so consequently network services will be severely impaired. </para> <para> The use of Dynamic DNS is highly recommended with Active Directory, in which case -the use of BIND9 is preferred for it's ability to adequately support the SRV (service) +the use of BIND9 is preferred for its ability to adequately support the SRV (service) records that are needed for Active Directory. </para> </sect2> -<sect2> +<sect2 id="adsdnstech"> <title>DNS and Active Directory</title> -<indexterm><primary>DNS</primary><secondary>Active Directory</secondary></indexterm> <para> -Occasionally we hear from UNIX network administrators who want to use a UNIX based Dynamic +<indexterm><primary>DNS</primary><secondary>Active Directory</secondary></indexterm> +Occasionally we hear from UNIX network administrators who want to use a UNIX-based Dynamic DNS server in place of the Microsoft DNS server. While this might be desirable to some, the MS Windows 200x DNS server is auto-configured to work with Active Directory. It is possible to use BIND version 8 or 9, but it will almost certainly be necessary to create service records -so that MS Active Directory clients can resolve host names to locate essential network services. +so MS Active Directory clients can resolve host names to locate essential network services. The following are some of the default service records that Active Directory requires: </para> -<itemizedlist> - <listitem><para>_ldap._tcp.pdc.ms-dcs.<emphasis>Domain</emphasis></para> - - <para> - This provides the address of the Windows NT PDC for the Domain. - </para> +<variablelist> +<varlistentry> + <term>_ldap._tcp.pdc.ms-dcs.<emphasis>Domain</emphasis></term> + <listitem> + <para> + This provides the address of the Windows NT PDC for the Domain. + </para> </listitem> - - <listitem><para>_ldap._tcp.pdc.ms-dcs.<emphasis>DomainTree</emphasis></para> - - <para> - Resolves the addresses of Global Catalog servers in the domain. - </para> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.pdc.ms-dcs.<emphasis>DomainTree</emphasis></term> + <listitem> + <para> + Resolves the addresses of Global Catalog servers in the domain. + </para> </listitem> - - <listitem><para>_ldap._tcp.<emphasis>site</emphasis>.sites.writable.ms-dcs.<emphasis>Domain</emphasis></para> - <para> - Provides list of domain controllers based on sites. - </para> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.<emphasis>site</emphasis>.sites.writable.ms-dcs.<emphasis>Domain</emphasis></term> + <listitem> + <para> + Provides list of Domain Controllers based on sites. + </para> </listitem> - - <listitem><para>_ldap._tcp.writable.ms-dcs.<emphasis>Domain</emphasis></para> - - <para> - Enumerates list of domain controllers that have the writable - copies of the Active Directory data store. - </para> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.writable.ms-dcs.<emphasis>Domain</emphasis></term> + <listitem> + <para> + Enumerates list of Domain Controllers that have the writable copies of the Active Directory datastore. + </para> </listitem> - - <listitem><para>_ldap._tcp.<emphasis>GUID</emphasis>.domains.ms-dcs.<emphasis>DomainTree</emphasis></para> - <para> - Entry used by MS Windows clients to locate machines using the - Global Unique Identifier. - </para> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.<emphasis>GUID</emphasis>.domains.ms-dcs.<emphasis>DomainTree</emphasis></term> + <listitem> + <para> + Entry used by MS Windows clients to locate machines using the Global Unique Identifier. + </para> </listitem> - - <listitem><para>_ldap._tcp.<emphasis>Site</emphasis>.gc.ms-dcs.<emphasis>DomainTree</emphasis></para> - <para> - Used by MS Windows clients to locate site configuration dependent - Global Catalog server. - </para> +</varlistentry> +<varlistentry> + <term>_ldap._tcp.<emphasis>Site</emphasis>.gc.ms-dcs.<emphasis>DomainTree</emphasis></term> + <listitem> + <para> + Used by MS Windows clients to locate site configuration dependent Global Catalog server. + </para> </listitem> -</itemizedlist> +</varlistentry> +</variablelist> </sect2> @@ -349,8 +358,8 @@ The following are some of the default service records that Active Directory requ <para> MS Windows machines register their NetBIOS names -(ie: the machine name for each service type in operation) on start -up. The exact method by which this name registration +(i.e., the machine name for each service type in operation) on start-up. +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. @@ -360,7 +369,7 @@ 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 +names and IP addresses. In such situations, Samba provides a means by which the Samba server name may be forcibly injected into the browse list of a remote MS Windows network (using the <smbconfoption><name>remote announce</name></smbconfoption> parameter). @@ -374,17 +383,17 @@ and thus WINS allows name resolution to function across routed networks. <para> 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 +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 +list of all machines that are on the network. Every 11 to 15 minutes an election is held to determine which machine will be the master browser. By the nature of the election criteria used, the machine with the highest uptime, or the -most senior protocol version, or other criteria, will win the election -as domain master browser. +most senior protocol version or other criteria, will win the election +as Domain Master Browser. </para> <para> @@ -400,43 +409,43 @@ inability to use the network services. </para> <para> -Samba supports a feature that allows forced synchronisation -of browse lists across routed networks using the <smbconfoption><name>remote browse sync</name></smbconfoption> 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 <smbconfoption><name>remote browse sync</name></smbconfoption> 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, <filename>/etc/hosts</filename>, -and so on. +Samba supports a feature that allows forced synchronization of browse lists across +routed networks using the <smbconfoption><name>remote browse sync</name></smbconfoption> +parameter in the &smb.conf; file. This causes Samba to contact the local master +browser on a remote network and to request browse list synchronization. This +effectively bridges two networks that are separated by routers. The two remote +networks may use either broadcast-based name resolution or WINS-based name +resolution, but it should be noted that the +<smbconfoption><name>remote browse sync</name></smbconfoption> parameter provides +browse list synchronization &smbmdash; 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, <filename>/etc/hosts</filename>, and so on. </para> <sect2 id="DMB"> -<title>Setting up WORKGROUP Browsing</title> +<title>Configuring WORKGROUP Browsing</title> <para> -To set up cross subnet browsing on a network containing machines -in up to be in a WORKGROUP, not an NT Domain you need to set up one -Samba server to be the Domain Master Browser (note that this is *NOT* +To configure cross-subnet browsing on a network containing machines +in a WORKGROUP, not an NT Domain, you need to set up one +Samba server to be the Domain Master Browser (note that this is not the same as a Primary Domain Controller, although in an NT Domain the -same machine plays both roles). The role of a Domain master browser is -to collate the browse lists from local master browsers on all the -subnets that have a machine participating in the workgroup. Without -one machine configured as a domain master browser each subnet would -be an isolated workgroup, unable to see any machines on any other -subnet. It is the presence of a domain master browser that makes -cross subnet browsing possible for a workgroup. +same machine plays both roles). The role of a Domain Master Browser is +to collate the browse lists from Local Master Browsers on all the +subnets that have a machine participating in the workgroup. Without +one machine configured as a Domain Master Browser, each subnet would +be an isolated workgroup unable to see any machines on another +subnet. It is the presence of a Domain Master Browser that makes +cross-subnet browsing possible for a workgroup. </para> <para> -In an WORKGROUP environment the domain master browser must be a -Samba server, and there must only be one domain master browser per -workgroup name. To set up a Samba server as a domain master browser, +In a WORKGROUP environment the Domain Master Browser must be a +Samba server, and there must only be one Domain Master Browser per +workgroup name. To set up a Samba server as a Domain Master Browser, set the following option in the <smbconfsection>[global]</smbconfsection> section -of the &smb.conf; file : +of the &smb.conf; file: </para> <para> @@ -446,15 +455,16 @@ of the &smb.conf; file : </para> <para> -The domain master browser should also preferably be the local master -browser for its own subnet. In order to achieve this set the following -options in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; file : +The Domain Master Browser should preferably be the local master +browser for its own subnet. In order to achieve this, set the following +options in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; +file as shown in <link linkend="dmbexample"/>. </para> <para> - <smbconfexample> - <title>Domain master browser smb.conf</title> - <smbconfsection>[global]</smbconfsection> +<smbconfexample id="dmbexample"> +<title>Domain Master Browser smb.conf</title> +<smbconfsection>[global]</smbconfsection> <smbconfoption><name>domain master</name><value>yes</value></smbconfoption> <smbconfoption><name>local master</name><value>yes</value></smbconfoption> <smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> @@ -463,25 +473,23 @@ options in the <smbconfsection>[global]</smbconfsection> section of the &smb.con </para> <para> -The domain master browser may be the same machine as the WINS -server, if you require. +The Domain Master Browser may be the same machine as the WINS server, if necessary. </para> <para> -Next, you should ensure that each of the subnets contains a -machine that can act as a local master browser for the -workgroup. Any MS Windows NT/2K/XP/2003 machine should be -able to do this, as will Windows 9x machines (although these -tend to get rebooted more often, so it's not such a good idea -to use these). To make a Samba server a local master browser -set the following options in the <smbconfsection>[global]</smbconfsection> section of the -&smb.conf; file : +Next, you should ensure that each of the subnets contains a machine that can act as +a Local Master Browser for the workgroup. Any MS Windows NT/200x/XP machine should +be able to do this, as will Windows 9x/Me machines (although these tend to get +rebooted more often, so it is not such a good idea to use these). To make a Samba +server a Local Master Browser set the following options in the +<smbconfsection>[global]</smbconfsection> section of the &smb.conf; file as +shown in <link linkend="lmbexample"/>: </para> <para> -<smbconfexample> - <title>Local master browser smb.conf</title> - <smbconfsection>[global]</smbconfsection> +<smbconfexample id="lmbexample"> +<title>Local master browser smb.conf</title> +<smbconfsection>[global]</smbconfsection> <smbconfoption><name>domain master</name><value>no</value></smbconfoption> <smbconfoption><name>local master</name><value>yes</value></smbconfoption> <smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> @@ -490,30 +498,27 @@ set the following options in the <smbconfsection>[global]</smbconfsection> secti </para> <para> -Do not do this for more than one Samba server on each subnet, -or they will war with each other over which is to be the local -master browser. +Do not do this for more than one Samba server on each subnet, or they will war with +each other over which is to be the Local Master Browser. </para> <para> The <smbconfoption><name>local master</name></smbconfoption> parameter allows Samba to act as a -local master browser. The <smbconfoption><name>preferred master</name></smbconfoption> causes nmbd +Local Master Browser. The <smbconfoption><name>preferred master</name></smbconfoption> causes <command>nmbd</command> to force a browser election on startup and the <smbconfoption><name>os level</name></smbconfoption> -parameter sets Samba high enough so that it should win any browser elections. +parameter sets Samba high enough so it should win any browser elections. </para> <para> -If you have an NT machine on the subnet that you wish to -be the local master browser then you can disable Samba from -becoming a local master browser by setting the following -options in the <smbconfsection>[global]</smbconfsection> section of the -&smb.conf; file : +If you have an NT machine on the subnet that you wish to be the Local Master Browser, you can disable Samba from +becoming a Local Master Browser by setting the following options in the <smbconfsection>[global]</smbconfsection> section of the +&smb.conf; file as shown in <link linkend="nombexample"/>: </para> <para> -<smbconfexample> - <title>smb.conf for not being a master browser</title> - <smbconfsection>[global]</smbconfsection> +<smbconfexample id="nombexample"> +<title>smb.conf for not being a Master Browser</title> +<smbconfsection>[global]</smbconfsection> <smbconfoption><name>domain master</name><value>no</value></smbconfoption> <smbconfoption><name>local master</name><value>no</value></smbconfoption> <smbconfoption><name>preferred master</name><value>no</value></smbconfoption> @@ -524,30 +529,25 @@ options in the <smbconfsection>[global]</smbconfsection> section of the </sect2> <sect2> -<title>Setting up DOMAIN Browsing</title> +<title>DOMAIN Browsing Configuration</title> <para> -If you are adding Samba servers to a Windows NT Domain then -you must not set up a Samba server as a domain master browser. -By default, a Windows NT Primary Domain Controller for a domain -is also the Domain master browser for that domain, and many -things will break if a Samba server registers the Domain master -browser NetBIOS name (<replaceable>DOMAIN</replaceable><1B>) +If you are adding Samba servers to a Windows NT Domain, then you must not set up a Samba server as a Domain Master Browser. +By default, a Windows NT Primary Domain Controller for a domain is also the Domain Master Browser for that domain. Network +browsing may break if a Samba server registers the domain master browser NetBIOS name (<replaceable>DOMAIN</replaceable><1B>) with WINS instead of the PDC. </para> <para> -For subnets other than the one containing the Windows NT PDC -you may set up Samba servers as local master browsers as -described. To make a Samba server a local master browser set -the following options in the <smbconfsection>[global]</smbconfsection> section -of the &smb.conf; file : +For subnets other than the one containing the Windows NT PDC, you may set up Samba servers as Local Master Browsers as +described. To make a Samba server a Local Master Browser, set the following options in the <smbconfsection>[global]</smbconfsection> section +of the &smb.conf; file as shown in <link linkend="remsmb"/>: </para> <para> - <smbconfexample> - <title>Local master browser smb.conf</title> - <smbconfsection>[global]</smbconfsection> +<smbconfexample id="remsmb"> +<title>Local Master Browser smb.conf</title> +<smbconfsection>[global]</smbconfsection> <smbconfoption><name>domain master</name><value>no</value></smbconfoption> <smbconfoption><name>local master</name><value>yes</value></smbconfoption> <smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> @@ -556,28 +556,23 @@ of the &smb.conf; file : </para> <para> -If you wish to have a Samba server fight the election with machines -on the same subnet you may set the <smbconfoption><name>os level</name></smbconfoption> parameter -to lower levels. By doing this you can tune the order of machines that -will become local master browsers if they are running. For -more details on this see the section <link linkend="browse-force-master"> -Forcing Samba to be the master browser</link> -below. +If you wish to have a Samba server fight the election with machines on the same subnet you +may set the <smbconfoption><name>os level</name></smbconfoption> parameter to lower levels. +By doing this you can tune the order of machines that will become Local Master Browsers if +they are running. For more details on this refer to <link linkend="browse-force-master"/>. </para> <para> -If you have Windows NT machines that are members of the domain -on all subnets, and you are sure they will always be running then -you can disable Samba from taking part in browser elections and -ever becoming a local master browser by setting following options -in the <smbconfsection>[global]</smbconfsection> section of the &smb.conf; -file : +If you have Windows NT machines that are members of the domain on all subnets and you are +sure they will always be running, you can disable Samba from taking part in browser elections +and ever becoming a Local Master Browser by setting the following options in the +<smbconfsection>[global]</smbconfsection> section of the &smb.conf; file as shown in <link linkend="xremmb"/>: </para> <para> -<smbconfexample> - <title>smb.conf for not being a master browser</title> - <smbconfsection>[global]</smbconfsection> +<smbconfexample id="xremmb"> +<title>&smb.conf; for not being a master browser</title> +<smbconfsection>[global]</smbconfsection> <smbconfoption><name>domain master</name><value>no</value></smbconfoption> <smbconfoption><name>local master</name><value>no</value></smbconfoption> <smbconfoption><name>preferred master</name><value>no</value></smbconfoption> @@ -588,109 +583,96 @@ file : </sect2> <sect2 id="browse-force-master"> -<title>Forcing Samba to be the master</title> +<title>Forcing Samba to Be the Master</title> <para> -Who becomes the master browser is determined by an election -process using broadcasts. Each election packet contains a number of parameters -which determine what precedence (bias) a host should have in the -election. By default Samba uses a very low precedence and thus loses -elections to just about anyone else. +Who becomes the master browser is determined by an election process using broadcasts. Each election packet contains a number of parameters +that determine what precedence (bias) a host should have in the election. By default Samba uses a low precedence and thus loses +elections to just about every Windows network server or client. </para> <para> -If you want Samba to win elections then just set the <smbconfoption><name>os level</name></smbconfoption> global -option in &smb.conf; to a higher number. It defaults to 0. Using 34 -would make it win all elections over every other system (except other -samba systems!) +If you want Samba to win elections, set the <smbconfoption><name>os level</name></smbconfoption> +global option in &smb.conf; to a higher number. It defaults to zero. Using 34 would make it win +all elections every other system (except other samba systems). </para> <para> -A <smbconfoption><name>os level</name></smbconfoption> of 2 would make it beat WfWg and Win95, but not MS Windows -NT/2K Server. A MS Windows NT/2K Server domain controller uses level 32. +An <smbconfoption><name>os level</name></smbconfoption> of two would make it beat Windows for Workgroups and Windows 9x/Me, but not MS Windows +NT/200x Server. An MS Windows NT/200x Server Domain Controller uses level 32. The maximum os level is 255. </para> -<para>The maximum os level is 255</para> - <para> -If you want Samba to force an election on startup, then set the -<smbconfoption><name>preferred master</name></smbconfoption> global option in &smb.conf; to <constant>yes</constant>. Samba will -then have a slight advantage over other potential master browsers -that are not preferred master browsers. Use this parameter with -care, as if you have two hosts (whether they are Windows 95 or NT or -Samba) on the same local subnet both set with <smbconfoption><name>preferred master</name></smbconfoption> to -<constant>yes</constant>, then periodically and continually they will force an election -in order to become the local master browser. +If you want Samba to force an election on startup, set the +<smbconfoption><name>preferred master</name></smbconfoption> global option in &smb.conf; to <constant>yes</constant>. +Samba will then have a slight advantage over other potential master browsers that are not Perferred Master Browsers. +Use this parameter with care, as if you have two hosts (whether they are Windows 9x/Me or +NT/200x/XP or Samba) on the same local subnet both set with <smbconfoption><name>preferred master</name></smbconfoption> +to <constant>yes</constant>, then periodically and continually they will force an election in order +to become the Local Master Browser. </para> <para> - If you want Samba to be a <emphasis>domain master browser</emphasis>, then it is -recommended that you also set <smbconfoption><name>preferred master</name></smbconfoption> to <constant>yes</constant>, because -Samba will not become a domain master browser for the whole of your -LAN or WAN if it is not also a local master browser on its own -broadcast isolated subnet. +If you want Samba to be a <emphasis>Domain Master Browser</emphasis>, then it is recommended that +you also set <smbconfoption><name>preferred master</name></smbconfoption> to <constant>yes</constant>, because +Samba will not become a Domain Master Browser for the whole of your LAN or WAN if it is not also a +Local Master Browser on its own broadcast isolated subnet. </para> <para> -It is possible to configure two Samba servers to attempt to become -the domain master browser for a domain. The first server that comes -up will be the domain master browser. All other Samba servers will -attempt to become the domain master browser every 5 minutes. They -will find that another Samba server is already the domain master -browser and will fail. This provides automatic redundancy, should -the current domain master browser fail. +It is possible to configure two Samba servers to attempt to become the Domain Master Browser for a domain. The first server that comes +up will be the Domain Master Browser. All other Samba servers will attempt to become the Domain Master Browser every five minutes. They +will find that another Samba server is already the domain master browser and will fail. This provides automatic redundancy, should +the current Domain Master Browser fail. </para> </sect2> <sect2> -<title>Making Samba the domain master</title> +<title>Making Samba the Domain Master</title> <para> -The domain master is responsible for collating the browse lists of -multiple subnets so that browsing can occur between subnets. You can -make Samba act as the domain master by setting <smbconfoption><name>domain master</name><value>yes</value></smbconfoption> -in &smb.conf;. By default it will not be a domain master. +The domain master is responsible for collating the browse lists of multiple subnets so browsing can occur between subnets. You can +make Samba act as the Domain Master by setting <smbconfoption><name>domain master</name><value>yes</value></smbconfoption> +in &smb.conf;. By default it will not be a Domain Master. </para> <para> -Note that you should <emphasis>not</emphasis> set Samba to be the domain master for a -workgroup that has the same name as an NT Domain. +Do not set Samba to be the Domain Master for a workgroup that has the same name as an NT/200x Domain. +If Samba is configured to be the Domain Master for a workgroup that is present on the same +network as a Windows NT/200x domain that has the same name, network browsing problems will +certainly be experienced. </para> <para> -When Samba is the domain master and the master browser, it will listen -for master announcements (made roughly every twelve minutes) from local -master browsers on other subnets and then contact them to synchronise -browse lists. +When Samba is the Domain Master and the Master Browser, it will listen for master +announcements (made roughly every twelve minutes) from Local Master Browsers on +other subnets and then contact them to synchronize browse lists. </para> <para> -If you want Samba to be the domain master then I suggest you also set -the <smbconfoption><name>os level</name></smbconfoption> high enough to make sure it wins elections, and set -<smbconfoption><name>preferred master</name></smbconfoption> to <constant>yes</constant>, to get Samba to force an election on -startup. +If you want Samba to be the domain master, you should also set the +<smbconfoption><name>os level</name></smbconfoption> high enough to make sure it wins elections, and +set <smbconfoption><name>preferred master</name></smbconfoption> to <constant>yes</constant>, to +get Samba to force an election on startup. </para> <para> -Note that all your servers (including Samba) and clients should be -using a WINS server to resolve NetBIOS names. If your clients are only -using broadcasting to resolve NetBIOS names, then two things will occur: +All servers (including Samba) and clients should be using a WINS server to resolve NetBIOS names. If your +clients are only using broadcasting to resolve NetBIOS names, then two things will occur: </para> <orderedlist> <listitem> <para> - your local master browsers will be unable to find a domain master - browser, as it will only be looking on the local subnet. + Local Master Browsers will be unable to find a Domain Master Browser, as they will be looking only on the local subnet. </para> </listitem> <listitem> <para> - if a client happens to get hold of a domain-wide browse list, and - a user attempts to access a host in that list, it will be unable to - resolve the NetBIOS name of that host. + If a client happens to get hold of a domain-wide browse list and a user attempts to access a + host in that list, it will be unable to resolve the NetBIOS name of that host. </para> </listitem> </orderedlist> @@ -702,20 +684,16 @@ If, however, both Samba and your clients are using a WINS server, then: <orderedlist> <listitem> <para> - your local master browsers will contact the WINS server and, as long as - Samba has registered that it is a domain master browser with the WINS - server, your local master browser will receive Samba's IP address - as its domain master browser. + Local master browsers will contact the WINS server and, as long as Samba has registered that it is a Domain Master Browser with the WINS + server, the Local Master Browser will receive Samba's IP address as its Domain Master Browser. </para> </listitem> <listitem> <para> - when a client receives a domain-wide browse list, and a user attempts - to access a host in that list, it will contact the WINS server to - resolve the NetBIOS name of that host. as long as that host has - registered its NetBIOS name with the same WINS server, the user will - be able to see that host. + When a client receives a domain-wide browse list and a user attempts to access a host in that list, it will contact the WINS server to + resolve the NetBIOS name of that host. As long as that host has registered its NetBIOS name with the same WINS server, the user will + be able to see that host. </para> </listitem> </orderedlist> @@ -723,27 +701,24 @@ If, however, both Samba and your clients are using a WINS server, then: </sect2> <sect2> -<title>Note about broadcast addresses</title> +<title>Note about Broadcast Addresses</title> <para> -If your network uses a "0" based broadcast address (for example if it -ends in a 0) then you will strike problems. Windows for Workgroups -does not seem to support a 0's broadcast and you will probably find -that browsing and name lookups won't work. +If your network uses a 0 based broadcast address (for example, if it ends in a 0) then you will strike problems. Windows for Workgroups +does not seem to support a zeros broadcast and you will probably find that browsing and name lookups will not work. </para> </sect2> <sect2> -<title>Multiple interfaces</title> +<title>Multiple Interfaces</title> <para> -Samba now supports machines with multiple network interfaces. If you -have multiple interfaces then you will need to use the <smbconfoption><name>interfaces</name></smbconfoption> -option in &smb.conf; to configure them. +Samba supports machines with multiple network interfaces. If you have multiple interfaces, you will +need to use the <smbconfoption><name>interfaces</name></smbconfoption> option in &smb.conf; to configure them. </para> </sect2> <sect2> -<title>Use of the Remote Announce parameter</title> +<title>Use of the Remote Announce Parameter</title> <para> The <smbconfoption><name>remote announce</name></smbconfoption> parameter of &smb.conf; can be used to forcibly ensure @@ -759,47 +734,37 @@ The syntax of the <smbconfoption><name>remote announce</name></smbconfoption> pa where: <variablelist> -<varlistentry><term><replaceable>a.b.c.d</replaceable> and -<replaceable>e.f.g.h</replaceable></term> -<listitem><para> - <indexterm><primary>LMB</primary><see>Local Master Browser</see></indexterm> + <varlistentry><term><replaceable>a.b.c.d</replaceable> and <replaceable>e.f.g.h</replaceable></term> + <listitem><para> +<indexterm><primary>LMB</primary><see>Local Master Browser</see></indexterm> <indexterm><primary>Local Master Browser</primary></indexterm> - - is either the LMB (Local Master Browser) IP address -or the broadcast address of the remote network. -ie: the LMB is at 192.168.1.10, or the address -could be given as 192.168.1.255 where the netmask -is assumed to be 24 bits (255.255.255.0). -When the remote announcement is made to the broadcast -address of the remote network, every host will receive -our announcements. This is noisy and therefore -undesirable but may be necessary if we do NOT know -the IP address of the remote LMB.</para></listitem> -</varlistentry> - -<varlistentry> -<term><replaceable>WORKGROUP</replaceable></term> -<listitem><para>is optional and can be either our own workgroup -or that of the remote network. If you use the -workgroup name of the remote network then our -NetBIOS machine names will end up looking like -they belong to that workgroup, this may cause -name resolution problems and should be avoided. -</para></listitem> -</varlistentry> + is either the LMB (Local Master Browser) IP address or the broadcast address of the remote network. + i.e., the LMB is at 192.168.1.10, or the address could be given as 192.168.1.255 where the netmask + is assumed to be 24 bits (255.255.255.0). When the remote announcement is made to the broadcast + address of the remote network, every host will receive our announcements. This is noisy and therefore + undesirable but may be necessary if we do not know the IP address of the remote LMB. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>WORKGROUP</replaceable></term> + <listitem><para>is optional and can be either our own workgroup or that of the remote network. If you use the + workgroup name of the remote network, our NetBIOS machine names will end up looking like + they belong to that workgroup. This may cause name resolution problems and should be avoided. + </para></listitem> + </varlistentry> </variablelist> </para> </sect2> <sect2> -<title>Use of the Remote Browse Sync parameter</title> +<title>Use of the Remote Browse Sync Parameter</title> <para> The <smbconfoption><name>remote browse sync</name></smbconfoption> parameter of -&smb.conf; is used to announce to -another LMB that it must synchronise its NetBIOS name list with our -Samba LMB. It works ONLY if the Samba server that has this option is +&smb.conf; is used to announce to another LMB that it must synchronize its NetBIOS name list with our +Samba LMB. This works only if the Samba server that has this option is simultaneously the LMB on its network segment. </para> @@ -819,13 +784,13 @@ remote LMB or else is the network broadcast address of the remote segment. </sect1> <sect1> -<title>WINS - The Windows Internetworking Name Server</title> +<title>WINS &smbmdash; The Windows Internetworking Name Server</title> <para> -Use of WINS (either Samba WINS <emphasis>or</emphasis> MS Windows NT Server WINS) is highly +Use of WINS (either Samba WINS or MS Windows NT Server WINS) is highly recommended. Every NetBIOS machine registers its name together with a name_type value for each of several types of service it has available. -eg: It registers its name directly as a unique (the type 0x03) name. +It registers its name directly as a unique (the type 0x03) name. It also registers its name if it is running the LanManager compatible server service (used to make shares and printers available to other users) by registering the server (the type 0x20) name. @@ -833,38 +798,38 @@ by registering the server (the type 0x20) name. <para> All NetBIOS names are up to 15 characters in length. The name_type variable -is added to the end of the name - thus creating a 16 character name. Any +is added to the end of the name, thus creating a 16 character name. Any name that is shorter than 15 characters is padded with spaces to the 15th -character. ie: All NetBIOS names are 16 characters long (including the +character. Thus, all NetBIOS names are 16 characters long (including the name_type information). </para> <para> -WINS can store these 16 character names as they get registered. A client +WINS can store these 16-character names as they get registered. A client that wants to log onto the network can ask the WINS server for a list of all names that have registered the NetLogon service name_type. This saves broadcast traffic and greatly expedites logon processing. Since broadcast -name resolution can not be used across network segments this type of -information can only be provided via WINS <emphasis>or</emphasis> via statically configured -<filename>lmhosts</filename> files that must reside on all clients in the +name resolution cannot be used across network segments this type of +information can only be provided via WINS or via a statically configured +<filename>lmhosts</filename> file that must reside on all clients in the absence of WINS. </para> <para> -WINS also serves the purpose of forcing browse list synchronisation by all -LMB's. LMB's must synchronise their browse list with the DMB (domain master -browser) and WINS helps the LMB to identify it's DMB. By definition this -will work only within a single workgroup. Note that the domain master browser -has NOTHING to do with what is referred to as an MS Windows NT Domain. The +WINS also serves the purpose of forcing browse list synchronization by all +LMBs. LMBs must synchronize their browse list with the DMB (Domain Master +Browser) and WINS helps the LMB to identify its DMB. By definition this +will work only within a single workgroup. Note that the Domain Master Browser +has nothing to do with what is referred to as an MS Windows NT Domain. The later is a reference to a security environment while the DMB refers to the master controller for browse list information only. </para> <para> -Use of WINS will work correctly only if EVERY client TCP/IP protocol stack -has been configured to use the WINS server/s. Any client that has not been -configured to use the WINS server will continue to use only broadcast based -name registration so that WINS may NEVER get to know about it. In any case, +WINS will work correctly only if every client TCP/IP protocol stack +has been configured to use the WINS servers. Any client that has not been +configured to use the WINS server will continue to use only broadcast-based +name registration so WINS may never get to know about it. In any case, machines that have not registered with a WINS server will fail name to address lookup attempts by other clients and will therefore cause workstation access errors. @@ -878,76 +843,77 @@ file [global] section. <para> To configure Samba to register with a WINS server just add -<smbconfoption><name>wins server</name><value>a.b.c.d</value></smbconfoption> to your &smb.conf; file <smbconfsection>[global]</smbconfsection> section. +<smbconfoption><name>wins server</name><value>a.b.c.d</value></smbconfoption> +to your &smb.conf; file <smbconfsection>[global]</smbconfsection> section. </para> <important><para> Never use both <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> together with <smbconfoption><name>wins server</name><value>a.b.c.d</value></smbconfoption> -particularly not using it's own IP address. -Specifying both will cause &nmbd; to refuse to start! +particularly not using its own IP address. Specifying both will cause &nmbd; to refuse to start! </para></important> <sect2> -<title>Setting up a WINS server</title> +<title>WINS Server Configuration</title> <para> -Either a Samba machine or a Windows NT Server machine may be set up -as a WINS server. To set a Samba machine to be a WINS server you must -add the following option to the &smb.conf; file on the selected machine : -in the <smbconfsection>[global]</smbconfsection> section add the line +Either a Samba Server or a Windows NT Server machine may be set up +as a WINS server. To configure a Samba Server to be a WINS server you must +add to the &smb.conf; file on the selected Server the following line to +the <smbconfsection>[global]</smbconfsection> section: </para> <para> - <smbconfblock> +<smbconfblock> <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> </smbconfblock> </para> <para> Versions of Samba prior to 1.9.17 had this parameter default to -yes. If you have any older versions of Samba on your network it is +yes. If you have any older versions of Samba on your network it is strongly suggested you upgrade to a recent version, or at the very -least set the parameter to 'no' on all these machines. +least set the parameter to <quote>no</quote> on all these machines. </para> <para> -Machines with <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> will keep a list of +Machines configured with <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> will keep a list of all NetBIOS names registered with them, acting as a DNS for NetBIOS names. </para> <para> -You should set up only ONE WINS server. Do NOT set the +It is strongly recommended to set up only one WINS server. Do not set the <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> option on more than one Samba server. </para> <para> -To set up a Windows NT Server as a WINS server you need to set up -the WINS service - see your NT documentation for details. Note that -Windows NT WINS Servers can replicate to each other, allowing more -than one to be set up in a complex subnet environment. As Microsoft -refuses to document these replication protocols, Samba cannot currently -participate in these replications. It is possible in the future that -a Samba->Samba WINS replication protocol may be defined, in which -case more than one Samba machine could be set up as a WINS server -but currently only one Samba server should have the +<indexterm><primary>replication</primary><secondary>WINS</secondary></indexterm> +To configure Windows NT/200x Server as a WINS server, install and configure +the WINS service. See the Windows NT/200x documentation for details. +Windows NT/200x WINS servers can replicate to each other, allowing more +than one to be set up in a complex subnet environment. As Microsoft +refuses to document the replication protocols, Samba cannot currently +participate in these replications. It is possible in the future that +a Samba-to-Samba WINS replication protocol may be defined, in which +case more than one Samba machine could be set up as a WINS server. +Currently only one Samba server should have the <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> parameter set. </para> <para> -After the WINS server has been configured you must ensure that all +After the WINS server has been configured, you must ensure that all machines participating on the network are configured with the address -of this WINS server. If your WINS server is a Samba machine, fill in +of this WINS server. If your WINS server is a Samba machine, fill in the Samba machine IP address in the <guilabel>Primary WINS Server</guilabel> field of the <guilabel>Control Panel->Network->Protocols->TCP->WINS Server</guilabel> dialogs -in Windows 95 or Windows NT. To tell a Samba server the IP address -of the WINS server add the following line to the <smbconfsection>[global]</smbconfsection> section of -all &smb.conf; files : +in Windows 9x/Me or Windows NT/200x. To tell a Samba server the IP address +of the WINS server, add the following line to the <smbconfsection>[global]</smbconfsection> section of +all &smb.conf; files: </para> <para> - <smbconfblock> +<smbconfblock> <smbconfoption><name>wins server</name><value><name or IP address></value></smbconfoption> </smbconfblock> </para> @@ -958,18 +924,18 @@ machine or its IP address. </para> <para> -Note that this line MUST NOT BE SET in the &smb.conf; file of the Samba -server acting as the WINS server itself. If you set both the +This line must not be set in the &smb.conf; file of the Samba +server acting as the WINS server itself. If you set both the <smbconfoption><name>wins support</name><value>yes</value></smbconfoption> option and the <smbconfoption><name>wins server</name><value><name></value></smbconfoption> option then -nmbd will fail to start. +<command>nmbd</command> will fail to start. </para> <para> -There are two possible scenarios for setting up cross subnet browsing. -The first details setting up cross subnet browsing on a network containing -Windows 95, Samba and Windows NT machines that are not configured as -part of a Windows NT Domain. The second details setting up cross subnet +There are two possible scenarios for setting up cross-subnet browsing. +The first details setting up cross-subnet browsing on a network containing +Windows 9x/Me, Samba and Windows NT/200x machines that are not configured as +part of a Windows NT Domain. The second details setting up cross-subnet browsing on networks that contain NT Domains. </para> @@ -979,9 +945,10 @@ browsing on networks that contain NT Domains. <title>WINS Replication</title> <para> +<indexterm><primary>replication</primary><secondary>WINS</secondary></indexterm> Samba-3 permits WINS replication through the use of the <filename>wrepld</filename> utility. This tool is not currently capable of being used as it is still in active development. -As soon as this tool becomes moderately functional we will prepare man pages and enhance this +As soon as this tool becomes moderately functional, we will prepare man pages and enhance this section of the documentation to provide usage and technical details. </para> @@ -996,7 +963,7 @@ located in <filename class="directory">/usr/local/samba/var/locks</filename>. </para> <para> -Entries in <filename>wins.dat</filename> take the form of +Entries in <filename>wins.dat</filename> take the form of: <programlisting> "NAME#TYPE" TTL ADDRESS+ FLAGS @@ -1009,12 +976,12 @@ flags for the registration. </para> <para> -A typical dynamic entry looks like: +A typical dynamic entry looks like this: <programlisting> "MADMAN#03" 1055298378 192.168.1.2 66R </programlisting> -To make it static, all that has to be done is set the TTL to 0: +To make it static, all that has to be done is set the TTL to 0, like this: <programlisting> "MADMAN#03" 0 192.168.1.2 66R @@ -1022,7 +989,7 @@ To make it static, all that has to be done is set the TTL to 0: </para> <para> -Though this method works with early Samba-3 versions, there's a +Though this method works with early Samba-3 versions, there is a possibility that it may change in future versions if WINS replication is added. </para> @@ -1042,11 +1009,11 @@ for many new network administrators. <title>Windows Networking Protocols</title> <warning><para> -Do NOT use more than one (1) protocol on MS Windows machines +Do not use more than one protocol on MS Windows machines. </para></warning> <para> -A very common cause of browsing problems results from installing more than +A common cause of browsing problems results from installing more than one protocol on an MS Windows machine. </para> @@ -1054,33 +1021,33 @@ one protocol on an MS Windows machine. Every NetBIOS machine takes part in a process of electing the LMB (and DMB) every 15 minutes. A set of election criteria is used to determine the order of precedence for winning this election process. A machine running Samba or -Windows NT will be biased so that the most suitable machine will predictably -win and thus retain it's role. +Windows NT will be biased so the most suitable machine will predictably +win and thus retain its role. </para> <para> -The election process is "fought out" so to speak over every NetBIOS network -interface. In the case of a Windows 9x machine that has both TCP/IP and IPX -installed and has NetBIOS enabled over both protocols the election will be -decided over both protocols. As often happens, if the Windows 9x machine is +The election process is <quote>fought out</quote> so to speak over every NetBIOS network +interface. In the case of a Windows 9x/Me machine that has both TCP/IP and IPX +installed and has NetBIOS enabled over both protocols, the election will be +decided over both protocols. As often happens, if the Windows 9x/Me machine is the only one with both protocols then the LMB may be won on the NetBIOS interface over the IPX protocol. Samba will then lose the LMB role as Windows -9x will insist it knows who the LMB is. Samba will then cease to function -as an LMB and thus browse list operation on all TCP/IP only machines will +9x/Me will insist it knows who the LMB is. Samba will then cease to function +as an LMB and thus browse list operation on all TCP/IP-only machines will fail. </para> -<para><emphasis> -Windows 95, 98, 98se, Me are referred to generically as Windows 9x. -The Windows NT4, 2000, XP and 2003 use common protocols. These are roughly -referred to as the WinNT family, but it should be recognised that 2000 and +<para> +Windows 95, 98, 98se, and Me are referred to generically as Windows 9x/Me. +The Windows NT4, 200x, and XP use common protocols. These are roughly +referred to as the Windows NT family, but it should be recognized that 2000 and XP/2003 introduce new protocol extensions that cause them to behave -differently from MS Windows NT4. Generally, where a server does NOT support +differently from MS Windows NT4. Generally, where a server does not support the newer or extended protocol, these will fall back to the NT4 protocols. -</emphasis></para> +</para> <para> -The safest rule of all to follow it this - USE ONLY ONE PROTOCOL! +The safest rule of all to follow is: use only one protocol! </para> </sect2> @@ -1095,21 +1062,21 @@ are: </para> <itemizedlist> - <listitem><para>WINS: the best tool!</para></listitem> - <listitem><para>LMHOSTS: is static and hard to maintain.</para></listitem> - <listitem><para>Broadcast: uses UDP and can not resolve names across remote segments.</para></listitem> + <listitem>WINS &smbmdash; the best tool.</listitem> + <listitem>LMHOSTS &smbmdash; static and hard to maintain.</listitem> + <listitem>Broadcast &smbmdash; uses UDP and cannot resolve names across remote segments.</listitem> </itemizedlist> <para> -Alternative means of name resolution includes: +Alternative means of name resolution include: </para> <itemizedlist> -<listitem><para><filename>/etc/hosts</filename>: is static, hard to maintain, and lacks name_type info</para></listitem> -<listitem><para>DNS: is a good choice but lacks essential name_type info.</para></listitem> +<listitem>Static <filename>/etc/hosts</filename> &smbmdash; hard to maintain, and lacks name_type info.</listitem> +<listitem>DNS &smbmdash; is a good choice but lacks essential name_type info.</listitem> </itemizedlist> <para> -Many sites want to restrict DNS lookups and want to avoid broadcast name +Many sites want to restrict DNS lookups and avoid broadcast name resolution traffic. The <parameter>name resolve order</parameter> parameter is of great help here. The syntax of the <parameter>name resolve order</parameter> parameter is: <smbconfblock> @@ -1123,7 +1090,7 @@ The default is: <smbconfblock> <smbconfoption><name>name resolve order</name><value>host lmhost wins bcast</value></smbconfoption> </smbconfblock> -where "host" refers to the native methods used by the UNIX system +where <quote>host</quote> refers to the native methods used by the UNIX system to implement the gethostbyname() function call. This is normally controlled by <filename>/etc/host.conf</filename>, <filename>/etc/nsswitch.conf</filename> and <filename>/etc/resolv.conf</filename>. </para> @@ -1131,68 +1098,67 @@ controlled by <filename>/etc/host.conf</filename>, <filename>/etc/nsswitch.conf< </sect1> <sect1> -<title>Technical Overview of browsing</title> +<title>Technical Overview of Browsing</title> <para> SMB networking provides a mechanism by which clients can access a list -of machines in a network, a so-called <smbconfoption><name>browse list</name></smbconfoption>. This list +of machines in a network, a so-called <smbconfoption><name>browse list</name></smbconfoption>. This list contains machines that are ready to offer file and/or print services to other machines within the network. Thus it does not include -machines which aren't currently able to do server tasks. The browse -list is heavily used by all SMB clients. Configuration of SMB +machines that aren't currently able to do server tasks. The browse +list is heavily used by all SMB clients. Configuration of SMB browsing has been problematic for some Samba users, hence this document. </para> <para> -MS Windows 2000 and later, as with Samba 3 and later, can be +MS Windows 2000 and later versions, as with Samba-3 and later versions, can be configured to not use NetBIOS over TCP/IP. When configured this way, it is imperative that name resolution (using DNS/LDAP/ADS) be correctly -configured and operative. Browsing will NOT work if name resolution +configured and operative. Browsing will not work if name resolution from SMB machine names to IP addresses does not function correctly. </para> <para> -Where NetBIOS over TCP/IP is enabled use of a WINS server is highly +Where NetBIOS over TCP/IP is enabled, use of a WINS server is highly recommended to aid the resolution of NetBIOS (SMB) names to IP addresses. WINS allows remote segment clients to obtain NetBIOS name_type information -that can NOT be provided by any other means of name resolution. +that cannot be provided by any other means of name resolution. </para> <sect2> -<title>Browsing support in Samba</title> +<title>Browsing Support in Samba</title> <para> -Samba facilitates browsing. The browsing is supported by &nmbd; +Samba facilitates browsing. The browsing is supported by &nmbd; and is also controlled by options in the &smb.conf; file. Samba can act as a local browse master for a workgroup and the ability to support domain logons and scripts is now available. </para> <para> -Samba can also act as a domain master browser for a workgroup. This -means that it will collate lists from local browse masters into a -wide area network server list. In order for browse clients to +Samba can also act as a Domain Master Browser for a workgroup. This +means that it will collate lists from Local Master Browsers into a +wide area network server list. In order for browse clients to resolve the names they may find in this list, it is recommended that both Samba and your clients use a WINS server. </para> <para> -Note that you should NOT set Samba to be the domain master for a -workgroup that has the same name as an NT Domain: on each wide area -network, you must only ever have one domain master browser per workgroup, -regardless of whether it is NT, Samba or any other type of domain master -that is providing this service. +Do not set Samba to be the Domain Master for a workgroup that has the same +name as an NT Domain. On each wide area network, you must only ever have one +Domain Master Browser per workgroup, regardless of whether it is NT, Samba +or any other type of domain master that is providing this service. </para> <note><para> -Nmbd can be configured as a WINS server, but it is not -necessary to specifically use Samba as your WINS server. MS Windows -NT4, Server or Advanced Server 2000 or 2003 can be configured as -your WINS server. In a mixed NT/2000/2003 server and Samba environment on +<command>nmbd</command> can be configured as a WINS server, but it is not +necessary to specifically use Samba as your WINS server. MS Windows +NT4, Server or Advanced Server 200x can be configured as +your WINS server. In a mixed NT/200x server and Samba environment on a Wide Area Network, it is recommended that you use the Microsoft -WINS server capabilities. In a Samba-only environment, it is -recommended that you use one and only one Samba server as your WINS server. +WINS server capabilities. In a Samba-only environment, it is +recommended that you use one and only one Samba server as the WINS server. </para></note> <para> @@ -1203,151 +1169,151 @@ to control what workgroup Samba becomes a part of. <para> Samba also has a useful option for a Samba server to offer itself for -browsing on another subnet. It is recommended that this option is only -used for 'unusual' purposes: announcements over the internet, for -example. See <smbconfoption><name>remote announce</name></smbconfoption> in the -&smb.conf; man page. +browsing on another subnet. It is recommended that this option is only +used for <quote>unusual</quote> purposes: announcements over the Internet, for +example. See <smbconfoption><name>remote announce</name></smbconfoption> in the +&smb.conf; man page. </para> </sect2> <sect2> -<title>Problem resolution</title> +<title>Problem Resolution</title> <para> -If something doesn't work then hopefully the log.nmbd file will help -you track down the problem. Try a debug level of 2 or 3 for finding +If something does not work, the <filename>log.nmbd</filename> file will help +to track down the problem. Try a <smbconfoption><name>log level</name><value></value></smbconfoption> of 2 or 3 for finding problems. Also note that the current browse list usually gets stored in text form in a file called <filename>browse.dat</filename>. </para> <para> -Note that if it doesn't work for you, then you should still be able to -type the server name as <filename>\\SERVER</filename> in filemanager then -hit enter and filemanager should display the list of available shares. +If it does not work, you should still be able to +type the server name as <filename>\\SERVER</filename> in <command>filemanager</command>, then +press enter and <command>filemanager</command> should display the list of available shares. </para> <para> -Some people find browsing fails because they don't have the global -<smbconfoption><name>guest account</name></smbconfoption> set to a valid account. Remember that the -IPC$ connection that lists the shares is done as guest, and thus you must -have a valid guest account. +Some people find browsing fails because they do not have the global +<smbconfoption><name>guest account</name></smbconfoption> set to a valid account. Remember that the +IPC$ connection that lists the shares is done as guest and, thus, you must have a valid guest account. </para> -<para><emphasis> -MS Windows 2000 and upwards (as with Samba) can be configured to disallow -anonymous (ie: Guest account) access to the IPC$ share. In that case, the +<para> +MS Windows 2000 and later (as with Samba) can be configured to disallow +anonymous (i.e., guest account) access to the IPC$ share. In that case, the MS Windows 2000/XP/2003 machine acting as an SMB/CIFS client will use the -name of the currently logged in user to query the IPC$ share. MS Windows -9X clients are not able to do this and thus will NOT be able to browse +name of the currently logged-in user to query the IPC$ share. MS Windows +9x/Me clients are not able to do this and thus will not be able to browse server resources. -</emphasis></para> +</para> <para> The other big problem people have is that their broadcast address, -netmask or IP address is wrong (specified with the "interfaces" option +netmask or IP address is wrong (specified with the <smbconfoption><name>interfaces</name><value></value></smbconfoption> option in &smb.conf;) </para> </sect2> <sect2> -<title>Browsing across subnets</title> +<title>Cross-Subnet Browsing</title> + <para> -Since the release of Samba 1.9.17(alpha1), Samba has supported the +<indexterm><primary>replication</primary><secondary>browse lists</secondary></indexterm> +Since the release of Samba 1.9.17 (alpha1), Samba has supported the replication of browse lists across subnet boundaries. This section describes how to set this feature up in different settings. </para> <para> -To see browse lists that span TCP/IP subnets (ie. networks separated -by routers that don't pass broadcast traffic), you must set up at least -one WINS server. The WINS server acts as a DNS for NetBIOS names, allowing -NetBIOS name to IP address translation to be done by doing a direct -query of the WINS server. This is done via a directed UDP packet on -port 137 to the WINS server machine. The reason for a WINS server is -that by default, all NetBIOS name to IP address translation is done -by broadcasts from the querying machine. This means that machines +To see browse lists that span TCP/IP subnets (i.e., networks separated +by routers that do not pass broadcast traffic), you must set up at least +one WINS server. The WINS server acts as a DNS for NetBIOS names. This will +allow NetBIOS name-to-IP address translation to be completed by a direct +query of the WINS server. This is done via a directed UDP packet on +port 137 to the WINS server machine. The WINS server avoids the necessity +of default NetBIOS name-to-IP address translation, which is done +using UDP broadcasts from the querying machine. This means that machines on one subnet will not be able to resolve the names of machines on another subnet without using a WINS server. </para> <para> Remember, for browsing across subnets to work correctly, all machines, -be they Windows 95, Windows NT, or Samba servers must have the IP address +be they Windows 95, Windows NT or Samba servers, must have the IP address of a WINS server given to them by a DHCP server, or by manual configuration -(for Win95 and WinNT, this is in the TCP/IP Properties, under Network -settings) for Samba this is in the &smb.conf; file. +(for Windows 9x/Me and Windows NT/200x/XP, this is in the TCP/IP Properties, under Network +settings); for Samba, this is in the &smb.conf; file. </para> <sect3> -<title>How does cross subnet browsing work ?</title> +<title>Behavior of Cross-Subnet Browsing</title> <para> -Cross subnet browsing is a complicated dance, containing multiple -moving parts. It has taken Microsoft several years to get the code +Cross-subnet Browsing is a complicated dance, containing multiple +moving parts. It has taken Microsoft several years to get the code that achieves this correct, and Samba lags behind in some areas. -Samba is capable of cross subnet browsing when configured correctly. +Samba is capable of cross-subnet browsing when configured correctly. </para> <para> - Consider a network set up as <link linkend="browsing1">in the diagram below</link>. +Consider a network set up as <link linkend="browsing1"/>. </para> -<image><imagedescription>Cross subnet browsing example</imagedescription><imagefile>browsing1</imagefile></image> +<image id="browsing1" scale="40"><imagedescription>Cross-Subnet Browsing Example.</imagedescription><imagefile>browsing1</imagefile></image> <para> -Consisting of 3 subnets (1, 2, 3) connected by two routers -(R1, R2) - these do not pass broadcasts. Subnet 1 has 5 machines -on it, subnet 2 has 4 machines, subnet 3 has 4 machines. Assume -for the moment that all these machines are configured to be in the -same workgroup (for simplicity's sake). Machine N1_C on subnet 1 -is configured as Domain Master Browser (ie. it will collate the -browse lists for the workgroup). Machine N2_D is configured as +This consists of 3 subnets (1, 2, 3) connected by two routers +(R1, R2) which do not pass broadcasts. Subnet 1 has five machines +on it, subnet 2 has four machines, subnet 3 has four machines. Assume +for the moment that all machines are configured to be in the +same workgroup (for simplicity's sake). Machine N1_C on subnet 1 +is configured as Domain Master Browser (i.e., it will collate the +browse lists for the workgroup). Machine N2_D is configured as WINS server and all the other machines are configured to register their NetBIOS names with it. </para> <para> -As all these machines are booted up, elections for master browsers -will take place on each of the three subnets. Assume that machine +As these machines are booted up, elections for master browsers +will take place on each of the three subnets. Assume that machine N1_C wins on subnet 1, N2_B wins on subnet 2, and N3_D wins on -subnet 3 - these machines are known as local master browsers for -their particular subnet. N1_C has an advantage in winning as the -local master browser on subnet 1 as it is set up as Domain Master +subnet 3. These machines are known as Local Master Browsers for +their particular subnet. N1_C has an advantage in winning as the +Local Master Browser on subnet 1 as it is set up as Domain Master Browser. </para> <para> On each of the three networks, machines that are configured to offer sharing services will broadcast that they are offering -these services. The local master browser on each subnet will +these services. The Local Master Browser on each subnet will receive these broadcasts and keep a record of the fact that -the machine is offering a service. This list of records is -the basis of the browse list. For this case, assume that -all the machines are configured to offer services so all machines +the machine is offering a service. This list of records is +the basis of the browse list. For this case, assume that +all the machines are configured to offer services, so all machines will be on the browse list. </para> <para> -For each network, the local master browser on that network is -considered 'authoritative' for all the names it receives via -local broadcast. This is because a machine seen by the local -master browser via a local broadcast must be on the same -network as the local master browser and thus is a 'trusted' -and 'verifiable' resource. Machines on other networks that -the local master browsers learn about when collating their -browse lists have not been directly seen - these records are -called 'non-authoritative'. +For each network, the Local Master Browser on that network is +considered <quote>authoritative</quote> for all the names it receives via +local broadcast. This is because a machine seen by the Local Master +Browser via a local broadcast must be on the same network as the +Local Master Browser and thus is a <quote>trusted</quote> +and <quote>verifiable</quote> resource. Machines on other networks that +the Local Master Browsers learn about when collating their +browse lists have not been directly seen. These records are +called <quote>non-authoritative.</quote> </para> <para> -At this point the browse lists look as follows (these are -the machines you would see in your network neighborhood if -you looked in it on a particular network right now). +At this point the browse lists appear as shown in <link linkend="browsubnet"/> (these are +the machines you would see in your network neighborhood if you looked in it on a particular network right now). </para> <para> -<table frame="all"> - <title>Browse subnet example 1</title> +<table frame="all" id="browsubnet"> + <title>Browse Subnet Example 1</title> <tgroup align="left" cols="3"> <thead> <row><entry>Subnet</entry><entry>Browse Master</entry><entry>List</entry></row> @@ -1363,38 +1329,36 @@ you looked in it on a particular network right now). </para> <para> -Note that at this point all the subnets are separate, no -machine is seen across any of the subnets. +At this point all the subnets are separate, and no machine is seen across any of the subnets. </para> <para> -Now examine subnet 2. As soon as N2_B has become the local -master browser it looks for a Domain master browser to synchronize -its browse list with. It does this by querying the WINS server +Now examine subnet 2. As soon as N2_B has become the Local +Master Browser it looks for a Domain Master Browser with which to synchronize +its browse list. It does this by querying the WINS server (N2_D) for the IP address associated with the NetBIOS name -WORKGROUP<1B>. This name was registered by the Domain master -browser (N1_C) with the WINS server as soon as it was booted. +WORKGROUP<1B>. This name was registered by the Domain Master +Browser (N1_C) with the WINS server as soon as it was started. </para> <para> -Once N2_B knows the address of the Domain master browser it -tells it that is the local master browser for subnet 2 by -sending a MasterAnnouncement packet as a UDP port 138 packet. -It then synchronizes with it by doing a NetServerEnum2 call. This +Once N2_B knows the address of the Domain Master Browser, it +tells it that is the Local Master Browser for subnet 2 by +sending a <emphasis>MasterAnnouncement</emphasis> packet as a UDP port 138 packet. +It then synchronizes with it by doing a <emphasis>NetServerEnum2</emphasis> call. This tells the Domain Master Browser to send it all the server -names it knows about. Once the domain master browser receives -the MasterAnnouncement packet it schedules a synchronization -request to the sender of that packet. After both synchronizations -are done the browse lists look like : +names it knows about. Once the Domain Master Browser receives +the <emphasis>MasterAnnouncement</emphasis> packet, it schedules a synchronization +request to the sender of that packet. After both synchronizations +are complete the browse lists look as shown in <link linkend="brsbex"/>: </para> -<para> -<table frame="all"> - <title>Browse subnet example 2</title> +<table frame="all" id="brsbex"> + <title>Browse Subnet Example 2</title> <tgroup cols="3"> <colspec align="left"/> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" colwidth="1*"/> <thead> <row><entry>Subnet</entry><entry>Browse Master</entry><entry>List</entry></row> </thead> @@ -1409,7 +1373,8 @@ N1_B(*), N1_C(*), N1_D(*), N1_E(*)</entry></row> </tgroup> </table> -Servers with a (*) after them are non-authoritative names. +<para> +Servers with an (*) after them are non-authoritative names. </para> <para> @@ -1420,20 +1385,19 @@ subnet 3 will still only see the servers on their own subnet. <para> The same sequence of events that occurred for N2_B now occurs -for the local master browser on subnet 3 (N3_D). When it -synchronizes browse lists with the domain master browser (N1_A) +for the Local Master Browser on subnet 3 (N3_D). When it +synchronizes browse lists with the Domain Master Browser (N1_A) it gets both the server entries on subnet 1, and those on -subnet 2. After N3_D has synchronized with N1_C and vica-versa -the browse lists look like. +subnet 2. After N3_D has synchronized with N1_C and vica versa, +the browse lists will appear as shown in <link linkend="brsex2"/>. </para> -<para> -<table frame="all"> - <title>Browse subnet example 3</title> +<table frame="all" id="brsex2"> + <title>Browse Subnet Example 3</title> <tgroup cols="3" align="left"> <colspec align="left"/> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" colwidth="1*"/> <thead> <row><entry>Subnet</entry><entry>Browse Master</entry><entry>List</entry></row> @@ -1450,29 +1414,30 @@ N1_B(*), N1_C(*), N1_D(*), N1_E(*), N2_A(*), N2_B(*), N2_C(*), N2_D(*)</entry></ </tgroup> </table> -Servers with a (*) after them are non-authoritative names. +<para> +Servers with an (*) after them are non-authoritative names. </para> <para> -At this point users looking in their network neighborhood on -subnets 1 or 3 will see all the servers on all subnets, users on +At this point, users looking in their network neighborhood on +subnets 1 or 3 will see all the servers on all subnets, while users on subnet 2 will still only see the servers on subnets 1 and 2, but not 3. </para> <para> -Finally, the local master browser for subnet 2 (N2_B) will sync again -with the domain master browser (N1_C) and will receive the missing -server entries. Finally - and as a steady state (if no machines -are removed or shut off) the browse lists will look like : +Finally, the Local Master Browser for subnet 2 (N2_B) will sync again +with the Domain Master Browser (N1_C) and will receive the missing +server entries. Finally, as when a steady state (if no machines +are removed or shut off) has been achieved, the browse lists will appear +as shown in <link linkend="brsex3"/>. </para> -<para> -<table frame="all"> - <title>Browse subnet example 4</title> +<table frame="all" id="brsex3"> + <title>Browse Subnet Example 4</title> <tgroup cols="3" align="left"> <colspec align="left"/> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" width="1*"/> <thead> <row><entry>Subnet</entry><entry>Browse Master</entry><entry>List</entry></row> @@ -1491,25 +1456,26 @@ N2_C(*), N2_D(*)</entry></row> </tbody> </tgroup> </table> - -Servers with a (*) after them are non-authoritative names. + +<para> +Servers with an (*) after them are non-authoritative names. </para> <para> -Synchronizations between the domain master browser and local -master browsers will continue to occur, but this should be a -steady state situation. +Synchronizations between the Domain Master Browser and Local +Master Browsers will continue to occur, but this should remain a +steady state operation. </para> <para> -If either router R1 or R2 fails the following will occur: +If either router R1 or R2 fails, the following will occur: </para> <orderedlist> <listitem> <para> Names of computers on each side of the inaccessible network fragments - will be maintained for as long as 36 minutes, in the network neighbourhood + will be maintained for as long as 36 minutes in the network neighborhood lists. </para> </listitem> @@ -1517,15 +1483,15 @@ If either router R1 or R2 fails the following will occur: <listitem> <para> Attempts to connect to these inaccessible computers will fail, but the - names will not be removed from the network neighbourhood lists. + names will not be removed from the network neighborhood lists. </para> </listitem> <listitem> <para> If one of the fragments is cut off from the WINS server, it will only - be able to access servers on its local subnet, by using subnet-isolated - broadcast NetBIOS name resolution. The effects are similar to that of + be able to access servers on its local subnet using subnet-isolated + broadcast NetBIOS name resolution. The effects are similar to that of losing access to a DNS server. </para> </listitem> @@ -1539,54 +1505,126 @@ If either router R1 or R2 fails the following will occur: <para> Many questions are asked on the mailing lists regarding browsing. The majority of browsing -problems originate out of incorrect configuration of NetBIOS name resolution. Some are of +problems originate from incorrect configuration of NetBIOS name resolution. Some are of particular note. </para> <sect2> -<title>How can one flush the Samba NetBIOS name cache without restarting Samba?</title> +<title>How Can One Flush the Samba NetBIOS Name Cache without Restarting Samba?</title> <para> -Samba's nmbd process controls all browse list handling. Under normal circumstances it is -safe to restart nmbd. This will effectively flush the Samba NetBIOS name cache and cause it -to be rebuilt. Note that this does NOT make certain that a rogue machine name will not re-appear -in the browse list. When nmbd is taken out of service another machine on the network will -become the browse master. This new list may still have the rogue entry in it. If you really -want to clear a rogue machine from the list then every machine on the network will need to be -shut down and restarted at after all machines are down. Failing a complete restart, the only +<indexterm><primary>flush name cache</primary></indexterm> +Samba's <command>nmbd</command> process controls all browse list handling. Under normal circumstances it is +safe to restart <command>nmbd</command>. This will effectively flush the Samba NetBIOS name cache and cause it +to be rebuilt. This does not make certain that a rogue machine name will not re-appear +in the browse list. When <command>nmbd</command> is taken out of service, another machine on the network will +become the Browse Master. This new list may still have the rogue entry in it. If you really +want to clear a rogue machine from the list, every machine on the network will need to be +shut down and restarted after all machines are down. Failing a complete restart, the only other thing you can do is wait until the entry times out and is then flushed from the list. -This may take a long time on some networks (months). +This may take a long time on some networks (perhaps months). </para> </sect2> - + <sect2> -<title>My client reports "This server is not configured to list shared resources"</title> + <title>Server Resources Can Not Be Listed</title> +<para><quote>My Client Reports <quote>This server is not configured to list shared resources</quote></quote></para> + + <para> Your guest account is probably invalid for some reason. Samba uses the -guest account for browsing in smbd. Check that your guest account is +guest account for browsing in <command>smbd</command>. Check that your guest account is valid. </para> -<para>See also <smbconfoption><name>guest account</name></smbconfoption> in the &smb.conf; man page.</para> +<para>Also see <smbconfoption><name>guest account</name></smbconfoption> in the &smb.conf; man page.</para> </sect2> <sect2> - <title>I get an <errorname>Unable to browse the network</errorname> error</title> + <title>I get an <errorname>`Unable to browse the network'</errorname> error</title> - <para>This error can have multiple causes:</para> + <para>This error can have multiple causes: +<indexterm><primary>browsing problems</primary></indexterm> + </para> <itemizedlist> - <listitem><para>There is no local master browser. Configure &nmbd; - or any other machine to serve as local master browser.</para></listitem> - <listitem><para>You can not log onto the machine that is the local master - browser. Can you logon to it as guest user? </para></listitem> - <listitem><para>There is no IP connectivity to the local master browser. + <listitem><para>There is no Local Master Browser. Configure &nmbd; + or any other machine to serve as Local Master Browser.</para></listitem> + <listitem><para>You cannot log onto the machine that is the local master + browser. Can you logon to it as a guest user? </para></listitem> + <listitem><para>There is no IP connectivity to the Local Master Browser. Can you reach it by broadcast?</para></listitem> </itemizedlist> </sect2> +<sect2> +<title>Browsing of Shares and Directories is Very Slow</title> + +<para><quote> +<indexterm><primary>slow browsing</primary></indexterm> +There are only two machines on a test network. One a Samba server, the other a Windows XP machine. +Authentication and logons work perfectly, but when I try to explore shares on the Samba server, the +Windows XP client becomes unrespsonsive. Sometimes it does not respond for some minutes. Eventually, +Windows Explorer will respond and displays files and directories without problem. +display file and directory.</quote> +</para> + +<para><quote> +But, the share is immediately available from a command shell (<command>cmd</command>, followed by +exploration with dos command. Is this a Samba problem or is it a Windows problem? How can I solve this? +</quote></para> + +<para> +Here are a few possibilities: +</para> + +<variablelist> + <varlistentry> + <term>Bad Networking Hardware</term> + <listitem><para> +<indexterm><primary>bad hardware</primary></indexterm> +<indexterm><primary>WebClient</primary></indexterm> + Most common defective hardware problems center around low cost or defective HUBs, routers, + Network Interface Controllers (NICs) and bad wiring. If one piece of hardware is defective + the whole network may suffer. Bad networking hardware can cause data corruption. Most bad + networking hardware problems are accompanied by an increase in apparent network traffic, + but not all. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>The Windows XP WebClient</term> + <listitem><para> + A number of sites have reported similar slow network browsing problems and found that when + the WebClient service is turned off, the problem dissapears. This is certainly something + that should be explored as it is a simple solution &smbmdash; if it works. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>Inconsistent WINS Configuration</term> + <listitem><para> + This type of problem is common when one client is configured to use a WINS server (that is + a TCP/IP configuration setting) and there is no WINS server on the network. Alternately, + this will happen is there is a WINS server and Samba is not configured to use it. The use of + WINS is highly recommended if the network is using NetBIOS over TCP/IP protocols. If use + of NetBIOS over TCP/IP is disabled on all clients, Samba should not be configured as a WINS + server neither should it be configured to use one. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>Incorrect DNS Configuration</term> + <listitem><para> + If use of NetBIOS over TCP/IP is disabled, Active Directory is in use and the DNS server + has been incorrectly configured. Refer <link linkend="adsdnstech"/> for more information. + </para></listitem> + </varlistentry> +</variablelist> + +</sect2> </sect1> </chapter> diff --git a/docs/docbook/projdoc/Other-Clients.xml b/docs/docbook/projdoc/Other-Clients.xml index 968a584f9d..76909e5236 100644 --- a/docs/docbook/projdoc/Other-Clients.xml +++ b/docs/docbook/projdoc/Other-Clients.xml @@ -1,41 +1,38 @@ <chapter id="Other-Clients"> <chapterinfo> &author.jelmer; + &author.jht; + &author.danshearer; <author>&person.jmcd;<contrib>OS/2</contrib></author> <pubdate>5 Mar 2001</pubdate> </chapterinfo> -<title>Samba and other CIFS clients</title> +<title>Samba and Other CIFS Clients</title> <para>This chapter contains client-specific information.</para> <sect1> -<title>Macintosh clients?</title> +<title>Macintosh Clients</title> <para> - Yes. <ulink url="http://www.thursby.com/">Thursby</ulink> now has a CIFS Client / Server called <ulink url="http://www.thursby.com/products/dave.html">DAVE</ulink> -</para> - -<para> -They test it against Windows 95, Windows NT and samba for -compatibility issues. At the time of writing, DAVE was at version -1.0.1. The 1.0.0 to 1.0.1 update is available as a free download from -the Thursby web site (the speed of finder copies has been greatly -enhanced, and there are bug-fixes included). +Yes. <ulink url="http://www.thursby.com/">Thursby</ulink> has a CIFS Client/Server called <ulink url="http://www.thursby.com/products/dave.html">DAVE.</ulink> +They test it against Windows 95, Windows NT /200x/XP and Samba for +compatibility issues. At the time of this writing, DAVE was at version +4.1. Please refer to Thursby's Web site for more information regarding this +product. </para> <para> -Alternatives - There are two free implementations of AppleTalk for -several kinds of UNIX machines, and several more commercial ones. +Alternatives &smbmdash; There are two free implementations of AppleTalk for +several kinds of UNIX machines and several more commercial ones. These products allow you to run file services and print services natively to Macintosh users, with no additional support required on -the Macintosh. The two free implementations are -<ulink url="http://www.umich.edu/~rsug/netatalk/">Netatalk</ulink>, and -<ulink url="http://www.cs.mu.oz.au/appletalk/atalk.html">CAP</ulink>. -What Samba offers MS -Windows users, these packages offer to Macs. For more info on these -packages, Samba, and Linux (and other UNIX-based systems) see -<ulink noescape="1" url="http://www.eats.com/linux_mac_win.html">http://www.eats.com/linux_mac_win.html</ulink> +the Macintosh. The two free implementations are +<ulink url="http://www.umich.edu/~rsug/netatalk/">Netatalk,</ulink> and +<ulink url="http://www.cs.mu.oz.au/appletalk/atalk.html">CAP.</ulink> +What Samba offers MS Windows users, these packages offer to Macs. +For more info on these packages, Samba, and Linux (and other UNIX-based systems), see +<ulink noescape="1" url="http://www.eats.com/linux_mac_win.html">http://www.eats.com/linux_mac_win.html.</ulink> </para> <para>Newer versions of the Macintosh (Mac OS X) include Samba.</para> @@ -46,50 +43,48 @@ packages, Samba, and Linux (and other UNIX-based systems) see <title>OS2 Client</title> <sect2> - <title>Configuring OS/2 Warp Connect or - OS/2 Warp 4 as a client for Samba</title> + <title>Configuring OS/2 Warp Connect or OS/2 Warp 4</title> <para>Basically, you need three components:</para> <itemizedlist> - <listitem><para>The File and Print Client ('IBM Peer')</para></listitem> - <listitem><para>TCP/IP ('Internet support') </para></listitem> - <listitem><para>The "NetBIOS over TCP/IP" driver ('TCPBEUI')</para></listitem> + <listitem>The File and Print Client (IBM Peer)</listitem> + <listitem>TCP/IP (Internet support) </listitem> + <listitem>The <quote>NetBIOS over TCP/IP</quote> driver (TCPBEUI)</listitem> </itemizedlist> <para>Installing the first two together with the base operating system on a blank system is explained in the Warp manual. If Warp has already been installed, but you now want to install the - networking support, use the "Selective Install for Networking" - object in the "System Setup" folder.</para> + networking support, use the <quote>Selective Install for Networking</quote> + object in the <quote>System Setup</quote> folder.</para> - <para>Adding the "NetBIOS over TCP/IP" driver is not described + <para>Adding the <quote>NetBIOS over TCP/IP</quote> driver is not described in the manual and just barely in the online documentation. Start - MPTS.EXE, click on OK, click on "Configure LAPS" and click - on "IBM OS/2 NETBIOS OVER TCP/IP" in 'Protocols'. This line - is then moved to 'Current Configuration'. Select that line, - click on "Change number" and increase it from 0 to 1. Save this + <command>MPTS.EXE</command>, click on <guiicon>OK</guiicon>, click on <guimenu>Configure LAPS</guimenu> and click + on <guimenu>IBM OS/2 NETBIOS OVER TCP/IP</guimenu> in <guilabel>Protocols</guilabel>. This line + is then moved to <guilabel>Current Configuration</guilabel>. Select that line, + click on <guimenuitem>Change number</guimenuitem> and increase it from 0 to 1. Save this configuration.</para> - <para>If the Samba server(s) is not on your local subnet, you + <para>If the Samba server is not on your local subnet, you can optionally add IP names and addresses of these servers - to the "Names List", or specify a WINS server ('NetBIOS - Nameserver' in IBM and RFC terminology). For Warp Connect you - may need to download an update for 'IBM Peer' to bring it on - the same level as Warp 4. See the webpage mentioned above.</para> + to the <guimenu>Names List</guimenu>, or specify a WINS server (NetBIOS + Nameserver in IBM and RFC terminology). For Warp Connect, you + may need to download an update for <constant>IBM Peer</constant> to bring it on + the same level as Warp 4. See the Web page mentioned above.</para> </sect2> <sect2> - <title>Configuring OS/2 Warp 3 (not Connect), - OS/2 1.2, 1.3 or 2.x for Samba</title> + <title>Configuring Other Versions of OS/2</title> + + <para>This sections deals with configuring OS/2 Warp 3 (not Connect), OS/2 1.2, 1.3 or 2.x.</para> - <para>You can use the free Microsoft LAN Manager 2.2c Client - for OS/2 from + <para>You can use the free Microsoft LAN Manager 2.2c Client for OS/2 that is + available from <ulink noescape="1" url="ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/"> - ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/</ulink>. - In - a nutshell, edit the file \OS2VER in the root directory of - the OS/2 boot partition and add the lines:</para> + ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/</ulink>. In a nutshell, edit + the file <filename>\OS2VER</filename> in the root directory of the OS/2 boot partition and add the lines:</para> <para><programlisting> 20=setup.exe @@ -97,30 +92,26 @@ packages, Samba, and Linux (and other UNIX-based systems) see 20=netvdd.sys </programlisting></para> - <para>before you install the client. Also, don't use the - included NE2000 driver because it is buggy. Try the NE2000 - or NS2000 driver from - <ulink noescape="1" url="ftp://ftp.cdrom.com/pub/os2/network/ndis/"> + <para>before you install the client. Also, do not use the included NE2000 driver because it is buggy. + Try the NE2000 or NS2000 driver from <ulink noescape="1" url="ftp://ftp.cdrom.com/pub/os2/network/ndis/"> ftp://ftp.cdrom.com/pub/os2/network/ndis/</ulink> instead. </para> </sect2> <sect2> - <title>Printer driver download for for OS/2 clients?</title> + <title>Printer Driver Download for OS/2 Clients</title> - <para>First, create a share called <smbconfsection>[PRINTDRV]</smbconfsection> that is - world-readable. Copy your OS/2 driver files there. Note - that the .EA_ files must still be separate, so you will need - to use the original install files, and not copy an installed - driver from an OS/2 system.</para> + <para>Create a share called <smbconfsection>[PRINTDRV]</smbconfsection> that is + world-readable. Copy your OS/2 driver files there. The <filename>.EA_</filename> + files must still be separate, so you will need to use the original install files + and not copy an installed driver from an OS/2 system.</para> - <para>Install the NT driver first for that printer. Then, - add to your &smb.conf; a parameter, <smbconfoption><name>os2 driver map</name><value><replaceable>filename</replaceable></value></smbconfoption>. Then, in the file - specified by <replaceable>filename</replaceable>, map the - name of the NT driver name to the OS/2 driver name as - follows:</para> + <para>Install the NT driver first for that printer. Then, add to your &smb.conf; a parameter, + <smbconfoption><name>os2 driver map</name><value><replaceable>filename</replaceable></value></smbconfoption>. + Next, in the file specified by <replaceable>filename</replaceable>, map the + name of the NT driver name to the OS/2 driver name as follows:</para> - <para><parameter><replaceable>nt driver name</replaceable> = <replaceable>os2 driver name</replaceable>.<replaceable>device name</replaceable></parameter>, e.g.:</para> + <para><parameter><replaceable>nt driver name</replaceable> = <replaceable>os2 driver name</replaceable>.<replaceable>device name</replaceable></parameter>, e.g.</para> <para><parameter> HP LaserJet 5L = LASERJET.HP LaserJet 5L</parameter></para> @@ -130,8 +121,8 @@ packages, Samba, and Linux (and other UNIX-based systems) see <para>If you only specify the OS/2 driver name, and not the device name, the first attempt to download the driver will actually download the files, but the OS/2 client will tell - you the driver is not available. On the second attempt, it - will work. This is fixed simply by adding the device name + you the driver is not available. On the second attempt, it + will work. This is fixed simply by adding the device name to the mapping, after which it will work on the first attempt. </para> </sect2> @@ -141,20 +132,17 @@ packages, Samba, and Linux (and other UNIX-based systems) see <title>Windows for Workgroups</title> <sect2> -<title>Latest TCP/IP stack from Microsoft</title> +<title>Latest TCP/IP Stack from Microsoft</title> <para>Use the latest TCP/IP stack from Microsoft if you use Windows -for Workgroups. -</para> - -<para>The early TCP/IP stacks had lots of bugs.</para> +for Workgroups. The early TCP/IP stacks had lots of bugs.</para> <para> -Microsoft has released an incremental upgrade to their TCP/IP 32-Bit -VxD drivers. The latest release can be found on their ftp site at +Microsoft has released an incremental upgrade to their TCP/IP 32-bit +VxD drivers. The latest release can be found on their ftp site at ftp.microsoft.com, located in <filename>/peropsys/windows/public/tcpip/wfwt32.exe</filename>. There is an update.txt file there that describes the problems that were -fixed. New files include <filename>WINSOCK.DLL</filename>, +fixed. New files include <filename>WINSOCK.DLL</filename>, <filename>TELNET.EXE</filename>, <filename>WSOCK.386</filename>, <filename>VNBT.386</filename>, @@ -167,84 +155,88 @@ fixed. New files include <filename>WINSOCK.DLL</filename>, </sect2> <sect2> -<title>Delete .pwl files after password change</title> +<title>Delete .pwl Files After Password Change</title> <para> -WfWg does a lousy job with passwords. I find that if I change my -password on either the unix box or the PC the safest thing to do is to -delete the .pwl files in the windows directory. The PC will complain about not finding the files, but will soon get over it, allowing you to enter the new password. +Windows for Workgroups does a lousy job with passwords. When you change passwords on either +the UNIX box or the PC, the safest thing to do is to delete the .pwl files in the Windows +directory. The PC will complain about not finding the files, but will soon get over it, +allowing you to enter the new password. </para> <para> -If you don't do this you may find that WfWg remembers and uses the old +If you do not do this, you may find that Windows for Workgroups remembers and uses the old password, even if you told it a new one. </para> <para> -Often WfWg will totally ignore a password you give it in a dialog box. +Often Windows for Workgroups will totally ignore a password you give it in a dialog box. </para> </sect2> <sect2> - <title>Configuring WfW password handling</title> +<title>Configuring Windows for Workgroups Password Handling</title> <para> -There is a program call admincfg.exe -on the last disk (disk 8) of the WFW 3.11 disk set. To install it +There is a program call <filename>admincfg.exe</filename> +on the last disk (disk 8) of the WFW 3.11 disk set. To install it, type <userinput>EXPAND A:\ADMINCFG.EX_ C:\WINDOWS\ADMINCFG.EXE</userinput>. -Then add an icon -for it via the <application>Program Manager</application> <guimenu>New</guimenu> Menu. -This program allows you to control how WFW handles passwords. ie disable Password Caching etc -for use with <smbconfoption><name>security</name><value>user</value></smbconfoption> +Then add an icon for it via the <application>Program Manager</application> <guimenu>New</guimenu> Menu. +This program allows you to control how WFW handles passwords, i.e., +Disable Password Caching and so on. +for use with <smbconfoption><name>security</name><value>user</value></smbconfoption>. </para> </sect2> <sect2> -<title>Case handling of passwords</title> +<title>Password Case Sensitivity</title> -<para>Windows for Workgroups uppercases the password before sending it to the server. Unix passwords can be case-sensitive though. Check the &smb.conf; information on <smbconfoption><name>password level</name></smbconfoption> to specify what characters samba should try to uppercase when checking.</para> +<para>Windows for Workgroups uppercases the password before sending it to the server. +UNIX passwords can be case-sensitive though. Check the &smb.conf; information on +<smbconfoption><name>password level</name></smbconfoption> to specify what characters +Samba should try to uppercase when checking.</para> </sect2> <sect2> -<title>Use TCP/IP as default protocol</title> +<title>Use TCP/IP as Default Protocol</title> -<para>To support print queue reporting you may find +<para>To support print queue reporting, you may find that you have to use TCP/IP as the default protocol under -WfWg. For some reason if you leave NetBEUI as the default +Windows for Workgroups. For some reason, if you leave NetBEUI as the default, it may break the print queue reporting on some systems. -It is presumably a WfWg bug.</para> +It is presumably a Windows for Workgroups bug.</para> </sect2> <sect2> -<title>Speed improvement</title> +<title>Speed Improvement</title> <para> Note that some people have found that setting <parameter>DefaultRcvWindow</parameter> in the <smbconfsection>[MSTCP]</smbconfsection> section of the -<filename>SYSTEM.INI</filename> file under WfWg to 3072 gives a -big improvement. I don't know why. +<filename>SYSTEM.INI</filename> file under Windows for Workgroups to 3072 gives a +big improvement. </para> <para> -My own experience with DefaultRcvWindow is that I get much better +My own experience with DefaultRcvWindow is that I get a much better performance with a large value (16384 or larger). Other people have reported that anything over 3072 slows things down enormously. One person even reported a speed drop of a factor of 30 when he went from -3072 to 8192. I don't know why. +3072 to 8192. </para> </sect2> </sect1> <sect1> -<title>Windows '95/'98</title> +<title>Windows 95/98</title> <para> -When using Windows 95 OEM SR2 the following updates are recommended where Samba -is being used. Please NOTE that the above change will affect you once these +When using Windows 95 OEM SR2, the following updates are recommended where Samba +is being used. Please note that the above change will effect you once these updates have been installed. </para> @@ -263,20 +255,20 @@ of Windows 95. </simplelist> <para> -Also, if using <application>MS Outlook</application> it is desirable to +Also, if using <application>MS Outlook,</application> it is desirable to install the <command>OLEUPD.EXE</command> fix. This fix may stop your machine from hanging for an extended period when exiting -Outlook and you may also notice a significant speedup when accessing network +Outlook and you may notice a significant speedup when accessing network neighborhood services. </para> <sect2> -<title>Speed improvement</title> +<title>Speed Improvement</title> <para> -Configure the win95 TCPIP registry settings to give better -performance. I use a program called <command>MTUSPEED.exe</command> which I got off the -net. There are various other utilities of this type freely available. +Configure the Windows 95 TCP/IP registry settings to give better +performance. I use a program called <command>MTUSPEED.exe</command> that I got off the +Internet. There are various other utilities of this type freely available. </para> </sect2> @@ -289,9 +281,9 @@ net. There are various other utilities of this type freely available. <para> There are several annoyances with Windows 2000 SP2. One of which only appears when using a Samba server to host user profiles -to Windows 2000 SP2 clients in a Windows domain. This assumes +to Windows 2000 SP2 clients in a Windows domain. This assumes that Samba is a member of the domain, but the problem will -likely occur if it is not. +most likely occur if it is not. </para> <para> @@ -302,19 +294,18 @@ added to the file share which houses the roaming profiles. If this is not done, then the Windows 2000 SP2 client will complain about not being able to access the profile (Access Denied) and create multiple copies of it on disk (DOMAIN.user.001, -DOMAIN.user.002, etc...). See the -&smb.conf; man page -for more details on this option. Also note that the +DOMAIN.user.002, and so on). See the &smb.conf; man page +for more details on this option. Also note that the <smbconfoption><name>nt acl support</name></smbconfoption> parameter was formally a global parameter in releases prior to Samba 2.2.2. </para> <para> -The following is a minimal profile share: +<link linkend="minimalprofile"/> provides a minimal profile share. </para> -<para><smbconfexample> - <title>Minimal profile share</title> +<para><smbconfexample id="minimalprofile"> +<title>Minimal profile share</title> <smbconfsection>[profile]</smbconfsection> <smbconfoption><name>path</name><value>/export/profile</value></smbconfoption> <smbconfoption><name>create mask</name><value>0600</value></smbconfoption> @@ -324,24 +315,23 @@ The following is a minimal profile share: </smbconfexample></para> <para> -The reason for this bug is that the Win2k SP2 client copies -the security descriptor for the profile which contains -the Samba server's SID, and not the domain SID. The client +The reason for this bug is that the Windows 200x SP2 client copies +the security descriptor for the profile that contains +the Samba server's SID, and not the domain SID. The client compares the SID for SAMBA\user and realizes it is -different that the one assigned to DOMAIN\user. Hence the reason +different from the one assigned to DOMAIN\user. Hence, the reason for the <errorname>access denied</errorname> message. </para> <para> By disabling the <smbconfoption><name>nt acl support</name></smbconfoption> parameter, Samba will send -the Win2k client a response to the QuerySecurityDescriptor -trans2 call which causes the client to set a default ACL -for the profile. This default ACL includes +the Windows 200x client a response to the QuerySecurityDescriptor trans2 call, which causes the client +to set a default ACL for the profile. This default ACL includes: </para> -<para><emphasis>DOMAIN\user "Full Control"</emphasis>></para> +<para><emphasis>DOMAIN\user <quote>Full Control</quote></emphasis>></para> -<note><para>This bug does not occur when using winbind to +<note><para>This bug does not occur when using Winbind to create accounts on the Samba host for Domain users.</para></note> </sect1> @@ -350,7 +340,7 @@ create accounts on the Samba host for Domain users.</para></note> <title>Windows NT 3.1</title> <para>If you have problems communicating across routers with Windows -NT 3.1 workstations, read <ulink url="http://support.microsoft.com/default.aspx?scid=kb;Q103765">this Microsoft Knowledge Base article</ulink>. +NT 3.1 workstations, read <ulink url="http://support.microsoft.com/default.aspx?scid=kb;Q103765">this Microsoft Knowledge Base article.</ulink> </para> diff --git a/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml index addd646057..2f8383aae2 100644 --- a/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml +++ b/docs/docbook/projdoc/PAM-Authentication-And-Samba.xml @@ -10,49 +10,50 @@ <pubdate>May 31, 2003</pubdate> </chapterinfo> -<title>PAM based Distributed Authentication</title> +<title>PAM-Based Distributed Authentication</title> <para> -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 +This chapter should help you to deploy Winbind-based authentication on any PAM-enabled +UNIX/Linux system. Winbind can be used to enable User-Level application access authentication +from any MS Windows NT Domain, MS Windows 200x Active Directory-based +domain, or any Samba-based domain environment. It will also help you to configure PAM-based local host access controls that are appropriate to your Samba configuration. </para> <para> -In addition to knowing how to configure winbind into PAM, you will learn generic PAM management -possibilities and in particular how to deploy tools like pam_smbpass.so to your advantage. +In addition to knowing how to configure Winbind into PAM, you will learn generic PAM management +possibilities and in particular how to deploy tools like <filename>pam_smbpass.so</filename> to your advantage. </para> <note><para> -The use of Winbind require more than PAM configuration alone. Please refer to <link linkend="winbind">the Winbind chapter</link>. +The use of Winbind requires more than PAM configuration alone. +Please refer to <link linkend="winbind"/>, for further information regarding Winbind. </para></note> <sect1> <title>Features and Benefits</title> <para> -A number of UNIX systems (eg: Sun Solaris), as well as the xxxxBSD family and Linux, +A number of UNIX systems (e.g., Sun Solaris), as well as the xxxxBSD family and Linux, now utilize the Pluggable Authentication Modules (PAM) facility to provide all authentication, authorization and resource control services. Prior to the introduction of PAM, a decision to use an alternative to the system password database (<filename>/etc/passwd</filename>) would require the provision of alternatives for all programs that provide security services. -Such a choice would involve provision of alternatives to such programs as: <command>login</command>, -<command>passwd</command>, <command>chown</command>, etc. +Such a choice would involve provision of alternatives to programs such as: <command>login</command>, +<command>passwd</command>, <command>chown</command>, and so on. </para> <para> PAM provides a mechanism that disconnects these security programs from the underlying -authentication/authorization infrastructure. PAM is configured either through one file -<filename>/etc/pam.conf</filename> (Solaris), or by editing individual files that are +authentication/authorization infrastructure. PAM is configured by making appropriate modifications to one file +<filename>/etc/pam.conf</filename> (Solaris), or by editing individual control files that are located in <filename>/etc/pam.d</filename>. </para> <para> -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 +On PAM-enabled UNIX/Linux systems, it is an easy matter to configure the system to use any +authentication backend so long as the appropriate dynamically loadable library modules +are available for it. The backend may be local to the system, or may be centralized on a remote server. </para> @@ -61,63 +62,63 @@ PAM support modules are available for: </para> <variablelist> - <varlistentry><term><filename>/etc/passwd</filename>:</term><listitem> + <varlistentry><term><filename>/etc/passwd</filename></term><listitem> <para> 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. + database. The most common are called: <filename>pam_unix.so</filename>, <filename>pam_unix2.so</filename>, <filename>pam_pwdb.so</filename> + and <filename>pam_userdb.so</filename>. </para> </listitem></varlistentry> - <varlistentry><term>Kerberos:</term><listitem> + <varlistentry><term>Kerberos</term><listitem> <para> - The pam_krb5.so module allows the use of any Kerberos compliant server. + The <filename>pam_krb5.so</filename> 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). </para> </listitem></varlistentry> - <varlistentry><term>LDAP:</term><listitem> + <varlistentry><term>LDAP</term><listitem> <para> - The pam_ldap.so module allows the use of any LDAP v2 or v3 compatible backend + The <filename>pam_ldap.so</filename> 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. </para> </listitem></varlistentry> - <varlistentry><term>NetWare Bindery:</term><listitem> + <varlistentry><term>NetWare Bindery</term><listitem> <para> - The pam_ncp_auth.so module allows authentication off any bindery enabled - NetWare Core Protocol based server. + The <filename>pam_ncp_auth.so</filename> module allows authentication off any bindery-enabled + NetWare Core Protocol-based server. </para> </listitem></varlistentry> - <varlistentry><term>SMB Password:</term><listitem> + <varlistentry><term>SMB Password</term><listitem> <para> - This module, called pam_smbpass.so, will allow user authentication off + This module, called <filename>pam_smbpass.so</filename>, will allow user authentication off the passdb backend that is configured in the Samba &smb.conf; file. </para> </listitem></varlistentry> - <varlistentry><term>SMB Server:</term><listitem> + <varlistentry><term>SMB Server</term><listitem> <para> - The pam_smb_auth.so module is the original MS Windows networking authentication + The <filename>pam_smb_auth.so</filename> module is the original MS Windows networking authentication tool. This module has been somewhat outdated by the Winbind module. </para> </listitem></varlistentry> - <varlistentry><term>Winbind:</term><listitem> + <varlistentry><term>Winbind</term><listitem> <para> - The pam_winbind.so module allows Samba to obtain authentication from any + The <filename>pam_winbind.so</filename> 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. + users for access to any PAM-enabled application. </para> </listitem></varlistentry> - <varlistentry><term>RADIUS:</term><listitem> + <varlistentry><term>RADIUS</term><listitem> <para> 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 + module. In most cases, administrators 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. </para> @@ -125,15 +126,15 @@ PAM support modules are available for: </variablelist> <para> -Of the above, Samba provides the pam_smbpasswd.so and the pam_winbind.so modules alone. +Of the above, Samba provides the <filename>pam_smbpasswd.so</filename> and the <filename>pam_winbind.so</filename> modules alone. </para> <para> 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. +of distributed Samba Domain Controllers that can provide wide area network bandwidth +efficient authentication services for PAM-capable systems. In effect, this allows the +deployment of centrally managed and maintained distributed authentication from a +single-user account database. </para> </sect1> @@ -145,7 +146,8 @@ user account database. 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. +either the single system file, <filename>/etc/pam.conf</filename>, or the +<filename>/etc/pam.d/</filename> directory. </para> <sect2> @@ -153,22 +155,23 @@ either the single system file, /etc/pam.conf; or the /etc/pam.d/ directory. <para> 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. +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. </para> <para> 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. +of the system administrator: comments are preceded by a <quote>#</quote> and extend to the next end-of-line; also, +module specification lines may be extended with a <quote>\</quote> escaped newline. </para> <para> If the PAM authentication module (loadable link library file) is located in the -default location then it is not necessary to specify the path. In the case of +default location, then it is not necessary to specify the path. In the case of Linux, the default location is <filename>/lib/security</filename>. If the module -is located outside the default then the path must be specified as: +is located outside the default, then the path must be specified as: </para> <para> @@ -183,11 +186,11 @@ auth required /other_path/pam_strange_module.so <para> The remaining information in this subsection was taken from the documentation of the Linux-PAM project. For more information on PAM, see -<ulink url="http://ftp.kernel.org/pub/linux/libs/pam/">The Official Linux-PAM home page</ulink> +<ulink url="http://ftp.kernel.org/pub/linux/libs/pam/">The Official Linux-PAM home page.</ulink> </para> <para> -A general configuration line of the /etc/pam.conf file has the following form: +A general configuration line of the <filename>/etc/pam.conf</filename> file has the following form: </para> <para> @@ -203,58 +206,60 @@ Once we have explained the meaning of the above tokens, we will describe this me </para> <variablelist> - <varlistentry><term>service-name:</term><listitem> + <varlistentry><term>service-name</term><listitem> <para> - 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. . + The name of the service associated with this entry. Frequently, the service name is the conventional + name of the given application. For example, <command>ftpd</command>, <command>rlogind</command> and + <command>su</command>, and so on. </para> <para> - 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. + There is a special service-name reserved for defining a default authentication mechanism. It has + the name <parameter>OTHER</parameter> and may be specified in either lower- or upper-case characters. + Note, when there is a module specified for a named service, the <parameter>OTHER</parameter> + entries are ignored. </para> </listitem> </varlistentry> - <varlistentry><term>module-type:</term><listitem> + <varlistentry><term>module-type</term><listitem> <para> One of (currently) four types of module. The four types are as follows: </para> <itemizedlist> <listitem><para> - <emphasis>auth:</emphasis> 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 + <parameter>auth:</parameter> This module type provides two aspects of authenticating the user. + It establishes that the user is who he claims 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 <filename>/etc/groups</filename> file discussed above) or other privileges through its credential granting properties. </para></listitem> <listitem><para> - <emphasis>account:</emphasis> this module performs non-authentication based account management. + <parameter>account:</parameter> 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. + user <quote>root</quote> login only on the console. </para></listitem> <listitem><para> - <emphasis>session:</emphasis> 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 logging - of information concerning the opening/closing of some data exchange with a user, mounting - directories, etc. + <parameter>session:</parameter> Primarily, this module is associated with doing things that need + to be done for the user before and after they can be given service. Such things include the logging + of information concerning the opening and closing of some data exchange with a user, mounting + directories, and so on. </para></listitem> <listitem><para> - <emphasis>password:</emphasis> 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. + <parameter>password:</parameter> This last module type is required for updating the authentication + token associated with the user. Typically, there is one module for each <quote>challenge/response</quote> + -based authentication <parameter>(auth)</parameter> module type. </para></listitem> </itemizedlist> </listitem> </varlistentry> - <varlistentry><term>control-flag:</term><listitem> + <varlistentry><term>control-flag</term><listitem> <para> 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, @@ -269,7 +274,7 @@ Once we have explained the meaning of the above tokens, we will describe this me <para> 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 - <emphasis>keywords: required, requisite, sufficient and optional</emphasis>. + keywords: <parameter>required, requisite, sufficient and optional</parameter>. </para> <para> @@ -278,15 +283,15 @@ Once we have explained the meaning of the above tokens, we will describe this me <itemizedlist> <listitem><para> - <emphasis>required:</emphasis> this indicates that the success of the module is required for the + <parameter>required:</parameter> 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. </para></listitem> <listitem><para> - <emphasis>requisite:</emphasis> like required, however, in the case that such a module returns a + <parameter>requisite:</parameter> 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 + the first required or requisite module to fail. This flag can be used to protect against the possibility of a user getting the opportunity to enter a password over an unsafe medium. It is conceivable that such behavior might inform an attacker of valid accounts on a system. This possibility should be weighed against the not insignificant concerns of exposing a sensitive @@ -294,19 +299,19 @@ Once we have explained the meaning of the above tokens, we will describe this me </para></listitem> <listitem><para> - <emphasis>sufficient:</emphasis> the success of this module is deemed `sufficient' to satisfy + <parameter>sufficient:</parameter> The success of this module is deemed <parameter>sufficient</parameter> 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 + previous required module has failed, no more <quote>stacked</quote> modules of this type are invoked. + (In this case, subsequent required modules are not invoked). A failure of this module is not deemed as fatal to satisfying the application that this module-type has succeeded. </para></listitem> <listitem><para> - <emphasis>optional:</emphasis> as its name suggests, this control-flag marks the module as not + <parameter>optional:</parameter> 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 + 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. </para></listitem> </itemizedlist> @@ -314,7 +319,7 @@ Once we have explained the meaning of the above tokens, we will describe this me <para> The more elaborate (newer) syntax is much more specific and gives the administrator a great deal of control over how the user is authenticated. This form of the control flag is delimited with square brackets and - consists of a series of value=action tokens: + consists of a series of <parameter>value=action</parameter> tokens: </para> <para><programlisting> @@ -322,16 +327,25 @@ Once we have explained the meaning of the above tokens, we will describe this me </programlisting></para> <para> - Here, value1 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. + Here, <parameter>value1</parameter> is one of the following return values: +<screen> +<parameter>success; open_err; symbol_err; service_err; system_err; buf_err;</parameter> +<parameter>perm_denied; auth_err; cred_insufficient; authinfo_unavail;</parameter> +<parameter>user_unknown; maxtries; new_authtok_reqd; acct_expired; session_err;</parameter> +<parameter>cred_unavail; cred_expired; cred_err; no_module_data; conv_err;</parameter> +<parameter>authtok_err; authtok_recover_err; authtok_lock_busy;</parameter> +<parameter>authtok_disable_aging; try_again; ignore; abort; authtok_expired;</parameter> +<parameter>module_unknown; bad_item;</parameter> and <parameter>default</parameter>. +</screen> +</para> + + <para> + The last of these <parameter>(default)</parameter> can be used to set the action for those return values that are not explicitly defined. </para> <para> - The action1 can be a positive integer or one of the following tokens: ignore; ok; done; bad; die; and reset. + The <parameter>action1</parameter> can be a positive integer or one of the following tokens: + <parameter>ignore; ok; done; bad; die;</parameter> and <parameter>reset</parameter>. 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 @@ -340,61 +354,61 @@ Once we have explained the meaning of the above tokens, we will describe this me <itemizedlist> <listitem><para> - <emphasis>ignore:</emphasis> when used with a stack of modules, the module's return status will not + <parameter>ignore:</parameter> When used with a stack of modules, the module's return status will not contribute to the return code the application obtains. </para></listitem> <listitem><para> - <emphasis>bad:</emphasis> this action indicates that the return code should be thought of as indicative + <parameter>bad:</parameter> 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. </para></listitem> <listitem><para> - <emphasis>die:</emphasis> equivalent to bad with the side effect of terminating the module stack and + <parameter>die:</parameter> Equivalent to bad with the side effect of terminating the module stack and PAM immediately returning to the application. </para></listitem> <listitem><para> - <emphasis>ok:</emphasis> this tells PAM that the administrator thinks this return code should + <parameter>ok:</parameter> 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. + failure, this <parameter>ok</parameter> value will not be used to override that value. </para></listitem> <listitem><para> - <emphasis>done:</emphasis> equivalent to ok with the side effect of terminating the module stack and + <parameter>done:</parameter> Equivalent to <parameter>ok</parameter> with the side effect of terminating the module stack and PAM immediately returning to the application. </para></listitem> <listitem><para> - <emphasis>reset:</emphasis> clear all memory of the state of the module stack and start again with + <parameter>reset:</parameter> Clears all memory of the state of the module stack and starts again with the next stacked module. </para></listitem> </itemizedlist> <para> - Each of the four keywords: required; requisite; sufficient; and optional, have an equivalent expression in - terms of the [...] syntax. They are as follows: + Each of the four keywords: <parameter>required; requisite; sufficient;</parameter> and <parameter>optional</parameter>, + have an equivalent expression in terms of the [...] syntax. They are as follows: </para> <para> <itemizedlist> <listitem><para> - required is equivalent to [success=ok new_authtok_reqd=ok ignore=ignore default=bad] + <parameter>required</parameter> is equivalent to <parameter>[success=ok new_authtok_reqd=ok ignore=ignore default=bad]</parameter>. </para></listitem> <listitem><para> - requisite is equivalent to [success=ok new_authtok_reqd=ok ignore=ignore default=die] + <parameter>requisite</parameter> is equivalent to <parameter>[success=ok new_authtok_reqd=ok ignore=ignore default=die]</parameter>. </para></listitem> <listitem><para> - sufficient is equivalent to [success=done new_authtok_reqd=done default=ignore] + <parameter>sufficient</parameter> is equivalent to <parameter>[success=done new_authtok_reqd=done<?latex \linebreak ?> default=ignore]</parameter>. </para></listitem> <listitem><para> - optional is equivalent to [success=ok new_authtok_reqd=ok default=ignore] + <parameter>optional</parameter> is equivalent to <parameter>[success=ok new_authtok_reqd=ok default=ignore]</parameter>. </para></listitem> </itemizedlist> </para> @@ -403,49 +417,48 @@ Once we have explained the meaning of the above tokens, we will describe this me 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 - <emphasis>[ ... value=action ... ]</emphasis> control syntax, it is possible for an application to be configured + <parameter>[ ... value=action ... ]</parameter> 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. + mode for older, legacy applications. </para> </listitem> </varlistentry> - <varlistentry><term>module-path:</term><listitem> + <varlistentry><term>module-path</term><listitem> <para> 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 + module path is <quote>/</quote>, 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: <filename>/lib/security</filename> (but see the notes above). </para> <para> - The args are a list of tokens that are passed to the module when it is invoked. Much like arguments to a typical + The arguments are a list of tokens that are passed to the module when it is invoked, much like arguments to a typical Linux shell command. Generally, valid arguments are optional and are specific to any given module. Invalid arguments are ignored by a module, however, when encountering an invalid argument, the module is required to write an error - to syslog(3). For a list of generic options see the next section. + to syslog(3). For a list of generic options, see the next section. </para> <para> - Note, if you wish to include spaces in an argument, you should surround that argument with square brackets. For example: + If you wish to include spaces in an argument, you should surround that argument with square brackets. For example: </para> <para><programlisting> 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'] +db=eminence [query=select user_name from internet_service where \ +user_name=<quote>%u</quote> and password=PASSWORD(<quote>%p</quote>) and service=<quote>web_proxy</quote>] </programlisting></para> <para> - 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: + When using this convention, you can include <quote>[</quote> characters inside the string, and if you wish to have a <quote>]</quote> + character inside the string that will survive the argument parsing, you should use <quote>\[</quote>. In other words: </para> -<para><programlisting><!--FIXME:Diagram--> +<para><programlisting> [..[..\]..] --> ..[..].. </programlisting></para> <para> - Any line in (one of) the configuration file(s), that is not formatted correctly, will generally tend (erring on the + Any line in one of the configuration files that is not formatted correctly will generally tend (erring on the side of caution) to make the authentication process fail. A corresponding error is written to the system log files with a call to syslog(3). </para> @@ -462,18 +475,18 @@ squid auth required pam_mysql.so user=passwd_query passwd=mada \ <para> The following is an example <filename>/etc/pam.d/login</filename> configuration file. -This example had all options been uncommented is probably not usable -as it stacks many conditions before allowing successful completion +This example had all options uncommented and is probably not usable +because it stacks many conditions before allowing successful completion of the login process. Essentially all conditions can be disabled -by commenting them out except the calls to <filename>pam_pwdb.so</filename>. +by commenting them out, except the calls to <filename>pam_pwdb.so</filename>. </para> <sect3> -<title>PAM: original login config</title> +<title>PAM: Original Login Config</title> <para><programlisting> #%PAM-1.0 -# The PAM configuration file for the `login' service +# The PAM configuration file for the <quote>login</quote> service # auth required pam_securetty.so auth required pam_nologin.so @@ -491,7 +504,7 @@ password required pam_pwdb.so shadow md5 </sect3> <sect3> -<title>PAM: login using pam_smbpass</title> +<title>PAM: Login Using <filename>pam_smbpass</filename></title> <para> PAM allows use of replaceable modules. Those available on a sample system include: @@ -506,19 +519,19 @@ pam_nologin.so pam_rootok.so pam_tally.so pam_deny.so pam_issue.so pam_mail.so pam_permit.so pam_securetty.so pam_time.so pam_dialup.so pam_lastlog.so pam_mkhomedir.so -pam_pwdb.so pam_shells.so pam_unix.so +pam_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 +pam_radius.so pam_smbpass.so pam_UNIX_acct.so +pam_wheel.so pam_UNIX_auth.so pam_UNIX_passwd.so +pam_userdb.so pam_warn.so pam_UNIX_session.so </programlisting></para> <para> The following example for the login program replaces the use of -the <filename>pam_pwdb.so</filename> module which uses the system +the <filename>pam_pwdb.so</filename> module that uses the system password database (<filename>/etc/passwd</filename>, <filename>/etc/shadow</filename>, <filename>/etc/group</filename>) with -the module <filename>pam_smbpass.so</filename> which uses the Samba +the module <filename>pam_smbpass.so</filename>, which uses the Samba database which contains the Microsoft MD4 encrypted password hashes. This database is stored in either <filename>/usr/local/samba/private/smbpasswd</filename>, @@ -528,7 +541,7 @@ Samba implementation for your UNIX/Linux system. The <filename>pam_smbpass.so</filename> module is provided by Samba version 2.2.1 or later. It can be compiled by specifying the <option>--with-pam_smbpass</option> options when running Samba's -<command>configure</command> script. For more information +<command>configure</command> script. For more information on the <filename>pam_smbpass</filename> module, see the documentation in the <filename>source/pam_smbpass</filename> directory of the Samba source distribution. @@ -536,7 +549,7 @@ source distribution. <para><programlisting> #%PAM-1.0 -# The PAM configuration file for the `login' service +# The PAM configuration file for the <quote>login</quote> service # auth required pam_smbpass.so nodelay account required pam_smbpass.so nodelay @@ -551,7 +564,7 @@ Linux system. The default condition uses <filename>pam_pwdb.so</filename>. <para><programlisting> #%PAM-1.0 -# The PAM configuration file for the `samba' service +# The PAM configuration file for the <quote>samba</quote> service # auth required pam_pwdb.so nullok nodelay shadow audit account required pam_pwdb.so audit nodelay @@ -560,16 +573,16 @@ password required pam_pwdb.so shadow md5 </programlisting></para> <para> -In the following example the decision has been made to use the -smbpasswd database even for basic samba authentication. Such a -decision could also be made for the passwd program and would -thus allow the smbpasswd passwords to be changed using the passwd -program. +In the following example, the decision has been made to use the +<command>smbpasswd</command> database even for basic Samba authentication. Such a +decision could also be made for the <command>passwd</command> program and would +thus allow the <command>smbpasswd</command> passwords to be changed using the +<command>passwd</command> program: </para> <para><programlisting> #%PAM-1.0 -# The PAM configuration file for the `samba' service +# The PAM configuration file for the <quote>samba</quote> service # auth required pam_smbpass.so nodelay account required pam_pwdb.so audit nodelay @@ -584,9 +597,9 @@ your particular system implementation for details regarding the specific capabilities of PAM in this environment. Some Linux implementations also provide the <filename>pam_stack.so</filename> module that allows all authentication to be configured in a single central file. The -<filename>pam_stack.so</filename> method has some very devoted followers +<filename>pam_stack.so</filename> method has some 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 +life though, every decision makes trade-offs, so you may want to examine the PAM documentation for further helpful information. </para></note> @@ -595,24 +608,19 @@ PAM documentation for further helpful information. </sect2> <sect2> -<title>smb.conf PAM Configuration</title> +<title>&smb.conf; PAM Configuration</title> <para> - There is an option in smb.conf called <smbconfoption><name>obey pam restrictions</name></smbconfoption>. -The following is from the on-line help for this option in SWAT; + There is an option in &smb.conf; called <smbconfoption><name>obey pam restrictions</name></smbconfoption>. +The following is from the online help for this option in SWAT; </para> <para> -When Samba is configured to enable PAM support (i.e. -<option>--with-pam</option>), 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 -<smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption>. -The reason is that PAM modules cannot support the challenge/response -authentication mechanism needed in the presence of SMB +When Samba is configured to enable PAM support (i.e., <option>--with-pam</option>), 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 cleartext authentication only and to ignore any account or session management. Samba always +ignores PAM for authentication in the case of <smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption>. +The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption. </para> @@ -621,7 +629,7 @@ password encryption. </sect2> <sect2> -<title>Remote CIFS Authentication using winbindd.so</title> +<title>Remote CIFS Authentication Using <filename>winbindd.so</filename></title> <para> All operating systems depend on the provision of users credentials acceptable to the platform. @@ -631,72 +639,74 @@ as <filename>/etc/passwd</filename>. </para> <para> -Users and groups on a Windows NT server are assigned a relative id (rid) which is unique for +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 +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. </para> <para> -As winbind users and groups are resolved from a server, user and group ids are allocated +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 +enumeration command. The allocated UNIX IDs are stored in a database file under the Samba lock directory and will be remembered. </para> <para> The astute administrator will realize from this that the combination of <filename>pam_smbpass.so</filename>, -<command>winbindd</command>, and a distributed passdb backend, such as ldap, will allow the establishment of a -centrally managed, distributed user/password database that can also be used by all PAM (eg: Linux) aware -programs and applications. This arrangement can have particularly potent advantages compared with the use of -Microsoft Active Directory Service (ADS) in so far as reduction of wide area network authentication traffic. +<command>winbindd</command> and a distributed <smbconfoption><name>passdb backend</name><value></value></smbconfoption>, +such as <parameter>ldap</parameter>, will allow the establishment of a centrally managed, distributed user/password +database that can also be used by all PAM-aware (e.g., Linux) programs and applications. This arrangement can have +particularly potent advantages compared with the use of Microsoft Active Directory Service (ADS) in so far as +the reduction of wide area network authentication traffic. </para> <warning><para> -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. +The RID to UNIX ID database is the only location where the user and group mappings are +stored by <command>winbindd</command>. If this file is deleted or corrupted, there is no way for <command>winbindd</command> +to determine which user and group IDs correspond to Windows NT user and group RIDs. </para></warning> </sect2> <sect2> -<title>Password Synchronization using pam_smbpass.so</title> +<title>Password Synchronization Using <filename>pam_smbpass.so</filename></title> <para> -pam_smbpass is a PAM module which can be used on conforming systems to -keep the smbpasswd (Samba password) database in sync with the unix +<filename>pam_smbpass</filename> is a PAM module that can be used on conforming systems to +keep the <filename>smbpasswd</filename> (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 +under some UNIX operating systems, such as Solaris, HPUX and Linux, that provides a generic interface to authentication mechanisms. </para> <para> -This module authenticates a local smbpasswd user database. If you require -support for authenticating against a remote SMB server, or if you're -concerned about the presence of suid root binaries on your system, it is -recommended that you use pam_winbind instead. +This module authenticates a local <filename>smbpasswd</filename> user database. If you require +support for authenticating against a remote SMB server, or if you are +concerned about the presence of SUID root binaries on your system, it is +recommended that you use <filename>pam_winbind</filename> instead. </para> <para> -Options recognized by this module are as follows: -<table frame="all"> - <title>Options recognized by pam_smbpass</title> +Options recognized by this module are shown in <link linkend="smbpassoptions"/>. +<table frame="all" id="smbpassoptions"> + <title>Options recognized by <parameter>pam_smbpass</parameter></title> <tgroup cols="2" align="left"> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" colwidth="1*"/> <tbody> - <row><entry>debug</entry><entry>log more debugging info</entry></row> - <row><entry>audit</entry><entry>like debug, but also logs unknown usernames</entry></row> - <row><entry>use_first_pass</entry><entry>don't prompt the user for passwords; take them from PAM_ items instead</entry></row> - <row><entry>try_first_pass</entry><entry>try to get the password from a previous PAM module, fall back to prompting the user</entry></row> - <row><entry>use_authtok</entry><entry>like try_first_pass, but *fail* if the new PAM_AUTHTOK has not been previously set. (intended for stacking password modules only)</entry></row> - <row><entry>not_set_pass</entry><entry>don't make passwords used by this module available to other modules.</entry></row> - <row><entry>nodelay</entry><entry>don't insert ~1 second delays on authentication failure.</entry></row> + <row><entry>debug</entry><entry>log more debugging info.</entry></row> + <row><entry>audit</entry><entry>like debug, but also logs unknown usernames.</entry></row> + <row><entry>use_first_pass</entry><entry>do not prompt the user for passwords; take them from PAM_ items instead.</entry></row> + <row><entry>try_first_pass</entry><entry>try to get the password from a previous PAM module fall back to prompting the user.</entry></row> + <row><entry>use_authtok</entry> + <entry>like try_first_pass, but *fail* if the new PAM_AUTHTOK has not been previously set (intended for stacking password modules only).</entry></row> + <row><entry>not_set_pass</entry><entry>do not make passwords used by this module available to other modules.</entry></row> + <row><entry>nodelay</entry><entry>do not insert ~1 second delays on authentication failure.</entry></row> <row><entry>nullok</entry><entry>null passwords are allowed.</entry></row> <row><entry>nonull</entry><entry>null passwords are not allowed. Used to override the Samba configuration.</entry></row> - <row><entry>migrate</entry><entry>only meaningful in an "auth" context; used to update smbpasswd file with a password used for successful authentication.</entry></row> + <row><entry>migrate</entry><entry>only meaningful in an <quote>auth</quote> context; used to update smbpasswd file with a password used for successful authentication.</entry></row> <row><entry>smbconf=<replaceable>file</replaceable></entry><entry>specify an alternate path to the &smb.conf; file.</entry></row> </tbody> </tgroup> @@ -704,33 +714,19 @@ Options recognized by this module are as follows: </para> <para> -<itemizedlist> - <listitem><para><ulink url="mailto:morgan@transmeta.com">Andrew Morgan</ulink>, for providing the Linux-PAM - framework, without which none of this would have happened</para></listitem> - -<listitem><para><ulink url="mailto:gafton@redhat.com">Christian Gafton</ulink> and Andrew Morgan again, for the - pam_pwdb module upon which pam_smbpass was originally based</para></listitem> - -<listitem><para><ulink url="mailto:lkcl@switchboard.net">Luke Leighton</ulink> for being receptive to the idea, - and for the occasional good-natured complaint about the project's status - that keep me working on it :)</para></listitem> -</itemizedlist>. -</para> - -<para> -The following are examples of the use of pam_smbpass.so in the format of Linux +The following are examples of the use of <filename>pam_smbpass.so</filename> in the format of Linux <filename>/etc/pam.d/</filename> files structure. Those wishing to implement this tool on other platforms will need to adapt this appropriately. </para> <sect3> -<title>Password Synchronisation Configuration</title> +<title>Password Synchronization Configuration</title> <para> A sample PAM configuration that shows the use of pam_smbpass to make -sure private/smbpasswd is kept in sync when /etc/passwd (/etc/shadow) -is changed. Useful when an expired password might be changed by an -application (such as ssh). +sure <filename>private/smbpasswd</filename> is kept in sync when <filename>/etc/passwd (/etc/shadow)</filename> +is changed. Useful when an expired password might be changed by an +application (such as <command>ssh</command>). </para> <para><programlisting> @@ -738,12 +734,12 @@ application (such as ssh). # password-sync # auth requisite pam_nologin.so -auth required pam_unix.so -account required pam_unix.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 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 +session required pam_UNIX.so </programlisting></para> </sect3> @@ -751,11 +747,11 @@ session required pam_unix.so <title>Password Migration Configuration</title> <para> -A sample PAM configuration that shows the use of pam_smbpass to migrate -from plaintext to encrypted passwords for Samba. Unlike other methods, +A sample PAM configuration that shows the use of <filename>pam_smbpass</filename> 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. +password migration takes place when users <command>ftp</command> in, login using <command>ssh</command>, pop +their mail, and so on. </para> <para><programlisting> @@ -763,14 +759,14 @@ their mail, etc. # password-migration # auth requisite pam_nologin.so -# pam_smbpass is called IF pam_unix succeeds. -auth requisite pam_unix.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 +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 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 +session required pam_UNIX.so </programlisting></para> </sect3> @@ -778,9 +774,9 @@ session required pam_unix.so <title>Mature Password Configuration</title> <para> -A sample PAM configuration for a 'mature' smbpasswd installation. -private/smbpasswd is fully populated, and we consider it an error if -the smbpasswd doesn't exist or doesn't match the UNIX password. +A sample PAM configuration for a mature <filename>smbpasswd</filename> installation. +<filename>private/smbpasswd</filename> is fully populated, and we consider it an error if +the SMB password does not exist or does not match the UNIX password. </para> <para><programlisting> @@ -788,12 +784,12 @@ the smbpasswd doesn't exist or doesn't match the UNIX password. # password-mature # auth requisite pam_nologin.so -auth required pam_unix.so -account required pam_unix.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 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 +session required pam_UNIX.so </programlisting></para> </sect3> @@ -801,8 +797,8 @@ session required pam_unix.so <title>Kerberos Password Integration Configuration</title> <para> -A sample PAM configuration that shows pam_smbpass used together with -pam_krb5. This could be useful on a Samba PDC that is also a member of +A sample PAM configuration that shows <parameter>pam_smbpass</parameter> used together with +<parameter>pam_krb5</parameter>. This could be useful on a Samba PDC that is also a member of a Kerberos realm. </para> @@ -830,61 +826,57 @@ session required pam_krb5.so <title>Common Errors</title> <para> -PAM can be a very fickle and sensitive to configuration glitches. Here we look at a few cases from +PAM can be fickle and sensitive to configuration glitches. Here we look at a few cases from the Samba mailing list. </para> <sect2> - <title>pam_winbind problem</title> + <title>pam_winbind Problem</title> <para> - <quote> - I have the following PAM configuration: - </quote> + A user reported: I have the following PAM configuration: </para> - <para> +<para> <programlisting> 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 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 </programlisting> - </para> +</para> <para> - <quote> - 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. -</quote> + When I open a new console with [ctrl][alt][F1], I can't log in with my user <quote>pitie</quote>. + I have tried with user <quote>scienceu+pitie</quote> also. </para> <para> - The problem may lie with your inclusion of <parameter>pam_stack.so + <emphasis>Answer:</emphasis> The problem may lie with your inclusion of <parameter>pam_stack.so service=system-auth</parameter>. 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 + duplicate what you are already doing. Try commenting out the <parameter>pam_stack</parameter> lines + for <parameter>auth</parameter> and <parameter>account</parameter> and see if things work. If they do, look at <filename>/etc/pam.d/system-auth</filename> and copy only what you need from it into your - <filename>/etc/pam.d/login</filename> file. Alternatively, if you want all services to use - winbind, you can put the winbind-specific stuff in <filename>/etc/pam.d/system-auth</filename>. + <filename>/etc/pam.d/login</filename> file. Alternately, if you want all services to use + Winbind, you can put the Winbind-specific stuff in <filename>/etc/pam.d/system-auth</filename>. </para> </sect2> <sect2> - <title>Winbind is not resolving users and groups</title> + <title>Winbind Is Not Resolving Users and Groups</title> <para> - <quote> - My smb.conf file is correctly configured. I have specified + <quote> + My &smb.conf; file is correctly configured. I have specified <smbconfoption><name>idmap uid</name><value>12000</value></smbconfoption>, and <smbconfoption><name>idmap gid</name><value>3000-3500</value></smbconfoption> and <command>winbind</command> is running. When I do the following it all works fine. -</quote> + </quote> </para> <para><screen> @@ -909,22 +901,20 @@ bin:x:1:1:bin:/bin:/bin/bash maryo:x:15000:15003:Mary Orville:/home/MIDEARTH/maryo:/bin/false </screen></para> -<para> + <para> <quote> - But the following command just fails: -</quote> + But this command fails: + </quote> <screen> -&rootprompt;<userinput>chown 'maryo' a_file</userinput> -chown: `maryo': invalid user +&rootprompt;<userinput>chown maryo a_file</userinput> +chown: 'maryo': invalid user </screen> -<quote> -This is driving me nuts! What can be wrong? -</quote> + <quote>This is driving me nuts! What can be wrong?</quote> </para> <para> - Your system is likely running <command>nscd</command>, the name service - caching daemon. Shut it down, do NOT restart it! You will find your problem resolved. + <emphasis>Answer:</emphasis> Your system is likely running <command>nscd</command>, the name service + caching daemon. Shut it down, do not restart it! You will find your problem resolved. </para> </sect2> diff --git a/docs/docbook/projdoc/PolicyMgmt.xml b/docs/docbook/projdoc/PolicyMgmt.xml index 351c51d1c6..fc06ffefb1 100644 --- a/docs/docbook/projdoc/PolicyMgmt.xml +++ b/docs/docbook/projdoc/PolicyMgmt.xml @@ -7,9 +7,9 @@ <title>System and Account Policies</title> <para> -This chapter summarises the current state of knowledge derived from personal -practice and knowledge from samba mailing list subscribers. Before reproduction -of posted information effort has been made to validate the information provided. +This chapter summarizes the current state of knowledge derived from personal +practice and knowledge from Samba mailing list subscribers. Before reproduction +of posted information, every effort has been made to validate the information given. Where additional information was uncovered through this validation it is provided also. </para> @@ -18,19 +18,22 @@ also. <title>Features and Benefits</title> <para> -When MS Windows NT3.5 was introduced the hot new topic was the ability to implement -Group Policies for users and group. Then along came MS Windows NT4 and a few sites -started to adopt this capability. How do we know that? By way of the number of "booboos" +When MS Windows NT 3.5 was introduced, the hot new topic was the ability to implement +Group Policies for users and groups. Then along came MS Windows NT4 and a few sites +started to adopt this capability. How do we know that? By the number of <quote>booboos</quote> (or mistakes) administrators made and then requested help to resolve. </para> <para> +<indexterm><primary>group policies</primary></indexterm> +<indexterm><primary>GPOs</primary></indexterm> +<indexterm><primary>group policy objects</primary><see>GPOs</see></indexterm> By the time that MS Windows 2000 and Active Directory was released, administrators got the message: Group Policies are a good thing! They can help reduce administrative -costs and actually can help to create happier users. But adoption of the true +costs and actually make happier users. But adoption of the true potential of MS Windows 200x Active Directory and Group Policy Objects (GPOs) for users -and machines were picked up on rather slowly. This was very obvious from the samba -mailing list as in 2000 and 2001 there were very few postings regarding GPOs and +and machines were picked up on rather slowly. This was obvious from the Samba +mailing list as in 2000 and 2001 when there were few postings regarding GPOs and how to replicate them in a Samba environment. </para> @@ -42,8 +45,9 @@ network client workstations. </para> <para> -A tool new to Samba may become an important part of the future Samba Administrators' -arsenal. The <command>editreg</command> tool is described in this document. +A tool new to Samba &smbmdash; the <command>editreg</command> tool +&smbmdash; may become an important part of the future Samba administrators' +arsenal is described in this document. </para> </sect1> @@ -53,118 +57,122 @@ arsenal. The <command>editreg</command> tool is described in this document. <para> Under MS Windows platforms, particularly those following the release of MS Windows -NT4 and MS Windows 95) it is possible to create a type of file that would be placed -in the NETLOGON share of a domain controller. As the client logs onto the network +NT4 and MS Windows 95, it is possible to create a type of file that would be placed +in the NETLOGON share of a Domain Controller. As the client logs onto the network, this file is read and the contents initiate changes to the registry of the client machine. This file allows changes to be made to those parts of the registry that affect users, groups of users, or machines. </para> <para> -For MS Windows 9x/Me this file must be called <filename>Config.POL</filename> and may +<indexterm><primary>Config.POL</primary></indexterm> +For MS Windows 9x/ME, this file must be called <filename>Config.POL</filename> and may be generated using a tool called <filename>poledit.exe</filename>, better known as the Policy Editor. The policy editor was provided on the Windows 98 installation CD, but disappeared again with the introduction of MS Windows Me (Millennium Edition). From -comments from MS Windows network administrators it would appear that this tool became +comments of MS Windows network administrators, it would appear that this tool became a part of the MS Windows Me Resource Kit. </para> <para> +<indexterm><primary>System Policy Editor</primary></indexterm> MS Windows NT4 Server products include the <emphasis>System Policy Editor</emphasis> -under the <filename>Start -> Programs -> Administrative Tools</filename> menu item. -For MS Windows NT4 and later clients this file must be called <filename>NTConfig.POL</filename>. +under <guimenu>Start -> Programs -> Administrative Tools</guimenu>. +For MS Windows NT4 and later clients, this file must be called <filename>NTConfig.POL</filename>. </para> <para> New with the introduction of MS Windows 2000 was the Microsoft Management Console -or MMC. This tool is the new wave in the ever changing landscape of Microsoft +or MMC. This tool is the new wave in the ever-changing landscape of Microsoft methods for management of network access and security. Every new Microsoft product -or technology seems to obsolete the old rules and to introduce newer and more -complex tools and methods. To Microsoft's credit though, the MMC does appear to +or technology seems to make the old rules obsolete and introduces newer and more +complex tools and methods. To Microsoft's credit, the MMC does appear to be a step forward, but improved functionality comes at a great price. </para> <para> -Before embarking on the configuration of network and system policies it is highly -advisable to read the documentation available from Microsoft's web site regarding +Before embarking on the configuration of network and system policies, it is highly +advisable to read the documentation available from Microsoft's Web site regarding <ulink url="http://www.microsoft.com/ntserver/management/deployment/planguide/prof_policies.asp"> Implementing Profiles and Policies in Windows NT 4.0</ulink> available from Microsoft. There are a large number of documents in addition to this old one that should also -be read and understood. Try searching on the Microsoft web site for "Group Policies". +be read and understood. Try searching on the Microsoft Web site for <quote>Group Policies</quote>. </para> <para> -What follows is a very brief discussion with some helpful notes. The information provided -here is incomplete - you are warned. +What follows is a brief discussion with some helpful notes. The information provided +here is incomplete &smbmdash; you are warned. </para> <sect2> - <title>Windows 9x/Me Policies</title> + <title>Windows 9x/ME Policies</title> <para> - You need the Win98 Group Policy Editor to set Group Profiles up under Windows 9x/Me. - It can be found on the Original full product Win98 installation CD under - <filename>tools/reskit/netadmin/poledit</filename>. Install this using the - Add/Remove Programs facility and then click on the 'Have Disk' tab. + You need the Windows 98 Group Policy Editor to set up Group Profiles under Windows 9x/ME. + It can be found on the original full product Windows 98 installation CD under + <filename>tools/reskit/netadmin/poledit</filename>. Install this using the + Add/Remove Programs facility and then click on <guiicon>Have Disk</guiicon>. </para> + <para> +<indexterm><primary>NTConfig.POL</primary></indexterm> Use the Group Policy Editor to create a policy file that specifies the location of - user profiles and/or the <filename>My Documents</filename> etc. Then save these + user profiles and/or <filename>My Documents</filename>, and so on. Then save these settings in a file called <filename>Config.POL</filename> that needs to be placed in the - root of the <smbconfsection>[NETLOGON]</smbconfsection> share. If Win98 is configured to log onto - the Samba Domain, it will automatically read this file and update the Win9x/Me registry + root of the <smbconfsection>[NETLOGON]</smbconfsection> share. If Windows 98 is configured to log onto + the Samba Domain, it will automatically read this file and update the Windows 9x/Me registry of the machine as it logs on. </para> <para> - Further details are covered in the Win98 Resource Kit documentation. + Further details are covered in the Windows 98 Resource Kit documentation. </para> <para> - If you do not take the right steps, then every so often Win9x/Me will check the - integrity of the registry and will restore it's settings from the back-up - copy of the registry it stores on each Win9x/Me machine. Hence, you will + If you do not take the correct steps, then every so often Windows 9x/ME will check the + integrity of the registry and restore its settings from the back-up + copy of the registry it stores on each Windows 9x/ME machine. So, you will occasionally notice things changing back to the original settings. </para> <para> - Install the group policy handler for Win9x to pick up group policies. Look on the - Win98 CD in <filename>\tools\reskit\netadmin\poledit</filename>. - Install group policies on a Win9x client by double-clicking + Install the group policy handler for Windows 9x/Me to pick up Group Policies. Look on the + Windows 98 CDROM in <filename>\tools\reskit\netadmin\poledit</filename>. + Install group policies on a Windows 9x/Me client by double-clicking on <filename>grouppol.inf</filename>. Log off and on again a couple of times and see - if Win98 picks up group policies. Unfortunately this needs to be done on every - Win9x/Me machine that uses group policies. + if Windows 98 picks up Group Policies. Unfortunately, this needs to be done on every + Windows 9x/Me machine that uses Group Policies. </para> </sect2> <sect2> - <title>Windows NT4 Style Policy Files</title> + <title>Windows NT4-Style Policy Files</title> <para> To create or edit <filename>ntconfig.pol</filename> you must use the NT Server - Policy Editor, <command>poledit.exe</command> which is included with NT4 Server - but <emphasis>not NT Workstation</emphasis>. There is a Policy Editor on a NT4 - Workstation but it is not suitable for creating <emphasis>Domain Policies</emphasis>. - Further, although the Windows 95 Policy Editor can be installed on an NT4 + Policy Editor, <command>poledit.exe</command>, which is included with NT4 Server + but not with NT Workstation. There is a Policy Editor on an NT4 + Workstation but it is not suitable for creating domain policies. + Furthermore, although the Windows 95 Policy Editor can be installed on an NT4 Workstation/Server, it will not work with NT clients. However, the files from the NT Server will run happily enough on an NT4 Workstation. </para> <para> You need <filename>poledit.exe</filename>, <filename>common.adm</filename> and <filename>winnt.adm</filename>. - It is convenient to put the two *.adm files in the <filename>c:\winnt\inf</filename> - directory which is where the binary will look for them unless told otherwise. Note also that that - directory is normally 'hidden'. + It is convenient to put the two <filename>*.adm</filename> files in the <filename>c:\winnt\inf</filename> + directory, which is where the binary will look for them unless told otherwise. This + directory is normally <quote>hidden.</quote> </para> <para> The Windows NT policy editor is also included with the Service Pack 3 (and later) for Windows NT 4.0. Extract the files using <command>servicepackname /x</command>, - i.e. that's <command>Nt4sp6ai.exe /x</command> for service pack 6a. The policy editor, - <command>poledit.exe</command> and the associated template files (*.adm) should - be extracted as well. It is also possible to downloaded the policy template - files for Office97 and get a copy of the policy editor. Another possible + that's <command>Nt4sp6ai.exe /x</command> for service pack 6a. The Policy Editor, + <command>poledit.exe</command>, and the associated template files (*.adm) should + be extracted as well. It is also possible to downloaded the policy template + files for Office97 and get a copy of the Policy Editor. Another possible location is with the Zero Administration Kit available for download from Microsoft. </para> @@ -172,105 +180,106 @@ here is incomplete - you are warned. <title>Registry Spoiling</title> <para> - With NT4 style registry based policy changes, a large number of settings are not - automatically reversed as the user logs off. Since the settings that were in the - NTConfig.POL file were applied to the client machine registry and that apply to the + With NT4-style registry-based policy changes, a large number of settings are not + automatically reversed as the user logs off. The settings that were in the + <filename>NTConfig.POL</filename> file were applied to the client machine registry and apply to the hive key HKEY_LOCAL_MACHINE are permanent until explicitly reversed. This is known - as tattooing. It can have serious consequences down-stream and the administrator must + as tattooing. It can have serious consequences downstream and the administrator must be extremely careful not to lock out the ability to manage the machine at a later date. </para> - </sect3> </sect2> <sect2> - <title>MS Windows 200x / XP Professional Policies</title> + <title>MS Windows 200x/XP Professional Policies</title> <para> - Windows NT4 System policies allows setting of registry parameters specific to - users, groups and computers (client workstations) that are members of the NT4 - style domain. Such policy file will work with MS Windows 2000 / XP clients also. + Windows NT4 system policies allow the setting of registry parameters specific to + users, groups and computers (client workstations) that are members of the NT4-style + domain. Such policy files will work with MS Windows 200x/XP clients also. </para> <para> - New to MS Windows 2000 Microsoft introduced a new style of group policy that confers - a superset of capabilities compared with NT4 style policies. Obviously, the tool used - to create them is different, and the mechanism for implementing them is much changed. + New to MS Windows 2000, Microsoft recently introduced a style of group policy that confers + a superset of capabilities compared with NT4-style policies. Obviously, the tool used + to create them is different, and the mechanism for implementing them is much improved. </para> <para> - The older NT4 style registry based policies are known as <emphasis>Administrative Templates</emphasis> - in MS Windows 2000/XP Group Policy Objects (GPOs). The later includes ability to set various security +<indexterm><primary>GPOs</primary></indexterm> + The older NT4-style registry-based policies are known as <emphasis>Administrative Templates</emphasis> + in MS Windows 2000/XP Group Policy Objects (GPOs). The later includes the ability to set various security configurations, enforce Internet Explorer browser settings, change and redirect aspects of the - users' desktop (including: the location of <filename>My Documents</filename> files (directory), as + users desktop (including the location of <filename>My Documents</filename> files (directory), as well as intrinsics of where menu items will appear in the Start menu). An additional new feature is the ability to make available particular software Windows applications to particular users and/or groups. </para> <para> - Remember: NT4 policy files are named <filename>NTConfig.POL</filename> and are stored in the root - of the NETLOGON share on the domain controllers. A Windows NT4 user enters a username, a password - and selects the domain name to which the logon will attempt to take place. During the logon - process the client machine reads the NTConfig.POL file from the NETLOGON share on the authenticating - server, modifies the local registry values according to the settings in this file. + Remember, NT4 policy files are named <filename>NTConfig.POL</filename> and are stored in the root + of the NETLOGON share on the Domain Controllers. A Windows NT4 user enters a username, password + and selects the domain name to which the logon will attempt to take place. During the logon process, + the client machine reads the <filename>NTConfig.POL</filename> file from the NETLOGON share on + the authenticating server and modifies the local registry values according to the settings in this file. </para> <para> - Windows 2K GPOs are very feature rich. They are NOT stored in the NETLOGON share, rather part of + Windows 200x GPOs are feature-rich. They are not stored in the NETLOGON share, but rather part of a Windows 200x policy file is stored in the Active Directory itself and the other part is stored in a shared (and replicated) volume called the SYSVOL folder. This folder is present on all Active - Directory domain controllers. The part that is stored in the Active Directory itself is called the - group policy container (GPC), and the part that is stored in the replicated share called SYSVOL is - known as the group policy template (GPT). + Directory Domain Controllers. The part that is stored in the Active Directory itself is called the + Group Policy Container (GPC), and the part that is stored in the replicated share called SYSVOL is + known as the Group Policy Template (GPT). </para> <para> - With NT4 clients the policy file is read and executed upon only as each user logs onto the network. - MS Windows 200x policies are much more complex - GPOs are processed and applied at client machine - startup (machine specific part) and when the user logs onto the network the user specific part - is applied. In MS Windows 200x style policy management each machine and/or user may be subject + With NT4 clients, the policy file is read and executed only as each user logs onto the network. + MS Windows 200x policies are much more complex &smbmdash; GPOs are processed and applied at client machine + startup (machine specific part) and when the user logs onto the network, the user-specific part + is applied. In MS Windows 200x-style policy management, each machine and/or user may be subject to any number of concurrently applicable (and applied) policy sets (GPOs). Active Directory allows the administrator to also set filters over the policy settings. No such equivalent capability - exists with NT4 style policy files. + exists with NT4-style policy files. </para> <sect3> - <title>Administration of Win2K / XP Policies</title> + <title>Administration of Windows 200x/XP Policies</title> <para> +<indexterm><primary>GPOs</primary></indexterm> +<indexterm><primary>System Policy Editor</primary></indexterm> Instead of using the tool called <application>The System Policy Editor</application>, commonly called Poledit (from the executable name <command>poledit.exe</command>), <acronym>GPOs</acronym> are created and managed using a <application>Microsoft Management Console</application> <acronym>(MMC)</acronym> snap-in as follows:</para> <procedure> - <step> - <para> - Go to the Windows 200x / XP menu <guimenu>Start->Programs->Administrative Tools</guimenu> - and select the MMC snap-in called <guimenuitem>Active Directory Users and Computers</guimenuitem> - </para> - </step> - - <step><para> - Select the domain or organizational unit (OU) that you wish to manage, then right click - to open the context menu for that object, select the properties item. - </para></step> - - <step><para> - Now left click on the <guilabel>Group Policy</guilabel> tab, then left click on the New tab. Type a name - for the new policy you will create. - </para></step> - - <step><para> - Now left click on the <guilabel>Edit</guilabel> tab to commence the steps needed to create the GPO. - </para></step> + <step><para> + Go to the Windows 200x/XP menu <guimenu>Start->Programs->Administrative Tools</guimenu> + and select the MMC snap-in called <guimenuitem>Active Directory Users and Computers</guimenuitem> + </para></step> + + <step><para> + Select the domain or organizational unit (OU) that you wish to manage, then right-click + to open the context menu for that object, and select the <guibutton>Properties</guibutton>. + </para></step> + + <step><para> + Left-click on the <guilabel>Group Policy</guilabel> tab, then + left-click on the New tab. Type a name + for the new policy you will create. + </para></step> + + <step><para> + Left-click on the <guilabel>Edit</guilabel> tab to commence the steps needed to create the GPO. + </para></step> </procedure> <para> All policy configuration options are controlled through the use of policy administrative - templates. These files have a .adm extension, both in NT4 as well as in Windows 200x / XP. - Beware however, since the .adm files are NOT interchangeable across NT4 and Windows 200x. - The later introduces many new features as well as extended definition capabilities. It is - well beyond the scope of this documentation to explain how to program .adm files, for that + templates. These files have an .adm extension, both in NT4 as well as in Windows 200x/XP. + Beware, however, the .adm files are not interchangeable across NT4 and Windows 200x. + The latter introduces many new features as well as extended definition capabilities. It is + well beyond the scope of this documentation to explain how to program .adm files; for that the administrator is referred to the Microsoft Windows Resource Kit for your particular version of MS Windows. </para> @@ -297,56 +306,80 @@ the policy file. Separate policy files for each user, group, or computer are not </para> <para> -If you create a policy that will be automatically downloaded from validating domain controllers, -you should name the file NTconfig.POL. As system administrator, you have the option of renaming the +<indexterm><primary>NTConfig.POL</primary></indexterm> +If you create a policy that will be automatically downloaded from validating Domain Controllers, +you should name the file <filename>NTConfig.POL</filename>. As system administrator, you have the option of renaming the policy file and, by modifying the Windows NT-based workstation, directing the computer to update the policy from a manual path. You can do this by either manually changing the registry or by using -the System Policy Editor. This path can even be a local path such that each machine has its own policy file, -but if a change is necessary to all machines, this change must be made individually to each workstation. +the System Policy Editor. This can even be a local path such that each machine has its own policy file, +but if a change is necessary to all machines, it must be made individually to each workstation. </para> <para> -When a Windows NT4/200x/XP machine logs onto the network the NETLOGON share on the authenticating domain -controller for the presence of the NTConfig.POL file. If one exists it is downloaded, parsed and then -applied to the user's part of the registry. +When a Windows NT4/200x/XP machine logs onto the network, the client looks in the NETLOGON share on +the authenticating domain controller for the presence of the NTConfig.POL file. If one exists it is +downloaded, parsed and then applied to the user's part of the registry. </para> <para> -MS Windows 200x/XP clients that log onto an MS Windows Active Directory security domain may additionally, +<indexterm><primary>GPOs</primary></indexterm> +MS Windows 200x/XP clients that log onto an MS Windows Active Directory security domain may additionally acquire policy settings through Group Policy Objects (GPOs) that are defined and stored in Active Directory itself. The key benefit of using AS GPOs is that they impose no registry <emphasis>spoiling</emphasis> effect. -This has considerable advantage compared with the use of NTConfig.POL (NT4) style policy updates. +This has considerable advantage compared with the use of <filename>NTConfig.POL</filename> (NT4) style policy updates. </para> <para> In addition to user access controls that may be imposed or applied via system and/or group policies in a manner that works in conjunction with user profiles, the user management environment under MS Windows NT4/200x/XP allows per domain as well as per user account restrictions to be applied. -Common restrictions that are frequently used includes: +Common restrictions that are frequently used include: </para> <para> +<indexterm><primary>Account Controls</primary></indexterm> <itemizedlist> - <listitem><para>Logon Hours</para></listitem> - <listitem><para>Password Aging</para></listitem> - <listitem><para>Permitted Logon from certain machines only</para></listitem> - <listitem><para>Account type (Local or Global)</para></listitem> - <listitem><para>User Rights</para></listitem> + <listitem>Logon hours</listitem> + <listitem>Password aging</listitem> + <listitem>Permitted logon from certain machines only</listitem> + <listitem>Account type (local or global)</listitem> + <listitem>User rights</listitem> </itemizedlist> </para> +<para> +Samba-3.0.0 doe not yet implement all account controls that are common to MS Windows NT4/200x/XP. +While it is possible to set many controls using the Domain User Manager for MS Windows NT4, only password +expirey is functional today. Most of the remaining controls at this time have only stub routines +that may eventually be completed to provide actual control. Do not be misled by the fact that a +parameter can be set using the NT4 Domain User Manager or in the <filename>NTConfig.POL</filename>. +</para> + +</sect1> +<sect1> +<title>Management Tools</title> + +<para> +Anyone who wishes to create or manage Group Policies will need to be familiar with a number of tools. +The following sections describe a few key tools that will help you to create a low maintenance user +environment. +</para> + <sect2> <title>Samba Editreg Toolset</title> <para> +<indexterm><primary>editreg</primary></indexterm> +<indexterm><primary>NTUser.DAT</primary></indexterm> +<indexterm><primary>NTConfig.POL</primary></indexterm> A new tool called <command>editreg</command> is under development. This tool can be used - to edit registry files (called NTUser.DAT) that are stored in user and group profiles. - NTConfig.POL files have the same structure as the NTUser.DAT file and can be editted using - this tool. <command>editreg</command> is being built with the intent to enable NTConfig.POL - files to be saved in text format and to permit the building of new NTConfig.POL files with - extended capabilities. It is proving difficult to realise this capability, so do not be surprised - if this feature does not materialise. Formal capabilities will be announced at the time that - this tool is released for production use. + to edit registry files (called <filename>NTUser.DAT</filename>) that are stored in user + and group profiles. <filename>NTConfig.POL</filename> files have the same structure as the + <filename>NTUser.DAT</filename> file and can be edited using this tool. <command>editreg</command> + is being built with the intent to enable <filename>NTConfig.POL</filename> files to be saved in text format and to + permit the building of new <filename>NTConfig.POL</filename> files with extended capabilities. It is proving difficult + to realize this capability, so do not be surprised if this feature does not materialize. Formal + capabilities will be announced at the time that this tool is released for production use. </para> </sect2> @@ -356,9 +389,9 @@ Common restrictions that are frequently used includes: <para> The tools that may be used to configure these types of controls from the MS Windows environment are: - The NT4 User Manager for domains, the NT4 System and Group Policy Editor, the registry editor (regedt32.exe). - Under MS Windows 200x/XP this is done using the Microsoft Management Console (MMC) with appropriate - "snap-ins", the registry editor, and potentially also the NT4 System and Group Policy Editor. + the NT4 User Manager for Domains, the NT4 System and Group Policy Editor, and the Registry Editor (regedt32.exe). + Under MS Windows 200x/XP, this is done using the Microsoft Management Console (MMC) with appropriate + <quote>snap-ins,</quote> the registry editor, and potentially also the NT4 System and Group Policy Editor. </para> </sect2> @@ -366,10 +399,9 @@ Common restrictions that are frequently used includes: <title>Samba PDC</title> <para> - With a Samba Domain Controller, the new tools for managing of user account and policy information includes: + With a Samba Domain Controller, the new tools for managing user account and policy information include: <command>smbpasswd</command>, <command>pdbedit</command>, <command>net</command>, <command>rpcclient</command>. - The administrator should read the - man pages for these tools and become familiar with their use. + The administrator should read the man pages for these tools and become familiar with their use. </para> </sect2> @@ -379,23 +411,24 @@ Common restrictions that are frequently used includes: <title>System Startup and Logon Processing Overview</title> <para> -The following attempts to document the order of processing of system and user policies following a system +The following attempts to document the order of processing the system and user policies following a system reboot and as part of the user logon: </para> <orderedlist> <listitem><para> Network starts, then Remote Procedure Call System Service (RPCSS) and Multiple Universal Naming - Convention Provider (MUP) start + Convention Provider (MUP) start. </para></listitem> <listitem><para> Where Active Directory is involved, an ordered list of Group Policy Objects (GPOs) is downloaded and applied. The list may include GPOs that: <itemizedlist> - <listitem><para>Apply to the location of machines in a Directory</para></listitem> - <listitem><para>Apply only when settings have changed</para></listitem> - <listitem><para>Depend on configuration of scope of applicability: local, site, domain, organizational unit, etc.</para></listitem> + <listitem><para>Apply to the location of machines in a Directory.</para></listitem> + <listitem><para>Apply only when settings have changed.</para></listitem> + <listitem><para>Depend on configuration of the scope of applicability: local, + site, domain, organizational unit, and so on.</para></listitem> </itemizedlist> No desktop user interface is presented until the above have been processed. </para></listitem> @@ -405,21 +438,21 @@ reboot and as part of the user logon: </para></listitem> <listitem><para> - A keyboard action to affect start of logon (Ctrl-Alt-Del). + A keyboard action to effect start of logon (Ctrl-Alt-Del). </para></listitem> <listitem><para> - User credentials are validated, User profile is loaded (depends on policy settings). + User credentials are validated, user profile is loaded (depends on policy settings). </para></listitem> <listitem><para> - An ordered list of User GPOs is obtained. The list contents depends on what is configured in respect of: + An ordered list of user GPOs is obtained. The list contents depends on what is configured in respect of: <itemizedlist> - <listitem><para>Is user a domain member, thus subject to particular policies</para></listitem> - <listitem><para>Loopback enablement, and the state of the loopback policy (Merge or Replace)</para></listitem> - <listitem><para>Location of the Active Directory itself</para></listitem> - <listitem><para>Has the list of GPOs changed. No processing is needed if not changed.</para></listitem> + <listitem>Is the user a Domain Member, thus subject to particular policies?</listitem> + <listitem>Loopback enablement, and the state of the loopback policy (Merge or Replace).</listitem> + <listitem>Location of the Active Directory itself.</listitem> + <listitem>Has the list of GPOs changed? No processing is needed if not changed.</listitem> </itemizedlist> </para></listitem> @@ -428,14 +461,14 @@ reboot and as part of the user logon: </para></listitem> <listitem><para> - Logon scripts are run. New to Win2K and Active Directory, logon scripts may be obtained based on Group - Policy objects (hidden and executed synchronously). NT4 style logon scripts are then run in a normal + Logon scripts are run. New to Windows 200x and Active Directory, logon scripts may be obtained based on Group + Policy objects (hidden and executed synchronously). NT4-style logon scripts are then run in a normal window. </para></listitem> <listitem><para> - The User Interface as determined from the GPOs is presented. Note: In a Samba domain (like and NT4 - Domain) machine (system) policies are applied at start-up, User policies are applied at logon. + The User Interface as determined from the GPOs is presented. Note: In a Samba domain (like an NT4 + Domain), machine (system) policies are applied at start-up; user policies are applied at logon. </para></listitem> </orderedlist> @@ -445,7 +478,7 @@ reboot and as part of the user logon: <title>Common Errors</title> <para> -Policy related problems can be very difficult to diagnose and even more difficult to rectify. The following +Policy-related problems can be quite difficult to diagnose and even more difficult to rectify. The following collection demonstrates only basic issues. </para> @@ -453,15 +486,15 @@ collection demonstrates only basic issues. <title>Policy Does Not Work</title> <para> - <quote>We have created the <filename>config.pol</filename> file and put it in the <emphasis>NETLOGON</emphasis> share. -It has made no difference to our Win XP Pro machines, they just don't see it. IT worked fine with Win 98 but does not +<quote>We have created the <filename>Config.POL</filename> file and put it in the <emphasis>NETLOGON</emphasis> share. +It has made no difference to our Win XP Pro machines, they just do not see it. It worked fine with Win 98 but does not work any longer since we upgraded to Win XP Pro. Any hints?</quote> </para> <para> -Policy files are NOT portable between Windows 9x / Me and MS Windows NT4 / 200x / XP based -platforms. You need to use the NT4 Group Policy Editor to create a file called <filename>NTConfig.POL</filename> so that -it is in the correct format for your MS Windows XP Pro clients. +Policy files are not portable between Windows 9x/Me and MS Windows NT4/200x/XP-based platforms. You need to +use the NT4 Group Policy Editor to create a file called <filename>NTConfig.POL</filename> so it is in the +correct format for your MS Windows XP Pro clients. </para> </sect2> diff --git a/docs/docbook/projdoc/Portability.xml b/docs/docbook/projdoc/Portability.xml index 50cc8b4c7c..90cb8e2d4b 100644 --- a/docs/docbook/projdoc/Portability.xml +++ b/docs/docbook/projdoc/Portability.xml @@ -1,35 +1,35 @@ <chapter id="Portability"> <chapterinfo> &author.jelmer; - <!-- Some other people as well, but there were no author names in the text files - this file is based on--> + &author.jht; + <!-- Some other people as well, but there were no author names in the text files this file is based on--> </chapterinfo> <title>Portability</title> <para>Samba works on a wide range of platforms but the interface all the platforms provide is not always compatible. This chapter contains -platform-specific information about compiling and using samba.</para> +platform-specific information about compiling and using Samba.</para> <sect1> <title>HPUX</title> <para> -HP's implementation of supplementary groups is, er, non-standard (for -hysterical reasons). There are two group files, <filename>/etc/group</filename> and +HP's implementation of supplementary groups is non-standard (for +historical reasons). There are two group files, <filename>/etc/group</filename> and <filename>/etc/logingroup</filename>; the system maps UIDs to numbers using the former, but -initgroups() reads the latter. Most system admins who know the ropes +initgroups() reads the latter. Most system admins who know the ropes symlink <filename>/etc/group</filename> to <filename>/etc/logingroup</filename> -(hard link doesn't work for reasons too stupid to go into here). initgroups() will complain if one of the +(hard link does not work for reasons too obtuse to go into here). initgroups() will complain if one of the groups you're in in <filename>/etc/logingroup</filename> has what it considers to be an invalid ID, which means outside the range <constant>[0..UID_MAX]</constant>, where <constant>UID_MAX</constant> is (I think) -60000 currently on HP-UX. This precludes -2 and 65534, the usual <constant>nobody</constant> +60000 currently on HP-UX. This precludes -2 and 65534, the usual <constant>nobody</constant> GIDs. </para> <para> -If you encounter this problem, make sure that the programs that are failing -to initgroups() be run as users not in any groups with GIDs outside the +If you encounter this problem, make sure the programs that are failing +to initgroups() are run as users, not in any groups with GIDs outside the allowed range. </para> @@ -37,9 +37,8 @@ allowed range. </para> <para> -On HPUX you must use gcc or the HP ANSI compiler. The free compiler -that comes with HP-UX is not ANSI compliant and cannot compile -Samba. +On HP-UX you must use gcc or the HP ANSI compiler. The free compiler +that comes with HP-UX is not ANSI compliant and cannot compile Samba. </para> </sect1> @@ -48,9 +47,9 @@ Samba. <title>SCO UNIX</title> <para> -If you run an old version of SCO UNIX then you may need to get important +If you run an old version of SCO UNIX, you may need to get important TCP/IP patches for Samba to work correctly. Without the patch, you may -encounter corrupt data transfers using samba. +encounter corrupt data transfers using Samba. </para> <para> @@ -59,6 +58,16 @@ SCO (<ulink noescape="1" url="ftp://ftp.sco.com/">ftp.sco.com</ulink>, directory files uod385a.Z and uod385a.ltr.Z). </para> +<para> +The information provided here refers to an old version of SCO UNIX. If you require +binaries for more recent SCO UNIX products, please contact SCO to obtain packages that are +ready to install. You should also verify with SCO that your platform is up-to-date for the +binary packages you will install. This is important if you wish to avoid data corruption +problems with your installation. To build Samba for SCO UNIX products may +require significant patching of Samba source code. It is much easier to obtain binary +packages directly from SCO. +</para> + </sect1> <sect1> @@ -73,17 +82,13 @@ C library for some reason. <para> For this reason Samba by default defines the macro NO_EID in the DNIX section of includes.h. This works around the problem in a limited way, -but it is far from ideal, some things still won't work right. +but it is far from ideal, and some things still will not work right. </para> <para> -To fix the problem properly you need to assemble the following two +To fix the problem properly, you need to assemble the following two functions and then either add them to your C library or link them into -Samba. -</para> - -<para> -put this in the file <filename>setegid.s</filename>: +Samba. Put the following in the file <filename>setegid.s</filename>: </para> <para><programlisting> @@ -102,7 +107,7 @@ _setegid: </programlisting></para> <para> -put this in the file <filename>seteuid.s</filename>: +Put this in the file <filename>seteuid.s</filename>: </para> <para><programlisting> @@ -121,7 +126,7 @@ _seteuid: </programlisting></para> <para> -after creating the above files you then assemble them using +After creating the above files, you then assemble them using </para> <screen> @@ -135,7 +140,7 @@ that should produce the files <filename>seteuid.o</filename> and </para> <para> -then you need to add these to the LIBSM line in the DNIX section of +Then you need to add these to the LIBSM line in the DNIX section of the Samba Makefile. Your LIBSM line will then look something like this: </para> @@ -151,15 +156,15 @@ You should then remove the line: #define NO_EID </programlisting></para> -<para>from the DNIX section of <filename>includes.h</filename></para> +<para>from the DNIX section of <filename>includes.h</filename>.</para> </sect1> <sect1> -<title>RedHat Linux Rembrandt-II</title> +<title>Red Hat Linux</title> <para> -By default RedHat Rembrandt-II during installation adds an +By default during installation, some versions of Red Hat Linux add an entry to <filename>/etc/hosts</filename> as follows: <programlisting> 127.0.0.1 loopback "hostname"."domainname" @@ -169,13 +174,13 @@ entry to <filename>/etc/hosts</filename> as follows: <para> This causes Samba to loop back onto the loopback interface. The result is that Samba fails to communicate correctly with -the world and therefor may fail to correctly negotiate who +the world and therefore may fail to correctly negotiate who is the master browse list holder and who is the master browser. </para> <para> -Corrective Action: Delete the entry after the word loopback - in the line starting 127.0.0.1 +Corrective Action: Delete the entry after the word "loopback" +in the line starting 127.0.0.1. </para> </sect1> @@ -195,10 +200,10 @@ Samba performance significantly. <title>Solaris</title> <sect2> -<title>Locking improvements</title> +<title>Locking Improvements</title> <para>Some people have been experiencing problems with F_SETLKW64/fcntl -when running Samba on Solaris. The built in file locking mechanism was +when running Samba on Solaris. The built-in file locking mechanism was not scalable. Performance would degrade to the point where processes would get into loops of trying to lock a file. It would try a lock, then fail, then try again. The lock attempt was failing before the grant was @@ -213,24 +218,23 @@ has not been released yet. </para> <para> -The patch revision for 2.6 is 105181-34 -for 8 is 108528-19 and for 9 is 112233-04 +The patch revision for 2.6 is 105181-34, for 8 is 108528-19 and for 9 is 112233-04. </para> <para> -After the install of these patches it is recommended to reconfigure -and rebuild samba. +After the install of these patches, it is recommended to reconfigure +and rebuild Samba. </para> -<para>Thanks to Joe Meslovich for reporting</para> +<para>Thanks to Joe Meslovich for reporting this.</para> </sect2> <sect2 id="winbind-solaris9"> <title>Winbind on Solaris 9</title> <para> -Nsswitch on Solaris 9 refuses to use the winbind nss module. This behavior -is fixed by Sun in patch 113476-05 which as of March 2003 is not in any +Nsswitch on Solaris 9 refuses to use the Winbind NSS module. This behavior +is fixed by Sun in patch 113476-05, which as of March 2003, is not in any roll-up packages. </para> </sect2> diff --git a/docs/docbook/projdoc/Problems.xml b/docs/docbook/projdoc/Problems.xml index 46f3c002d2..2058b6867f 100644 --- a/docs/docbook/projdoc/Problems.xml +++ b/docs/docbook/projdoc/Problems.xml @@ -4,55 +4,57 @@ &author.jerry; &author.jelmer; &author.dbannon; + &author.danshearer; <pubdate>8 Apr 2003</pubdate> </chapterinfo> -<title>Analysing and solving samba problems</title> +<title>Analyzing and Solving Samba Problems</title> <para> There are many sources of information available in the form -of mailing lists, RFC's and documentation. The docs that come -with the samba distribution contain very good explanations of +of mailing lists, RFCs and documentation. The documentation that comes +with the Samba distribution contains good explanations of general SMB topics such as browsing.</para> <sect1> -<title>Diagnostics tools</title> +<title>Diagnostics Tools</title> <para>With SMB networking, it is often not immediately clear what the cause is of a certain problem. Samba itself provides rather useful information, but in some cases you might have to fall back to using a <emphasis>sniffer</emphasis>. A sniffer is a program that -listens on your LAN, analyses the data sent on it and displays it +listens on your LAN, analyzes the data sent on it and displays it on the screen.</para> <sect2> -<title>Debugging with Samba itself</title> +<title>Debugging with Samba Itself</title> - <para> -One of the best diagnostic tools for debugging problems is Samba itself. -You can use the <option>-d option</option> for both &smbd; and &nmbd; to specify what -<smbconfoption><name>debug level</name></smbconfoption> at which to run. See the man pages on smbd, nmbd and -smb.conf for more information on debugging options. The debug +<para> +One of the best diagnostic tools for debugging problems is Samba itself. +You can use the <option>-d option</option> for both &smbd; and &nmbd; to specify the +<smbconfoption><name>debug level</name></smbconfoption> at which to run. +See the man pages for <command>smbd, nmbd</command> and +&smb.conf; for more information regarding debugging options. The debug level can range from 1 (the default) to 10 (100 for debugging passwords). </para> <para> -Another helpful method of debugging is to compile samba using the -<userinput>gcc -g </userinput> flag. This will include debug -information in the binaries and allow you to attach gdb to the -running smbd / nmbd process. In order to attach gdb to an smbd +Another helpful method of debugging is to compile Samba using the +<command>gcc -g </command> flag. This will include debug information in the binaries and +allow you to attach gdb to the running <command>smbd/nmbd</command> process. +To attach <command>gdb</command> to an <command>smbd</command> process for an NT workstation, first get the workstation to make the connection. Pressing ctrl-alt-delete and going down to the domain box -is sufficient (at least, on the first time you join the domain) to -generate a 'LsaEnumTrustedDomains'. Thereafter, the workstation -maintains an open connection, and therefore there will be an smbd +is sufficient (at least, the first time you join the domain) to +generate a <parameter>LsaEnumTrustedDomains</parameter>. Thereafter, the workstation +maintains an open connection and there will be an smbd process running (assuming that you haven't set a really short smbd -idle timeout) So, in between pressing ctrl alt delete, and actually -typing in your password, you can attach gdb and continue. +idle timeout). So, in between pressing <command>ctrl-alt-delete</command> and actually +typing in your password, you can attach <command>gdb</command> and continue. </para> <para> -Some useful samba commands worth investigating: +Some useful Samba commands worth investigating are: </para> <screen> @@ -65,10 +67,12 @@ Some useful samba commands worth investigating: <sect2> <title>Tcpdump</title> -<para><ulink url="http://www.tcpdump.org/">Tcpdump</ulink> was the first -unix sniffer with SMB support. It is a command-line utility and -nowadays, it's SMB support is somewhat less then that of ethereal -and tethereal.</para> +<para> +<ulink url="http://www.tcpdump.org/">Tcpdump</ulink> was the first +UNIX sniffer with SMB support. It is a command-line utility and +now, its SMB support is somewhat lagging that of <command>ethereal</command> +and <command>tethereal</command>. +</para> </sect2> @@ -77,111 +81,104 @@ and tethereal.</para> <para> <ulink url="http://www.ethereal.com/">Ethereal</ulink> is a graphical -sniffer, available for both unix (Gtk) and Windows. Ethereal's -SMB support is very good.</para> +sniffer, available for both UNIX (Gtk) and Windows. Ethereal's +SMB support is quite good.</para> -<para>For details on the use of ethereal, read the well-written -ethereal User Guide.</para> +<para>For details on the use of <command>ethereal</command>, read the well-written +Ethereal User Guide.</para> + +<image id="ethereal1"><imagefile>ethereal1</imagefile><imagedescription>Starting a capture.</imagedescription></image> <para> -Listen for data on ports 137, 138, 139 and 445. E.g. -use the filter <userinput>port 137 or port 138 or port 139 or port 445</userinput>.</para> +Listen for data on ports 137, 138, 139, and 445. For example, use the filter <userinput>port 137, port 138, port 139, or port 445</userinput> as seen in <link linkend="ethereal1"/>.</para> <para>A console version of ethereal is available as well and is called <command>tethereal</command>.</para> +<image id="ethereal2"><imagefile>ethereal2</imagefile><imagedescription>Main ethereal data window.</imagedescription></image> + </sect2> <sect2> <title>The Windows Network Monitor</title> <para> -For tracing things on the Microsoft Windows NT, Network Monitor -(aka. netmon) is available on the Microsoft Developer Network CD's, -the Windows NT Server install CD and the SMS CD's. The version of -netmon that ships with SMS allows for dumping packets between any two -computers (i.e. placing the network interface in promiscuous mode). +For tracing things on Microsoft Windows NT, Network Monitor +(aka Netmon) is available on Microsoft Developer Network CDs, +the Windows NT Server install CD and the SMS CDs. The version of +Netmon that ships with SMS allows for dumping packets between any two +computers (i.e., placing the network interface in promiscuous mode). The version on the NT Server install CD will only allow monitoring of network traffic directed to the local NT box and broadcasts on the -local subnet. Be aware that Ethereal can read and write netmon +local subnet. Be aware that Ethereal can read and write Netmon formatted files. </para> <sect3> -<title>Installing 'Network Monitor' on an NT Workstation</title> +<title>Installing Network Monitor on an NT Workstation</title> <para> -Installing netmon on an NT workstation requires a couple -of steps. The following are for installing Netmon V4.00.349, which comes +Installing Netmon on an NT workstation requires a couple +of steps. The following are instructions for installing Netmon V4.00.349, which comes with Microsoft Windows NT Server 4.0, on Microsoft Windows NT -Workstation 4.0. The process should be similar for other versions of -Windows NT / Netmon. You will need both the Microsoft Windows +Workstation 4.0. The process should be similar for other versions of +Windows NT version of Netmon. You will need both the Microsoft Windows NT Server 4.0 Install CD and the Workstation 4.0 Install CD. </para> <para> Initially you will need to install <application>Network Monitor Tools and Agent</application> -on the NT Server. To do this +on the NT Server to do this: </para> <itemizedlist> - <listitem><para>Goto <guibutton>Start</guibutton> - <guibutton>Settings</guibutton> - <guibutton>Control Panel</guibutton> - - <guibutton>Network</guibutton> - <guibutton>Services</guibutton> - <guibutton>Add</guibutton> </para></listitem> + <listitem><para>Go to <guibutton>Start</guibutton> -> <guibutton>Settings</guibutton> -> <guibutton>Control Panel</guibutton> -> + <guibutton>Network</guibutton> -> <guibutton>Services</guibutton> -> <guibutton>Add</guibutton>.</para></listitem> - <listitem><para>Select the <guilabel>Network Monitor Tools and Agent</guilabel> and - click on <guibutton>OK</guibutton>.</para></listitem> + <listitem><para>Select the <guilabel>Network Monitor Tools and Agent</guilabel> and click on <guibutton>OK</guibutton>.</para></listitem> - <listitem><para>Click <guibutton>OK</guibutton> on the Network Control Panel. - </para></listitem> + <listitem><para>Click on <guibutton>OK</guibutton> on the Network Control Panel.</para></listitem> - <listitem><para>Insert the Windows NT Server 4.0 install CD - when prompted.</para></listitem> + <listitem><para>Insert the Windows NT Server 4.0 install CD when prompted.</para></listitem> </itemizedlist> <para> -At this point the Netmon files should exist in -<filename>%SYSTEMROOT%\System32\netmon\*.*</filename>. -Two subdirectories exist as well, <filename>parsers\</filename> -which contains the necessary DLL's for parsing the netmon packet -dump, and <filename>captures\</filename>. +At this point, the Netmon files should exist in <filename>%SYSTEMROOT%\System32\netmon\*.*</filename>. +Two subdirectories exist as well, <filename>parsers\</filename> which contains the necessary DLLs +for parsing the Netmon packet dump, and <filename>captures\</filename>. </para> <para> -In order to install the Netmon tools on an NT Workstation, you will -first need to install the 'Network Monitor Agent' from the Workstation -install CD. +To install the Netmon tools on an NT Workstation, you will first need to install the +Network Monitor Agent from the Workstation install CD. </para> <itemizedlist> - <listitem><para>Goto <guibutton>Start</guibutton> - <guibutton>Settings</guibutton> - <guibutton>Control Panel</guibutton> - - <guibutton>Network</guibutton> - <guibutton>Services</guibutton> - <guibutton>Add</guibutton></para></listitem> + <listitem><para>Go to <guibutton>Start</guibutton> -> <guibutton>Settings</guibutton> -> <guibutton>Control Panel</guibutton> -> + <guibutton>Network</guibutton> -> <guibutton>Services</guibutton> -> <guibutton>Add</guibutton>.</para></listitem> - <listitem><para>Select the <guilabel>Network Monitor Agent</guilabel> and click - on <guibutton>OK</guibutton>.</para></listitem> + <listitem><para>Select the <guilabel>Network Monitor Agent</guilabel>, click on <guibutton>OK</guibutton>.</para></listitem> - <listitem><para>Click <guibutton>OK</guibutton> on the Network Control Panel. + <listitem><para>Click on <guibutton>OK</guibutton> in the Network Control Panel. </para></listitem> - <listitem><para>Insert the Windows NT Workstation 4.0 install - CD when prompted.</para></listitem> + <listitem><para>Insert the Windows NT Workstation 4.0 install CD when prompted.</para></listitem> </itemizedlist> <para> -Now copy the files from the NT Server in <filename>%SYSTEMROOT%\System32\netmon\*.*</filename> -to <filename>%SYSTEMROOT%\System32\netmon\*.*</filename> on the Workstation and set -permissions as you deem appropriate for your site. You will need -administrative rights on the NT box to run netmon. +Now copy the files from the NT Server in <filename>%SYSTEMROOT%\System32\netmon</filename> +to <filename>%SYSTEMROOT%\System32\netmon</filename> on the Workstation and set permissions +as you deem appropriate for your site. You will need administrative rights on the NT box to run Netmon. </para> </sect3> <sect3> -<title>Installing 'Network Monitor' on an 9x Workstation</title> +<title>Installing Network Monitor on Windows 9x/Me</title> <para> -To install Netmon on a Windows 9x box install the network monitor agent -from the Windows 9x CD (<filename>\admin\nettools\netmon</filename>). There is a readme -file located with the netmon driver files on the CD if you need -information on how to do this. Copy the files from a working -Netmon installation. +To install Netmon on Windows 9x/Me, install the Network Monitor Agent +from the Windows 9x/Me CD (<filename>\admin\nettools\netmon</filename>). +There is a readme file located with the Netmon driver files on the CD if you need +information on how to do this. Copy the files from a working Netmon installation. </para> </sect3> </sect2> @@ -204,86 +201,90 @@ Netmon installation. </sect1> <sect1> -<title>Getting help from the mailing lists</title> +<title>Getting Mailing List Help</title> <para> -There are a number of Samba related mailing lists. Go to <ulink +There are a number of Samba-related mailing lists. Go to <ulink noescape="1" url="http://samba.org">http://samba.org</ulink>, click on your nearest mirror -and then click on <command>Support</command> and then click on <command> -Samba related mailing lists</command>. +and then click on <command>Support</command> and next click on <command> +Samba-related mailing lists</command>. </para> <para> -For questions relating to Samba TNG go to -<ulink noescape="1" url="http://www.samba-tng.org/">http://www.samba-tng.org/</ulink> -It has been requested that you don't post questions about Samba-TNG to the -main stream Samba lists.</para> - +For questions relating to Samba TNG, go to +<ulink noescape="1" url="http://www.samba-tng.org/">http://www.samba-tng.org/.</ulink> +It has been requested that you do not post questions about Samba-TNG to the +main-stream Samba lists.</para> + <para> -If you post a message to one of the lists please observe the following guide lines : +If you do post a message to one of the lists, please observe the following guidelines : </para> <itemizedlist> -<listitem><para>Always remember that the developers are volunteers, they are -not paid and they never guarantee to produce a particular feature at -a particular time. Any time lines are 'best guess' and nothing more. -</para></listitem> - -<listitem><para>Always mention what version of samba you are using and what -operating system its running under. You should probably list the -relevant sections of your &smb.conf; file, at least the options -in [global] that affect PDC support.</para></listitem> - -<listitem><para>In addition to the version, if you obtained Samba via -CVS mention the date when you last checked it out.</para></listitem> - -<listitem><para> Try and make your question clear and brief, lots of long, -convoluted questions get deleted before they are completely read ! -Don't post html encoded messages (if you can select colour or font -size its html).</para></listitem> - -<listitem><para> If you run one of those nifty 'I'm on holidays' things when -you are away, make sure its configured to not answer mailing lists. -</para></listitem> - -<listitem><para> Don't cross post. Work out which is the best list to post to -and see what happens, i.e. don't post to both samba-ntdom and samba-technical. -Many people active on the lists subscribe to more -than one list and get annoyed to see the same message two or more times. -Often someone will see a message and thinking it would be better dealt -with on another, will forward it on for you.</para></listitem> - -<listitem><para>You might include <emphasis>partial</emphasis> -log files written at a debug level set to as much as 20. -Please don't send the entire log but enough to give the context of the -error messages.</para></listitem> - -<listitem><para>(Possibly) If you have a complete netmon trace ( from the opening of -the pipe to the error ) you can send the *.CAP file as well.</para></listitem> - -<listitem><para>Please think carefully before attaching a document to an email. -Consider pasting the relevant parts into the body of the message. The samba -mailing lists go to a huge number of people, do they all need a copy of your -smb.conf in their attach directory?</para></listitem> + <listitem><para>Always remember that the developers are volunteers, they are + not paid and they never guarantee to produce a particular feature at + a particular time. Any timelines are <quote>best guess</quote> and nothing more. + </para></listitem> + + <listitem><para>Always mention what version of Samba you are using and what + operating system it's running under. You should list the relevant sections of + your &smb.conf; file, at least the options in <smbconfsection>[global]</smbconfsection> + that affect PDC support. + </para></listitem> + + <listitem><para>In addition to the version, if you obtained Samba via + CVS, mention the date when you last checked it out.</para></listitem> + + <listitem><para> Try and make your questions clear and brief. Lots of long, + convoluted questions get deleted before they are completely read! + Do not post HTML encoded messages. Most people on mailing lists simply delete + them. + </para></listitem> + + <listitem><para> If you run one of those nifty <quote>I'm on holidays</quote> things when + you are away, make sure its configured to not answer mailing list traffic. Auto-responses + to mailing lists really irritate the thousands of people who end up having to deal + with such bad netiquet bahavior. + </para></listitem> + + <listitem><para>Don't cross post. Work out which is the best list to post to + and see what happens. Do not post to both samba-ntdom and samba-technical. + Many people active on the lists subscribe to more + than one list and get annoyed to see the same message two or more times. + Often someone will see a message and thinking it would be better dealt + with on another list, will forward it on for you.</para></listitem> + + <listitem><para>You might include <emphasis>partial</emphasis> + log files written at a debug level set to as much as 20. + Please do not send the entire log but just enough to give the context of the + error messages.</para></listitem> + + <listitem><para>If you have a complete Netmon trace (from the opening of + the pipe to the error), you can send the *.CAP file as well.</para></listitem> + ` + <listitem><para>Please think carefully before attaching a document to an email. + Consider pasting the relevant parts into the body of the message. The Samba + mailing lists go to a huge number of people. Do they all need a copy of your + &smb.conf; in their attach directory?</para></listitem> </itemizedlist> </sect1> <sect1> -<title>How to get off the mailing lists</title> +<title>How to Get Off the Mailing Lists</title> -<para>To have your name removed from a samba mailing list, go to the -same place you went to to get on it. Go to <ulink - noescape="1" url="http://lists.samba.org/">http://lists.samba.org</ulink>, -click on your nearest mirror and then click on <command>Support</command> and -then click on <command> Samba related mailing lists</command>. +<para>To have your name removed from a Samba mailing list, go to the same +place where you went to +subscribe to it. Go to <ulink noescape="1" url="http://lists.samba.org/">http://lists.samba.org</ulink>, +click on your nearest mirror, click on <command>Support</command> and +then click on<command> Samba related mailing lists</command>. </para> <para> -Please don't post messages to the list asking to be removed, you will just -be referred to the above address (unless that process failed in some way...) +Please do not post messages to the list asking to be removed. You will only +be referred to the above address (unless that process failed in some way). </para> </sect1> diff --git a/docs/docbook/projdoc/ProfileMgmt.xml b/docs/docbook/projdoc/ProfileMgmt.xml index 37ae2d41e8..7171884410 100644 --- a/docs/docbook/projdoc/ProfileMgmt.xml +++ b/docs/docbook/projdoc/ProfileMgmt.xml @@ -10,22 +10,22 @@ <title>Features and Benefits</title> <para> -Roaming Profiles are feared by some, hated by a few, loved by many, and a Godsend for +Roaming profiles are feared by some, hated by a few, loved by many, and a Godsend for some administrators. </para> <para> -Roaming Profiles allow an administrator to make available a consistent user desktop +Roaming profiles allow an administrator to make available a consistent user desktop as the user moves from one machine to another. This chapter provides much information -regarding how to configure and manage Roaming Profiles. +regarding how to configure and manage roaming profiles. </para> <para> -While Roaming Profiles might sound like nirvana to some, they are a real and tangible +While roaming profiles might sound like nirvana to some, they are a real and tangible problem to others. In particular, users of mobile computing tools, where often there may not -be a sustained network connection, are often better served by purely Local Profiles. -This chapter provides information to help the Samba administrator to deal with those -situations also. +be a sustained network connection, are often better served by purely local profiles. +This chapter provides information to help the Samba administrator deal with those +situations. </para> </sect1> @@ -35,25 +35,25 @@ situations also. <warning> <para> -Roaming profiles support is different for Win9x / Me and Windows NT4/200x. +Roaming profiles support is different for Windows 9x/Me and Windows NT4/200x. </para> </warning> <para> Before discussing how to configure roaming profiles, it is useful to see how -Windows 9x / Me and Windows NT4/200x clients implement these features. +Windows 9x/Me and Windows NT4/200x clients implement these features. </para> <para> -Windows 9x / Me clients send a NetUserGetInfo request to the server to get the user's +Windows 9x/Me clients send a NetUserGetInfo request to the server to get the user's profiles location. However, the response does not have room for a separate -profiles location field, only the user's home share. This means that Win9X/Me +profiles location field, only the user's home share. This means that Windows 9x/Me profiles are restricted to being stored in the user's home directory. </para> <para> -Windows NT4/200x clients send a NetSAMLogon RPC request, which contains many fields, +Windows NT4/200x clients send a NetSAMLogon RPC request, which contains many fields including a separate field for the location of the user's profiles. </para> @@ -68,8 +68,7 @@ This section documents how to configure Samba for MS Windows client profile supp <title>NT4/200x User Profiles</title> <para> -To support Windows NT4/200x clients, in the [global] section of smb.conf set the -following (for example): +For example, to support Windows NT4/200x clients, set the followoing in the [global] section of the &smb.conf; file: </para> <para> @@ -77,68 +76,66 @@ following (for example): <smbconfoption><name>logon path</name><value>\\profileserver\profileshare\profilepath\%U\moreprofilepath</value></smbconfoption> </smbconfblock> - This is typically implemented like: +This is typically implemented like: <smbconfblock> <smbconfoption><name>logon path</name><value>\\%L\Profiles\%u</value></smbconfoption> </smbconfblock> -where %L translates to the name of the Samba server and %u translates to the user name +where <quote>%L</quote> translates to the name of the Samba server and <quote>%u</quote> translates to the user name. </para> <para> -The default for this option is <filename>\\%N\%U\profile</filename>, -namely <filename>\\sambaserver\username\profile</filename>. -The <filename>\\N%\%U</filename> service is created automatically by the [homes] service. If you are using -a samba server for the profiles, you _must_ make the share specified in the logon path +The default for this option is <filename>\\%N\%U\profile</filename>, namely <filename>\\sambaserver\username\profile</filename>. +The <filename>\\N%\%U</filename> service is created automatically by the [homes] service. If you are using +a Samba server for the profiles, you must make the share that is specified in the logon path browseable. Please refer to the man page for &smb.conf; in respect of the different -semantics of %L and %N, as well as %U and %u. +semantics of <quote>%L</quote> and <quote>%N</quote>, as well as <quote>%U</quote> and <quote>%u</quote>. </para> <note> <para> -MS Windows NT/2K clients at times do not disconnect a connection to a server -between logons. It is recommended to NOT use the <smbconfsection>homes</smbconfsection> -meta-service name as part of the profile share path. +MS Windows NT/200x clients at times do not disconnect a connection to a server between logons. It is recommended +to not use the <smbconfsection>homes</smbconfsection> meta-service name as part of the profile share path. </para> </note> </sect3> <sect3> -<title>Windows 9x / Me User Profiles</title> +<title>Windows 9x/Me User Profiles</title> <para> - To support Windows 9x / Me clients, you must use the <smbconfoption><name>logon home</name></smbconfoption> parameter. Samba has -now been fixed so that <userinput>net use /home</userinput> now works as well, and it, too, relies +To support Windows 9x/Me clients, you must use the <smbconfoption><name>logon home</name></smbconfoption> +parameter. Samba has been fixed so <userinput>net use /home</userinput> now works as well and it, too, relies on the <command>logon home</command> parameter. </para> <para> -By using the logon home parameter, you are restricted to putting Win9x / Me -profiles in the user's home directory. But wait! There is a trick you -can use. If you set the following in the <smbconfsection>[global]</smbconfsection> section of your &smb.conf; file: +By using the logon home parameter, you are restricted to putting Windows 9x/Me profiles in the user's home +directory. But wait! There is a trick you can use. If you set the following in the +<smbconfsection>[global]</smbconfsection> section of your &smb.conf; file: </para> <para><smbconfblock> <smbconfoption><name>logon home</name><value>\\%L\%U\.profiles</value></smbconfoption> </smbconfblock></para> <para> -then your Windows 9x / Me clients will dutifully put their clients in a subdirectory -of your home directory called <filename>.profiles</filename> (thus making them hidden). +then your Windows 9x/Me clients will dutifully put their clients in a subdirectory +of your home directory called <filename>.profiles</filename> (making them hidden). </para> <para> -Not only that, but <userinput>net use /home</userinput> will also work, because of a feature in -Windows 9x / Me. It removes any directory stuff off the end of the home directory area +Not only that, but <userinput>net use /home</userinput> will also work because of a feature in +Windows 9x/Me. It removes any directory stuff off the end of the home directory area and only uses the server and share portion. That is, it looks like you specified <filename>\\%L\%U</filename> for <smbconfoption><name>logon home</name></smbconfoption>. </para> </sect3> <sect3> -<title>Mixed Windows 9x / Me and Windows NT4/200x User Profiles</title> +<title>Mixed Windows 9x/Me and Windows NT4/200x User Profiles</title> <para> -You can support profiles for both Win9X and WinNT clients by setting both the +You can support profiles for Windows 9x and Windows NT clients by setting both the <smbconfoption><name>logon home</name></smbconfoption> and <smbconfoption><name>logon path</name></smbconfoption> parameters. For example: </para> @@ -152,250 +149,205 @@ You can support profiles for both Win9X and WinNT clients by setting both the <title>Disabling Roaming Profile Support</title> <para> - A question often asked is <quote>How may I enforce use of local profiles?</quote> or - <quote>How do I disable Roaming Profiles?</quote> +A question often asked is: <quote>How may I enforce use of local profiles?</quote> or +<quote>How do I disable roaming profiles?</quote> </para> <para> +<indexterm><primary>roaming profiles</primary></indexterm> There are three ways of doing this: +<indexterm><primary>windows registry settings</primary><secondary>roaming profiles</secondary></indexterm> </para> + <variablelist> <varlistentry> <term>In &smb.conf;</term> <listitem><para> - Affect the following settings and ALL clients - will be forced to use a local profile: - <smbconfblock> - <smbconfoption><name>logon home</name></smbconfoption> - <smbconfoption><name>logon path</name></smbconfoption> - </smbconfblock> + Affect the following settings and ALL clients will be forced to use a local profile: + <smbconfoption><name>logon home</name></smbconfoption> and <smbconfoption><name>logon path</name></smbconfoption> </para></listitem> </varlistentry> <varlistentry> - <term>MS Windows Registry:</term> + <term>MS Windows Registry</term> <listitem><para> - By using the Microsoft Management Console gpedit.msc to instruct your MS Windows XP machine to use only a local profile. This of course modifies registry settings. The full path to the option is: - <!-- FIXME: Diagram for this ? --> - <!-- FIXME: Yes, a diagram will help - JHT --> - <programlisting> - Local Computer Policy\ - Computer Configuration\ - Administrative Templates\ - System\ - User Profiles\ - - Disable: Only Allow Local User Profiles - Disable: Prevent Roaming Profile Change from Propagating to the Server - </programlisting> - </para> </listitem> + By using the Microsoft Management Console gpedit.msc to instruct your MS Windows XP + machine to use only a local profile. This, of course, modifies registry settings. The full + path to the option is: +<screen> +Local Computer Policy\ + Computer Configuration\ + Administrative Templates\ + System\ + User Profiles\ + +Disable: Only Allow Local User Profiles +Disable: Prevent Roaming Profile Change from Propagating to the Server +</screen> + </para> </listitem> </varlistentry> <varlistentry> <term>Change of Profile Type:</term> - <listitem><para> - From the start menu right click on the - My Computer icon, select <guimenuitem>Properties</guimenuitem>, click on the <guilabel>User Profiles</guilabel> - tab, select the profile you wish to change from Roaming type to Local, click <guibutton>Change Type</guibutton>. + <listitem><para>From the start menu right-click on <guiicon>My Computer icon</guiicon>, + select <guimenuitem>Properties</guimenuitem>, click on the <guilabel>User Profiles</guilabel> + tab, select the profile you wish to change from + <guimenu>Roaming</guimenu> type to <guimenu>Local</guimenu>, and click on + <guibutton>Change Type</guibutton>. </para></listitem> </varlistentry> </variablelist> <para> -Consult the MS Windows registry guide for your particular MS Windows version for more -information about which registry keys to change to enforce use of only local user -profiles. +Consult the MS Windows registry guide for your particular MS Windows version for more information +about which registry keys to change to enforce use of only local user profiles. </para> <note><para> The specifics of how to convert a local profile to a roaming profile, or a roaming profile -to a local one vary according to the version of MS Windows you are running. Consult the -Microsoft MS Windows Resource Kit for your version of Windows for specific information. +to a local one vary according to the version of MS Windows you are running. Consult the Microsoft MS +Windows Resource Kit for your version of Windows for specific information. </para></note> -</sect3> -</sect2> +</sect3> </sect2> -<sect2> -<title>Windows Client Profile Configuration Information</title> +<sect2> <title>Windows Client Profile Configuration Information</title> -<sect3> -<title>Windows 9x / Me Profile Setup</title> +<sect3> <title>Windows 9x/Me Profile Setup</title> <para> -When a user first logs in on Windows 9X, the file user.DAT is created, -as are folders <filename>Start Menu</filename>, <filename>Desktop</filename>, -<filename>Programs</filename> and <filename>Nethood</filename>. -These directories and their contents will be merged with the local -versions stored in <filename>c:\windows\profiles\username</filename> on subsequent logins, -taking the most recent from each. You will need to use the <smbconfsection>[global]</smbconfsection> -options <smbconfoption><name>preserve case</name><value>yes</value></smbconfoption>, <smbconfoption><name>short preserve case</name><value>yes</value></smbconfoption> and -<smbconfoption><name>case sensitive</name><value>no</value></smbconfoption> in order to maintain capital letters in shortcuts -in any of the profile folders. +When a user first logs in on Windows 9X, the file user.DAT is created, as are folders +<filename>Start Menu</filename>, <filename>Desktop</filename>, <filename>Programs</filename>, and +<filename>Nethood</filename>. These directories and their contents will be merged with the local +versions stored in <filename>c:\windows\profiles\username</filename> on subsequent logins, taking the +most recent from each. You will need to use the <smbconfsection>[global]</smbconfsection> options +<smbconfoption><name>preserve case</name><value>yes</value></smbconfoption>, +<smbconfoption><name>short preserve case</name><value>yes</value></smbconfoption> and +<smbconfoption><name>case sensitive</name><value>no</value></smbconfoption> +in order to maintain capital letters in shortcuts in any of the profile folders. </para> <para> -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. +The <filename>user.DAT</filename> file contains all the user's preferences. If you wish to enforce a set of preferences, +rename their <filename>user.DAT</filename> file to <filename>user.MAN</filename>, and deny them write access to this file. </para> <orderedlist> - <listitem> - <para> - On the Windows 9x / Me machine, go to <guimenu>Control Panel</guimenu> -> <guimenuitem>Passwords</guimenuitem> and - select the <guilabel>User Profiles</guilabel> tab. Select the required level of - roaming preferences. Press <guibutton>OK</guibutton>, but do _not_ allow the computer - to reboot. - </para> - </listitem> - - <listitem> - <para> - On the Windows 9x / Me machine, go to <guimenu>Control Panel</guimenu> -> <guimenuitem>Network</guimenuitem> -> - <guimenuitem>Client for Microsoft Networks</guimenuitem> -> <guilabel>Preferences</guilabel>. Select <guilabel>Log on to - NT Domain</guilabel>. Then, ensure that the Primary Logon is <guilabel>Client for - Microsoft Networks</guilabel>. Press <guibutton>OK</guibutton>, and this time allow the computer - to reboot. - </para> - </listitem> + <listitem> <para> + On the Windows 9x/Me machine, go to <guimenu>Control Panel</guimenu> -> + <guimenuitem>Passwords</guimenuitem> and select the <guilabel>User Profiles</guilabel> tab. + Select the required level of roaming preferences. Press <guibutton>OK</guibutton>, but do not + allow the computer to reboot. + </para> </listitem> + + <listitem> <para> + On the Windows 9x/Me machine, go to <guimenu>Control Panel</guimenu> -> + <guimenuitem>Network</guimenuitem> -> <guimenuitem>Client for Microsoft Networks</guimenuitem> + -> <guilabel>Preferences</guilabel>. Select <guilabel>Log on to NT Domain</guilabel>. Then, + ensure that the Primary Logon is <guilabel>Client for Microsoft Networks</guilabel>. Press + <guibutton>OK</guibutton>, and this time allow the computer to reboot. + </para> </listitem> </orderedlist> -<para> -Under Windows 9x / Me Profiles are downloaded from the Primary Logon. -If you have the Primary Logon as 'Client for Novell Networks', then -the profiles and logon script will be downloaded from your Novell -Server. If you have the Primary Logon as 'Windows Logon', then the -profiles will be loaded from the local machine - a bit against the -concept of roaming profiles, it would seem! -</para> +<para> Under Windows 9x/ME, profiles are downloaded from the Primary Logon. If you have the Primary Logon +as <quote>Client for Novell Networks</quote>, then the profiles and logon script will be downloaded from +your Novell Server. If you have the Primary Logon as <quote>Windows Logon</quote>, then the profiles will +be loaded from the local machine &smbmdash; a bit against the concept of roaming profiles, it would seem! </para> <para> -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. +You will now find that the Microsoft Networks Login box contains <constant>[user, password, domain]</constant> instead +of just <constant>[user, password]</constant>. 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. </para> -<para> -Once the user has been successfully validated, the Windows 9x / Me machine -will inform you that <computeroutput>The user has not logged on before</computeroutput> and asks you -<computeroutput>Do you wish to save the user's preferences?</computeroutput>. Select <guibutton>yes</guibutton>. -</para> +<para> Once the user has been successfully validated, the Windows 9x/Me machine will inform you that +<computeroutput>The user has not logged on before</computeroutput> and asks you <computeroutput>Do you +wish to save the user's preferences?</computeroutput> Select <guibutton>Yes</guibutton>. </para> -<para> -Once the Windows 9x / Me client comes up with the desktop, you should be able -to examine the contents of the directory specified in the <smbconfoption><name>logon path</name></smbconfoption> -on the samba server and verify that the <filename>Desktop</filename>, <filename>Start Menu</filename>, -<filename>Programs</filename> and <filename>Nethood</filename> folders have been created. -</para> +<para> Once the Windows 9x/Me client comes up with the desktop, you should be able to examine the +contents of the directory specified in the <smbconfoption><name>logon path</name></smbconfoption> on +the Samba server and verify that the <filename>Desktop</filename>, <filename>Start Menu</filename>, +<filename>Programs</filename> and <filename>Nethood</filename> folders have been created. </para> -<para> -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. -</para> +<para> 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 +shortcut, 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 shortcut from each set. </para> -<para> -If you have made the folders / files read-only on the samba server, -then you will get errors from the Windows 9x / Me machine on logon and logout, as -it attempts to merge the local and the remote profile. Basically, if -you have any errors reported by the Windows 9x / Me machine, check the UNIX file -permissions and ownership rights on the profile directory contents, -on the samba server. -</para> +<para> If you have made the folders/files read-only on the Samba server, then you will get errors from +the Windows 9x/Me machine on logon and logout as it attempts to merge the local and remote profile. +Basically, if you have any errors reported by the Windows 9x/Me machine, check the UNIX file permissions +and ownership rights on the profile directory contents, on the Samba server. </para> -<para> -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". -</para> - - <warning> - <para> - Before deleting the contents of the - directory listed in the ProfilePath (this is likely to be - <filename>c:\windows\profiles\username)</filename>, 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). - </para> +<para> If you have problems creating user profiles, you can reset the user's local desktop cache, as +shown below. When this user next logs in, the user will be told that he/she is logging in <quote>for + the first time</quote>. + +<indexterm><primary>windows registry settings</primary><secondary>profile path</secondary></indexterm> + </para> - <para> - 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. - </para> - </warning> +<orderedlist> + <listitem><para> + Instead of logging in under the [user, password, domain] dialog, press <guibutton>escape</guibutton>. + </para> </listitem> + <listitem><para> + Run the <command>regedit.exe</command> program, and look in: + </para> -<orderedlist> - <listitem> - <para> - instead of logging in under the [user, password, domain] dialog, - press <guibutton>escape</guibutton>. - </para> - </listitem> - - <listitem> - <para> - run the <command>regedit.exe</command> program, and look in: - </para> - - <para> - <filename>HKEY_LOCAL_MACHINE\Windows\CurrentVersion\ProfileList</filename> - </para> - - <para> - you will find an entry, for each user, of ProfilePath. Note the - contents of this key (likely to be <filename>c:\windows\profiles\username</filename>), - then delete the key ProfilePath for the required user. - </para> - - <para>[Exit the registry editor].</para> - </listitem> - - <listitem> - <para> - search for the user's .PWL password-caching file in the <filename>c:\windows</filename> - directory, and delete it. - </para> - </listitem> - - <listitem> - <para> - log off the windows 9x / Me client. - </para> - </listitem> - - <listitem> - <para> - check the contents of the profile path (see <smbconfoption><name>logon path</name></smbconfoption> described - above), and delete the <filename>user.DAT</filename> or <filename>user.MAN</filename> file for the user, - making a backup if required. - </para> - </listitem> + <para> + <filename>HKEY_LOCAL_MACHINE\Windows\CurrentVersion\ProfileList</filename> + </para> + <para> + You will find an entry for each user of ProfilePath. Note the contents of this key + (likely to be <filename>c:\windows\profiles\username</filename>), then delete the key + <parameter>ProfilePath</parameter> for the required user. + </para></listitem> + + <listitem><para> + Exit the registry editor. + </para></listitem> + + <listitem><para> + Search for the user's .PWL password-caching file in the <filename>c:\windows</filename> directory, and delete it. + </para></listitem> + + <listitem><para> + Log off the Windows 9x/Me client. + </para></listitem> + + <listitem><para> + Check the contents of the profile path (see <smbconfoption><name>logon path</name></smbconfoption> + described above) and delete the <filename>user.DAT</filename> or <filename>user.MAN</filename> + file for the user, making a backup if required. + </para></listitem> </orderedlist> -<para> -If all else fails, increase samba's debug log levels to between 3 and 10, -and / or run a packet trace program such as ethereal or <command>netmon.exe</command>, and -look for error messages. +<warning><para> +Before deleting the contents of the directory listed in the <parameter>ProfilePath</parameter> +(this is likely to be <filename>c:\windows\profiles\username)</filename>, ask the owner if they have +any important files stored on their desktop or in their start menu. Delete the contents of the +directory <parameter>ProfilePath</parameter> (making a backup if any of the files are needed). </para> <para> -If you have access to an Windows NT4/200x server, then first set up roaming profiles -and / or netlogons on the Windows NT4/200x server. Make a packet trace, or examine -the example packet traces provided with Windows NT4/200x server, and see what the -differences are with the equivalent samba trace. +This will have the effect of removing the local (read-only hidden system file) <filename>user.DAT</filename> +in their profile directory, as well as the local <quote>desktop,</quote> <quote>nethood,</quote> +<quote>start menu,</quote> and <quote>programs</quote> folders. +</para></warning> + +<para> +If all else fails, increase Samba's debug log levels to between 3 and 10, and/or run a packet +sniffer program such as ethereal or <command>netmon.exe</command>, and look for error messages. +</para> + +<para> If you have access to an Windows NT4/200x server, then first set up roaming profiles and/or +netlogons on the Windows NT4/200x server. Make a packet trace, or examine the example packet traces +provided with Windows NT4/200x server, and see what the differences are with the equivalent Samba trace. </para> </sect3> @@ -403,272 +355,206 @@ differences are with the equivalent samba trace. <sect3> <title>Windows NT4 Workstation</title> -<para> -When a user first logs in to a Windows NT Workstation, the profile -NTuser.DAT is created. The profile location can be now specified -through the <smbconfoption><name>logon path</name></smbconfoption> parameter. +<para> When a user first logs in to a Windows NT Workstation, the profile NTuser.DAT is created. The profile +location can be now specified through the <smbconfoption><name>logon path</name></smbconfoption> parameter. </para> -<para> -There is a parameter that is now available for use with NT Profiles: -<smbconfoption><name>logon drive</name></smbconfoption>. This should be set to <filename>H:</filename> or any other drive, and -should be used in conjunction with the new <smbconfoption><name>logon home</name></smbconfoption> parameter. -</para> +<para> There is a parameter that is now available for use with NT Profiles: <smbconfoption><name>logon drive</name></smbconfoption>. +This should be set to <filename>H:</filename> or any other drive, and should be used in conjunction with +the new <smbconfoption><name>logon home</name></smbconfoption> parameter. </para> -<para> -The entry for the NT4 profile is a _directory_ not a file. The NT -help on profiles mentions that a directory is also created with a .PDS -extension. The user, while logging in, must have write permission to -create the full profile path (and the folder with the .PDS extension -for those situations where it might be created.) -</para> +<para> The entry for the NT4 profile is a directory not a file. The NT help on Profiles mentions that a +directory is also created with a .PDS extension. The user, while logging in, must have write permission +to create the full profile path (and the folder with the .PDS extension for those situations where it +might be created.) </para> -<para> -In the profile directory, Windows NT4 creates more folders than Windows 9x / Me. -It creates <filename>Application Data</filename> and others, as well as <filename>Desktop</filename>, <filename>Nethood</filename>, -<filename>Start Menu</filename> and <filename>Programs</filename>. The profile itself is stored in a file -<filename>NTuser.DAT</filename>. Nothing appears to be stored in the .PDS directory, and -its purpose is currently unknown. -</para> +<para> In the profile directory, Windows NT4 creates more folders than Windows 9x/Me. It creates +<filename>Application Data</filename> and others, as well as <filename>Desktop</filename>, +<filename>Nethood</filename>, <filename>Start Menu,</filename> and <filename>Programs</filename>. +The profile itself is stored in a file <filename>NTuser.DAT</filename>. Nothing appears to be stored +in the .PDS directory, and its purpose is currently unknown. </para> -<para> -You can use the <application>System Control Panel</application> 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 <application>System Control Panel</application> for you). The -NT Help file also mentions that renaming <filename>NTuser.DAT</filename> to <filename>NTuser.MAN</filename> -turns a profile into a mandatory one. +<para> You can use the <application>System Control Panel</application> 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 +<application>System Control Panel</application> for you). The NT Help file also mentions that renaming +<filename>NTuser.DAT</filename> to <filename>NTuser.MAN</filename> turns a profile into a mandatory one. </para> -<para> -The case of the profile is significant. The file must be called -<filename>NTuser.DAT</filename> or, for a mandatory profile, <filename>NTuser.MAN</filename>. -</para> -</sect3> +<para> The case of the profile is significant. The file must be called <filename>NTuser.DAT</filename> +or, for a mandatory profile, <filename>NTuser.MAN</filename>. </para> </sect3> -<sect3> -<title>Windows 2000/XP Professional</title> +<sect3> <title>Windows 2000/XP Professional</title> -<para> -You must first convert the profile from a local profile to a domain -profile on the MS Windows workstation as follows: -</para> +<para> You must first convert the profile from a local profile to a domain profile on the MS Windows +workstation as follows: </para> <procedure> - <step><para> - Log on as the <emphasis>LOCAL</emphasis> workstation administrator. - </para></step> - - <step><para> - Right click on the <guiicon>My Computer</guiicon> Icon, select <guimenuitem>Properties</guimenuitem> - </para></step> - - <step><para> - Click on the <guilabel>User Profiles</guilabel> tab - </para></step> - - <step><para> - Select the profile you wish to convert (click on it once) - </para></step> - - <step><para> - Click on the button <guibutton>Copy To</guibutton> - </para></step> - - <step><para> - In the <guilabel>Permitted to use</guilabel> box, click on the <guibutton>Change</guibutton> button. - </para></step> - - <step><para> - Click on the 'Look in" area that lists the machine name, when you click - here it will open up a selection box. Click on the domain to which the - profile must be accessible. - </para> + <step><para> Log on as the <emphasis>local</emphasis> workstation administrator. </para></step> + + <step><para> Right-click on the <guiicon>My Computer</guiicon> Icon, select + <guimenuitem>Properties</guimenuitem>.</para></step> + + <step><para> Click on the <guilabel>User Profiles</guilabel> tab.</para></step> + + <step><para> Select the profile you wish to convert (click it once).</para></step> + + <step><para> Click on the <guibutton>Copy To</guibutton> button.</para></step> + + <step><para> In the <guilabel>Permitted to use</guilabel> box, click on the + <guibutton>Change</guibutton> button. </para></step> - <note><para>You will need to log on if a logon box opens up. Eg: In the connect as: <replaceable>DOMAIN</replaceable>\root, password: <replaceable>mypassword</replaceable>.</para></note> - </step> + <step><para> Click on the <guilabel>Look in</guilabel> area that lists the machine name. When you click here, it will + open up a selection box. Click on the domain to which the profile must be accessible. </para> - <step><para> - To make the profile capable of being used by anyone select 'Everyone' - </para></step> + <note><para>You will need to log on if a logon box opens up. + For example, connect as <replaceable>DOMAIN</replaceable>\root, password: + <replaceable>mypassword</replaceable>.</para></note> </step> - <step><para> - Click <guibutton>OK</guibutton>. The Selection box will close. - </para></step> + <step><para> To make the profile capable of being used by anyone, select <quote>Everyone</quote>. </para></step> - <step><para> - Now click on the <guibutton>Ok</guibutton> button to create the profile in the path you - nominated. - </para></step> + <step><para> Click on <guibutton>OK</guibutton> and the Selection box will close. </para></step> + + <step><para> Now click on <guibutton>OK</guibutton> to create the profile in the path + you nominated. </para></step> </procedure> -<para> -Done. You now have a profile that can be edited using the samba -<command>profiles</command> tool. +<para> Done. You now have a profile that can be edited using the Samba <command>profiles</command> tool. </para> -<note> -<para> -Under NT/2K the use of mandatory profiles forces the use of MS Exchange -storage of mail data. That keeps desktop profiles usable. -</para> -</note> +<note><para> +Under Windows NT/200x, the use of mandatory profiles forces the use of MS Exchange storage of mail +data and keeps it out of the desktop profile. That keeps desktop profiles from becoming unusable. +</para> </note> -<procedure> - <title>Windows XP Service Pack 1</title> -<step><para> -This is a security check new to Windows XP (or maybe only -Windows XP service pack 1). It can be disabled via a group policy in -Active Directory. The policy is:</para> - -<para><filename>Computer Configuration\Administrative Templates\System\User -Profiles\Do not check for user ownership of Roaming Profile Folders</filename></para> - -<para>...and it should be set to <constant>Enabled</constant>. -Does the new version of samba have an Active Directory analogue? If so, -then you may be able to set the policy through this. -</para> +<sect4> +<title>Windows XP Service Pack 1</title> + <para> + There is a security check new to Windows XP (or maybe only Windows XP service pack 1). + It can be disabled via a group policy in the Active Directory. The policy is called: + </para> -<para> -If you cannot set group policies in samba, then you may be able to set -the policy locally on each machine. If you want to try this, then do -the following (N.B. I don't know for sure that this will work in the -same way as a domain group policy): -</para> + <para> + <filename>Computer Configuration\Administrative Templates\System\User Profiles\<?latex \linebreak ?>Do not check for + user ownership of Roaming Profile Folders</filename>i + </para> + + <para> + This should be set to <constant>Enabled</constant>. + </para> -</step> + <para> + Does the new version of Samba have an Active Directory analogue? If so, then you may be able to set the policy through this. + </para> -<step><para> -On the XP workstation log in with an Administrator account. -</para></step> + <para>If you cannot set group policies in Samba, then you may be able to set the policy locally on + each machine. If you want to try this, then do the following (N.B. I do not know for sure that this + will work in the same way as a domain group policy): + </para> - <step><para>Click: <guimenu>Start</guimenu>, <guimenuitem>Run</guimenuitem></para></step> - <step><para>Type: <userinput>mmc</userinput></para></step> - <step><para>Click: <guibutton>OK</guibutton></para></step> +<procedure> + <step><para>On the XP workstation, log in with an Administrative account.</para></step> + + <step><para>Click on <guimenu>Start</guimenu> -> <guimenuitem>Run</guimenuitem>.</para></step> + <step><para>Type <command>mmc</command>.</para></step> + <step><para>Click on <guibutton>OK</guibutton>.</para></step> <step><para>A Microsoft Management Console should appear.</para></step> - <step><para>Click: <guimenu>File</guimenu>, <guimenuitem>Add/Remove Snap-in...</guimenuitem>, <guimenuitem>Add</guimenuitem></para></step> - <step><para>Double-Click: <guiicon>Group Policy</guiicon></para></step> - <step><para>Click: <guibutton>Finish</guibutton>, <guibutton>Close</guibutton></para></step> - <step><para>Click: <guibutton>OK</guibutton></para></step> - - <step><para>In the "Console Root" window:</para></step> - <step><para>Expand: <guiicon>Local Computer Policy</guiicon>, <guiicon>Computer Configuration</guiicon>, - <guiicon>Administrative Templates</guiicon>, <guiicon>System</guiicon>, <guiicon>User Profiles</guiicon></para></step> - <step><para>Double-Click: <guilabel>Do not check for user ownership of Roaming Profile Folders</guilabel></para></step> - <step><para>Select: <guilabel>Enabled</guilabel></para></step> - <step><para>Click: <guibutton>OK</guibutton></para></step> - - <step><para>Close the whole console. You do not need to save the settings (this - refers to the console settings rather than the policies you have - changed).</para></step> - - <step><para>Reboot</para></step> + <step><para>Click on <guimenu>File</guimenu> -> <guimenuitem>Add/Remove Snap-in</guimenuitem> -> <guimenuitem>Add</guimenuitem>.</para></step> + <step><para>Double-click on <guiicon>Group Policy</guiicon>.</para></step> + <step><para>Click on <guibutton>Finish</guibutton> -> <guibutton>Close</guibutton>.</para></step> + <step><para>Click on <guibutton>OK</guibutton>.</para></step> + <step><para>In the <quote>Console Root</quote> window expand <guiicon>Local Computer Policy</guiicon> -> + <guiicon>Computer Configuration</guiicon> -> <guiicon>Administrative Templates</guiicon> -> <guiicon>System</guiicon> -> <guiicon>User Profiles</guiicon>.</para></step> + <step><para>Double-click on <guilabel>Do not check for user ownership of Roaming Profile Folders</guilabel>.</para></step> + <step><para>Select <guilabel>Enabled</guilabel>.</para></step> + <step><para>Click on <guibutton>OK</guibutton>.</para></step> + <step><para>Close the whole console. You do not need to save the settings (this refers to the + console settings rather than the policies you have changed).</para></step> + <step><para>Reboot.</para></step> </procedure> +</sect4> </sect3> </sect2> <sect2> -<title>Sharing Profiles between W9x/Me and NT4/200x/XP workstations</title> + <title>Sharing Profiles between W9x/Me and NT4/200x/XP <?latex \linebreak ?>Workstations</title> -<para> -Sharing of desktop profiles between Windows versions is NOT recommended. -Desktop profiles are an evolving phenomenon and profiles for later versions -of MS Windows clients add features that may interfere with earlier versions -of MS Windows clients. Probably the more salient reason to NOT mix profiles -is that when logging off an earlier version of MS Windows the older format -of profile contents may overwrite information that belongs to the newer -version resulting in loss of profile information content when that user logs -on again with the newer version of MS Windows. -</para> +<para> Sharing of desktop profiles between Windows versions is not recommended. Desktop profiles are an +evolving phenomenon and profiles for later versions of MS Windows clients add features that may interfere +with earlier versions of MS Windows clients. Probably the more salient reason to not mix profiles is +that when logging off an earlier version of MS Windows, the older format of profile contents may overwrite +information that belongs to the newer version resulting in loss of profile information content when that +user logs on again with the newer version of MS Windows. </para> -<para> -If you then want to share the same Start Menu / Desktop with W9x/Me, you will -need to specify a common location for the profiles. The &smb.conf; parameters -that need to be common are <smbconfoption><name>logon path</name></smbconfoption> and -<smbconfoption><name>logon home</name></smbconfoption>. -</para> +<para> If you then want to share the same Start Menu/Desktop with W9x/Me, you will need to specify a common +location for the profiles. The &smb.conf; parameters that need to be common are <smbconfoption><name>logon path</name></smbconfoption> and <smbconfoption><name>logon home</name></smbconfoption>. </para> -<para> -If you have this set up correctly, you will find separate <filename>user.DAT</filename> and -<filename>NTuser.DAT</filename> files in the same profile directory. -</para> +<para> If you have this set up correctly, you will find separate <filename>user.DAT</filename> and +<filename>NTuser.DAT</filename> files in the same profile directory. </para> </sect2> <sect2> <title>Profile Migration from Windows NT4/200x Server to Samba</title> -<para> -There is nothing to stop you specifying any path that you like for the -location of users' profiles. Therefore, you could specify that the -profile be stored on a samba server, or any other SMB server, as long as -that SMB server supports encrypted passwords. -</para> +<para> There is nothing to stop you from specifying any path that you like for the location of users' profiles. +Therefore, you could specify that the profile be stored on a Samba server, or any other SMB server, +as long as that SMB server supports encrypted passwords. </para> <sect3> <title>Windows NT4 Profile Management Tools</title> -<para> -Unfortunately, the Resource Kit information is specific to the version of MS Windows -NT4/200x. The correct resource kit is required for each platform. -</para> +<para> Unfortunately, the Resource Kit information is specific to the version of MS Windows NT4/200x. The +correct resource kit is required for each platform. </para> -<para> -Here is a quick guide: -</para> +<para>Here is a quick guide:</para> <procedure> + <step><para> On your NT4 Domain Controller, right click on <guiicon>My Computer</guiicon>, then select the + tab labeled <guilabel>User Profiles</guilabel>. </para></step> -<step><para> -On your NT4 Domain Controller, right click on <guiicon>My Computer</guiicon>, then -select the tab labelled <guilabel>User Profiles</guilabel>. -</para></step> + <step><para> Select a user profile you want to migrate and click on it. </para> -<step><para> -Select a user profile you want to migrate and click on it. -</para> - -<note><para>I am using the term "migrate" loosely. You can copy a profile to -create a group profile. You can give the user 'Everyone' rights to the -profile you copy this to. That is what you need to do, since your samba -domain is not a member of a trust relationship with your NT4 PDC.</para></note> -</step> + <note><para>I am using the term <quote>migrate</quote> loosely. You can copy a profile to create a group + profile. You can give the user <parameter>Everyone</parameter> rights to the profile you copy this to. That + is what you need to do, since your Samba domain is not a member of a trust relationship with your NT4 + PDC.</para></note></step> -<step><para>Click the <guibutton>Copy To</guibutton> button.</para></step> + <step><para>Click on the <guibutton>Copy To</guibutton> button.</para></step> - <step><para>In the box labelled <guilabel>Copy Profile to</guilabel> add your new path, eg: + <step><para>In the box labeled <guilabel>Copy Profile to</guilabel> add your new path, e.g., <filename>c:\temp\foobar</filename></para></step> - <step><para>Click on the button <guibutton>Change</guibutton> in the <guilabel>Permitted to use</guilabel> box.</para></step> + <step><para>Click on <guibutton>Change</guibutton> in the <guilabel>Permitted to use</guilabel> box.</para></step> - <step><para>Click on the group 'Everyone' and then click <guibutton>OK</guibutton>. This closes the - 'choose user' box.</para></step> + <step><para>Click on the group <quote>Everyone</quote>, click on <guibutton>OK</guibutton>. This + closes the <quote>choose user</quote> box.</para></step> - <step><para>Now click <guibutton>OK</guibutton>.</para></step> + <step><para>Now click on <guibutton>OK</guibutton>.</para></step> </procedure> -<para> -Follow the above for every profile you need to migrate. -</para> +<para> Follow the above for every profile you need to migrate. </para> </sect3> <sect3> -<title>Side bar Notes</title> +<title>Side Bar Notes</title> + <para> -You should obtain the SID of your NT4 domain. You can use smbpasswd to do -this. Read the man page.</para> +<indexterm><primary>SID</primary></indexterm> +You should obtain the SID of your NT4 domain. You can use smbpasswd to do this. Read the man +page.</para> </sect3> -<sect3> -<title>moveuser.exe</title> +<sect3> <title>moveuser.exe</title> + +<para> The Windows 200x professional resource kit has <command>moveuser.exe</command>. <command>moveuser.exe</command> changes the security of a profile +from one user to another. This allows the account domain to change, and/or the user name to change.</para> <para> -The W2K professional resource kit has moveuser.exe. moveuser.exe changes -the security of a profile from one user to another. This allows the account -domain to change, and/or the user name to change. +This command is like the Samba <command>profiles</command> tool. </para> </sect3> @@ -677,83 +563,61 @@ domain to change, and/or the user name to change. <title>Get SID</title> <para> -You can identify the SID by using GetSID.exe from the Windows NT Server 4.0 -Resource Kit. -</para> +<indexterm><primary>SID</primary></indexterm> +You can identify the SID by using <command>GetSID.exe</command> from the Windows NT Server 4.0 Resource Kit. </para> -<para> -Windows NT 4.0 stores the local profile information in the registry under -the following key: -<filename>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList</filename> -</para> +<para> Windows NT 4.0 stores the local profile information in the registry under the following key: +<filename>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList</filename> </para> -<para> -Under the ProfileList key, there will be subkeys named with the SIDs of the -users who have logged on to this computer. (To find the profile information -for the user whose locally cached profile you want to move, find the SID for -the user with the GetSID.exe utility.) Inside of the appropriate user's -subkey, you will see a string value named ProfileImagePath. -</para> +<para> Under the ProfileList key, there will be subkeys named with the SIDs of the users who have logged +on to this computer. (To find the profile information for the user whose locally cached profile you want +to move, find the SID for the user with the <command>GetSID.exe</command> utility.) Inside the appropriate user's subkey, +you will see a string value named <parameter>ProfileImagePath</parameter>. </para> -</sect3> -</sect2> -</sect1> +</sect3> </sect2> </sect1> -<sect1> -<title>Mandatory profiles</title> +<sect1> <title>Mandatory Profiles</title> <para> -A Mandatory Profile is a profile that the user does NOT have the ability to overwrite. -During the user's session it may be possible to change the desktop environment, but -as the user logs out all changes made will be lost. If it is desired to NOT allow the -user any ability to change the desktop environment then this must be done through -policy settings. See previous chapter. -</para> +<indexterm><primary>mandatory profiles</primary></indexterm> +A Mandatory Profile is a profile that the user does not have the ability to overwrite. During the +user's session, it may be possible to change the desktop environment, however, as the user logs out all changes +made will be lost. If it is desired to not allow the user any ability to change the desktop environment, +then this must be done through policy settings. See the previous chapter. </para> -<note> -<para> -Under NO circumstances should the profile directory (or it's contents) be made read-only -as this may render the profile un-usable. -</para> -</note> +<note><para> +Under NO circumstances should the profile directory (or its contents) be made read-only +as this may render the profile un-usable. Where it is essential to make a profile read-only +within the UNIX file system, this can be done but then you absolutely must use the <command>fake-permissions</command> +VFS module to instruct MS Windows NT/200x/XP clients that the Profile has write permission for the user. See <link linkend="fakeperms"/>. +</para></note> -<para> -For MS Windows NT4/200x/XP the above method can be used to create mandatory profiles -also. To convert a group profile into a mandatory profile simply locate the NTUser.DAT -file in the copied profile and rename it to NTUser.MAN. -</para> +<para> For MS Windows NT4/200x/XP, the above method can also be used to create mandatory profiles. To +convert a group profile into a mandatory profile, simply locate the <filename>NTUser.DAT</filename> file in the copied profile +and rename it to <filename>NTUser.MAN</filename>. </para> -<para> -For MS Windows 9x / Me it is the <filename>User.DAT</filename> file that must be renamed to <filename>User.MAN</filename> to -affect a mandatory profile. -</para> +<para> For MS Windows 9x/ME, it is the <filename>User.DAT</filename> file that must be renamed to +<filename>User.MAN</filename> to effect a mandatory profile. </para> </sect1> <sect1> -<title>Creating/Managing Group Profiles</title> +<title>Creating and Managing Group Profiles</title> <para> -Most organisations are arranged into departments. There is a nice benefit in -this fact since usually most users in a department will require the same desktop -applications and the same desktop layout. MS Windows NT4/200x/XP will allow the -use of Group Profiles. A Group Profile is a profile that is created firstly using -a template (example) user. Then using the profile migration tool (see above) the -profile is assigned access rights for the user group that needs to be given access -to the group profile. -</para> +<indexterm><primary>group profiles</primary></indexterm> +Most organizations are arranged into departments. There is a nice benefit in this fact since usually +most users in a department require the same desktop applications and the same desktop layout. MS +Windows NT4/200x/XP will allow the use of Group Profiles. A Group Profile is a profile that is created +first using a template (example) user. Then using the profile migration tool (see above), the profile is +assigned access rights for the user group that needs to be given access to the group profile. </para> -<para> -The next step is rather important. <emphasis>Please note:</emphasis> Instead of assigning a group profile -to users (ie: Using User Manager) on a "per user" basis, the group itself is assigned -the now modified profile. -</para> +<para> The next step is rather important. Instead of assigning a group profile to users (Using User Manager) +on a <quote>per user</quote> basis, the group itself is assigned the now modified profile. </para> <note> - <para> - Be careful with group profiles, if the user who is a member of a group also - has a personal profile, then the result will be a fusion (merge) of the two. - </para> +<para> Be careful with Group Profiles. If the user who is a member of a group also has a personal +profile, then the result will be a fusion (merge) of the two. </para> </note> </sect1> @@ -762,175 +626,147 @@ the now modified profile. <title>Default Profile for Windows Users</title> <para> -MS Windows 9x / Me and NT4/200x/XP will use a default profile for any user for whom -a profile does not already exist. Armed with a knowledge of where the default profile -is located on the Windows workstation, and knowing which registry keys affect the path -from which the default profile is created, it is possible to modify the default profile -to one that has been optimised for the site. This has significant administrative -advantages. -</para> +<indexterm><primary>default profile</primary></indexterm> +MS Windows 9x/Me and NT4/200x/XP will use a default profile for any user for whom a profile +does not already exist. Armed with a knowledge of where the default profile is located on the Windows +workstation, and knowing which registry keys effect the path from which the default profile is created, +it is possible to modify the default profile to one that has been optimized for the site. This has +significant administrative advantages. </para> <sect2> <title>MS Windows 9x/Me</title> -<para> -To enable default per use profiles in Windows 9x / Me you can either use the <application>Windows 98 System -Policy Editor</application> or change the registry directly. -</para> +<para> To enable default per use profiles in Windows 9x/ME, you can either use the <application>Windows +98 System Policy Editor</application> or change the registry directly. </para> -<para> -To enable default per user profiles in Windows 9x / Me, launch the <application>System Policy Editor</application>, then -select <guimenu>File</guimenu> -> <guimenuitem>Open Registry</guimenuitem>, then click on the -<guiicon>Local Computer</guiicon> icon, click on <guilabel>Windows 98 System</guilabel>, -select <guilabel>User Profiles</guilabel>, click on the enable box. Do not forget to save the registry changes. -</para> +<para> To enable default per user profiles in Windows 9x/ME, launch the <application>System Policy +Editor</application>, then select <guimenu>File</guimenu> -> <guimenuitem>Open Registry</guimenuitem>, +next click on the <guiicon>Local Computer</guiicon> icon, click on <guilabel>Windows 98 System</guilabel>, +select <guilabel>User Profiles</guilabel>, and click on the enable box. Remember to save the registry +changes. </para> -<para> -To modify the registry directly, launch the <application>Registry Editor</application> (<command>regedit.exe</command>), select the hive -<filename>HKEY_LOCAL_MACHINE\Network\Logon</filename>. Now add a DWORD type key with the name -"User Profiles", to enable user profiles set the value to 1, to disable user profiles set it to 0. -</para> +<para> To modify the registry directly, launch the <application>Registry Editor</application> +(<command>regedit.exe</command>) and select the hive <filename>HKEY_LOCAL_MACHINE\Network\Logon</filename>. Now +add a DWORD type key with the name <quote>User Profiles,</quote> to +enable user profiles to set the value +to 1; to disable user profiles set it to 0. </para> <sect3> -<title>How User Profiles Are Handled in Windows 9x / Me?</title> +<title>User Profile Handling with Windows 9x/Me</title> -<para> -When a user logs on to a Windows 9x / Me machine, the local profile path, +<para> When a user logs on to a Windows 9x/Me machine, the local profile path, <filename>HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\ProfileList</filename>, is checked -for an existing entry for that user: -</para> +for an existing entry for that user. </para> -<para> -If the user has an entry in this registry location, Windows 9x / Me checks for a locally cached -version of the user profile. Windows 9x / Me also checks the user's home directory (or other -specified directory if the location has been modified) on the server for the User Profile. -If a profile exists in both locations, the newer of the two is used. If the User Profile exists -on the server, but does not exist on the local machine, the profile on the server is downloaded -and used. If the User Profile only exists on the local machine, that copy is used. -</para> +<para> If the user has an entry in this registry location, Windows 9x/Me checks for a locally cached +version of the user profile. Windows 9x/Me also checks the user's home directory (or other specified +directory if the location has been modified) on the server for the User Profile. If a profile exists +in both locations, the newer of the two is used. If the User Profile exists on the server, but does not +exist on the local machine, the profile on the server is downloaded and used. If the User Profile only +exists on the local machine, that copy is used. </para> -<para> -If a User Profile is not found in either location, the Default User Profile from the Windows 9x / Me -machine is used and is copied to a newly created folder for the logged on user. At log off, any -changes that the user made are written to the user's local profile. If the user has a roaming -profile, the changes are written to the user's profile on the server. -</para> +<para> If a User Profile is not found in either location, the Default User Profile from the Windows +9x/Me machine is used and copied to a newly created folder for the logged on user. At log off, any +changes that the user made are written to the user's local profile. If the user has a roaming profile, +the changes are written to the user's profile on the server. </para> -</sect3> -</sect2> +</sect3> </sect2> <sect2> <title>MS Windows NT4 Workstation</title> -<para> -On MS Windows NT4 the default user profile is obtained from the location +<para> On MS Windows NT4, the default user profile is obtained from the location <filename>%SystemRoot%\Profiles</filename> which in a default installation will translate to -<filename>C:\WinNT\Profiles</filename>. Under this directory on a clean install there will be -three (3) directories: <filename>Administrator</filename>, <filename>All Users</filename>, <filename>Default User</filename>. -</para> +<filename>C:\Windows NT\Profiles</filename>. Under this directory on a clean install there will be three +(3) directories: <filename>Administrator</filename>, <filename>All +Users,</filename> and <filename>Default +User</filename>. </para> -<para> -The <filename>All Users</filename> directory contains menu settings that are common across all -system users. The <filename>Default User</filename> directory contains menu entries that are -customisable per user depending on the profile settings chosen/created. -</para> +<para> The <filename>All Users</filename> directory contains menu settings that are common across all +system users. The <filename>Default User</filename> directory contains menu entries that are customizable +per user depending on the profile settings chosen/created. </para> -<para> -When a new user first logs onto an MS Windows NT4 machine a new profile is created from: -</para> +<para> When a new user first logs onto an MS Windows NT4 machine, a new profile is created from: </para> <itemizedlist> - <listitem><para>All Users settings</para></listitem> - <listitem><para>Default User settings (contains the default NTUser.DAT file)</para></listitem> + <listitem><para>All Users settings.</para></listitem> + <listitem><para>Default User settings (contains the default <filename>NTUser.DAT</filename> file).</para></listitem> </itemizedlist> -<para> -When a user logs onto an MS Windows NT4 machine that is a member of a Microsoft security domain -the following steps are followed in respect of profile handling: -</para> - -<procedure> - <step> - <para> - The users' account information which is obtained during the logon process contains - the location of the users' desktop profile. The profile path may be local to the - machine or it may be located on a network share. If there exists a profile at the location - of the path from the user account, then this profile is copied to the location - <filename>%SystemRoot%\Profiles\%USERNAME%</filename>. This profile then inherits the - settings in the <filename>All Users</filename> profile in the <filename>%SystemRoot%\Profiles</filename> - location. - </para> - </step> - - <step> - <para> - If the user account has a profile path, but at it's location a profile does not exist, - then a new profile is created in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> - directory from reading the <filename>Default User</filename> profile. - </para> - </step> - - <step> - <para> - If the NETLOGON share on the authenticating server (logon server) contains a policy file - (<filename>NTConfig.POL</filename>) then it's contents are applied to the <filename>NTUser.DAT</filename> - which is applied to the <filename>HKEY_CURRENT_USER</filename> part of the registry. - </para> - </step> - - <step> - <para> - When the user logs out, if the profile is set to be a roaming profile it will be written - out to the location of the profile. The <filename>NTuser.DAT</filename> file is then - re-created from the contents of the <filename>HKEY_CURRENT_USER</filename> contents. - Thus, should there not exist in the NETLOGON share an <filename>NTConfig.POL</filename> at the - next logon, the effect of the previous <filename>NTConfig.POL</filename> will still be held - in the profile. The effect of this is known as <emphasis>tatooing</emphasis>. - </para> - </step> -</procedure> +<para> When a user logs onto an MS Windows NT4 machine that is a member of a Microsoft security domain, + the following steps are followed in respect of profile handling: -<para> -MS Windows NT4 profiles may be <emphasis>Local</emphasis> or <emphasis>Roaming</emphasis>. A Local profile -will stored in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> location. A roaming profile will -also remain stored in the same way, unless the following registry key is created: +<indexterm><primary>NTConfig.POL</primary></indexterm> </para> -<para> -<programlisting> -HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ -winlogon\"DeleteRoamingCache"=dword:00000001 -</programlisting> -In which case, the local copy (in <filename>%SystemRoot%\Profiles\%USERNAME%</filename>) will be -deleted on logout. -</para> - -<para> -Under MS Windows NT4 default locations for common resources (like <filename>My Documents</filename> -may be redirected to a network share by modifying the following registry keys. These changes may be affected -via use of the System Policy Editor (to do so may require that you create your owns template extension -for the policy editor to allow this to be done through the GUI. Another way to do this is by way of first -creating a default user profile, then while logged in as that user, run regedt32 to edit the key settings. -</para> - -<para> -The Registry Hive key that affects the behaviour of folders that are part of the default user profile -are controlled by entries on Windows NT4 is: -</para> - -<para> -<filename>HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders\</filename> -</para> - -<para> -The above hive key contains a list of automatically managed folders. The default entries are: -</para> +<procedure> + <step> <para> The users' account information that is obtained during the logon process + contains the location of the users' desktop profile. The profile path may be local to + the machine or it may be located on a network share. If there exists a profile at the + location of the path from the user account, then this profile is copied to the location + <filename>%SystemRoot%\Profiles\%USERNAME%</filename>. This profile then inherits the settings + in the <filename>All Users</filename> profile in the <filename>%SystemRoot%\Profiles</filename> + location. </para> </step> + + <step> <para> If the user account has a profile path, but at its location a profile does not + exist, then a new profile is created in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> + directory from reading the <filename>Default User</filename> profile. </para> </step> + + <step> <para> If the NETLOGON share on the authenticating server (logon server) contains + a policy file (<filename>NTConfig.POL</filename>), then its contents are applied to the + <filename>NTUser.DAT</filename> which is applied to the <filename>HKEY_CURRENT_USER</filename> + part of the registry. + </para> </step> + + <step> <para> When the user logs out, if the profile is set to be a roaming profile it will be + written out to the location of the profile. The <filename>NTuser.DAT</filename> file is then + recreated from the contents of the <filename>HKEY_CURRENT_USER</filename> contents. Thus, + should there not exist in the NETLOGON share an <filename>NTConfig.POL</filename> at the next + logon, the effect of the previous <filename>NTConfig.POL</filename> will still be held in the + profile. The effect of this is known as tattooing. + </para> </step> +</procedure> -<para> -<table frame="all"> - <title>User Shell Folder registry keys default values</title> +<para> MS Windows NT4 profiles may be <emphasis>local</emphasis> or <emphasis>roaming</emphasis>. A local +profile will stored in the <filename>%SystemRoot%\Profiles\%USERNAME%</filename> location. A roaming +profile will also remain stored in the same way, unless the following registry key is created as shown: </para> + +<para><screen> HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ +winlogon\"DeleteRoamingCache"=dword:0000000 + </screen> +In this case, the local copy (in <filename>%SystemRoot%\Profiles\%USERNAME%</filename>) will be deleted +on logout.</para> + +<para> Under MS Windows NT4, default locations for common resources like <filename>My Documents</filename> +may be redirected to a network share by modifying the following registry keys. These changes may be +affected via use of the System Policy Editor. To do so may require that you create your own template +extension for the policy editor to allow this to be done through the GUI. Another way to do this is by +way of first creating a default user profile, then while logged in as that user, run <command>regedt32</command> to edit +the key settings. </para> + +<para> +The Registry Hive key that affects the behavior of folders that are part of the default user +profile are controlled by entries on Windows NT4 is: +<screen> +HKEY_CURRENT_USER + \Software + \Microsoft + \Windows + \CurrentVersion + \Explorer + \User Shell Folders +</screen> +<indexterm><primary>windows registry settings</primary><secondary>default profile locations</secondary></indexterm> +</para> + +<para> The above hive key contains a list of automatically managed folders. The default entries are shown in <link linkend="ProfileLocs"/>. </para> + +<table frame="all" id="ProfileLocs"> + <title>User Shell Folder Registry Keys Default Values</title> <tgroup cols="2"> + <colspec align="left"/> + <colspec align="left"/> <thead> <row><entry>Name</entry><entry>Default Value</entry></row> </thead> @@ -948,22 +784,19 @@ The above hive key contains a list of automatically managed folders. The default </tbody> </tgroup> </table> -</para> -<para> -The registry key that contains the location of the default profile settings is: -</para> +<para> The registry key that contains the location of the default profile settings is: </para> -<para> -<filename>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders</filename> -</para> +<para> <filename>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\<?latex \linebreak ?> +User Shell Folders</filename> </para> -<para> -The default entries are: +<para> The default entries are shown in <link linkend="regkeys"/>.</para> -<table frame="all"> - <title>Defaults of profile settings registry keys</title> +<table frame="all" id="regkeys"> + <title>Defaults of Profile Settings Registry Keys</title> <tgroup cols="2"> + <colspec align="left"/> + <colspec align="left"/> <tbody> <row><entry>Common Desktop</entry><entry>%SystemRoot%\Profiles\All Users\Desktop</entry></row> <row><entry>Common Programs</entry><entry>%SystemRoot%\Profiles\All Users\Programs</entry></row> @@ -972,104 +805,78 @@ The default entries are: </tbody> </tgroup> </table> -</para> </sect2> -<sect2> -<title>MS Windows 200x/XP</title> +<sect2> <title>MS Windows 200x/XP</title> - <note> - <para> - MS Windows XP Home Edition does use default per user profiles, but can not participate - in domain security, can not log onto an NT/ADS style domain, and thus can obtain the profile - only from itself. While there are benefits in doing this the beauty of those MS Windows - clients that CAN participate in domain logon processes allows the administrator to create - a global default profile and to enforce it through the use of Group Policy Objects (GPOs). - </para> - </note> +<note><para> +<indexterm><primary>GPOs</primary></indexterm> +MS Windows XP Home Edition does use default per user profiles, but cannot participate +in domain security, cannot log onto an NT/ADS-style domain, and thus can obtain the profile only +from itself. While there are benefits in doing this, the beauty of those MS Windows clients that +can participate in domain logon processes allows the administrator to create a global default +profile and enforce it through the use of Group Policy Objects (GPOs). +</para></note> -<para> -When a new user first logs onto MS Windows 200x/XP machine the default profile is obtained from -<filename>C:\Documents and Settings\Default User</filename>. The administrator can modify (or change -the contents of this location and MS Windows 200x/XP will gladly use it. This is far from the optimum -arrangement since it will involve copying a new default profile to every MS Windows 200x/XP client -workstation. -</para> +<para> When a new user first logs onto an MS Windows 200x/XP machine, the default profile is obtained from +<filename>C:\Documents and Settings\Default User</filename>. The administrator can modify or change the +contents of this location and MS Windows 200x/XP will gladly use it. This is far from the optimum arrangement +since it will involve copying a new default profile to every MS Windows 200x/XP client workstation. </para> -<para> -When MS Windows 200x/XP participate in a domain security context, and if the default user -profile is not found, then the client will search for a default profile in the NETLOGON share -of the authenticating server. ie: In MS Windows parlance: -<filename>%LOGONSERVER%\NETLOGON\Default User</filename> and if one exits there it will copy this -to the workstation to the <filename>C:\Documents and Settings\</filename> under the Windows -login name of the user. -</para> +<para> When MS Windows 200x/XP participates in a domain security context, and if the default user profile is + not found, then the client will search for a default profile in the NETLOGON share of the authenticating + server. In MS Windows parlance,<?latex \linebreak ?><filename>%LOGONSERVER%\NETLOGON\Default User,</filename> and if one +exists there it will copy this to the workstation to the <filename>C:\Documents and Settings\</filename> +under the Windows login name of the user. </para> - <note> - <para> - This path translates, in Samba parlance, to the &smb.conf; <smbconfsection>[NETLOGON]</smbconfsection> share. The directory - should be created at the root of this share and must be called <filename>Default Profile</filename>. - </para> - </note> +<note> <para> This path translates, in Samba parlance, to the &smb.conf; +<smbconfsection>[NETLOGON]</smbconfsection> share. The directory should be created at the root +of this share and must be called <filename>Default Profile</filename>. </para> </note> -<para> -If a default profile does not exist in this location then MS Windows 200x/XP will use the local -default profile. -</para> +<para> If a default profile does not exist in this location, then MS Windows 200x/XP will use the local +default profile. </para> -<para> -On logging out, the users' desktop profile will be stored to the location specified in the registry -settings that pertain to the user. If no specific policies have been created, or passed to the client -during the login process (as Samba does automatically), then the user's profile will be written to -the local machine only under the path <filename>C:\Documents and Settings\%USERNAME%</filename>. -</para> +<para> On logging out, the users' desktop profile will be stored to the location specified in the registry +settings that pertain to the user. If no specific policies have been created or passed to the client +during the login process (as Samba does automatically), then the user's profile will be written to the +local machine only under the path <filename>C:\Documents and Settings\%USERNAME%</filename>. </para> -<para> -Those wishing to modify the default behaviour can do so through three methods: -</para> +<para> Those wishing to modify the default behavior can do so through these three methods: </para> <itemizedlist> - <listitem> - <para> - Modify the registry keys on the local machine manually and place the new default profile in the - NETLOGON share root - NOT recommended as it is maintenance intensive. - </para> - </listitem> + <listitem> <para> Modify the registry keys on the local machine manually and place the new + default profile in the NETLOGON share root. This is not recommended as it is maintenance intensive. + </para> </listitem> - <listitem> - <para> - Create an NT4 style NTConfig.POL file that specified this behaviour and locate this file - in the root of the NETLOGON share along with the new default profile. - </para> - </listitem> + <listitem> <para> Create an NT4-style NTConfig.POL file that specified this behavior and locate + this file in the root of the NETLOGON share along with the new default profile. </para> </listitem> - <listitem> - <para> - Create a GPO that enforces this through Active Directory, and place the new default profile - in the NETLOGON share. - </para> - </listitem> + <listitem> <para> Create a GPO that enforces this through Active Directory, and place the new + default profile in the NETLOGON share. </para> </listitem> </itemizedlist> -<para> -The Registry Hive key that affects the behaviour of folders that are part of the default user profile -are controlled by entries on Windows 200x/XP is: -</para> +<para>The registry hive key that effects the behavior of folders that are part of the default user +profile are controlled by entries on Windows 200x/XP is: </para> -<para> -<filename>HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders\</filename> -</para> +<para> <filename>HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell +Folders\</filename> </para> <para> -The above hive key contains a list of automatically managed folders. The default entries are: +The above hive key contains a list of automatically managed folders. The default entries are shown +in <link linkend="defregpthkeys"/> +<indexterm><primary>windows registry settings</primary><secondary>default profile locations</secondary></indexterm> </para> -<para> -<table frame="all"> - <title>Defaults of default user profile paths registry keys</title> + +<table frame="all" id="defregpthkeys"> + <title>Defaults of Default User Profile Paths Registry Keys</title> <tgroup cols="2"> - <thead><row><entry>Name</entry><entry>Default Value</entry></row></thead> + <colspec align="left"/> + <colspec align="left"/> + <thead> + <row><entry>Name</entry><entry>Default Value</entry></row> + </thead> <tbody> <row><entry>AppData</entry><entry>%USERPROFILE%\Application Data</entry></row> <row><entry>Cache</entry><entry>%USERPROFILE%\Local Settings\Temporary Internet Files</entry></row> @@ -1089,227 +896,171 @@ The above hive key contains a list of automatically managed folders. The default <row><entry>Start Menu</entry><entry>%USERPROFILE%\Start Menu</entry></row> <row><entry>Startup</entry><entry>%USERPROFILE%\Start Menu\Programs\Startup</entry></row> <row><entry>Templates</entry><entry>%USERPROFILE%\Templates</entry></row> - </tbody></tgroup></table> -</para> + </tbody> + </tgroup> +</table> -<para> -There is also an entry called "Default" that has no value set. The default entry is of type <constant>REG_SZ</constant>, all -the others are of type <constant>REG_EXPAND_SZ</constant>. -</para> +<para> There is also an entry called <quote>Default</quote> that has no value set. The default entry is +of type <constant>REG_SZ</constant>, all the others are of type <constant>REG_EXPAND_SZ</constant>. </para> -<para> -It makes a huge difference to the speed of handling roaming user profiles if all the folders are -stored on a dedicated location on a network server. This means that it will NOT be necessary to -write the Outlook PST file over the network for every login and logout. -</para> +<para> It makes a huge difference to the speed of handling roaming user profiles if all the folders are +stored on a dedicated location on a network server. This means that it will not be necessary to write +the Outlook PST file over the network for every login and logout. </para> -<para> -To set this to a network location you could use the following examples: -</para> +<para> To set this to a network location, you could use the following examples: </para> <para><filename>%LOGONSERVER%\%USERNAME%\Default Folders</filename></para> -<para> -This would store the folders in the user's home directory under a directory called <filename>Default Folders</filename> -You could also use: -</para> +<para> This would store the folders in the user's home directory under a directory called <filename>Default +Folders</filename>. You could also use: </para> <para><filename>\\<replaceable>SambaServer</replaceable>\<replaceable>FolderShare</replaceable>\%USERNAME%</filename></para> <para> - in which case the default folders will be stored in the server named <replaceable>SambaServer</replaceable> -in the share called <replaceable>FolderShare</replaceable> under a directory that has the name of the MS Windows -user as seen by the Linux/UNIX file system. -</para> +in which case the default folders will be stored in the server named <replaceable>SambaServer</replaceable> +in the share called <replaceable>FolderShare</replaceable> under a directory that has the name of the +MS Windows user as seen by the Linux/UNIX file system. </para> -<para> -Please note that once you have created a default profile share, you MUST migrate a user's profile -(default or custom) to it. -</para> +<para> Please note that once you have created a default profile share, you MUST migrate a user's profile +(default or custom) to it. </para> -<para> -MS Windows 200x/XP profiles may be <emphasis>Local</emphasis> or <emphasis>Roaming</emphasis>. -A roaming profile will be cached locally unless the following registry key is created: +<para> MS Windows 200x/XP profiles may be <emphasis>Local</emphasis> or <emphasis>Roaming</emphasis>. + A roaming profile will be cached locally unless the following registry key is created: + +<indexterm><primary>delete roaming profiles</primary></indexterm> </para> -<para> -<programlisting> -HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ + +<para> <programlisting> HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\ winlogon\"DeleteRoamingCache"=dword:00000001</programlisting></para> <para> -In which case, the local cache copy will be deleted on logout. -</para> -</sect2> +In this case, the local cache copy will be deleted on logout. +</para> +</sect2> </sect1> -<sect1> -<title>Common Errors</title> +<sect1> <title>Common Errors</title> <para> -The following are some typical errors/problems/questions that have been asked. +The following are some typical errors, problems and questions that have been asked on the Samba mailing lists. </para> <sect2> -<title>Setting up roaming profiles for just a few user's or group's?</title> +<title>Configuring Roaming Profiles for a Few Users or Groups</title> <para> -With samba-2.2.x the choice you have is to enable or disable roaming -profiles support. It is a global only setting. The default is to have -roaming profiles and the default path will locate them in the user's home -directory. +With Samba-2.2.x, the choice you have is to enable or disable roaming profiles support. It is a +global only setting. The default is to have roaming profiles and the default path will locate them in +the user's home directory. </para> <para> -If disabled globally then no-one will have roaming profile ability. -If enabled and you want it to apply only to certain machines, then on -those machines on which roaming profile support is NOT wanted it is then -necessary to disable roaming profile handling in the registry of each such -machine. +If disabled globally, then no one will have roaming profile ability. If enabled and you want it +to apply only to certain machines, then on those machines on which roaming profile support is not wanted +it is then necessary to disable roaming profile handling in the registry of each such machine. </para> <para> -With samba-3 you can have a global profile -setting in &smb.conf; _AND_ you can over-ride this by per-user settings -using the Domain User Manager (as with MS Windows NT4/ Win 2Kx). -</para> +With Samba-3, you can have a global profile setting in &smb.conf; and you can override this by +per-user settings using the Domain User Manager (as with MS Windows NT4/ Win 200xx). </para> -<para> -In any case, you can configure only one profile per user. That profile can -be either: -</para> +<para> In any case, you can configure only one profile per user. That profile can be either: </para> <itemizedlist> - <listitem><para>A profile unique to that user</para></listitem> - <listitem><para>A mandatory profile (one the user can not change)</para></listitem> - <listitem><para>A group profile (really should be mandatory ie:unchangable)</para></listitem> + <listitem>A profile unique to that user.</listitem> + <listitem>A mandatory profile (one the user cannot change).</listitem> + <listitem>A group profile (really should be mandatory, that is unchangable).</listitem> </itemizedlist> </sect2> -<sect2> -<title>Can NOT use Roaming Profiles</title> +<sect2> <title>Cannot Use Roaming Profiles</title> -<para> -A user requested the following: -<quote> -I do not want Roaming profiles to be implemented. I want to give users a local profile alone. ... -Please help me I am totally lost with this error. For the past two days I tried everything, I googled -around but found no useful pointers. Please help me. -</quote></para> +<para> A user requested the following: <quote> I do not want Roaming profiles to be implemented. I want +to give users a local profile alone. Please help me, I am totally lost with this error. For the past +two days I tried everything, I googled around but found no useful pointers. Please help me. </quote></para> -<para> -The choices are: -</para> +<para> The choices are: </para> <variablelist> <varlistentry> - <term>Local profiles:</term> - <listitem><para> - I know of no registry keys that will allow auto-deletion of LOCAL profiles on log out - </para></listitem> + <term>Local profiles</term> <listitem><para> I know of no registry keys that will allow + auto-deletion of LOCAL profiles on log out.</para></listitem> </varlistentry> - + <varlistentry> - <term>Roaming profiles:</term> - <listitem><para> - As a user logs onto the network a centrally stored profile is copied to the workstation - to form a local profile. This local profile will persist (remain on the workstation disk) - unless a registry key is changed that will cause this profile to be automatically deleted - on logout. - </para></listitem> + <term>Roaming profiles</term> <listitem><para> As a user logs onto the network, a centrally + stored profile is copied to the workstation to form a local profile. This local profile + will persist (remain on the workstation disk) unless a registry key is changed that will + cause this profile to be automatically deleted on logout. </para></listitem> </varlistentry> </variablelist> -<para> -The <emphasis>Roaming Profile</emphasis> choices are: -</para> +<para>The roaming profile choices are: </para> <variablelist> <varlistentry> - <term>Personal Roaming profiles</term> - <listitem><para> - These are typically stored in a profile share on a central (or conveniently located - local) server. - </para> + <term>Personal roaming profiles</term> <listitem><para> These are typically stored in + a profile share on a central (or conveniently located local) server. </para> - <para> - Workstations 'cache' (store) a local copy of the profile. This cached copy is used when - the profile can not be downloaded at next logon. - </para></listitem> + <para> Workstations cache (store) a local copy of the profile. This cached + copy is used when the profile cannot be downloaded at next logon. </para></listitem> </varlistentry> <varlistentry> - <term>Group profiles</term> - <listitem><para>These are loaded from a central profile server</para></listitem> + <term>Group profiles</term> <listitem><para>These are loaded from a central profile + server.</para></listitem> </varlistentry> <varlistentry> - <term>Mandatory profiles</term> - <listitem><para> - Mandatory profiles can be created for a user as well as for any group that a user - is a member of. Mandatory profiles can NOT be changed by ordinary users. Only the administrator - can change or reconfigure a mandatory profile. - </para></listitem> + <term>Mandatory profiles</term> <listitem><para> Mandatory profiles can be created for + a user as well as for any group that a user is a member of. Mandatory profiles cannot be + changed by ordinary users. Only the administrator can change or reconfigure a mandatory + profile. </para></listitem> </varlistentry> </variablelist> -<para> -A WinNT4/2K/XP profile can vary in size from 130KB to off the scale. -Outlook PST files are most often part of the profile and can be many GB in -size. On average (in a well controlled environment) roaming profile size of -2MB is a good rule of thumb to use for planning purposes. In an -undisciplined environment I have seen up to 2GB profiles. Users tend to -complain when it take an hour to log onto a workstation but they harvest -the fruits of folly (and ignorance). -</para> +<para> A Windows NT4/200x/XP profile can vary in size from 130KB to very large. Outlook PST files are +most often part of the profile and can be many GB in size. On average (in a well controlled environment), +roaming profile size of 2MB is a good rule of thumb to use for planning purposes. In an undisciplined +environment, I have seen up to 2GB profiles. Users tend to complain when it takes an hour to log onto a +workstation but they harvest the fruits of folly (and ignorance). </para> -<para> -The point of all the above is to show that roaming profiles and good -controls of how they can be changed as well as good discipline make up for -a problem free site. -</para> +<para> The point of all the above is to show that roaming profiles and good controls of how they can be +changed as well as good discipline make up for a problem-free site. </para> -<para> -Microsoft's answer to the PST problem is to store all email in an MS -Exchange Server back-end. This removes the need for a PST file. -</para> +<para> Microsoft's answer to the PST problem is to store all email in an MS Exchange Server backend. This +removes the need for a PST file. </para> -<para> -LOCAL profiles mean: -</para> +<para>Local profiles mean: </para> <itemizedlist> - <listitem><para>If each machine is used my many users then much local disk storage is needed for local profiles</para></listitem> - <listitem><para>Every workstation the user logs into has it's own profile, these can be very different from machine to machine</para></listitem> + <listitem><para>If each machine is used by many users, then much local disk storage is needed + for local profiles.</para></listitem> <listitem><para>Every workstation the user logs into has + its own profile; these can be very different from machine to machine.</para></listitem> </itemizedlist> -<para> -On the other hand, use of roaming profiles means: -</para> +<para> On the other hand, use of roaming profiles means: </para> <itemizedlist> <listitem><para>The network administrator can control the desktop environment of all users.</para></listitem> - <listitem><para>Use of mandatory profiles drasitcally reduces network management overheads.</para></listitem> - <listitem><para>In the long run users will be experience fewer problems.</para></listitem> + <listitem><para>Use of mandatory profiles drastically reduces network management overheads.</para></listitem> + <listitem><para>In the long run, users will experience fewer problems.</para></listitem> </itemizedlist> </sect2> <sect2> -<title>Changing the default profile</title> +<title>Changing the Default Profile</title> -<para> -<emphasis>Question:</emphasis> -<quote> -When the client logs onto the domain controller it searches for a profile to download, -where do I put this default profile? -</quote></para> +<para><quote>When the client logs onto the Domain Controller, it searches +for a profile to download. Where do I put this default profile?</quote></para> <para> -Firstly, the samba server needs to be configured as a domain controller. -This can be done by setting in &smb.conf;: -</para> +<indexterm><primary>default profile</primary></indexterm> +First, the Samba server needs to be configured as a Domain Controller. This can be done by +setting in &smb.conf;: </para> <smbconfblock> <smbconfoption><name>security</name><value>user</value></smbconfoption> @@ -1317,39 +1068,28 @@ This can be done by setting in &smb.conf;: <smbconfoption><name>domain logons</name><value>Yes</value></smbconfoption> </smbconfblock> -<para> -There must be an <smbconfsection>[netlogon]</smbconfsection> share that is world readable. -It is a good idea to add a logon script to pre-set printer and -drive connections. There is also a facility for automatically -synchronizing the workstation time clock with that of the logon -server (another good thing to do). -</para> +<para> There must be a <smbconfsection>[netlogon]</smbconfsection> share that is world readable. It is +a good idea to add a logon script to pre-set printer and drive connections. There is also a facility +for automatically synchronizing the workstation time clock with that of the logon server (another good +thing to do). </para> -<note><para> -To invoke auto-deletion of roaming profile from the local -workstation cache (disk storage) use the <application>Group Policy Editor</application> -to create a file called <filename>NTConfig.POL</filename> with the appropriate entries. This -file needs to be located in the <smbconfsection>netlogon</smbconfsection> share root directory.</para></note> +<note><para> To invoke auto-deletion of roaming profile from the local workstation cache (disk storage), use +the <application>Group Policy Editor</application> to create a file called <filename>NTConfig.POL</filename> +with the appropriate entries. This file needs to be located in the <smbconfsection>netlogon</smbconfsection> +share root directory.</para></note> -<para> -Windows clients need to be members of the domain. Workgroup machines do NOT use network logons so -they do not interoperate with domain profiles. -</para> +<para> Windows clients need to be members of the domain. Workgroup machines do not use network logons +so they do not interoperate with domain profiles. </para> -<para> -For roaming profiles add to &smb.conf;: -</para> +<para> For roaming profiles, add to &smb.conf;: </para> -<para> <smbconfblock> <smbconfoption><name>logon path</name><value>\\%N\profiles\%U</value></smbconfoption> <smbconfcomment>Default logon drive is Z:</smbconfcomment> <smbconfoption><name>logon drive</name><value>H:</value></smbconfoption> <smbconfcomment>This requires a PROFILES share that is world writable.</smbconfcomment> </smbconfblock> -</para> </sect2> </sect1> - </chapter> diff --git a/docs/docbook/projdoc/SWAT.xml b/docs/docbook/projdoc/SWAT.xml index 90994f65e0..346fe86948 100644 --- a/docs/docbook/projdoc/SWAT.xml +++ b/docs/docbook/projdoc/SWAT.xml @@ -4,15 +4,15 @@ <pubdate>April 21, 2003</pubdate> </chapterinfo> -<title>SWAT - The Samba Web Administration Tool</title> +<title>SWAT &smbmdash; The Samba Web Administration Tool</title> <para> -There are many and varied opinions regarding the usefulness or otherwise of SWAT. -No matter how hard one tries to produce the perfect configuration tool it remains -an object of personal taste. SWAT is a tool that will allow web based configuration -of samba. It has a wizard that may help to get samba configured quickly, it has context -sensitive help on each smb.conf parameter, it provides for monitoring of current state -of connection information, and it allows network wide MS Windows network password +There are many and varied opinions regarding the usefulness of SWAT. +No matter how hard one tries to produce the perfect configuration tool, it remains +an object of personal taste. SWAT is a tool that will allow Web-based configuration +of Samba. It has a wizard that may help to get Samba configured +quickly, it has context-sensitive help on each &smb.conf; parameter, it provides for monitoring of current state +of connection information, and it allows network-wide MS Windows network password management. </para> @@ -20,41 +20,225 @@ management. <title>Features and Benefits</title> <para> +SWAT is a facility that is part of the Samba suite. The main executable is called +<command>swat</command> and is invoked by the inter-networking super daemon. +See <link linkend="xinetd"/> for details. +</para> + +<para> +SWAT uses integral samba components to locate parameters supported by the particular +version of Samba. Unlike tools and utilities that are external to Samba, SWAT is always +up to date as known Samba parameters change. SWAT provides context-sensitive help for each +configuration parameter, directly from <command>man</command> page entries. +</para> + +<para> There are network administrators who believe that it is a good idea to write systems -documentation inside configuration files, for them SWAT will aways be a nasty tool. SWAT +documentation inside configuration files, and for them SWAT will aways be a nasty tool. SWAT does not store the configuration file in any intermediate form, rather, it stores only the -parameter settings, so when SWAT writes the smb.conf file to disk it will write only -those parameters that are at other than the default settings. The result is that all comments -will be lost from the &smb.conf; file. Additionally, the parameters will be written back in -internal ordering. +parameter settings, so when SWAT writes the &smb.conf; file to disk, it will write only +those parameters that are at other than the default settings. The result is that all comments, +as well as parameters that are no longer supported, will be lost from the &smb.conf; file. +Additionally, the parameters will be written back in internal ordering. </para> <note><para> -So before using SWAT please be warned - SWAT will completely replace your smb.conf with -a fully optimised file that has been stripped of all comments you might have placed there +Before using SWAT, please be warned &smbmdash; SWAT will completely replace your &smb.conf; with +a fully-optimized file that has been stripped of all comments you might have placed there and only non-default settings will be written to the file. </para></note> +</sect1> + +<sect1> +<title>Guidelines and Technical Tips</title> + +<para> +This section aims to unlock the dark secrets behind how SWAT may be made to work, +may be made more secure, and how to solve Internationalization support problems. +</para> + <sect2> -<title>Enabling SWAT for use</title> +<title>Validate SWAT Installation</title> + +<para> +The very first step that should be taken before attempting to configure a host +system for SWAT operation is to check that it is installed. This may seem a trivial +point to some, however several Linux distributions do not install SWAT by default, +even though they do ship an installable binary support package containing SWAT +on the distribution media. +</para> + +<para> +When you have configrmed that SWAT is installed it is necessary to validate +that the installation includes the binary <command>swat</command> file as well +as all the supporting text and Web files. A number of operating system distributions +in the past have failed to include the necessary support files, evne though the +<command>swat</command> binary executable file was installed. +</para> + +<para> +Finally, when you are sure that SWAT has been fully installed, please check the SWAT +has been enebled in the control file for the internetworking super-daemon (inetd or xinetd) +that is used on your operating system platform. +</para> + +<sect3> +<title>Locating the <command>swat</command> File</title> + +<para> +To validate that SWAT is installed, first locate the <command>swat</command> binary +file on the system. It may be found under the following directories: +<simplelist> + <member><filename>/usr/local/samba/bin</filename> &smbmdash; the default Samba location.</member> + <member><filename>/usr/sbin</filename> &smbmdash; the default location on most Linux systems.</member> + <member><filename>/opt/samba/bin</filename></member> +</simplelist> +</para> <para> -SWAT should be installed to run via the network super daemon. Depending on which system -your UNIX/Linux system has you will have either an <command>inetd</command> or -<command>xinetd</command> based system. +The actual location is much dependant on the choice of the operating system vendor, or as determined +by the administrator who compiled and installed Samba. +</para> + +<para> +There are a number methods that may be used to locate the <command>swat</command> binary file. +The following methods may be helpful: +</para> + +<para> +If <command>swat</command> is in your current operating system search path it will be easy to +find it. You can ask what are the command-line options for <command>swat</command> as shown here: +<screen> +frodo:~ # swat -? +Usage: swat [OPTION...] + -a, --disable-authentication Disable authentication (demo mode) + +Help options: + -?, --help Show this help message + --usage Display brief usage message + +Common samba options: + -d, --debuglevel=DEBUGLEVEL Set debug level + -s, --configfile=CONFIGFILE Use alternative configuration file + -l, --log-basename=LOGFILEBASE Basename for log/debug files + -V, --version Print version +</screen> +</para> + +</sect3> + +<sect3> +<title>Locating the SWAT Support Files</title> + +<para> +Now that you have found that <command>swat</command> is in the search path, it is easy +to identify where the file is located. Here is another simple way this may be done: +<screen> +frodo:~ # whereis swat +swat: /usr/sbin/swat /usr/share/man/man8/swat.8.gz +</screen> +</para> + +<para> +If the above measures fail to locate the <command>swat</command> binary, another approach +is needed. The following may be used: +<screen> +frodo:/ # find / -name swat -print +/etc/xinetd.d/swat +/usr/sbin/swat +/usr/share/samba/swat +frodo:/ # +</screen> +</para> + +<para> +This list shows that there is a control file for <command>xinetd</command>, the internetwork +super-daemon that is installed on this server. The location of the SWAT binary file is +<filename>/usr/sbin/swat</filename>, and the support files for it are located under the +directory <filename>/usr/share/samba/swat</filename>. +</para> + +<para> +We must now check where <command>swat</command> expects to find its support files. This can +be done as follows: +<screen> +frodo:/ # strings /usr/sbin/swat | grep "/swat" +/swat/ +... +/usr/share/samba/swat +frodo:/ # +</screen> +</para> + +<para> +The <filename>/usr/share/samba/swat/</filename> entry shown in this listing is the location of the +support files. You should verify that the support files exist under this directory. A sample +list is as shown: +<screen> +jht@frodo:/> find /usr/share/samba/swat -print +/usr/share/samba/swat +/usr/share/samba/swat/help +/usr/share/samba/swat/lang +/usr/share/samba/swat/lang/ja +/usr/share/samba/swat/lang/ja/help +/usr/share/samba/swat/lang/ja/help/welcome.html +/usr/share/samba/swat/lang/ja/images +/usr/share/samba/swat/lang/ja/images/home.gif +... +/usr/share/samba/swat/lang/ja/include +/usr/share/samba/swat/lang/ja/include/header.nocss.html +... +/usr/share/samba/swat/lang/tr +/usr/share/samba/swat/lang/tr/help +/usr/share/samba/swat/lang/tr/help/welcome.html +/usr/share/samba/swat/lang/tr/images +/usr/share/samba/swat/lang/tr/images/home.gif +... +/usr/share/samba/swat/lang/tr/include +/usr/share/samba/swat/lang/tr/include/header.html +/usr/share/samba/swat/using_samba +... +/usr/share/samba/swat/images +/usr/share/samba/swat/images/home.gif +... +/usr/share/samba/swat/include +/usr/share/samba/swat/include/footer.html +/usr/share/samba/swat/include/header.html +jht@frodo:/> +</screen> +</para> + +<para> +If the files needed are not available it will be necessary to obtain and install them +before SWAT can be used. +</para> + +</sect3> +</sect2> + +<sect2 id="xinetd"> +<title>Enabling SWAT for Use</title> + +<para> +SWAT should be installed to run via the network super-daemon. Depending on which system +your UNIX/Linux system has, you will have either an <command>inetd</command>- or +<command>xinetd</command>-based system. </para> <para> The nature and location of the network super-daemon varies with the operating system implementation. The control file (or files) can be located in the file -<filename>/etc/inetd.conf</filename> or in the directory <filename>/etc/[x]inet.d</filename> +<filename>/etc/inetd.conf</filename> or in the directory <filename>/etc/[x]inet[d].d</filename> or similar. </para> <para> The control entry for the older style file might be: +<indexterm><primary>swat</primary><secondary>enable</secondary></indexterm> </para> + <para><programlisting> # swat is the Samba Web Administration Tool swat stream tcp nowait.400 root /usr/sbin/swat swat @@ -66,36 +250,36 @@ A control file for the newer style xinetd could be: <para> <programlisting> - # default: off - # description: SWAT is the Samba Web Admin Tool. Use swat \ - # to configure your Samba server. To use SWAT, \ - # connect to port 901 with your favorite web browser. - service swat - { - port = 901 - socket_type = stream - wait = no - only_from = localhost - user = root - server = /usr/sbin/swat - log_on_failure += USERID - disable = yes - } +# default: off +# description: SWAT is the Samba Web Admin Tool. Use swat \ +# to configure your Samba server. To use SWAT, \ +# connect to port 901 with your favorite web browser. +service swat +{ + port = 901 + socket_type = stream + wait = no + only_from = localhost + user = root + server = /usr/sbin/swat + log_on_failure += USERID + disable = yes +} </programlisting> </para> <para> -Both the above examples assume that the <command>swat</command> binary has been -located in the <filename>/usr/sbin</filename> directory. In addition to the above -SWAT will use a directory access point from which it will load it's help files +Both of the above examples assume that the <command>swat</command> binary has been +located in the <filename>/usr/sbin</filename> directory. In addition to the above, +SWAT will use a directory access point from which it will load its Help files as well as other control information. The default location for this on most Linux systems is in the directory <filename>/usr/share/samba/swat</filename>. The default -location using samba defaults will be <filename>/usr/local/samba/swat</filename>. +location using Samba defaults will be <filename>/usr/local/samba/swat</filename>. </para> <para> -Access to SWAT will prompt for a logon. If you log onto SWAT as any non-root user +Access to SWAT will prompt for a logon. If you log onto SWAT as any non-root user, the only permission allowed is to view certain aspects of configuration as well as access to the password change facility. The buttons that will be exposed to the non-root user are: <guibutton>HOME</guibutton>, <guibutton>STATUS</guibutton>, <guibutton>VIEW</guibutton>, @@ -104,8 +288,8 @@ change capability in this case is <guibutton>PASSWORD</guibutton>. </para> <para> -So long as you log onto SWAT as the user <emphasis>root</emphasis> you should obtain -full change and commit ability. The buttons that will be exposed includes: +As long as you log onto SWAT as the user <emphasis>root</emphasis>, you should obtain +full change and commit ability. The buttons that will be exposed include: <guibutton>HOME</guibutton>, <guibutton>GLOBALS</guibutton>, <guibutton>SHARES</guibutton>, <guibutton>PRINTERS</guibutton>, <guibutton>WIZARD</guibutton>, <guibutton>STATUS</guibutton>, <guibutton>VIEW</guibutton>, <guibutton>PASSWORD</guibutton>. </para> @@ -115,22 +299,24 @@ full change and commit ability. The buttons that will be exposed includes: <sect2> <title>Securing SWAT through SSL</title> + <para> -Lots of people have asked about how to setup SWAT with SSL to allow for secure remote -administration of Samba. Here is a method that works, courtesy of Markus Krieger +<indexterm><primary>swat</primary><secondary>security</secondary></indexterm> +Many people have asked about how to setup SWAT with SSL to allow for secure remote +administration of Samba. Here is a method that works, courtesy of Markus Krieger. </para> <para> -Modifications to the swat setup are as following: +Modifications to the SWAT setup are as follows: </para> <procedure> <step><para> - install OpenSSL + Install OpenSSL. </para></step> <step><para> - generate certificate and private key + Generate certificate and private key. <screen> &rootprompt;<userinput>/usr/bin/openssl req -new -x509 -days 365 -nodes -config \ @@ -139,11 +325,11 @@ Modifications to the swat setup are as following: </screen></para></step> <step><para> - remove swat-entry from [x]inetd + Remove swat-entry from [x]inetd. </para></step> <step><para> - start stunnel + Start <command>stunnel</command>. <screen> &rootprompt;<userinput>stunnel -p /etc/stunnel/stunnel.pem -d 901 \ @@ -152,33 +338,100 @@ Modifications to the swat setup are as following: </procedure> <para> -afterwords simply contact to swat by using the URL <ulink noescape="1" url="https://myhost:901">https://myhost:901</ulink>, accept the certificate +Afterward, simply connect to swat by using the URL <ulink noescape="1" url="https://myhost:901">https://myhost:901</ulink>, accept the certificate and the SSL connection is up. </para> </sect2> <sect2> +<title>Enabling SWAT Internationalization Support</title> + +<para> +SWAT can be configured to display its messages to match the settings of +the language configurations of your Web browser. It will be passed to SWAT +in the Accept-Language header of the HTTP request. +<para> + +<para> +To enable this feature: +</para> + +<itemizedlist> + <listitem><para> + Install the proper <command>msg</command> files from the Samba + <filename>source/po</filename> directory into $LIBDIR. + </para></listitem> + + <listitem><para> + Set the correct locale value for <smbconfoption><name>display charset</name></smbconfoption>. + </para></listitem> + + <listitem><para> + Set your browser's language setting. + </para></listitem> +</itemizedlist> + +<para> +The name of msg file is same as the language ID sent by the browser. For +example en means "English", ja means "Japanese", fr means "French. +</para> + +<para> +If you do not like some of messages, or there are no <command>msg</command> files for +your locale, you can create them simply by copying the <command>en.msg</command> files +to the dirertory for <quote>your language ID.msg</quote> and filling in proper strings +to each <quote>msgstr</quote>. For example, in <filename>it.msg</filename>, the +<command>msg</command> file for the Italian locale, just set: +<screen> +msgid "Set Default" +msgstr "Imposta Default" +</screen> +and so on. If you find a mistake or create a new <command>msg</command> file, please email it +to us so we will include this in the next release of Samba. +</para> + +</para> +Note that if you enable this feature and the <smbconfoption><name>display charset</name></smbconfoption> is not +matched to your browser's setting, the SWAT display may be corrupted. In a future version of +Samba, SWAT will always display messages with UTF-8 encoding. You will then not need to set +this &smb.conf; file parameter. +</para> + +</sect2> + +</sect1> + +<sect1> +<title>Overview and Quick Tour</title> + +<para> +SWAT is a tools that many be used to configure Samba, or just to obtain useful links +to important reference materials such as the contents of this book, as well as other +documents that have been found useful for solving Windows networking problems. +</para> + +<sect2> <title>The SWAT Home Page</title> <para> The SWAT title page provides access to the latest Samba documentation. The manual page for -each samba component is accessible from this page as are the Samba-HOWTO-Collection (this -document) as well as the O'Reilly book "Using Samba". +each Samba component is accessible from this page, as are the Samba HOWTO-Collection (this +document) as well as the O'Reilly book <quote>Using Samba.</quote> </para> <para> -Administrators who wish to validate their samba configuration may obtain useful information +Administrators who wish to validate their Samba configuration may obtain useful information from the man pages for the diagnostic utilities. These are available from the SWAT home page -also. One diagnostic tool that is NOT mentioned on this page, but that is particularly -useful is <ulink url="http://www.ethereal.com/"><command>ethereal</command></ulink>. +also. One diagnostic tool that is not mentioned on this page, but that is particularly +useful is <ulink url="http://www.ethereal.com/"><command>ethereal</command>.</ulink> </para> <warning><para> -SWAT can be configured to run in <emphasis>demo</emphasis> mode. This is NOT recommended -as it runs SWAT without authentication and with full administrative ability. ie: Allows -changes to smb.conf as well as general operation with root privileges. The option that -creates this ability is the <option>-a</option> flag to swat. <emphasis>Do not use this in any +SWAT can be configured to run in <emphasis>demo</emphasis> mode. This is not recommended +as it runs SWAT without authentication and with full administrative ability. Allows +changes to &smb.conf; as well as general operation with root privileges. The option that +creates this ability is the <option>-a</option> flag to swat. <emphasis>Do not use this in a production environment.</emphasis> </para></warning> @@ -188,40 +441,36 @@ production environment.</emphasis> <title>Global Settings</title> <para> -The Globals button will expose a page that allows configuration of the global parameters -in smb.conf. There are three levels of exposure of the parameters: +The <guibutton>GLOBALS</guibutton> button will expose a page that allows configuration of the global parameters +in &smb.conf;. There are two levels of exposure of the parameters: </para> <itemizedlist> <listitem><para> - <emphasis>Basic</emphasis> - exposes common configuration options. + <guibutton>Basic</guibutton> &smbmdash; exposes common configuration options. </para></listitem> <listitem><para> - <emphasis>Advanced</emphasis> - exposes configuration options needed in more + <guibutton>Advanced</guibutton> &smbmdash; exposes configuration options needed in more complex environments. </para></listitem> - - <listitem><para> - <emphasis>Developer</emphasis> - exposes configuration options that only the brave - will want to tamper with. - </para></listitem> </itemizedlist> <para> -To switch to other than <emphasis>Basic</emphasis> editing ability click on either the -<emphasis>Advanced</emphasis> or the <emphasis>Developer</emphasis> button. You may also -do this by clicking on the radio button, then click the <guibutton>Commit Changes</guibutton> button. +To switch to other than <guibutton>Basic</guibutton> editing ability, click on <guibutton>Advanced</guibutton>. +You may also do this by clicking on the radio button, then click on the <guibutton>Commit Changes</guibutton> button. </para> <para> -After making any changes to configuration parameters make sure that you click on the -<guibutton>Commit Changes</guibutton> button before moving to another area otherwise -your changes will be immediately lost. +After making any changes to configuration parameters, make sure that +you click on the +<guibutton>Commit Changes</guibutton> button before moving to another area, otherwise +your changes will be lost. </para> <note><para> -SWAT has context sensitive help. To find out what each parameter is for simply click the +SWAT has context-sensitive help. To find out what each parameter is +for, simply click on the <guibutton>Help</guibutton> link to the left of the configuration parameter. </para></note> @@ -231,15 +480,16 @@ SWAT has context sensitive help. To find out what each parameter is for simply c <title>Share Settings</title> <para> -To affect a currently configured share, simply click on the pull down button between the +To effect a currently configured share, simply click on the pull down button between the <guibutton>Choose Share</guibutton> and the <guibutton>Delete Share</guibutton> buttons, -select the share you wish to operate on, then to edit the settings click on the -<guibutton>Choose Share</guibutton> button, to delete the share simply press the +select the share you wish to operate on, then to edit the settings +click on the +<guibutton>Choose Share</guibutton> button. To delete the share, simply press the <guibutton>Delete Share</guibutton> button. </para> <para> -To create a new share, next to the button labelled <guibutton>Create Share</guibutton> enter +To create a new share, next to the button labeled <guibutton>Create Share</guibutton> enter into the text field the name of the share to be created, then click on the <guibutton>Create Share</guibutton> button. </para> @@ -252,13 +502,14 @@ into the text field the name of the share to be created, then click on the <para> To affect a currently configured printer, simply click on the pull down button between the <guibutton>Choose Printer</guibutton> and the <guibutton>Delete Printer</guibutton> buttons, -select the printer you wish to operate on, then to edit the settings click on the -<guibutton>Choose Printer</guibutton> button, to delete the share simply press the +select the printer you wish to operate on, then to edit the settings +click on the +<guibutton>Choose Printer</guibutton> button. To delete the share, simply press the <guibutton>Delete Printer</guibutton> button. </para> <para> -To create a new printer, next to the button labelled <guibutton>Create Printer</guibutton> enter +To create a new printer, next to the button labeled <guibutton>Create Printer</guibutton> enter into the text field the name of the share to be created, then click on the <guibutton>Create Printer</guibutton> button. </para> @@ -269,15 +520,15 @@ into the text field the name of the share to be created, then click on the <title>The SWAT Wizard</title> <para> -The purpose if the SWAT Wizard is to help the Microsoft knowledgeable network administrator +The purpose if the SWAT Wizard is to help the Microsoft-knowledgeable network administrator to configure Samba with a minimum of effort. </para> <para> -The Wizard page provides a tool for rewriting the smb.conf file in fully optimised format. -This will also happen if you press the commit button. The two differ in the the rewrite button -ignores any changes that may have been made, while the Commit button causes all changes to be -affected. +The Wizard page provides a tool for rewriting the &smb.conf; file in fully optimized format. +This will also happen if you press the <guibutton>Commit</guibutton> button. The two differ +since the <guibutton>Rewrite</guibutton> button ignores any changes that may have been made, +while the <guibutton>Commit</guibutton> button causes all changes to be affected. </para> <para> @@ -288,7 +539,7 @@ options that may be necessary to create a working Samba server. <para> Finally, there are a limited set of options that will determine what type of server Samba will be configured for, whether it will be a WINS server, participate as a WINS client, or -operate with no WINS support. By clicking on one button you can elect to expose (or not) user +operate with no WINS support. By clicking one button, you can elect to expose (or not) user home directories. </para> @@ -298,13 +549,13 @@ home directories. <title>The Status Page</title> <para> -The status page serves a limited purpose. Firstly, it allows control of the samba daemons. -The key daemons that create the samba server environment are: &smbd;, &nmbd;, &winbindd;. +The status page serves a limited purpose. First, it allows control of the Samba daemons. +The key daemons that create the Samba server environment are: &smbd;, &nmbd;, &winbindd;. </para> <para> The daemons may be controlled individually or as a total group. Additionally, you may set -an automatic screen refresh timing. As MS Windows clients interact with Samba new smbd processes +an automatic screen refresh timing. As MS Windows clients interact with Samba, new smbd processes will be continually spawned. The auto-refresh facility will allow you to track the changing conditions with minimal effort. </para> @@ -320,7 +571,7 @@ free files that may be locked. <title>The View Page</title> <para> -This page allows the administrator to view the optimised &smb.conf; file and, if you are +This page allows the administrator to view the optimized &smb.conf; file and, if you are particularly masochistic, will permit you also to see all possible global configuration parameters and their settings. </para> @@ -331,14 +582,14 @@ parameters and their settings. <title>The Password Change Page</title> <para> -The Password Change page is a popular tool. This tool allows the creation, deletion, deactivation -and reactivation of MS Windows networking users on the local machine. Alternatively, you can use +The Password Change page is a popular tool that allows the creation, deletion, deactivation, +and reactivation of MS Windows networking users on the local machine. Alternately, you can use this tool to change a local password for a user account. </para> <para> -When logged in as a non-root account the user will have to provide the old password as well as -the new password (twice). When logged in as <emphasis>root</emphasis> only the new password is +When logged in as a non-root account, the user will have to provide the old password as well as +the new password (twice). When logged in as <emphasis>root</emphasis>, only the new password is required. </para> diff --git a/docs/docbook/projdoc/Samba-BDC-HOWTO.xml b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml index 9800c508d5..acdf284366 100644 --- a/docs/docbook/projdoc/Samba-BDC-HOWTO.xml +++ b/docs/docbook/projdoc/Samba-BDC-HOWTO.xml @@ -3,121 +3,123 @@ <chapterinfo> &author.jht; &author.vl; + <author>&person.gd;<contrib>LDAP updates</contrib></author> </chapterinfo> <title>Backup Domain Control</title> <para> -Before you continue reading in this section, please make sure that you are comfortable -with configuring a Samba Domain Controller as described in <link linkend="samba-pdc">chapter on setting up Samba as a PDC</link>. +Before you continue reading this section, please make sure that you are comfortable +with configuring a Samba Domain Controller as described in <link linkend="samba-pdc"/>. </para> <sect1> -<title>Features And Benefits</title> +<title>Features and Benefits</title> <para> -This is one of the most difficult chapters to summarise. It does not matter what we say here -for someone will still draw conclusions and / or approach the Samba-Team with expectations +This is one of the most difficult chapters to summarize. It does not matter what we say here +for someone will still draw conclusions and/or approach the Samba Team with expectations that are either not yet capable of being delivered, or that can be achieved far more effectively using a totally different approach. In the event that you should have a persistent -concern that is not addressed in this book then please email -<ulink url="mailto:jht@samba.org">John H Terpstra</ulink> clearly setting out your requirements -and / or question and we will do our best to provide a solution. +concern that is not addressed in this book, please email <ulink url="mailto:jht@samba.org">John H. Terpstra</ulink> +clearly setting out your requirements and/or question and we will do our best to provide a solution. </para> <para> -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 LDAP backend can be +<indexterm><primary>SAM backend</primary><secondary>LDAP</secondary></indexterm> +Samba-3 is capable of acting as a Backup Domain Controller (BDC) to another Samba Primary Domain +Controller (PDC). A Samba-3 PDC can operate with an LDAP Account backend. The LDAP backend can be either a common master LDAP server, or a slave server. The use of a slave LDAP server has the -benefit that when the master is down clients may still be able to log onto the network. -This effectively gives samba a high degree of scalability iand is a very sweet (nice) solution -for large organisations. +benefit that when the master is down, clients may still be able to log onto the network. +This effectively gives Samba a high degree of scalability and is an effective solution +for large organizations. Do not use an LDAP slave server for a PDC, this may cause serious +stability and operational problems. </para> <para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> 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. +need to figure out precisely what is the best way to replicate (copy/distribute) the +user and machine accounts' backend. </para> <para> -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 +<indexterm><primary>SAM backend</primary><secondary>non-LDAP</secondary></indexterm> +The use of a non-LDAP backend SAM database is particularly problematic because Domain Member +servers and workstations periodically change the Machine Trust Account password. The new password is then stored only locally. This means that in the absence of a centrally stored -accounts database (such as that provided with an LDAP based solution) if Samba-3 is running -as a BDC, the BDC instance of the Domain member trust account password will not reach the -PDC (master) copy of the SAM. If the PDC SAM is then replicated to BDCs this results in -overwriting of the SAM that contains the updated (changed) trust account password with resulting +accounts database (such as that provided with an LDAP-based solution) if Samba-3 is running +as a BDC, the BDC instance of the Domain Member trust account password will not reach the +PDC (master) copy of the SAM. If the PDC SAM is then replicated to BDCs, this results in +overwriting the SAM that contains the updated (changed) trust account password with resulting breakage of the domain trust. </para> <para> -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: -</para> - -<itemizedlist> -<title>Backup Domain Backend Account Distribution Options</title> - <listitem><para> - Solution: Passwd Backend is LDAP based, BDCs use a slave LDAP server - </para> - - <para> - Arguments For: This is a neat and manageable solution. The LDAP based SAM (ldapsam) - is constantly kept up to date. - </para> - - <para> - Arguments Against: Complexity - </para> - </listitem> - - <listitem><para> - Passdb Backend is tdbsam based, BDCs use cron based <emphasis>net rpc vampire</emphasis> to - obtain the Accounts database from the PDC and place them into the Samba SAM. - <emphasis>net rpc vampire</emphasis> is a Samba function of the "net" command. - </para> - - <para> - Arguments For: It would be a nice solution - </para> - - <para> - 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. - </para> - </listitem> - - <listitem><para> - Make use of rsync to replicate (pull down) copies of the essential account files - </para> - - <para> - Arguments For: It is a simple solution, easy to set up as a scheduled job - </para> - - <para> - Arguments Against: This will over-write the locally changed machine trust account - passwords. This is a broken and flawed solution. Do NOT do this. - </para> - </listitem> - - <listitem><para> - Operate with an entirely local accounts database (not recommended) - </para> - - <para> - Arguments For: Simple, easy to maintain - </para> - - <para> - 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. - </para> - - </listitem> -</itemizedlist> +Considering the number of comments and questions raised concerning how to configure a BDC, +let's consider each possible option and look at the pros and cons for each possible solution. +<link linkend="pdc-bdc-table"/> lists possible design configurations for a PDC/BDC infrastructure. +<indexterm><primary>net</primary><secondary>rpc</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm> +<indexterm><primary>SAM backend</primary><secondary>tdbsam</secondary></indexterm> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +</para> + +<table frame="all" id="pdc-bdc-table"><title>Domain Backend Account Distribution Options</title> +<tgroup cols="3"> + <colspec align="center" colwidth="1*"/> + <colspec align="center" colwidth="1*"/> + <colspec align="left" colwidth="3*"/> + + <thead> + <row><entry>PDC Backend</entry><entry>BDC Backend</entry><entry>Notes/Discussion</entry></row> + </thead> + <tbody> + <row> + <entry><para>Master LDAP Server</para></entry> + <entry><para>Slave LDAP Server</para></entry> + <entry><para>The optimal solution that provides high integrity. The SAM will be + replicated to a common master LDAP server.</para></entry> + </row> + <row> + <entry><para>Single Central LDAP Server</para></entry> + <entry><para>Single Central LDAP Server</para></entry> + <entry><para> + A workable solution without fail-over ability. This is a useable solution, but not optimal. + </para></entry> + </row> + <row> + <entry><para>tdbsam</para></entry> + <entry><para>tdbsam + <command>net rpc vampire</command></para></entry> + <entry><para> + Does not work with Samba-3.0.0; may be implemented in a later release. The downside of this solution + is that an external process will control account database integrity. This solution may appeal to sites + that wish to avoid the complexity of LDAP. The <command>net rpc vampire</command> is used to + synchronize domain accounts from the PDC to the BDC. + </para></entry> + </row> + <row> + <entry><para>tdbsam</para></entry> + <entry><para>tdbsam + <command>rsync</command></para></entry> + <entry><para> + Do not use this configuration. + Does not work because the TDB files are live and data may not have been flushed to disk. + Use <command>rsync</command> to synchronize the TDB database files from the PDC to the BDC. + </para></entry> + </row> + <row> + <entry><para>smbpasswd file</para></entry> + <entry><para>smbpasswd file</para></entry> + <entry><para> + Do not use this configuration. + Not an elegant solution due to the delays in synchronization. + Use <command>rsync</command> to synchronize the TDB database files from the PDC to the BDC. + Can be made to work using a <command>cron</command> job to synchronize data from the PDC to the BDC. + </para></entry> + </row> + </tbody> +</tgroup> +</table> </sect1> @@ -131,27 +133,27 @@ provided this capability. The technology has become known as the LanMan Netlogon </para> <para> -When MS Windows NT3.10 was first released, it supported an new style of Domain Control +When MS Windows NT3.10 was first released, it supported a new style of Domain Control and with it a new form of the network logon service that has extended functionality. This service became known as the NT NetLogon Service. The nature of this service has -changed with the evolution of MS Windows NT and today provides a very complex array of -services that are implemented over a complex spectrum of technologies. +changed with the evolution of MS Windows NT and today provides a complex array of +services that are implemented over an intricate spectrum of technologies. </para> <sect2> -<title>MS Windows NT4 Style Domain Control</title> +<title>MS Windows NT4-style Domain Control</title> <para> -Whenever a user logs into a Windows NT4 / 200x / XP Professional 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 Account Manager database) then a set of error +Whenever a user logs into a Windows NT4/200x/XP Professional Workstation, +the workstation connects to a Domain Controller (authentication server) to validate that +the username and password the user entered are valid. If the information entered +does not match account information that has been stored in the Domain +Control database (the SAM, or Security Account Manager database), a set of error codes is returned to the workstation that has made the authentication request. </para> <para> -When the username / password pair has been validated, the Domain Controller +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 @@ -164,9 +166,10 @@ in all versions of MS Windows NT (3.10, 3.50, 3.51, 4.0). </para> <para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> 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 <filename>C:\WinNT\System32\config</filename> directory. These +by the same name in the <filename>C:\Windows NT\System32\config</filename> directory. These are the files that are involved in replication of the SAM database where Backup Domain Controllers are present on the network. </para> @@ -185,52 +188,69 @@ There are two situations in which it is desirable to install Backup Domain Contr <listitem><para> 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 + Backup Domain Controllers, together with an implementation that localizes as much + of network to client interchange as possible will help to minimize wide area network bandwidth needs (and thus costs). </para></listitem> </itemizedlist> <para> -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. +The inter-operation of a PDC and its BDCs in a true Windows NT4 environemt is worth +mentioning here. The PDC contains the master copy of the SAM. In the event that an +administrator makes a change to the user account database while physically present +on the local network that has the PDC, the change will likely be made directly to +the PDC instance of the master copy of the SAM. In the event that this update may +be performed in a branch office, the change will likely be stored in a delta file +on the local BDC. The BDC will then send a trigger to the PDC to commence the process +of SAM synchronization. The PDC will then request the delta from the BDC and apply +it to the master SAM. The PDC will then contact all the BDCs in the Domain and +trigger them to obtain the update and then apply that to their own copy of the SAM. +</para> + +<para> +Samba-3 can not participate in true SAM replication and is therefore not able to +employ precisely the same protocols used by MS Windows NT4. A Samba-3 BDC will +not create SAM update delta files. It will not inter-operate with a PDC (NT4 or Samba) +to synchronize the SAM from delta files that are held by BDCs. </para> <para> -Thus the BDC is said to hold a <emphasis>read-only</emphasis> of the SAM from which -it is able to process network logon requests and to authenticate users. The BDC can +Samba-3 cannot function as a BDC to an MS Windows NT4 PDC, and Samba-3 can not +function correctly as a PDC to an MS Windows NT4 BDC. Both Samba-3 and MS Windows +NT4 can function as a BDC to its own type of PDC. +</para> + +<para> +The BDC is said to hold a <emphasis>read-only</emphasis> of the SAM from which +it is able to process network logon requests and authenticate users. The BDC can continue to provide this service, particularly while, for example, the wide area -network link to the PDC is down. Thus a BDC plays a very important role in both -maintenance of Domain security as well as in network integrity. +network link to the PDC is down. A BDC plays a very important role in both the +maintenance of Domain Security as well as in network integrity. </para> <para> -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. +In the event that the NT4 PDC should need to be taken out of service, or if it dies, +one of the NT4 BDCs can be promoted to a PDC. If this happens while the original NT4 PDC is on +line, it is automatically demoted to an NT4 BDC. This is an important aspect of Domain +Controller management. The tool that is used to effect a promotion or a demotion is the +Server Manager for Domains. It should be noted that Samba-3 BDCs can not be promoted +in this manner because reconfiguration of Samba requires changes to the &smb.conf; file. </para> <sect3> <title>Example PDC Configuration</title> <para> -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 <smbconfsection>[global]</smbconfsection>-section of the &smb.conf; have to be set: +Beginning with Version 2.2, Samba officially supports domain logons for all current Windows clients, +including Windows NT4, 2003 and XP Professional. For Samba to be enabled as a PDC, some +parameters in the <smbconfsection>[global]</smbconfsection>-section of the &smb.conf; have to be set. +Refer to <link linkend="minimalPDC"/> for an example of the minimum required settings. </para> -<para><smbconfexample> -<title>Minimal smb.conf for being a PDC</title> +<para><smbconfexample id="minimalPDC"> +<title>Minimal smb.conf for a PDC in Use With a BDC &smbmdash; LDAP Server on PDC.</title> <smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>ldapsam://localhost:389</value></smbconfoption> <smbconfoption><name>domain master</name><value>yes</value></smbconfoption> <smbconfoption><name>domain logons</name><value>yes</value></smbconfoption> </smbconfexample></para> @@ -238,77 +258,190 @@ parameters in the <smbconfsection>[global]</smbconfsection>-section of the &smb. <para> Several other things like a <smbconfsection>[homes]</smbconfsection> and a <smbconfsection>[netlogon]</smbconfsection> 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 <link linkend="samba-pdc">the chapter about samba as a PDC</link>. +settings for the profile path, the user's home drive, and so on. This is not covered in this +chapter; for more information please refer to <link linkend="samba-pdc"></link>. </para> </sect3> </sect2> <sect2> +<title>LDAP Configuration Notes</title> + +<para> +When configuring a master and a slave LDAP server, it is advisable to use the master LDAP server +for the PDC and slave LDAP servers for the BDCs. It is not essential to use slave LDAP servers, however, +many administrators will want to do so in order to provide redundant services. Of course, one or more BDCs +may use any slave LDAP server. Then again, it is entirely possible to use a single LDAP server for the +entire network. +</para> + +<para> +When configuring a master LDAP server that will have slave LDAP servers, do not forget to configure +this in the <filename>/etc/openldap/slapd.conf</filename> file. It must be noted that the DN of a +server certificate must use the CN attribute to name the server, and the CN must carry the servers' +fully qualified domain name. Additional alias names and wildcards may be present in the +subjectAltName certificate extension. More details on server certificate names are in RFC2830. +</para> + +<para> +It does not really fit within the scope of this document, but a working LDAP installation is +basic to LDAP enabled Samba operation. When using an OpenLdap server with Transport Layer Security +(TLS), the machine name in <filename>/etc/ssl/certs/slapd.pem</filename> must be the +same as in <filename>/etc/openldap/sldap.conf</filename>. The Red Hat Linux startup script +creates the <filename>slapd.pem</filename> file with hostname <quote>localhost.localdomain.</quote> +It is impossible to access this LDAP server from a slave LDAP server (i.e., a Samba BDC) unless the +certificate is recreated with a correct hostname. +</para> + +<para> +Do not install a Samba PDC on a OpenLDAP slave server. Joining client machines to the domain +will fail in this configuration because the change to the machine account in the LDAP tree +must take place on the master LDAP server. This is not replicated rapidly enough to the slave +server that the PDC queries. It therfore gives an error message on the client machine about +not being able to set up account credentials. The machine account is created on the LDAP server +but the password fields will be empty. +</para> + +<para> +Possible PDC/BDC plus LDAP configurations include: +</para> + +<itemizedlist> + <listitem><para> + PDC+BDC -> One Central LDAP Server. + </para></listitem> + <listitem><para> + PDC -> LDAP master server, BDC -> LDAP slave server. + </para></listitem> + <listitem><para> + PDC -> LDAP master, with secondary slave LDAP server. + </para><para> + BDC -> LDAP master, with secondary slave LDAP server. + </para></listitem> + <listitem><para> + PDC -> LDAP master, with secondary slave LDAP server. + </para><para> + BDC -> LDAP slave server, with secondary master LDAP server. + </para></listitem> +</itemizedlist> + +<para> +In order to have a fall-back configuration (secondary) LDAP server one would specify +the secondary LDAP server in the &smb.conf; file as shown in <link linkend="mulitldapcfg"/>. +</para> + +<para> +<smbconfexample id="mulitldapcfg"> +<title>Multiple LDAP Servers in &smb.conf;</title> +<member>...</member> +<smbconfoption><name>passdb backend</name><value>ldapsam:ldap://master.quenya.org</value></smbconfoption> +<member><parameter>ldapsam:ldap://slave.quenya.org</parameter></member> +<member>...</member> +</smbconfexample> +</para> + +</sect2> + +<sect2> <title>Active Directory Domain Control</title> <para> 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 +can be delegated. Samba-3 is not able to be a Domain Controller within an Active Directory +tree, and it cannot be an Active Directory server. This means that Samba-3 also cannot act as a Backup Domain Controller to an Active Directory Domain Controller. </para> </sect2> <sect2> -<title>What qualifies a Domain Controller on the network?</title> +<title>What Qualifies a Domain Controller on the Network?</title> <para> -Every machine that is a Domain Controller for the domain SAMBA has to register the NetBIOS -group name SAMBA<#1c> with the WINS server and/or by broadcast on the local network. -The PDC also registers the unique NetBIOS name SAMBA<#1b> with the WINS server. +Every machine that is a Domain Controller for the domain MIDEARTH has to register the NetBIOS +group name MIDEARTH<#1c> with the WINS server and/or by broadcast on the local network. +The PDC also registers the unique NetBIOS name MIDEARTH<#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. +implementation requires the Domain Master Browser to be on the same machine as the PDC. +</para> + +<para> +Where a WINS server is not used, broadcast name registrations alone must suffice. Refer to +<link linkend="netdiscuss"/> for more information regarding TCP/IP network protocols and how + SMB/CIFS names are handled. </para> </sect2> <sect2> -<title>How does a Workstation find its domain controller?</title> +<title>How does a Workstation find its Domain Controller?</title> + +<para> +There are two different mechanisms to locate a domain controller, one method is used when +NetBIOS over TCP/IP is enabled and the other when it has been disabled in the TCP/IP +network configuration. +</para> + +<para> +Where NetBIOS over TCP/IP is disabled, all name resolution involves the use of DNS, broadcast +messaging over UDP, as well as Active Directory communication technologies. In this type of +environment all machines require appropriate DNS entries. More information may be found in +<link linkend="adsdnstech"/>. +</para> +<sect3> +<title>NetBIOS Over TCP/IP Enabled</title> <para> -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 +An MS Windows NT4/200x/XP Professional workstation in the domain MIDEARTH that wants a +local user to be authenticated has to find the Domain Controller for MIDEARTH. It does this +by doing a NetBIOS name query for the group name MIDEARTH<#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 validation. +password) to the local Domain Controller for validation. </para> -</sect2> +</sect3> +<sect3> +<title>NetBIOS Over TCP/IP Disabled</title> + +<para> +An MS Windows NT4/200x/XP Professional workstation in the realm <constant>quenya.org</constant> +that has a need to affect user logon authentication will locate the Domain Controller by +requerying DNS servers for the <constant>_ldap._tcp.pdc.ms-dcs.quenya.org</constant> record. +More information regarding this subject may be found in <link linkend="adsdnstech"/>. +</para> + +</sect3> +</sect2> </sect1> <sect1> <title>Backup Domain Controller Configuration</title> <para> -Several things have to be done: +The creation of a BDC requires some steps to prepare the Samba server before +&smbd; is executed for the first time. These steps are outlines as follows: +<indexterm><primary>SID</primary></indexterm> </para> <itemizedlist> <listitem><para> - The domain SID has to be the same on the PDC and the BDC. This used to - be stored in the file private/MACHINE.SID. This file is not created - since Samba 2.2.5. Nowadays the domain SID is stored in the file - private/secrets.tdb. Simply copying the secrets.tdb - from the PDC to the BDC does not work, as the BDC would - generate a new SID for itself and override the domain SID with this - new BDC SID.</para> + The domain SID has to be the same on the PDC and the BDC. In Samba versions + pre-2.2.5, the domain SID was stored in the file <filename>private/MACHINE.SID</filename>. + The domain SID is now stored in the file <filename>private/secrets.tdb</filename>. This file + is unique to each server and can not be copied from a PDC to a BDC, the BDC will generate + a new SID at start-up. It will over-write the PDC domain SID with the newly created BDC SID. + There is a procedure that will allow the BDC to aquire the Domain SID. This is described here. + </para> <para> To retrieve the domain SID from the PDC or an existing BDC and store it in the - secrets.tdb, execute: + <filename>secrets.tdb</filename>, execute: </para> <screen> &rootprompt;<userinput>net rpc getsid</userinput> @@ -316,31 +449,45 @@ Several things have to be done: </listitem> <listitem><para> + Specification of the <smbconfoption><name>ldap admin dn</name></smbconfoption> is obligatory. + This also requires the LDAP administration password to be set in the <filename>secrets.tdb</filename> + using the <command>smbpasswd -w <replaceable>mysecret</replaceable></command>. + </para></listitem> + + <listitem><para> + Either <smbconfoption><name>ldap suffix</name></smbconfoption> or + <smbconfoption><name>ldap idmap suffix</name></smbconfoption> must be specified in + the &smb.conf; file. + </para></listitem> + + <listitem><para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> 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. NIS is by no means - the only method to synchronize passwords. An LDAP solution would work - as well. + BDC. This means that both the <filename>/etc/passwd</filename> and + <filename>/etc/group</filename> have to be replicated from the PDC + to the BDC. This can be done manually whenever changes are made. + Alternately, the PDC is set up as an NIS master server and the BDC as an NIS slave + server. To set up the BDC as a mere NIS client would not be enough, + as the BDC would not be able to access its user database in case of + a PDC failure. NIS is by no means the only method to synchronize + passwords. An LDAP solution would also work. </para> </listitem> <listitem><para> - The Samba password database has to be replicated from the PDC to the BDC. - As said above, though possible to synchronise the <filename>smbpasswd</filename> - file with rsync and ssh, this method is broken and flawed, and is - therefore not recommended. A better solution is to set up slave LDAP - servers for each BDC and a master LDAP server for the PDC. + The Samba password database must be replicated from the PDC to the BDC. + Although it is possible to synchronize the <filename>smbpasswd</filename> + file with <command>rsync</command> and <command>ssh</command>, this method + is broken and flawed, and is therefore not recommended. A better solution + is to set up slave LDAP servers for each BDC and a master LDAP server for the PDC. </para></listitem> <listitem><para> - Any netlogon share has to be replicated from the PDC to the + The netlogon share has to be replicated from the PDC to the BDC. This can be done manually whenever login scripts are changed, - or it can be done automatically together with the smbpasswd - synchronization. + or it can be done automatically using a <command>cron</command> job + that will replicate the directory structure in this share using a tool + like <command>rsync</command>. </para></listitem> </itemizedlist> @@ -349,15 +496,16 @@ Several things have to be done: <title>Example Configuration</title> <para> -Finally, the BDC has to be found by the workstations. This can be done by setting: +Finally, the BDC has to be found by the workstations. This can be done by setting Samba as shown in <link linkend="minim-bdc"/>. </para> -<para><smbconfexample> +<para><smbconfexample id="minim-bdc"> <title>Minimal setup for being a BDC</title> <smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>ldapsam:ldap://slave-ldap.quenya.org</value></smbconfoption> <smbconfoption><name>domain master</name><value>no</value></smbconfoption> <smbconfoption><name>domain logons</name><value>yes</value></smbconfoption> -<smbconfoption><name>idmap backend</name><value>ldapsam://slave-ldap.quenya.org</value></smbconfoption> +<smbconfoption><name>idmap backend</name><value>ldapsam:ldap://slave-ldap.quenya.org</value></smbconfoption> </smbconfexample></para> <para> @@ -366,24 +514,35 @@ 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 <smbconfoption><name>domain master</name><value>no</value></smbconfoption> -forces the BDC not to register SAMBA<#1b> which as a unique NetBIOS +forces the BDC not to register <?latex \linebreak ?>SAMBA<#1b> which as a unique NetBIOS name is reserved for the Primary Domain Controller. </para> <para> +<indexterm><primary>idmap backend</primary></indexterm> +<indexterm><primary>winbindd</primary></indexterm> The <parameter>idmap backend</parameter> will redirect the <command>winbindd</command> utility to use the LDAP database to resolve all UIDs and GIDs for UNIX accounts. </para> <note><para> +<indexterm><primary>Server Type</primary><secondary>Domain Member</secondary></indexterm> Samba-3 has introduced a new ID mapping facility. One of the features of this facility is that it -allows greater flexibility in how user and group IDs are handled in respect of NT Domain User and Group -SIDs. One of the new facilities provides for explicitly ensuring that UNIX / Linux UID and GID values +allows greater flexibility in how user and group IDs are handled in respect to NT Domain User and Group +SIDs. One of the new facilities provides for explicitly ensuring that UNIX/Linux UID and GID values will be consistent on the PDC, all BDCs and all Domain Member servers. The parameter that controls this is called <parameter>idmap backend</parameter>. Please refer to the man page for &smb.conf; for more information -regarding it's behaviour. Do NOT set this parameter except where an LDAP backend (ldapsam) is in use. +regarding its behavior. </para></note> +<para> +The use of the <smbconfoption><name>idmap backend</name><value>ldap://master.quenya/org</value></smbconfoption> +option on a BDC only make sense where ldapsam is used on a PDC. The purpose for an LDAP based idmap backend is +also to allow a domain-member (without its own passdb backend) to use winbindd to resolve Windows network users +and groups to common UID/GIDs. In other words, this option is generally intended for use on BDCs and on Domain +Member servers. +</para> + </sect2> </sect1> @@ -391,51 +550,55 @@ regarding it's behaviour. Do NOT set this parameter except where an LDAP backend <title>Common Errors</title> <para> -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. +As this is a rather new area for Samba, there are not many examples that we may refer to. +Updates will be published as they become available and may be found in later Samba releases or +from the Samba web <ulink url="http://samba.org">site.</ulink> </para> <sect2> -<title>Machine Accounts keep expiring, what can I do?</title> +<title>Machine Accounts Keep Expiring</title> <para> -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 +<indexterm><primary>Machine Trust Accounts</primary></indexterm> +This problem will occur when the passdb (SAM) files are copied from a central +server but the local Backup Domain Controller is acting as a PDC. This results in the application of +Local Machine Trust Account password updates to the local SAM. Such updates are not copied back to the central server. The newer machine account password is then 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 +written when the SAM is re-copied from the PDC. The result is that the Domain Member machine +on start up will find that its passwords do not match the one now in the database and since the startup security check will now fail, this machine will not allow logon attempts to proceed and the account expiry error will be reported. </para> <para> -The solution: use a more robust passdb backend, such as the ldapsam backend, setting up -an slave LDAP server for each BDC, and a master LDAP server for the PDC. +The solution is to use a more robust passdb backend, such as the ldapsam backend, setting up +a slave LDAP server for each BDC, and a master LDAP server for the PDC. </para> </sect2> <sect2> -<title>Can Samba be a Backup Domain Controller to an NT4 PDC?</title> +<title>Can Samba Be a Backup Domain Controller to an NT4 PDC?</title> <para> -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 Samba-3. +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +No. The native NT4 SAM replication protocols have not yet been fully implemented. </para> <para> -Can I get the benefits of a BDC with Samba? Yes, but only to a Samba PDC. The main reason for implementing a -BDC is availability. If the PDC is a Samba machine, a second Samba machine can be set up to -service logon requests whenever the PDC is down. +Can I get the benefits of a BDC with Samba? Yes, but only to a Samba PDC.The +main reason for implementing a BDC is availability. If the PDC is a Samba +machine, a second Samba machine can be set up to service logon requests whenever +the PDC is down. </para> </sect2> <sect2> -<title>How do I replicate the smbpasswd file?</title> +<title>How Do I Replicate the smbpasswd File?</title> <para> +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> 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. @@ -445,23 +608,23 @@ has to be replicated to the BDC. So replicating the smbpasswd file very often is 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 <emphasis>only</emphasis> rsync transfer without requiring the user -to type a password. +<command>ssh</command> itself can be set up to accept <emphasis>only</emphasis> +<command>rsync</command> transfer without requiring the user to type a password. </para> <para> As said a few times before, use of this method is broken and flawed. Machine trust -accounts will go out of sync, resulting in a very broken domain. This method is +accounts will go out of sync, resulting in a broken domain. This method is <emphasis>not</emphasis> recommended. Try using LDAP instead. </para> </sect2> <sect2> -<title>Can I do this all with LDAP?</title> +<title>Can I Do This All with LDAP?</title> <para> -The simple answer is YES. Samba's pdb_ldap code supports binding to a replica +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). diff --git a/docs/docbook/projdoc/Samba-PDC-HOWTO.xml b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml index 78a875792c..f86a4d5904 100644 --- a/docs/docbook/projdoc/Samba-PDC-HOWTO.xml +++ b/docs/docbook/projdoc/Samba-PDC-HOWTO.xml @@ -4,36 +4,43 @@ &author.jht; &author.jerry; &author.dbannon; + <author>&person.gd; <contrib>LDAP updates</contrib></author> </chapterinfo> <title>Domain Control</title> -<formalpara><title><emphasis>The Essence of Learning:</emphasis></title> <para> 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. +That's okay, 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. </para> -</formalpara> <para> -The reader is advised NOT to tackle this section without having first understood +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 of persistent niggles that may be caused by a broken network configuration. -To a great many people however, MS Windows networking starts with a domain controller -that in some magical way is expected to solve all ills. +To a great many people, however, MS Windows networking starts with a Domain Controller +that in some magical way is expected to solve all network operational ills. </para> -<figure id="domain-example"><title>An Example Domain</title> +<para> +The diagram in <link linkend="domain-example"/> shows a typical MS Windows Domain Security +network environment. Workstations A, B and C are representative of many physical MS Windows +network clients. +</para> + +<figure id="domain-example"><title>An Example Domain.</title> <mediaobject> -<imageobject role="latex"><imagedata fileref="projdoc/imagefiles/domain" scalefit="1"/></imageobject> +<imageobject role="latex"><imagedata fileref="projdoc/imagefiles/domain" width="4in" height="3in" scalefit="1"/></imageobject> <imageobject><imagedata fileref="projdoc/imagefiles/domain.png" scale="50" scalefit="1"/></imageobject> </mediaobject> </figure> +<?latex \newpage ?> + <para> From the Samba mailing list one can readily identify many common networking issues. If you are not clear on the following subjects, then it will do much good to read the @@ -42,28 +49,28 @@ networking problems: </para> <itemizedlist> - <listitem><para>Basic TCP/IP configuration</para></listitem> - <listitem><para>NetBIOS name resolution</para></listitem> - <listitem><para>Authentication configuration</para></listitem> - <listitem><para>User and Group configuration</para></listitem> - <listitem><para>Basic File and Directory Permission Control in UNIX/Linux</para></listitem> - <listitem><para>Understanding of how MS Windows clients interoperate in a network - environment</para></listitem> + <listitem><para>Basic TCP/IP configuration.</para></listitem> + <listitem><para>NetBIOS name resolution.</para></listitem> + <listitem><para>Authentication configuration.</para></listitem> + <listitem><para>User and group configuration.</para></listitem> + <listitem><para>Basic file and directory permission control in UNIX/Linux.</para></listitem> + <listitem><para>Understanding how MS Windows clients interoperate in a network + environment.</para></listitem> </itemizedlist> <para> Do not be put off; on the surface of it MS Windows networking seems so simple that anyone can do it. In fact, it is not a good idea to set up an MS Windows network with inadequate training and preparation. But let's get our first indelible principle out of the -way: <emphasis>It is perfectly OK to make mistakes!</emphasis> In the right place and at -the right time, mistakes are the essence of learning. It is <emphasis>very much</emphasis> -not ok to make mistakes that cause loss of productivity and impose an avoidable financial -burden on an organisation. +way: <emphasis>It is perfectly okay to make mistakes!</emphasis> In the right place and at +the right time, mistakes are the essence of learning. It is very much not okay to make +mistakes that cause loss of productivity and impose an avoidable financial burden on an +organization. </para> <para> -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 +Where is the right place to make mistakes? Only out of harm's way. If you are going to +make mistakes, then please do it on a test network, away from users and in such a way as to not inflict pain on others. Do your learning on a test network. </para> @@ -71,34 +78,36 @@ to not inflict pain on others. Do your learning on a test network. <title>Features and Benefits</title> <para> -<emphasis>What is the key benefit of Microsoft Domain security?</emphasis> +<indexterm><primary>domain security</primary></indexterm> +<emphasis>What is the key benefit of Microsoft Domain Security?</emphasis> </para> <para> -In a word, <emphasis>Single Sign On</emphasis>, 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 +In a word, <emphasis>Single Sign On</emphasis>, 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) +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. +Security protocols. </para> <para> -The benefits of Domain security are available to those sites that deploy a Samba PDC. +<indexterm><primary>SID</primary></indexterm> +The benefits of Domain Security are available to those sites that deploy a Samba PDC. A Domain provides a unique network security identifier (SID). Domain user and group security identifiers are comprised of the network SID plus a relative identifier (RID) that is unique to the account. User and Group SIDs (the network SID plus the RID) can be used to create Access Control Lists (ACLs) attached to network resources to provide organizational access control. UNIX systems -know only of local security identifiers. +recognize only local security identifiers. </para> <note><para> -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 +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 -<link linkend="domain-member">setting up samba as a domain member</link> for more information. +for the workstation (called a machine account). Refer to <link linkend="domain-member"></link> +for more information. </para></note> <para> @@ -107,73 +116,83 @@ The following functionalities are new to the Samba-3 release: <itemizedlist> <listitem><para> - Windows NT4 domain trusts + Windows NT4 domain trusts. </para></listitem> <listitem><para> + <indexterm><primary>Nexus.exe</primary></indexterm> 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. + client using the <filename>Nexus.exe</filename> toolkit that is available from Microsoft's Web site. Samba-3 supports the use of the Microsoft Management Console for user management. </para></listitem> <listitem><para> 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, + backends. In the case where the backend is placed in an LDAP database, + Samba-3 confers the benefits of a backend that can be distributed, replicated and is highly scalable. </para></listitem> <listitem><para> - Implements full Unicode support. This simplifies cross locale internationalisation + Implements full Unicode support. This simplifies cross locale internationalization support. It also opens up the use of protocols that Samba-2.2.x had but could not use due to the need to fully support Unicode. </para></listitem> </itemizedlist> <para> -The following functionalities are NOT provided by Samba-3: +The following functionalities are not provided by Samba-3: </para> - <itemizedlist> <listitem><para> +<indexterm><primary>SAM</primary></indexterm> +<indexterm><primary>replication</primary></indexterm> SAM replication with Windows NT4 Domain Controllers - (i.e. a Samba PDC and a Windows NT BDC or vice versa). This means samba + (i.e., a Samba PDC and a Windows NT BDC or vice versa). This means Samba cannot operate as a BDC when the PDC is Microsoft-based or - replicate account data to Windows-BDC's. + replicate account data to Windows BDCs. </para></listitem> <listitem><para> - Acting as a Windows 2000 Domain Controller (i.e. Kerberos and - Active Directory) - In point of fact, Samba-3 DOES have some + 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 <emphasis>AND</emphasis> that is certain - to change as it becomes a fully supported feature some time - during the Samba-3 (or later) life cycle. However, Active Directory is - more then just SMB - it's also LDAP, Kerberos, DHCP and other protocols - (with proprietary extensions, of course). + purely experimental that is certain to change as it becomes a + fully supported feature some time during the Samba-3 (or later) + life cycle. However, Active Directory is more then just SMB &smbmdash; + it's also LDAP, Kerberos, DHCP, and other protocols (with proprietary + extensions, of course). + </para></listitem> + + <listitem><para> + The Windows 200x/XP MMC (Computer Management) Console can not be used + to manage a Samba-3 server. For this you can use only the MS Windows NT4 + Domain Server manager and the MS Windows NT4 Domain User Manager. Both are + part of the SVRTOOLS.EXE package mentioned later. </para></listitem> </itemizedlist> <para> -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 +Windows 9x/Me/XP Home clients are not true members of a domain for reasons outlined +in this chapter. The protocol for support of Windows 9x/Me style network (domain) logons +is completely different from NT4/Windows 200x type domain logons and has been officially supported for some time. These clients use the old LanMan Network Logon facilities that are supported in Samba since approximately the Samba-1.9.15 series. </para> <para> -Samba-3 has an implementation of group mapping between Windows NT groups +Samba-3 implements group mapping between Windows NT groups and UNIX groups (this is really quite complicated to explain in a short space). This is -discussed more fully in <link linkend="groupmapping">the chapter on group mapping</link>. +discussed more fully in <link linkend="groupmapping"></link>. </para> <para> +<indexterm><primary>Machine Trust Accounts</primary></indexterm> Samba-3, like an MS Windows NT4 PDC or a Windows 200x Active Directory, needs to store -user and machine trust account information in a suitable backend data store. -Refer <link linkend="machine-trust-accounts">to the section on machine trust accounts</link>. With Samba-3 there can be multiple -back-ends for this. A complete discussion of account database backends can be found in -<link linkend="passdb">the chapter on Account Information Databases</link>. +user and Machine Trust Account information in a suitable backend datastore. +Refer to <link linkend="machine-trust-accounts"></link>. With Samba-3 there can be multiple +backends for this. A complete discussion of account database backends can be found in +<link linkend="passdb"></link>. </para> </sect1> @@ -184,7 +203,7 @@ back-ends for this. A complete discussion of account database backends can be fo <para> Over the years, public perceptions of what Domain Control really is has taken on an almost mystical nature. Before we branch into a brief overview of Domain Control, -there are three basic types of domain controllers: +there are three basic types of Domain Controllers. </para> <sect2> @@ -197,87 +216,88 @@ there are three basic types of domain controllers: </itemizedlist> <para> -The <emphasis>Primary Domain Controller</emphasis> or PDC plays an important role in the MS -Windows NT4. In Windows 200x Domain Control architecture this role is held by domain controllers. -There is folk lore that dictates that because of it's role in the MS Windows -network, the domain controllers 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 Stand-Alone -(or Domain Member) servers than in the domain controllers. +The <emphasis>Primary Domain Controller</emphasis> or PDC plays an important role in MS +Windows NT4. In Windows 200x Domain Control architecture, this role is held by Domain Controllers. +Folklore dictates that because of its role in the MS Windows +network, the Domain Controller should be the most powerful and most capable machine in the network. +As strange as it may seem to say this here, good overall network performance dictates that +the entire infrastructure needs to be balanced. It is advisable to invest more in Stand-alone +(Domain Member) servers than in the Domain Controllers. </para> <para> -In the case of MS Windows NT4 style domains, it is the PDC that initiates a new Domain Control database. -This forms a part of the Windows registry called the SAM (Security Account Manager). It plays a key -part in NT4 type domain user authentication and in synchronisation of the domain authentication +<indexterm><primary>SAM</primary></indexterm> +In the case of MS Windows NT4-style domains, it is the PDC that initiates a new Domain Control database. +This forms a part of the Windows registry called the Security Account Manager (SAM). It plays a key +part in NT4-type domain user authentication and in synchronization of the domain authentication database with Backup Domain Controllers. </para> <para> -With MS Windows 200x Server based Active Directory domains, one domain controller initiates a potential -hierarchy 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. +With MS Windows 200x Server-based Active Directory domains, one Domain Controller initiates a potential +hierarchy of Domain Controllers, each with their own area of delegated control. The master domain +controller has the ability to override any downstream controller, but a downline controller has +control only over its downline. With Samba-3, this functionality can be implemented using an +LDAP-based user and machine account backend. </para> <para> -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). -<footnote><para>See also <link linkend="passdb">the chapter on Account Information Databases</link>.</para></footnote> +New to Samba-3 is the ability to use a backend database that holds the same type of data as +the NT4-style SAM database (one of the registry files)<footnote>See also <link linkend="passdb"/>.</footnote>. </para> <para> The <emphasis>Backup Domain Controller</emphasis> or BDC plays a key role in servicing network authentication requests. The BDC is biased to answer logon requests 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 +On a network segment that has a BDC and a PDC, the BDC will most likely service network logon requests. The PDC will answer network logon requests when the BDC is too busy (high load). -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 PDC and BDC must be manually configured and changes need to be made likewise. +A BDC can be promoted to a PDC. If the PDC is online at the time that a BDC is promoted to +PDC, the previous PDC is automatically demoted to a BDC. With Samba-3, this is not an automatic +operation; the PDC and BDC must be manually configured and changes also need to be made. </para> <para> -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 vice versa only, but the only way -to convert a domain controller to a domain member server or a stand-alone server is to +With MS Windows NT4, a decision is made at installation to determine what type of machine the server will be. +It is possible to promote a BDC to a PDC and vice versa. The only 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: </para> <itemizedlist> - <listitem><para><emphasis>Primary Domain Controller</emphasis> - The one that seeds the domain SAM</para></listitem> - <listitem><para><emphasis>Backup Domain Controller</emphasis> - One that obtains a copy of the domain SAM</para></listitem> - <listitem><para><emphasis>Domain Member Server</emphasis> - One that has NO copy of the domain SAM, rather it obtains authentication from a Domain Controller for all access controls.</para></listitem> - <listitem><para><emphasis>Stand-Alone Server</emphasis> - One that plays NO part is SAM synchronisation, has it's own authentication database and plays no role in Domain security.</para></listitem> + <listitem><para><emphasis>Primary Domain Controller</emphasis> &smbmdash; the one that seeds the domain SAM.</para></listitem> + <listitem><para><emphasis>Backup Domain Controller</emphasis> &smbmdash; one that obtains a copy of the domain SAM.</para></listitem> + <listitem><para><emphasis>Domain Member Server</emphasis> &smbmdash; one that has no copy of the domain SAM, rather it obtains authentication from a Domain Controller for all access controls.</para></listitem> + <listitem><para><emphasis>Stand-alone Server</emphasis> &smbmdash; one that plays no part is SAM synchronization, has its own authentication database and plays no role in Domain Security.</para></listitem> </itemizedlist> <para> -With MS Windows 2000 the configuration of domain control is done after the server has been +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. </para> <para> -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. +<indexterm><primary>replication</primary><secondary>SAM</secondary></indexterm> +New to Samba-3 is the ability to function fully as an MS Windows NT4-style Domain Controller, +excluding the SAM replication components. However, please be aware that Samba-3 also supports the +MS Windows 200x Domain Control protocols. </para> <para> At this time any appearance that Samba-3 is capable of acting as an <emphasis>Domain Controller</emphasis> in native ADS mode is limited and experimental in nature. -This functionality should not be used until the Samba-Team offers formal support for it. +This functionality should not be used until the Samba Team offers formal support for it. At such a time, the documentation will be revised to duly reflect all configuration and management requirements. Samba can act as a NT4-style DC in a Windows 2000/XP environment. However, there are certain compromises: <itemizedlist> - <listitem><para>No machine policy files</para></listitem> - <listitem><para>No Group Policy Objects</para></listitem> - <listitem><para>No synchronously executed AD logon scripts</para></listitem> - <listitem><para>Can't use ANY Active Directory management tools to manage users and machines</para></listitem> - <listitem><para>Registry changes tattoo the main registry, while with AD they do NOT. ie: Leave permanent changes in effect</para></listitem> - <listitem><para>Without AD you can not peprform the function of exporting specific applications to specific users or groups</para></listitem> + <listitem>No machine policy files.</listitem> + <listitem>No Group Policy Objects.</listitem> + <listitem>No synchronously executed AD logon scripts.</listitem> + <listitem>Can't use Active Directory management tools to manage users and machines.</listitem> + <listitem>Registry changes tattoo the main registry, while with AD they do not leave permanent changes in effect.</listitem> + <listitem>Without AD you cannot perform the function of exporting specific applications to specific users or groups.</listitem> </itemizedlist> </para> @@ -287,76 +307,77 @@ environment. However, there are certain compromises: <title>Preparing for Domain Control</title> <para> -There are two ways that MS Windows machines may interact with each other, with other servers, -and with Domain Controllers: Either as <emphasis>Stand-Alone</emphasis> systems, more commonly +There are two ways that MS Windows machines may interact with each other, with other servers +and with Domain Controllers: either as <emphasis>Stand-alone</emphasis> systems, more commonly called <emphasis>Workgroup</emphasis> members, or as full participants in a security system, more commonly called <emphasis>Domain</emphasis> members. </para> <para> -It should be noted that <emphasis>Workgroup</emphasis> 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: <emphasis>workgroup mode does not involve any security machine +It should be noted that <emphasis>Workgroup</emphasis> membership involves no special configuration +other than the machine being configured so the network configuration has a commonly used name +for its workgroup entry. It is not uncommon for the name WORKGROUP to be used for this. With this +mode of configurationi, there are no Machine Trust Accounts and any concept of membership as such +is limited to the fact that all machines appear in the network neighborhood to be logically +grouped together. Again, just to be clear: <emphasis>workgroup mode does not involve security machine accounts</emphasis>. </para> <para> -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 Member machines have a machine account in the Domain accounts database. A special procedure +must be followed on each machine to effect Domain Membership. This procedure, which can be done +only by the local machine Administrator account, will create the Domain machine account (if it does +not exist), and then initializes that account. When the client first logs onto the Domain it triggers a machine password change. </para> <note><para> -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 to -<link linkend="domain-member">the chapter on domain membership</link> for information regarding HOW to make your MS Windows clients Domain members. +When Samba is configured as a Domain Controller, secure network operation demands that +all MS Windows NT4/200x/XP Professional clients should be configured as Domain Members. +If a machine is not made a member of the Domain, then it will operate like a workgroup +(Stand-alone) machine. Please refer to <link linkend="domain-member"></link> for +information regarding Domain Membership. </para></note> <para> -The following are necessary for configuring Samba-3 as an MS Windows NT4 style PDC for MS Windows -NT4 / 200x / XP clients. +The following are necessary for configuring Samba-3 as an MS Windows NT4-style PDC for MS Windows +NT4/200x/XP clients: </para> <itemizedlist> - <listitem><para>Configuration of basic TCP/IP and MS Windows Networking</para></listitem> - <listitem><para>Correct designation of the Server Role (<smbconfoption><name>security</name><value>user</value></smbconfoption>)</para></listitem> - <listitem><para>Consistent configuration of Name Resolution (See chapter on <link linkend="NetworkBrowsing">Network Browsing</link> and on - <link linkend="integrate-ms-networks">Integrating Unix into Windows networks</link>)</para></listitem> - <listitem><para>Domain logons for Windows NT4 / 200x / XP Professional clients</para></listitem> - <listitem><para>Configuration of Roaming Profiles or explicit configuration to force local profile usage</para></listitem> - <listitem><para>Configuration of Network/System Policies</para></listitem> - <listitem><para>Adding and managing domain user accounts</para></listitem> - <listitem><para>Configuring MS Windows client machines to become domain members</para></listitem> + <listitem><para>Configuration of basic TCP/IP and MS Windows networking.</para></listitem> + <listitem><para>Correct designation of the Server Role (<smbconfoption><name>security</name><value>user</value></smbconfoption>).</para></listitem> + <listitem><para>Consistent configuration of Name Resolution<footnote><para>See <link linkend="NetworkBrowsing"></link>, and + <link linkend="integrate-ms-networks"></link>.</para></footnote>.</para></listitem> + <listitem><para>Domain logons for Windows NT4/200x/XP Professional clients.</para></listitem> + <listitem><para>Configuration of Roaming Profiles or explicit configuration to force local profile usage.</para></listitem> + <listitem><para>Configuration of network/system policies.</para></listitem> + <listitem><para>Adding and managing domain user accounts.</para></listitem> + <listitem><para>Configuring MS Windows client machines to become Domain Members.</para></listitem> </itemizedlist> <para> -The following provisions are required to serve MS Windows 9x / Me Clients: +The following provisions are required to serve MS Windows 9x/Me clients: </para> <itemizedlist> - <listitem><para>Configuration of basic TCP/IP and MS Windows Networking</para></listitem> - <listitem><para>Correct designation of the Server Role (<smbconfoption><name>security</name><value>user</value></smbconfoption>)</para></listitem> - <listitem><para>Network Logon Configuration (Since Windows 9x / XP Home are not technically domain - members, they do not really participate in the security aspects of Domain logons as such)</para></listitem> - <listitem><para>Roaming Profile Configuration</para></listitem> - <listitem><para>Configuration of System Policy handling</para></listitem> - <listitem><para>Installation of the Network driver "Client for MS Windows Networks" and configuration - to log onto the domain</para></listitem> - <listitem><para>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.</para></listitem> - <listitem><para>Adding and managing domain user accounts</para></listitem> + <listitem><para>Configuration of basic TCP/IP and MS Windows networking.</para></listitem> + <listitem><para>Correct designation of the server role (<smbconfoption><name>security</name><value>user</value></smbconfoption>).</para></listitem> + <listitem><para>Network Logon Configuration (since Windows 9x/Me/XP Home are not technically domain + members, they do not really participate in the security aspects of Domain logons as such).</para></listitem> + <listitem><para>Roaming Profile Configuration.</para></listitem> + <listitem><para>Configuration of System Policy handling.</para></listitem> + <listitem><para>Installation of the network driver <quote>Client for MS Windows Networks</quote> and configuration + to log onto the domain.</para></listitem> + <listitem><para>Placing Windows 9x/Me clients in User Level Security &smbmdash; if it is desired to allow + all client share access to be controlled according to domain user/group identities.</para></listitem> + <listitem><para>Adding and managing domain user accounts.</para></listitem> </itemizedlist> <note><para> Roaming Profiles and System/Network policies are advanced network administration topics -that are covered in the <link linkend="ProfileMgmt">Profile Management</link> and -<link linkend="PolicyMgmt">Policy Management</link> chapters of this document. However, these are not +that are covered in the <link linkend="ProfileMgmt"></link> and +<link linkend="PolicyMgmt"></link> 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. </para></note> @@ -368,31 +389,29 @@ A Domain Controller is an SMB/CIFS server that: <listitem><para> 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) + to a WINS server over UDP unicast, or via DNS and Active Directory). </para></listitem> <listitem><para> - 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 the NETLOGON service. (This is actually a collection of services that runs over + mulitple protocols. These include the LanMan Logon service, the Netlogon service, + the Local Security Account service, and variations of them.) </para></listitem> <listitem><para> - Provides a share called NETLOGON + Provides a share called NETLOGON. </para></listitem> </itemizedlist> -<!-- FIXME: Provide link for "domain master browser" --> - <para> -For Samba to provide these is rather easy to configure. Each Samba Domain Controller must provide -the NETLOGON service which Samba calls the <smbconfoption><name>domain logons</name></smbconfoption> 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<footnote><para>See also <link linkend="NetworkBrowsing">the chapter about network browsing</link></para></footnote>. 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, +It is rather easy to configure Samba to provide these. Each Samba Domain Controller must provide +the NETLOGON service that Samba calls the <smbconfoption><name>domain logons</name></smbconfoption> functionality +(after the name of the parameter in the &smb.conf; file). Additionally, one server in a Samba-3 +Domain must advertise itself as the Domain Master Browser<footnote>See <link linkend="NetworkBrowsing"/>.</footnote>. +This causes the Primary Domain Controller to claim a domain-specific NetBIOS name that identifies it as a +Domain Master Browser for its given domain or workgroup. Local master browsers in the same domain or workgroup on +broadcast-isolated subnets then ask for a complete copy of the browse list for the whole wide area network. +Browser clients 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. </para> @@ -400,12 +419,11 @@ instead of just the list for their broadcast-isolated subnet. </sect1> <sect1> -<title>Domain Control - Example Configuration</title> +<title>Domain Control &smbmdash; Example Configuration</title> <para> The first step in creating a working Samba PDC is to understand the parameters necessary -in &smb.conf;. An example &smb.conf; for acting as a PDC can be found in the example -<link linkend="pdc-example">for being a PDC</link>. +in &smb.conf;. An example &smb.conf; for acting as a PDC can be found in <link linkend="pdc-example"/>. </para> <para> @@ -414,13 +432,12 @@ in &smb.conf;. An example &smb.conf; for acting as a PDC can be found in the ex <smbconfsection>[global]</smbconfsection> <smbconfoption><name>netbios name</name><value><replaceable>BELERIAND</replaceable></value></smbconfoption> <smbconfoption><name>workgroup</name><value><replaceable>&example.workgroup;</replaceable></value></smbconfoption> -<smbconfoption><name>passdb backend</name><value>ldapsam, guest</value></smbconfoption> +<smbconfoption><name>passdb backend</name><value>tdbsam</value></smbconfoption> <smbconfoption><name>os level</name><value>33</value></smbconfoption> <smbconfoption><name>preferred master</name><value>yes</value></smbconfoption> <smbconfoption><name>domain master</name><value>yes</value></smbconfoption> <smbconfoption><name>local master</name><value>yes</value></smbconfoption> <smbconfoption><name>security</name><value>user</value></smbconfoption> -<smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> <smbconfoption><name>domain logons</name><value>yes</value></smbconfoption> <smbconfoption><name>logon path</name><value>\\%N\profiles\%u</value></smbconfoption> <smbconfoption><name>logon drive</name><value>H:</value></smbconfoption> @@ -441,58 +458,58 @@ in &smb.conf;. An example &smb.conf; for acting as a PDC can be found in the ex </para> <para> -The basic options shown above are explained as follows: +The basic options shown in <link linkend="pdc-example"/> are explained as follows: </para> <variablelist> - <varlistentry><term>passdb backend</term> + <varlistentry><term>passdb backend </term> <listitem><para> This contains all the user and group account information. Acceptable values for a PDC - are: <emphasis>smbpasswd, tdbsam, ldapsam</emphasis>. The 'guest' entry provides needed - default accounts.</para> + are: <emphasis>smbpasswd, tdbsam, and ldapsam</emphasis>. The <quote>guest</quote> entry provides + default accounts and is included by default, there is no need to add it explicitly.</para> <para> - Where is is intended to use backup domain controllers (BDCs) the only logical choice is - to use LDAP so that the passdb backend can be distributed. The tdbsam and smbpasswd files - can not effectively be distributed and therefore should not be used. + Where use of backup Domain Controllers (BDCs) is intended, the only logical choice is + to use LDAP so the passdb backend can be distributed. The tdbsam and smbpasswd files + cannot effectively be distributed and therefore should not be used. </para></listitem> </varlistentry> - <varlistentry><term>Domain Control Parameters</term> + <varlistentry><term>Domain Control Parameters </term> <listitem><para> The parameters <emphasis>os level, preferred master, domain master, security, - encrypt passwords, domain logons</emphasis> play a central role in assuring domain + encrypt passwords, and domain logons</emphasis> play a central role in assuring domain control and network logon support.</para> <para> - The <emphasis>os level</emphasis> must be set at or above a value of 32. A domain controller - must be the domain master browser, must be set in <emphasis>user</emphasis> mode security, - must support Microsoft compatible encrypted passwords, and must provide the network logon - service (domain logons). Encrypted passwords must be enabled, for more details on how - to do this, refer to <link linkend="passdb">the chapter on account information databases</link>. + The <emphasis>os level</emphasis> must be set at or above a value of 32. A Domain Controller + must be the Domain Master Browser, must be set in <emphasis>user</emphasis> mode security, + must support Microsoft-compatible encrypted passwords, and must provide the network logon + service (domain logons). Encrypted passwords must be enabled. For more details on how + to do this, refer to <link linkend="passdb"></link>. </para></listitem> </varlistentry> - <varlistentry><term>Environment Parameters</term> + <varlistentry><term>Environment Parameters </term> <listitem><para> - The parameters <emphasis>logon path, logon home, logon drive, logon script</emphasis> are + The parameters <emphasis>logon path, logon home, logon drive, and logon script</emphasis> are environment support settings that help to facilitate client logon operations and that help to provide automated control facilities to ease network management overheads. Please refer to the man page information for these parameters. </para></listitem> </varlistentry> - <varlistentry><term>NETLOGON Share</term> + <varlistentry><term>NETLOGON Share </term> <listitem><para> - The NETLOGON share plays a central role in domain logon and domain membership support. - This share is provided on all Microsoft domain controllers. It is used to provide logon + The NETLOGON share plays a central role in domain logon and Domain Membership support. + This share is provided on all Microsoft Domain Controllers. It is used to provide logon scripts, to store Group Policy files (NTConfig.POL), as well as to locate other common - tools that may be needed for logon processing. This is an essential share on a domain controller. + tools that may be needed for logon processing. This is an essential share on a Domain Controller. </para></listitem> </varlistentry> - <varlistentry><term>PROFILE Share</term> + <varlistentry><term>PROFILE Share </term> <listitem><para> - This share is used to store user desktop profiles. Eash user must have a directory at the root - of this share. This directory must be write enabled for the user and must be globally read enabled. - Samba-3 has a VFS module called 'fake_permissions' that may be installed on this share. This will - allow a Samba administrator to make the directory read only to everyone. Of course this is useful + This share is used to store user desktop profiles. Each user must have a directory at the root + of this share. This directory must be write-enabled for the user and must be globally read-enabled. + Samba-3 has a VFS module called <quote>fake_permissions</quote> that may be installed on this share. This will + allow a Samba administrator to make the directory read-only to everyone. Of course this is useful only after the profile has been properly created. </para></listitem> </varlistentry> @@ -515,7 +532,7 @@ of operation. The following &smb.conf; parameters are the essentials alone: <para> The additional parameters shown in the longer listing above just makes for -more complete explanation. +a more complete explanation. </para></note> </sect1> @@ -524,21 +541,21 @@ more complete explanation. <title>Samba ADS Domain Control</title> <para> -Samba-3 is not, and can not act as, an Active Directory Server. It can not truly function as +Samba-3 is not, and cannot act as, an Active Directory Server. It cannot truly function as an Active Directory Primary Domain Controller. The protocols for some of the functionality -the Active Directory Domain Controllers has been partially implemented on an experimental -only basis. Please do NOT expect Samba-3 to support these protocols. Do not depend -on any such functionality either now or in the future. The Samba-Team may remove these -experimental features or may change their behaviour. This is mentioned for the benefit of those -who have discovered secret capabilities in samba-3 and who have asked when this functionality will be -completed. The answer is: Maybe or maybe never! +of Active Directory Domain Controllers has been partially implemented on an experimental +only basis. Please do not expect Samba-3 to support these protocols. Do not depend +on any such functionality either now or in the future. The Samba Team may remove these +experimental features or may change their behavior. This is mentioned for the benefit of those +who have discovered secret capabilities in Samba-3 and who have asked when this functionality will be +completed. The answer is maybe or maybe never! </para> <para> -To be sure: Samba-3 is designed to provide most of the functionality that Microsoft Windows NT4 style -domain controllers have. Samba-3 does NOT have all the capabilities of Windows NT4, but it does have +To be sure, Samba-3 is designed to provide most of the functionality that Microsoft Windows NT4-style +Domain Controllers have. Samba-3 does not have all the capabilities of Windows NT4, but it does have a number of features that Windows NT4 domain contollers do not have. In short, Samba-3 is not NT4 and it -is not Windows Server 200x and it is not an Active Directory server. We hope this is plain and simple +is not Windows Server 200x, it is not an Active Directory server. We hope this is plain and simple enough for all to understand. </para> @@ -558,16 +575,16 @@ an integral part of the essential functionality that is provided by a Domain Con <para> All Domain Controllers must run the netlogon service (<emphasis>domain logons</emphasis> in Samba). One Domain Controller must be configured with <smbconfoption><name>domain master</name><value>Yes</value></smbconfoption> -(the Primary Domain Controller); on ALL Backup Domain Controllers <smbconfoption><name>domain master</name><value>No</value></smbconfoption> +(the Primary Domain Controller); on all Backup Domain Controllers <smbconfoption><name>domain master</name><value>No</value></smbconfoption> must be set. </para> <sect3> <title>Example Configuration</title> -<smbconfexample> - <title>smb.conf for being a PDC</title> - <smbconfsection>[global]</smbconfsection> +<smbconfexample id="PDC-config"> +<title>smb.conf for being a PDC</title> +<smbconfsection>[global]</smbconfsection> <smbconfoption><name>domain logons</name><value>Yes</value></smbconfoption> <smbconfoption><name>domain master</name><value>(Yes on PDC, No on BDCs)</value></smbconfoption> @@ -582,22 +599,22 @@ must be set. <sect3> <title>The Special Case of MS Windows XP Home Edition</title> -<note><para> -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. -</para></note> - <para> 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 NT4 or Active Directory Domain Security, understand it cannot be done. +The only option is to purchase the upgrade from MS Windows XP Home Edition to MS Windows XP Professional. </para> +<note><para> +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. +</para></note> + <para> -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. +Now that this has been said, please do not ask the mailing list or email any of the +Samba Team members with your questions asking how to make this work. It can't be done. If it can be done, then to do so would violate your software license agreement with Microsoft, and we recommend that you do not do that. </para> @@ -605,15 +622,15 @@ Microsoft, and we recommend that you do not do that. </sect3> <sect3> -<title>The Special Case of Windows 9x / Me</title> +<title>The Special Case of Windows 9x/Me</title> <para> A domain and a workgroup are exactly the same in terms of network -browsing. The difference is that a distributable authentication +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 +network. Also, different access rights can be granted to users if they successfully authenticate against a domain logon server. Samba-3 does this -now in the same way that MS Windows NT/2K. +now in the same way as MS Windows NT/200x. </para> <para> @@ -621,23 +638,23 @@ The SMB client logging on to a domain has an expectation that every other server in the domain should accept the same authentication information. Network browsing functionality of domains and workgroups is identical and is explained in this documentation under the browsing discussions. -It should be noted, that browsing is totally orthogonal to logon support. +It should be noted that browsing is totally orthogonal to logon support. </para> <para> Issues related to the single-logon network model are discussed in this -section. Samba supports domain logons, network logon scripts, and user -profiles for MS Windows for workgroups and MS Windows 9X/ME clients +section. Samba supports domain logons, network logon scripts and user +profiles for MS Windows for workgroups and MS Windows 9X/ME clients, which are the focus of this section. </para> <para> When an SMB client in a domain wishes to logon, it broadcasts requests for a -logon server. The first one to reply gets the job, and validates its +logon server. The first one to reply gets the job, and validates its password using whatever mechanism the Samba administrator has installed. It is possible (but ill advised ) to create a domain where the user -database is not shared between servers, i.e. they are effectively workgroup -servers advertising themselves as participating in a domain. This +database is not shared between servers, i.e., they are effectively workgroup +servers advertising themselves as participating in a domain. This demonstrates how authentication is quite different from but closely involved with domains. </para> @@ -649,13 +666,13 @@ the network and download their preferences, desktop and start menu. </para> <para><emphasis> -MS Windows XP Home edition is NOT able to join a domain and does not permit +MS Windows XP Home edition is not able to join a domain and does not permit the use of domain logons. </emphasis></para> <para> Before launching into the configuration instructions, it is -worthwhile to look at how a Windows 9x/ME client performs a logon: +worthwhile to look at how a Windows 9x/Me client performs a logon: </para> <orderedlist> @@ -663,7 +680,7 @@ worthwhile to look at how a Windows 9x/ME client performs a logon: <para> The client broadcasts (to the IP broadcast address of the subnet it is in) a NetLogon request. This is sent to the NetBIOS name DOMAIN<#1c> at the - NetBIOS layer. The client chooses the first response it receives, which + 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 <filename>\\SERVER</filename>. </para> @@ -671,39 +688,39 @@ worthwhile to look at how a Windows 9x/ME client performs a logon: <listitem> <para> - The client then connects to that server, logs on (does an SMBsessetupX) and + The client connects to that server, logs on (does an SMBsessetupX) and then connects to the IPC$ share (using an SMBtconX). </para> </listitem> <listitem> <para> - The client then does a NetWkstaUserLogon request, which retrieves the name + The client does a NetWkstaUserLogon request, which retrieves the name of the user's logon script. </para> </listitem> <listitem> <para> - The client then connects to the NetLogon share and searches for said script - and if it is found and can be read, is retrieved and executed by the client. + The client then connects to the NetLogon share and searches for said script. + If it is found and can be read, it is retrieved and executed by the client. After this, the client disconnects from the NetLogon share. </para> </listitem> <listitem> <para> - The client then sends a NetUserGetInfo request to the server, to retrieve + The client sends a NetUserGetInfo request to the server to retrieve the user's home share, which is used to search for profiles. Since the response to the NetUserGetInfo request does not contain much more than - the user's home share, profiles for Win9X clients MUST reside in the user + the user's home share, profiles for Windows 9x clients must reside in the user home directory. </para> </listitem> <listitem> <para> - The client then connects to the user's home share and searches for the + The client connects to the user's home share and searches for the user's profile. As it turns out, you can specify the user's home share as a sharename and path. For example, <filename>\\server\fred\.winprofile</filename>. If the profiles are found, they are implemented. @@ -712,7 +729,7 @@ worthwhile to look at how a Windows 9x/ME client performs a logon: <listitem> <para> - The client then disconnects from the user's home share, and reconnects to + The client then disconnects from the user's home share and reconnects to the NetLogon share and looks for <filename>CONFIG.POL</filename>, the policies file. If this is found, it is read and implemented. </para> @@ -720,25 +737,25 @@ worthwhile to look at how a Windows 9x/ME client performs a logon: </orderedlist> <para> -The main difference between a PDC and a Windows 9x logon server configuration is that +The main difference between a PDC and a Windows 9x/Me logon server configuration is: </para> <itemizedlist> <listitem><para> - Password encryption is not required for a Windows 9x logon server. But note + Password encryption is not required for a Windows 9x/Me logon server. But note that beginning with MS Windows 98 the default setting is that plain-text password support is disabled. It can be re-enabled with the registry - changes that are documented in the chapter on Policies. + changes that are documented in <link linkend="PolicyMgmt"/>. </para></listitem> <listitem><para> - Windows 9x/ME clients do not require and do not use machine trust accounts. + Windows 9x/Me clients do not require and do not use Machine Trust Accounts. </para></listitem> </itemizedlist> <para> -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. +A Samba PDC will act as a Windows 9x/Me logon server; after all, it does provide the +network logon services that MS Windows 9x/Me expect to find. </para> <note><para> @@ -753,39 +770,35 @@ using a sniffer tool to examine network traffic. <title>Security Mode and Master Browsers</title> <para> -There are a few comments to make in order to tie up some -loose ends. There has been much debate over the issue of whether -or not it is ok to configure Samba as a Domain Controller in security -modes other than <constant>USER</constant>. The only security mode -which will not work due to technical reasons is <constant>SHARE</constant> -mode security. <constant>DOMAIN</constant> and <constant>SERVER</constant> -mode security are really just a variation on SMB user level security. +There are a few comments to make in order to tie up some loose ends. There has been +much debate over the issue of whether it is okay to configure Samba as a Domain +Controller in security modes other than user. The only security mode that will +not work due to technical reasons is share-mode security. Domain and server mode +security are really just a variation on SMB User Level Security. </para> <para> Actually, this issue is also closely tied to the debate on whether -or not Samba must be the domain master browser for its workgroup -when operating as a DC. While it may technically be possible +Samba must be the Domain Master Browser for its workgroup +when operating as a DC. While it may technically be possible to configure a server as such (after all, browsing and domain logons are two distinctly different functions), it is not a good idea to do -so. You should remember that the DC must register the DOMAIN<#1b> NetBIOS -name. This is the name used by Windows clients to locate the DC. +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. -A DMB is a Domain Master Browser - see <link linkend="DMB">Domain Master Browser</link>. -For this reason, it is very wise to configure the Samba DC as the DMB. +A DMB is a Domain Master Browser &smbmdash; see <link linkend="DMB"></link>. +For this reason, it is wise to configure the Samba DC as the DMB. </para> <para> -Now back to the issue of configuring a Samba DC to use a mode other -than <smbconfoption><name>security</name><value>user</value></smbconfoption>. 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 <smbconfoption><name>password server</name></smbconfoption>) 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 <smbconfoption><name>workgroup</name></smbconfoption> parameter -must be set to the name of the Windows NT domain (which already -has a domain controller). If the domain does NOT already have a Domain Controller -then you do not yet have a Domain! +Now back to the issue of configuring a Samba DC to use a mode other than +<smbconfoption><name>security</name><value>user</value></smbconfoption>. If a Samba host is +configured to use another SMB server or DC in order to validate user connection requests, +it is a fact that some other machine on the network (the <smbconfoption><name>password server</name></smbconfoption>) +knows more about the user than the Samba host. About 99% of the time, this other host is +a Domain Controller. Now to operate in domain mode security, the <smbconfoption><name>workgroup</name></smbconfoption> +parameter must be set to the name of the Windows NT domain (which already has a Domain Controller). +If the domain does not already have a Domain Controller, you do not yet have a Domain. </para> <para> @@ -803,61 +816,63 @@ This is the only officially supported mode of operation. <title>Common Errors</title> <sect2> - <title>'$' cannot be included in machine name</title> + <title><quote>$</quote> Cannot Be Included in Machine Name</title> <para> -A 'machine account', (typically) stored in <filename>/etc/passwd</filename>, -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. +A machine account, typically stored in <filename>/etc/passwd</filename>, takes the form of the machine +name with a <quote>$</quote> appended. FreeBSD (and other BSD systems) will not create a user with a +<quote>$</quote> in the name. </para> <para> The problem is only in the program used to make the entry. Once made, it works perfectly. -Create a user without the '$'. Then use <command>vipw</command> to edit the entry, adding -the '$'. Or create the whole entry with vipw if you like; make sure you use a unique User ID! +Create a user without the <quote>$</quote>. Then use <command>vipw</command> to edit the entry, adding +the <quote>$</quote>. Or create the whole entry with vipw if you like; make sure you use a unique user login ID. </para> +<para><note>The machine account must have the exact name that the workstation has.</note></para> + <note><para> -The UNIX tool <command>vipw</command> is a common tool for directly editting the <filename>/etc/passwd</filename> file. +The UNIX tool <command>vipw</command> is a common tool for directly editing the <filename>/etc/passwd</filename> file. </para></note> </sect2> <sect2> - <title>Joining domain fails because of existing machine account</title> +<title>Joining Domain Fails Because of Existing Machine Account</title> -<para><quote>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.</quote></para> - <para> -This happens if you try to create a machine trust account from the -machine itself and already have a connection (e.g. mapped drive) -to a share (or IPC$) on the Samba PDC. The following command -will remove all network drive connections: +<quote>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.</quote> </para> +<para> +This happens if you try to create a Machine Trust Account from the machine itself and already have a +connection (e.g., mapped drive) to a share (or IPC$) on the Samba PDC. The following command +will remove all network drive connections: <screen> &dosprompt;<userinput>net use * /d</userinput> </screen> +</para> <para> -Further, if the machine is already a 'member of a workgroup' that +Further, if the machine is already a <quote>member of a workgroup</quote> 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 +get this message. Change the workgroup name to something else, it does not matter what, reboot, and try again. </para> </sect2> <sect2> -<title>The system can not log you on (C000019B)....</title> +<title>The System Cannot Log You On (C000019B)</title> <para><quote>I joined the domain successfully but after upgrading -to a newer version of the Samba code I get the message, <errorname>The system -can not log you on (C000019B), Please try again or consult your -system administrator</errorname> when attempting to logon.</quote> +to a newer version of the Samba code I get the message, <errorname>`The system +cannot log you on (C000019B), Please try again or consult your +system administrator</errorname> when attempting to logon.'</quote> </para> <para> +<indexterm><primary>SID</primary></indexterm> 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. @@ -867,7 +882,7 @@ SID may be reset using either the net or rpcclient utilities. </para> <para> -The reset or change the domain SID you can use the net command as follows: +To reset or change the domain SID you can use the net command as follows: <screen> &rootprompt;<userinput>net getlocalsid 'OLDNAME'</userinput> @@ -876,8 +891,8 @@ The reset or change the domain SID you can use the net command as follows: </para> <para> -Workstation machine trust accounts work only with the Domain (or network) SID. If this SID changes -then domain members (workstations) will not be able to log onto the domain. The original Domain SID +Workstation Machine Trust Accounts work only with the Domain (or network) SID. If this SID changes +Domain Members (workstations) will not be able to log onto the domain. The original Domain SID can be recovered from the secrets.tdb file. The alternative is to visit each workstation to re-join it to the domain. </para> @@ -885,86 +900,88 @@ it to the domain. </sect2> <sect2> - <title>The machine trust account not accessible</title> +<title>The Machine Trust Account Is Not Accessible</title> <para> - <quote>When I try to join the domain I get the message <errorname>The machine account -for this computer either does not exist or is not accessible</errorname>. What's +<quote>When I try to join the domain I get the message, <errorname>`The machine account +for this computer either does not exist or is not accessible'</errorname>. What's wrong?</quote> </para> <para> -This problem is caused by the PDC not having a suitable machine trust account. +This problem is caused by the PDC not having a suitable Machine Trust Account. If you are using the <smbconfoption><name>add machine script</name></smbconfoption> method to create accounts then this would indicate that it has not worked. Ensure the domain admin user system is working. </para> <para> -Alternatively if you are creating account entries manually then they +Alternately, if you are creating account entries manually then they have not been created correctly. Make sure that you have the entry -correct for the machine trust account in <filename>smbpasswd</filename> file on the Samba PDC. +correct for the Machine Trust Account in <filename>smbpasswd</filename> 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 +with a <quote>$</quote> appended to it (i.e., computer_name$). There must be an entry in both /etc/passwd and the smbpasswd file. </para> <para> -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. +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. </para> </sect2> <sect2> - <title>Account disabled</title> +<title>Account Disabled</title> - <para><quote>When I attempt to login to a Samba Domain from a NT4/W2K workstation, - I get a message about my account being disabled.</quote></para> +<para><quote>When I attempt to login to a Samba Domain from a NT4/W200x workstation, +I get a message about my account being disabled.</quote></para> <para> Enable the user accounts with <userinput>smbpasswd -e <replaceable>username</replaceable> -</userinput>, this is normally done as an account is created. +</userinput>. This is normally done as an account is created. </para> </sect2> <sect2> - <title>Domain Controller Unavailable</title> +<title>Domain Controller Unavailable</title> - <para><quote>Until a few minutes after Samba has started, clients get the error "Domain Controller Unavailable"</quote></para> +<para><quote>Until a few minutes after Samba has started, clients get the error `Domain Controller Unavailable'</quote></para> - <para> - A domain controller has to announce on the network who it is. This usually takes a while. - </para> +<para> +A Domain Controller has to announce its role on the network. This usually takes a while. Be patient for up to fifteen minutes, +then try again. +</para> </sect2> <sect2> - <title>Can not log onto domain member workstation after joining domain</title> - - <para>After successfully joining the domain user logons fail with one of two messages:</para> - - <para>One to the effect that the domain controller can not be found, the other claiming that the - account does not exist in the domain or that the password is incorrect.</para> - - <para>This may be due to incompatible settings between - the Windows client and the Samba-3 server for <emphasis>schannel</emphasis> (secure channel) settings - or <emphasis>smb signing</emphasis> settings. Check your samba settings for <emphasis> - client schannel, server schannel, client signing, server signing</emphasis> by executing: - <command>testparm -v | more</command> and looking for the value of these parameters. - </para> +<title>Cannot Log onto Domain Member Workstation After Joining Domain</title> + +<para> +<indexterm><primary>schannel</primary></indexterm> +<indexterm><primary>signing</primary></indexterm> +After successfully joining the domain, user logons fail with one of two messages: one to the +effect that the Domain Controller cannot be found; the other claims that the account does not +exist in the domain or that the password is incorrect. This may be due to incompatible +settings between the Windows client and the Samba-3 server for <emphasis>schannel</emphasis> +(secure channel) settings or <emphasis>smb signing</emphasis> settings. Check your Samba +settings for <emphasis> client schannel, server schannel, client signing, server signing</emphasis> +by executing: +<screen> +<command>testparm -v | more</command> and looking for the value of these parameters. +</screen> +</para> - <para> - Also use the Microsoft Management Console - Local Security Settings. This tool is available from the - Control Panel. The Policy settings are found in the Local Policies / Securty Options area and are prefixed by - <emphasis>Secure Channel: ..., and Digitally sign ...</emphasis>. - </para> +<para> +Also use the Microsoft Management Console &smbmdash; Local Security Settings. This tool is available from the +Control Panel. The Policy settings are found in the Local Policies/Securty Options area and are prefixed by +<emphasis>Secure Channel: ..., and Digitally sign ....</emphasis>. +</para> - <para> - It is important that these be set consistently with the Samba-3 server settings. - </para> +<para> +It is important that these be set consistently with the Samba-3 server settings. +</para> </sect2> diff --git a/docs/docbook/projdoc/ServerType.xml b/docs/docbook/projdoc/ServerType.xml index 32a5103150..c7ee63cef2 100644 --- a/docs/docbook/projdoc/ServerType.xml +++ b/docs/docbook/projdoc/ServerType.xml @@ -9,22 +9,22 @@ <para> This chapter provides information regarding the types of server that Samba may be -configured to be. A Microsoft network administrator who wishes to migrate to or to -use Samba will want to know what, within a Samba context, terms familiar to MS Windows -administrator mean. This means that it is essential also to define how critical security -modes function BEFORE we get into the details of how to configure the server itself. +configured to be. A Microsoft network administrator who wishes to migrate to or +use Samba will want to know the meaning, within a Samba context, of terms familiar to MS Windows +administrator. This means that it is essential also to define how critical security +modes function before we get into the details of how to configure the server itself. </para> <para> The chapter provides an overview of the security modes of which Samba is capable -and how these relate to MS Windows servers and clients. +and how they relate to MS Windows servers and clients. </para> <para> -A question often asked is, "Why would I want to use Samba?" Most chapters contain a section +A question often asked is, <quote>Why would I want to use Samba?</quote> Most chapters contain a section that highlights features and benefits. We hope that the information provided will help to answer this question. Be warned though, we want to be fair and reasonable, so not all -features are positive towards Samba so the benefit may be on the side of our competition. +features are positive towards Samba. The benefit may be on the side of our competition. </para> <sect1> @@ -33,14 +33,14 @@ features are positive towards Samba so the benefit may be on the side of our com <para> Two men were walking down a dusty road, when one suddenly kicked up a small red stone. It hurt his toe and lodged in his sandal. He took the stone out and cursed it with a passion -and fury fitting his anguish. The other looked at the stone and said, that is a garnet - I -can turn that into a precious gem and some day it will make a princess very happy! +and fury befitting his anguish. The other looked at the stone and said, <quote>This is a garnet. +I can turn that into a precious gem and some day it will make a princess very happy!</quote> </para> <para> The moral of this tale: Two men, two very different perspectives regarding the same stone. Like it or not, Samba is like that stone. Treat it the right way and it can bring great -pleasure, but if you are forced upon it and have no time for its secrets then it can be +pleasure, but if you are forced to use it and have no time for its secrets, then it can be a source of discomfort. </para> @@ -48,26 +48,25 @@ a source of discomfort. Samba started out as a project that sought to provide interoperability for MS Windows 3.x clients with a UNIX server. It has grown up a lot since its humble beginnings and now provides features and functionality fit for large scale deployment. It also has some warts. In sections -like this one we will tell of both. +like this one we tell of both. </para> <para> -So now, what are the benefits of features mentioned in this chapter? +So, what are the benefits of features mentioned in this chapter? </para> <itemizedlist> <listitem><para> - Samba-3 can replace an MS Windows NT4 Domain Controller + Samba-3 can replace an MS Windows NT4 Domain Controller. </para></listitem> <listitem><para> - Samba-3 offers excellent interoperability with MS Windows NT4 - style domains as well as natively with Microsoft Active - Directory domains. + Samba-3 offers excellent interoperability with MS Windows NT4-style + domains as well as natively with Microsoft Active Directory domains. </para></listitem> <listitem><para> - Samba-3 permits full NT4 style Interdomain Trusts + Samba-3 permits full NT4-style Interdomain Trusts. </para></listitem> <listitem><para> @@ -76,7 +75,7 @@ So now, what are the benefits of features mentioned in this chapter? </para></listitem> <listitem><para> - Samba-3 permits use of multiple account database backends + Samba-3 permits use of multiple account database backends. </para></listitem> <listitem><para> @@ -93,24 +92,27 @@ So now, what are the benefits of features mentioned in this chapter? <sect1> <title>Server Types</title> -<para>Administrators of Microsoft networks often refer to three + +<para> +<indexterm><primary>Server Type</primary></indexterm> +Administrators of Microsoft networks often refer to three different type of servers:</para> <itemizedlist> <listitem><para>Domain Controller</para> <itemizedlist> - <listitem><para>Primary Domain Controller</para></listitem> - <listitem><para>Backup Domain Controller</para></listitem> - <listitem><para>ADS Domain Controller</para></listitem> + <listitem>Primary Domain Controller</listitem> + <listitem>Backup Domain Controller</listitem> + <listitem>ADS Domain Controller</listitem> </itemizedlist> </listitem> <listitem><para>Domain Member Server</para> <itemizedlist> - <listitem><para>Active Directory Domain Server</para></listitem> - <listitem><para>NT4 Style Domain Domain Server</para></listitem> + <listitem>Active Directory Domain Server</listitem> + <listitem>NT4 Style Domain Domain Server</listitem> </itemizedlist> </listitem> - <listitem><para>Stand Alone Server</para></listitem> + <listitem><para>Stand-alone Server</para></listitem> </itemizedlist> <para> @@ -125,52 +127,53 @@ presented. <sect1> <title>Samba Security Modes</title> + <para> -In this section the function and purpose of Samba's <smbconfoption><name>security</name></smbconfoption> +<indexterm><primary>Security Mode</primary></indexterm> +<indexterm><primary>security</primary></indexterm> +In this section the function and purpose of Samba's security modes are described. An accurate understanding of how Samba implements each security mode as well as how to configure MS Windows clients for each mode will significantly reduce user complaints and administrator heartache. </para> <para> -In the SMB/CIFS networking world, there are only two types of security: <emphasis>USER Level</emphasis> -and <emphasis>SHARE Level</emphasis>. We refer to these collectively as <emphasis>security levels</emphasis>. In implementing these two <emphasis>security levels</emphasis> Samba provides flexibilities -that are not available with Microsoft Windows NT4 / 200x servers. Samba knows of five (5) -ways that allow the security levels to be implemented. In actual fact, Samba implements -<emphasis>SHARE Level</emphasis> security only one way, but has four ways of implementing -<emphasis>USER Level</emphasis> security. Collectively, we call the Samba implementations -<emphasis>Security Modes</emphasis>. These are: <emphasis>SHARE</emphasis>, <emphasis>USER</emphasis>, <emphasis>DOMAIN</emphasis>, -<emphasis>ADS</emphasis>, and <emphasis>SERVER</emphasis> -modes. They are documented in this chapter. +In the SMB/CIFS networking world, there are only two types of security: <emphasis>User Level</emphasis> +and <emphasis>Share Level</emphasis>. We refer to these collectively as <emphasis>security levels</emphasis>. +In implementing these two security levels, Samba provides flexibilities +that are not available with Microsoft Windows NT4/200x servers. In actual fact, Samba implements +<emphasis>Share Level</emphasis> security only one way, but has four ways of implementing +<emphasis>User Level</emphasis> security. Collectively, we call the Samba implementations +<emphasis>Security Modes</emphasis>. They are known as: <emphasis>SHARE</emphasis>, <emphasis>USER</emphasis>, +<emphasis>DOMAIN</emphasis>, <emphasis>ADS</emphasis>, and <emphasis>SERVER</emphasis> modes. +They are documented in this chapter. </para> <para> - A SMB server tells the client at startup what <emphasis>security level</emphasis> -it is running. There are two options: <emphasis>share level</emphasis> and -<emphasis>user level</emphasis>. Which of these two the client receives affects -the way the client then tries to authenticate itself. It does not directly affect -(to any great extent) the way the Samba server does security. This may sound strange, -but it fits in with the client/server approach of SMB. In SMB everything is initiated -and controlled by the client, and the server can only tell the client what is -available and whether an action is allowed. +An SMB server tells the client at startup what security level it is running. There are two options: +Share Level and User Level. Which of these two the client receives affects the way the client then +tries to authenticate itself. It does not directly affect (to any great extent) the way the Samba +server does security. This may sound strange, but it fits in with the client/server approach of SMB. +In SMB everything is initiated and controlled by the client, and the server can only tell the client +what is available and whether an action is allowed. </para> <sect2> <title>User Level Security</title> <para> -We will describe <emphasis>user level</emphasis> security first, as it's simpler. -In <emphasis>user level</emphasis> security, the client will send a -<emphasis>session setup</emphasis> command directly after the protocol negotiation. -This contains a username and password. The server can either accept or reject that -username/password combination. Note that at this stage the server has no idea what +We will describe User Level Security first, as its simpler. +In User Level Security, the client will send a +session setup request directly following protocol negotiation. +This request provides a username and password. The server can either accept or reject that +username/password combination. At this stage the server has no idea what share the client will eventually try to connect to, so it can't base the <emphasis>accept/reject</emphasis> on anything other than: </para> <orderedlist> -<listitem><para>The username/password</para></listitem> -<listitem><para>The name of the client machine</para></listitem> +<listitem><para>the username/password.</para></listitem> +<listitem><para>the name of the client machine.</para></listitem> </orderedlist> <para> @@ -191,7 +194,7 @@ authentication contexts in this way (WinDD is an example of an application that <title>Example Configuration</title> <para> -The &smb.conf; parameter that sets <emphasis>User Level Security</emphasis> is: +The &smb.conf; parameter that sets user level security is: </para> <para><smbconfblock> @@ -199,7 +202,7 @@ The &smb.conf; parameter that sets <emphasis>User Level Security</emphasis> is: </smbconfblock></para> <para> -This is the default setting since samba-2.2.x. +This is the default setting since Samba-2.2.x. </para> </sect3> @@ -209,31 +212,30 @@ This is the default setting since samba-2.2.x. <title>Share Level Security</title> <para> -Ok, now for share level security. In share level security, the client authenticates -itself separately for each share. It will send a password along with each -<emphasis>tree connection</emphasis> (share mount). It does not explicitly send a +In Share Level security, the client authenticates +itself separately for each share. It sends a password along with each +tree connection (share mount). It does not explicitly send a username with this operation. The client expects a password to be associated with each share, independent of the user. This means that Samba has to work out what username the client probably wants to use. It is never explicitly sent the username. Some commercial SMB servers such as NT actually associate passwords directly with -shares in share level security, but Samba always uses the unix authentication scheme +shares in Share Level security, but Samba always uses the UNIX authentication scheme where it is a username/password pair that is authenticated, not a share/password pair. </para> <para> -To gain understanding of the MS Windows networking parallels to this, one should think +To understand the MS Windows networking parallels, one should think in terms of MS Windows 9x/Me where one can create a shared folder that provides read-only or full access, with or without a password. </para> <para> -Many clients send a <emphasis>session setup</emphasis> even if the server is in share -level security. They normally send a valid username but no password. Samba records -this username in a list of <emphasis>possible usernames</emphasis>. When the client -then does a <emphasis>tree connection</emphasis> it also adds to this list the name +Many clients send a session setup even if the server is in Share Level security. They +normally send a valid username but no password. Samba records this username in a list +of possible usernames. When the client then does a tree connection it also adds to this list the name of the share they try to connect to (useful for home directories) and any users -listed in the <smbconfoption><name>user</name></smbconfoption> &smb.conf; line. The password is then checked -in turn against these <emphasis>possible usernames</emphasis>. If a match is found +listed in the <smbconfoption><name>user</name></smbconfoption> parameter in the &smb.conf; file. +The password is then checked in turn against these possible usernames. If a match is found then the client is authenticated as that user. </para> @@ -241,7 +243,7 @@ then the client is authenticated as that user. <title>Example Configuration</title> <para> -The &smb.conf; parameter that sets <emphasis>Share Level Security</emphasis> is: +The &smb.conf; parameter that sets Share Level security is: </para> <para><smbconfblock> @@ -249,8 +251,8 @@ The &smb.conf; parameter that sets <emphasis>Share Level Security</emphasis> is: </smbconfblock></para> <para> -Please note that there are reports that recent MS Windows clients do not like to work -with share mode security servers. You are strongly discouraged from using share level security. +There are reports that recent MS Windows clients do not like to work +with share mode security servers. You are strongly discouraged from using Share Level security. </para> </sect3> @@ -260,9 +262,11 @@ with share mode security servers. You are strongly discouraged from using share <title>Domain Security Mode (User Level Security)</title> <para> +<indexterm><primary>Domain Member</primary></indexterm> When Samba is operating in <smbconfoption><name>security</name><value>domain</value></smbconfoption> mode, -the Samba server has a domain security trust account (a machine account) and will cause -all authentication requests to be passed through to the domain controllers. +the Samba server has a domain security trust account (a machine account) and causes +all authentication requests to be passed through to the Domain Controllers. +In other words, this configuration makes the Samba server a Domain Member server. </para> <sect3> @@ -271,7 +275,9 @@ all authentication requests to be passed through to the domain controllers. Samba as a Domain Member Server </emphasis></para> + <para> +<indexterm><primary>Server Type</primary><secondary>Domain Member</secondary></indexterm> This method involves addition of the following parameters in the &smb.conf; file: </para> @@ -283,21 +289,24 @@ This method involves addition of the following parameters in the &smb.conf; file <para> In order for this method to work, the Samba server needs to join the MS Windows NT security domain. This is done as follows: +<indexterm><primary>net</primary><secondary>rpc</secondary></indexterm> +<indexterm><primary>Domain Member</primary><secondary>joining</secondary></indexterm> </para> + <procedure> - <step><para>On the MS Windows NT domain controller, using + <step><para>On the MS Windows NT Domain Controller, using the Server Manager, add a machine account for the Samba server. </para></step> - <step><para>Next, on the UNIX/Linux system execute:</para> + <step><para>On the UNIX/Linux system execute:</para> <para><screen>&rootprompt;<userinput>net rpc join -U administrator%password</userinput></screen></para> </step> </procedure> <note><para> -Samba-2.2.4 and later can auto-join a Windows NT4 style Domain just by executing: +Samba-2.2.4 and later can auto-join a Windows NT4-style Domain just by executing: <screen> &rootprompt;<userinput>smbpasswd -j <replaceable>DOMAIN_NAME</replaceable> -r <replaceable>PDC_NAME</replaceable> \ -U Administrator%<replaceable>password</replaceable></userinput> @@ -314,18 +323,18 @@ It is not necessary with Samba-3 to specify the <replaceable>DOMAIN_NAME</replac <para> Use of this mode of authentication does require there to be a standard UNIX account for each user in order to assign a UID once the account has been authenticated by -the remote Windows DC. This account can be blocked to prevent logons by clients other than +the remote Windows DC. This account can be blocked to prevent logons by clients other than MS Windows through means such as setting an invalid shell in the <filename>/etc/passwd</filename> entry. </para> <para> An alternative to assigning UIDs to Windows users on a Samba member server is -presented in <link linkend="winbind">the chapter about winbind</link>. +presented in <link linkend="winbind"></link>. </para> <para> - For more information of being a domain member, see <link linkend="domain-member">the chapter about domain membership</link>. +For more information regarding Domain Membership, see <link linkend="domain-member"></link>. </para> </sect3> @@ -335,11 +344,11 @@ presented in <link linkend="winbind">the chapter about winbind</link>. <title>ADS Security Mode (User Level Security)</title> <para> -Both Samba 2.2 and 3.0 can join an Active Directory domain. This is +Both Samba-2.2, and Samba-3 can join an Active Directory domain. This is possible if the domain is run in native mode. Active Directory in -native mode perfectly allows NT4-style domain members. This is contrary to -popular belief. The only thing that Active Directory in native mode -prohibits is Backup Domain Controllers running NT4. +native mode perfectly allows NT4-style Domain Members. This is contrary to +popular belief. Active Directory in native mode prohibits only the use of +Backup Domain Controllers running MS Windows NT4. </para> <para> @@ -347,7 +356,7 @@ If you are using Active Directory, starting with Samba-3 you can join as a native AD member. Why would you want to do that? Your security policy might prohibit the use of NT-compatible authentication protocols. All your machines are running Windows 2000 -and above and all use Kerberos. In this case Samba as a NT4-style +and above and all use Kerberos. In this case Samba as an NT4-style domain would still require NT-compatible authentication data. Samba in AD-member mode can accept Kerberos tickets. </para> @@ -365,11 +374,11 @@ The following parameter may be required: </para> <para><smbconfblock> -<smbconfoption><name>ads server</name><value>your.kerberos.server</value></smbconfoption> +<smbconfoption><name>password server</name><value>your.kerberos.server</value></smbconfoption> </smbconfblock></para> <para> -Please refer to <link linkend="domain-member">the chapter on domain membership</link> +Please refer to <link linkend="domain-member"></link> and <link linkend="ads-member"></link> for more information regarding this configuration option. </para> @@ -380,34 +389,34 @@ for more information regarding this configuration option. <title>Server Security (User Level Security)</title> <para> -Server security mode is a left over from the time when Samba was not capable of acting -as a domain member server. It is highly recommended NOT to use this feature. Server -security mode has many draw backs. The draw backs include: +Server Security Mode is left over from the time when Samba was not capable of acting +as a Domain Member server. It is highly recommended not to use this feature. Server +security mode has many drawbacks that include: </para> <itemizedlist> - <listitem><para>Potential Account Lockout on MS Windows NT4/200x password servers</para></listitem> - <listitem><para>Lack of assurance that the password server is the one specified</para></listitem> - <listitem><para>Does not work with Winbind, particularly needed when storing profiles remotely</para></listitem> + <listitem><para>Potential Account Lockout on MS Windows NT4/200x password servers.</para></listitem> + <listitem><para>Lack of assurance that the password server is the one specified.</para></listitem> + <listitem><para>Does not work with Winbind, which is particularly needed when storing profiles remotely.</para></listitem> <listitem><para>This mode may open connections to the password server, and keep them open for extended periods.</para></listitem> - <listitem><para>Security on the Samba server breaks badly when the remote password server suddenly shuts down</para></listitem> + <listitem><para>Security on the Samba server breaks badly when the remote password server suddenly shuts down.</para></listitem> <listitem><para>With this mode there is NO security account in the domain that the password server belongs to for the Samba server.</para></listitem> </itemizedlist> <para> -In server security mode the Samba server reports to the client that it is in user level -security. The client then does a <emphasis>session setup</emphasis> as described earlier. +In Server Security Mode the Samba server reports to the client that it is in User Level +security. The client then does a session setup as described earlier. The Samba server takes the username/password that the client sends and attempts to login to the <smbconfoption><name>password server</name></smbconfoption> by sending exactly the same username/password that -it got from the client. If that server is in user level security and accepts the password, -then Samba accepts the clients connection. This allows the Samba server to use another SMB +it got from the client. If that server is in User Level Security and accepts the password, +then Samba accepts the client's connection. This allows the Samba server to use another SMB server as the <smbconfoption><name>password server</name></smbconfoption>. </para> <para> -You should also note that at the very start of all this, where the server tells the client +You should also note that at the start of all this where the server tells the client what security level it is in, it also tells the client if it supports encryption. If it -does then it supplies the client with a random cryptkey. The client will then send all +does, it supplies the client with a random cryptkey. The client will then send all passwords in encrypted form. Samba supports this type of encryption by default. </para> @@ -416,24 +425,24 @@ The parameter <smbconfoption><name>security</name><value>server</value></smbconf it is running in <emphasis>user mode</emphasis> but actually passes off all authentication requests to another <emphasis>user mode</emphasis> server. This requires an additional parameter <smbconfoption><name>password server</name></smbconfoption> that points to the real authentication server. -That real authentication server can be another Samba server or can be a Windows NT server, -the later natively capable of encrypted password support. +The real authentication server can be another Samba server, or it can be a Windows NT server, +the latter being natively capable of encrypted password support. </para> <note><para> -When Samba is running in <emphasis>server security mode</emphasis> it is essential that +When Samba is running in <emphasis>Server Security Mode</emphasis> it is essential that the parameter <emphasis>password server</emphasis> is set to the precise NetBIOS machine -name of the target authentication server. Samba can NOT determine this from NetBIOS name -lookups because the choice of the target authentication server is arbitrary and can not +name of the target authentication server. Samba cannot determine this from NetBIOS name +lookups because the choice of the target authentication server is arbitrary and cannot be determined from a domain name. In essence, a Samba server that is in -<emphasis>server security mode</emphasis> is operating in what used to be known as +<emphasis>Server Security Mode</emphasis> is operating in what used to be known as workgroup mode. </para></note> <sect3> <title>Example Configuration</title> <para><emphasis> -Using MS Windows NT as an authentication server +Using MS Windows NT as an Authentication Server </emphasis></para> <para> @@ -448,13 +457,13 @@ This method involves the additions of the following parameters in the &smb.conf; <para> -There are two ways of identifying whether or not a username and password pair was valid. +There are two ways of identifying whether or not a username and password pair is valid. One uses the reply information provided as part of the authentication messaging process, the other uses just an error code. </para> <para> -The down-side of this mode of configuration is the fact that for security reasons Samba +The downside 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 @@ -462,8 +471,8 @@ certain number of failed authentication attempts this will result in user lockou </para> <para> -Use of this mode of authentication does require there to be a standard UNIX account -for the user, though this account can be blocked to prevent logons by non-SMB/CIFS clients. +Use of this mode of authentication requires a standard UNIX account for the user. +This account can be blocked to prevent logons by non-SMB/CIFS clients. </para> </sect3> @@ -472,13 +481,13 @@ for the user, though this account can be blocked to prevent logons by non-SMB/CI </sect1> <sect1> -<title>Password checking</title> +<title>Password Checking</title> <para> MS Windows clients may use encrypted passwords as part of a challenge/response -authentication model (a.k.a. NTLMv1 and NTLMv2) or alone, or clear text strings for simple -password based authentication. It should be realized that with the SMB protocol, -the password is passed over the network either in plain text or encrypted, but +authentication model (a.k.a. NTLMv1 and NTLMv2) or alone, or cleartext strings for simple +password-based authentication. It should be realized that with the SMB protocol, +the password is passed over the network either in plain-text or encrypted, but not both in the same authentication request. </para> @@ -488,14 +497,14 @@ is encrypted in two ways: </para> <itemizedlist> - <listitem><para>An MD4 hash of the UNICODE of the password - string. This is known as the NT hash. + <listitem><para>An MD4 hash of the unicode of the password + string. This is known as the NT hash. </para></listitem> <listitem><para>The password is converted to upper case, - and then padded or truncated to 14 bytes. This string is + and then padded or truncated to 14 bytes. This string is then appended with 5 bytes of NULL characters and split to - form two 56 bit DES keys to encrypt a "magic" 8 byte value. + form two 56-bit DES keys to encrypt a <quote>magic</quote> 8-byte value. The resulting 16 bytes form the LanMan hash. </para></listitem> </itemizedlist> @@ -516,17 +525,17 @@ a cached copy of the password. <para> When Microsoft changed the default password mode, support was dropped for caching -of the plain text password. This means that when the registry parameter is changed -to re-enable use of plain text passwords it appears to work, but when a dropped -service connection mapping attempts to revalidate it will fail if the remote -authentication server does not support encrypted passwords. This means that it -is definitely not a good idea to re-enable plain text password support in such clients. +of the plain-text password. This means that when the registry parameter is changed +to re-enable use of plain-text passwords it appears to work, but when a dropped +service connection mapping attempts to revalidate, this will fail if the remote +authentication server does not support encrypted passwords. It is definitely not +a good idea to re-enable plain-text password support in such clients. </para> <para> -The following parameters can be used to work around the issue of Windows 9x clients -upper casing usernames and password before transmitting them to the SMB server -when using clear text authentication. +The following parameters can be used to work around the issue of Windows 9x/Me clients +upper-casing usernames and passwords before transmitting them to the SMB server +when using cleartext authentication: </para> <para><smbconfblock> @@ -535,27 +544,27 @@ when using clear text authentication. </smbconfblock></para> <para> -By default Samba will lower case the username before attempting to lookup the user -in the database of local system accounts. Because UNIX usernames conventionally -only contain lower-case character, the <smbconfoption><name>username level</name></smbconfoption> parameter +By default Samba will convert to 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 characters, the <smbconfoption><name>username level</name></smbconfoption> parameter is rarely needed. </para> <para> However, passwords on UNIX systems often make use of mixed-case characters. -This means that in order for a user on a Windows 9x client to connect to a Samba -server using clear text authentication, the <smbconfoption><name>password level</name></smbconfoption> -must be set to the maximum number of upper case letters which <emphasis>could</emphasis> -appear in a password. Note that if the server OS uses the traditional DES version +This means that in order for a user on a Windows 9x/Me client to connect to a Samba +server using cleartext authentication, the <smbconfoption><name>password level</name></smbconfoption> +must be set to the maximum number of upper case letters that <emphasis>could</emphasis> +appear in a password. Note that if the server OS uses the traditional DES version of crypt(), a <smbconfoption><name>password level</name></smbconfoption> of 8 will result in case -insensitive passwords as seen from Windows users. This will also result in longer +insensitive passwords as seen from Windows users. This will also result in longer login times as Samba has to compute the permutations of the password string and try them one by one until a match is located (or all combinations fail). </para> <para> The best option to adopt is to enable support for encrypted passwords wherever -Samba is used. Most attempts to apply the registry change to re-enable plain text +Samba is used. Most attempts to apply the registry change to re-enable plain-text passwords will eventually lead to user complaints and unhappiness. </para> @@ -565,48 +574,48 @@ passwords will eventually lead to user complaints and unhappiness. <title>Common Errors</title> <para> -We all make mistakes. It is Ok to make mistakes, so long as they are made in the right places -and at the right time. A mistake that causes lost productivity is seldom tolerated. A mistake +We all make mistakes. It is okay to make mistakes, as long as they are made in the right places +and at the right time. A mistake that causes lost productivity is seldom tolerated, however a mistake made in a developmental test lab is expected. </para> <para> Here we look at common mistakes and misapprehensions that have been the subject of discussions -on the Samba mailing lists. Many of these are avoidable by doing you homework before attempting -a Samba implementation. Some are the result of misunderstanding of the English language. The -English language has many turns of phrase that are potentially vague and may be highly confusing +on the Samba mailing lists. Many of these are avoidable by doing your homework before attempting +a Samba implementation. Some are the result of a misunderstanding of the English language. The +English language, which has many phrases that are potentially vague and may be highly confusing to those for whom English is not their native tongue. </para> <sect2> -<title>What makes Samba a SERVER?</title> +<title>What Makes Samba a Server?</title> <para> -To some the nature of the Samba <emphasis>security</emphasis> mode is very obvious, but entirely +To some the nature of the Samba <emphasis>security</emphasis> mode is obvious, but entirely wrong all the same. It is assumed that <smbconfoption><name>security</name><value>server</value></smbconfoption> means that Samba -will act as a server. Not so! See above - this setting means that Samba will <emphasis>try</emphasis> -to use another SMB server as its source of user authentication alone. +will act as a server. Not so! This setting means that Samba will <emphasis>try</emphasis> +to use another SMB server as its source for user authentication alone. </para> </sect2> <sect2> -<title>What makes Samba a Domain Controller?</title> +<title>What Makes Samba a Domain Controller?</title> <para> -The &smb.conf; parameter <smbconfoption><name>security</name><value>domain</value></smbconfoption> does NOT really make Samba behave -as a Domain Controller! This setting means we want Samba to be a domain member! +The &smb.conf; parameter <smbconfoption><name>security</name><value>domain</value></smbconfoption> does not really make Samba behave +as a Domain Controller. This setting means we want Samba to be a Domain Member. </para> </sect2> <sect2> -<title>What makes Samba a Domain Member?</title> +<title>What Makes Samba a Domain Member?</title> <para> -Guess! So many others do. But whatever you do, do NOT think that <smbconfoption><name>security</name><value>user</value></smbconfoption> -makes Samba act as a domain member. Read the manufacturers manual before the warranty expires! See -<link linkend="domain-member">the chapter about domain membership</link> for more information. +Guess! So many others do. But whatever you do, do not think that <smbconfoption><name>security</name><value>user</value></smbconfoption> +makes Samba act as a Domain Member. Read the manufacturer's manual before the warranty expires. See +<link linkend="domain-member"></link> for more information. </para> </sect2> @@ -617,15 +626,16 @@ makes Samba act as a domain member. Read the manufacturers manual before the war <para> <quote> -Why does server_validate() simply give up rather than re-establishing its connection to the +Why does server_validate() simply give up rather than re-establish its connection to the password server? Though I am not fluent in the SMB protocol, perhaps the cluster server process passes along to its client workstation the session key it receives from the password server, which means the password hashes submitted by the client would not work on a subsequent -connection, whose session key would be different. So server_validate() must give up.</quote> +connection whose session key would be different. So server_validate() must give up.</quote> </para> <para> - Indeed. That's why <smbconfoption><name>security</name><value>server</value></smbconfoption> is at best a nasty hack. Please use <smbconfoption><name>security</name><value>domain</value></smbconfoption>. +Indeed. That's why <smbconfoption><name>security</name><value>server</value></smbconfoption> +is at best a nasty hack. Please use <smbconfoption><name>security</name><value>domain</value></smbconfoption>; <smbconfoption><name>security</name><value>server</value></smbconfoption> mode is also known as pass-through authentication. </para> diff --git a/docs/docbook/projdoc/Speed.xml b/docs/docbook/projdoc/Speed.xml index f462bb8a8a..987915acd2 100644 --- a/docs/docbook/projdoc/Speed.xml +++ b/docs/docbook/projdoc/Speed.xml @@ -19,42 +19,42 @@ <para> The Samba server uses TCP to talk to the client. Thus if you are -trying to see if it performs well you should really compare it to +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 +programs for file transfer that use TCP are ftp or another TCP-based SMB server. </para> <para> -If you want to test against something like a NT or WfWg server then +If you want to test against something like an NT or Windows for Workgroups server, then you will have to disable all but TCP on either the client or -server. Otherwise you may well be using a totally different protocol +server. Otherwise, you may well be using a totally different protocol (such as NetBEUI) and comparisons may not be valid. </para> <para> -Generally you should find that Samba performs similarly to ftp at raw +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. +although this depends on your system. </para> <para> Several people have done comparisons between Samba and Novell, NFS or -WinNT. In some cases Samba performed the best, in others the worst. I -suspect the biggest factor is not Samba vs some other system but the +Windows NT. In some cases Samba performed the best, in others the worst. I +suspect the biggest factor is not Samba versus some other system, but the hardware and drivers used on the various systems. Given similar -hardware Samba should certainly be competitive in speed with other +hardware, Samba should certainly be competitive in speed with other systems. </para> </sect1> <sect1> -<title>Socket options</title> +<title>Socket Options</title> <para> There are a number of socket options that can greatly affect the -performance of a TCP based server like Samba. +performance of a TCP-based server like Samba. </para> <para> @@ -68,29 +68,29 @@ to set these and gives recommendations. </para> <para> -Getting the socket options right can make a big difference to your +Getting the socket options correct can make a big difference to your performance, but getting them wrong can degrade it by just as much. The correct settings are very dependent on your local network. </para> <para> -The socket option TCP_NODELAY is the one that seems to make the -biggest single difference for most networks. Many people report that -adding <smbconfoption><name>socket options</name><value>TCP_NODELAY</value></smbconfoption> 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. +The socket option TCP_NODELAY is the one that seems to make the biggest single difference +for most networks. Many people report that adding +<?latex \linebreak ?><smbconfoption><name>socket options</name><value>TCP_NODELAY</value></smbconfoption> +doubles the read performance of a Samba drive. The best explanation I have seen for +this is that the Microsoft TCP/IP stack is slow in sending TCP ACKs. </para> </sect1> <sect1> -<title>Read size</title> +<title>Read Size</title> <para> The option <smbconfoption><name>read size</name></smbconfoption> 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 +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. @@ -98,13 +98,13 @@ all the data has been read from disk. <para> This overlapping works best when the speeds of disk and network access -are similar, having very little effect when the speed of one is much +are similar, having little effect when the speed of one is much greater than the other. </para> <para> -The default value is 16384, but very little experimentation has been -done yet to determine the optimal value, and it is likely that the best +The default value is 16384, but little experimentation has been +done as yet to determine the optimal value, and it is likely that the best value will vary greatly between systems anyway. A value over 65536 is pointless and will cause you to allocate memory unnecessarily. </para> @@ -112,73 +112,69 @@ pointless and will cause you to allocate memory unnecessarily. </sect1> <sect1> -<title>Max xmit</title> +<title>Max Xmit</title> <para> At startup the client and server negotiate a <parameter>maximum transmit</parameter> size, which limits the size of nearly all SMB commands. You can set the maximum size that Samba will negotiate using the <smbconfoption><name>max xmit</name></smbconfoption> 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. +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. +honors this limit. </para> <para> It defaults to 65536 bytes (the maximum), but it is possible that some clients may perform better with a smaller transmit unit. Trying values of less than 2048 is likely to cause severe problems. -</para> - -<para> In most cases the default is the best option. </para> </sect1> <sect1> -<title>Log level</title> +<title>Log Level</title> <para> If you set the log level (also known as <smbconfoption><name>debug level</name></smbconfoption>) 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 +server flushes the log file after each operation, which can be quite expensive. </para> </sect1> <sect1> -<title>Read raw</title> +<title>Read Raw</title> <para> -The <smbconfoption><name>read raw</name></smbconfoption> operation is designed to be an optimised, low-latency +The <smbconfoption><name>read raw</name></smbconfoption> operation is designed to be an optimized, low-latency file read operation. A server may choose to not support it, -however. and Samba makes support for <smbconfoption><name>read raw</name></smbconfoption> optional, with it +however, and Samba makes support for <smbconfoption><name>read raw</name></smbconfoption> optional, with it being enabled by default. </para> <para> -In some cases clients don't handle <smbconfoption><name>read raw</name></smbconfoption> very well and actually +In some cases clients do not handle <smbconfoption><name>read raw</name></smbconfoption> very well and actually get lower performance using it than they get using the conventional read operations. </para> <para> So you might like to try <smbconfoption><name>read raw</name><value>no</value></smbconfoption> and see what happens on your -network. It might lower, raise or not affect your performance. Only +network. It might lower, raise or not effect your performance. Only testing can really tell. </para> </sect1> <sect1> -<title>Write raw</title> +<title>Write Raw</title> <para> -The <smbconfoption><name>write raw</name></smbconfoption> 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 <smbconfoption><name>write raw</name></smbconfoption> optional, with it -being enabled by default. +The <smbconfoption><name>write raw</name></smbconfoption> operation is designed to be an optimized, low-latency +file write operation. A server may choose to not support it, however, and Samba makes support for +<smbconfoption><name>write raw</name></smbconfoption> optional, with it being enabled by default. </para> <para> @@ -199,37 +195,45 @@ the lowest practical <smbconfoption><name>password level</name></smbconfoption> </sect1> <sect1> -<title>Client tuning</title> +<title>Client Tuning</title> <para> Often a speed problem can be traced to the client. The client (for example Windows for Workgroups) can often be tuned for better TCP performance. Check the sections on the various clients in -<link linkend="Other-Clients">Samba and Other Clients</link>. +<link linkend="Other-Clients"/>. </para> </sect1> <sect1> -<title>Samba performance problem due changing kernel</title> +<title>Samba Performance Problem Due to Changing Linux Kernel</title> + +<para> +A user wrote the following to the mailing list: +</para> + +<para> +I am running Gentoo on my server and Samba 2.2.8a. Recently +I changed kernel version from <filename>linux-2.4.19-gentoo-r10</filename> to +<filename>linux-2.4.20-wolk4.0s</filename>. And now I have a performance issue with Samba. +Many of you will probably say, <quote>Move to vanilla sources!</quote> +Well, I tried that and it didn't work. I have a 100mb LAN and two computers (Linux and +Windows 2000). The Linux server shares directories with DivX files, the client +(Windows 2000) plays them via LAN. Before when I was running the 2.4.19 kernel +everything was fine, but now movies freeze and stop. I tried moving +files between the server and Windows and it is terribly slow. +</para> <para> -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 tried -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 terribly slow. +The answer he was given is: </para> <para> -Grab mii-tool and check the duplex settings on the NIC. +Grab the mii-tool and check the duplex settings on the NIC. My guess is that it is a link layer issue, not an application -layer problem. Also run ifconfig and verify that the framing -error, collisions, etc... look normal for ethernet. +layer problem. Also run ifconfig and verify that the framing +error, collisions, and so on, look normal for ethernet. </para> </sect1> @@ -238,31 +242,30 @@ error, collisions, etc... look normal for ethernet. <title>Corrupt tdb Files</title> <para> -Well today it happened, 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 +Our Samba PDC server has been hosting three TB of data to our 500+ users +[Windows NT/XP] for the last three years using Samba without a problem. +Today all shares went very slow. Also the main smbd kept spawning new processes so we had 1600+ running smbd's (normally we avg. 250). -It crashed the SUN E3500 cluster twice. After a lot of searching I +It crashed the SUN E3500 cluster twice. After a lot of searching, I decided to <command>rm /var/locks/*.tdb</command>. Happy again. </para> <para> -Q1) Is there any method of keeping the *.tdb files in top condition or -how to early detect corruption? +<emphasis>Question:</emphasis> Is there any method of keeping the *.tdb files in top condition or +how can I detect early corruption? </para> <para> -A1) Yes, run <command>tdbbackup</command> each time after stopping nmbd and before starting nmbd. +<emphasis>Answer:</emphasis> Yes, run <command>tdbbackup</command> each time after stopping nmbd and before starting nmbd. </para> <para> -Q2) What I also would like to mention is that the service latency seems -a lot lower then before the locks cleanup, any ideas on keeping it top notch? +<emphasis>Question:</emphasis> What I also would like to mention is that the service latency seems +a lot lower than before the locks cleanup. Any ideas on keeping it top notch? </para> <para> -A2) Yes! Same answer as for Q1! +<emphasis>Answer:</emphasis> Yes. Same answer as for previous question! </para> </sect1> diff --git a/docs/docbook/projdoc/StandAloneServer.xml b/docs/docbook/projdoc/StandAloneServer.xml index ec4f9f2693..b52ad29fe1 100644 --- a/docs/docbook/projdoc/StandAloneServer.xml +++ b/docs/docbook/projdoc/StandAloneServer.xml @@ -2,12 +2,12 @@ <chapterinfo> &author.jht; </chapterinfo> -<title>Stand-Alone Servers</title> +<title>Stand-alone Servers</title> <para> -Stand-Alone servers are independent of Domain Controllers on the network. -They are NOT domain members and function more like workgroup servers. In many -cases a stand-alone server is configured with a minimum of security control +Stand-alone Servers are independent of Domain Controllers on the network. +They are not Domain Members and function more like workgroup servers. In many +cases a Stand-alone Server is configured with a minimum of security control with the intent that all data served will be readily accessible to all users. </para> @@ -15,25 +15,25 @@ with the intent that all data served will be readily accessible to all users. <title>Features and Benefits</title> <para> -Stand-Alone servers can be as secure or as insecure as needs dictate. They can +Stand-alone Servers can be as secure or as insecure as needs dictate. They can have simple or complex configurations. Above all, despite the hoopla about -Domain security they remain a very common installation. +Domain Security they remain a common installation. </para> <para> If all that is needed is a server for read-only files, or for -printers alone, it may not make sense to affect a complex installation. +printers alone, it may not make sense to effect a complex installation. For example: A drafting office needs to store old drawings and reference -standards. No-one can write files to the server as it is legislatively -important that all documents remain unaltered. A share mode read-only stand-alone -server is an ideal solution. +standards. Noone can write files to the server as it is legislatively +important that all documents remain unaltered. A share mode read-only Stand-alone +Server is an ideal solution. </para> <para> Another situation that warrants simplicity is an office that has many printers that are queued off a single central server. Everyone needs to be able to print -to the printers, there is no need to affect any access controls and no files will -be served from the print server. Again a share mode stand-alone server makes +to the printers, there is no need to effect any access controls and no files will +be served from the print server. Again, a share mode Stand-alone Server makes a great solution. </para> </sect1> @@ -42,39 +42,38 @@ a great solution. <title>Background</title> <para> -The term <emphasis>stand-alone server</emphasis> means that the server +The term <emphasis>Stand-alone Server</emphasis> means that it will provide local authentication and access control for all resources that are available from it. In general this means that there will be a -local user database. In more technical terms, it means that resources +local user database. In more technical terms, it means resources on the machine will be made available in either SHARE mode or in USER mode. </para> <para> No special action is needed other than to create user accounts. Stand-alone -servers do NOT provide network logon services. This means that machines that -use this server do NOT perform a domain logon to it. Whatever logon facility -the workstations are subject to is independent of this machine. It is however -necessary to accommodate any network user so that the logon name they use will -be translated (mapped) locally on the stand-alone server to a locally known +servers do not provide network logon services. This means that machines that +use this server do not perform a domain logon to it. Whatever logon facility +the workstations are subject to is independent of this machine. It is, however, +necessary to accommodate any network user so the logon name they use will +be translated (mapped) locally on the Stand-alone Server to a locally known user name. There are several ways this can be done. </para> <para> Samba tends to blur the distinction a little in respect of what is -a stand-alone server. This is because the authentication database may be -local or on a remote server, even if from the Samba protocol perspective -the Samba server is NOT a member of a domain security context. +a Stand-alone Server. This is because the authentication database may be +local or on a remote server, even if from the SMB protocol perspective +the Samba server is not a member of a domain security context. </para> <para> -Through the use of PAM (Pluggable Authentication Modules) and nsswitch -(the name service switcher, which maintains the unix user database) the source of authentication may reside on +Through the use of Pluggable Authentication Modules (PAM) and the name service switcher (NSSWITCH), +which maintains the UNIX-user database) the source of authentication may reside on another server. We would be inclined to call this the authentication server. This means that the Samba server may use the local UNIX/Linux system password database (<filename>/etc/passwd</filename> or <filename>/etc/shadow</filename>), may use a -local smbpasswd file, or may use -an LDAP back end, or even via PAM and Winbind another CIFS/SMB server +local smbpasswd file, or may use an LDAP backend, or even via PAM and Winbind another CIFS/SMB server for authentication. </para> @@ -84,23 +83,23 @@ for authentication. <title>Example Configuration</title> <para> -The following examples are designed to inspire simplicity. It is too easy to -attempt a high level of creativity and to introduce too much complexity in -server and network design. +The examples, <link linkend="simplynice"/>, and link linkend="SimplePrintServer"/>, +are designed to inspire simplicity. It is too easy to attempt a high level of creativity +and to introduce too much complexity in server and network design. </para> <sect2 id="RefDocServer"> <title>Reference Documentation Server</title> <para> -Configuration of a read-only data server that EVERYONE can access is very simple. -Here is the smb.conf file that will do this. Assume that all the reference documents -are stored in the directory /export, that the documents are owned by a user other than -nobody. No home directories are shared, that are no users in the <filename>/etc/passwd</filename> -UNIX system database. This is a very simple system to administer. +Configuration of a read-only data server that everyone can access is very simple. +<link linkend="simplynice"/> is the &smb.conf; file that will do this. Assume that all the reference documents +are stored in the directory <filename>/export</filename>, and the documents are owned by a user other than +nobody. No home directories are shared, and there are no users in the <filename>/etc/passwd</filename> +UNIX system database. This is a simple system to administer. </para> -<smbconfexample> +<smbconfexample id="simplynice"> <title>smb.conf for Reference Documentation Server</title> <smbconfcomment> Global parameters</smbconfcomment> <smbconfsection>[global]</smbconfsection> @@ -116,11 +115,10 @@ UNIX system database. This is a very simple system to administer. </smbconfexample> <para> -In the above example the machine name is set to REFDOCS, the workgroup is set to the name -of the local workgroup so that the machine will appear in with systems users are familiar -with. The only password backend required is the "guest" backend so as to allow default -unprivileged account names to be used. Given that there is a WINS server on this network -we do use it. +In <link linkend="simplynice"/> above, the machine name is set to &example.server.samba;, the workgroup is set to the name +of the local workgroup (&example.workgroup;) so the machine will appear together with systems with +which users are familiar. The only password backend required is the <quote>guest</quote> backend to allow default +unprivileged account names to be used. As there is a WINS server on this networki, we of obviously make use of it. </para> </sect2> @@ -129,30 +127,29 @@ we do use it. <title>Central Print Serving</title> <para> -Configuration of a simple print server is very simple if you have all the right tools +Configuration of a simple print server is easy if you have all the right tools on your system. </para> <orderedlist> <title> Assumptions:</title> <listitem><para> - The print server must require no administration + The print server must require no administration. </para></listitem> <listitem><para> The print spooling and processing system on our print server will be CUPS. - (Please refer to <link linkend="CUPS-printing">the chapter about CUPS</link> for more information). + (Please refer to <link linkend="CUPS-printing"></link> for more information). </para></listitem> <listitem><para> - All printers that the print server will service will be network - printers. They will be correctly configured, by the administrator, - in the CUPS environment. + The print server will service only network printers. The network administrator + will correctly configure the CUPS environment to support the printers. </para></listitem> <listitem><para> - All workstations will be installed using postscript drivers. The printer - of choice is the Apple Color LaserWriter. + All workstations will use only postscript drivers. The printer driver + of choice is the one shipped with the Windows OS for the Apple Color LaserWriter. </para></listitem> </orderedlist> @@ -168,12 +165,12 @@ the anonymous (guest) user, two things will be required: <listitem><para> The UNIX/Linux system must have a <command>guest</command> account. The default for this is usually the account <command>nobody</command>. - To find the correct name to use for your version of Samba do the + To find the correct name to use for your version of Samba, do the following: <screen> &prompt;<userinput>testparm -s -v | grep "guest account"</userinput> </screen> - Then make sure that this account exists in your system password + Make sure that this account exists in your system password database (<filename>/etc/passwd</filename>). </para></listitem> @@ -190,15 +187,18 @@ the anonymous (guest) user, two things will be required: </itemizedlist> <para> - <smbconfexample> - <title>smb.conf for anonymous printing</title> +The contents of the &smb.conf; file is shown in <link linkend="AnonPtrSvr"/>. +</para> + +<para> +<smbconfexample id="AnonPtrSvr"> +<title>&smb.conf; for Anonymous Printing</title> <smbconfcomment> Global parameters</smbconfcomment> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> <smbconfoption><name>netbios name</name><value>&example.server.samba;</value></smbconfoption> <smbconfoption><name>security</name><value>SHARE</value></smbconfoption> <smbconfoption><name>passdb backend</name><value>guest</value></smbconfoption> -<smbconfoption><name>wins server</name><value>&example.server.wins;</value></smbconfoption> <smbconfoption><name>printing</name><value>cups</value></smbconfoption> <smbconfoption><name>printcap name</name><value>cups</value></smbconfoption> @@ -213,6 +213,17 @@ the anonymous (guest) user, two things will be required: </smbconfexample> </para> + +<note><para> +<indexterm><primary>MIME</primary><secondary>raw</secondary></indexterm> +<indexterm><primary>raw printing</primary></indexterm> +On CUPS-enabled systems there is a facility to pass raw data directly to the printer without +intermediate processing via CUPS print filters. Where use of this mode of operation is desired, +it is necessary to configure a raw printing device. It is also necessary to enable the raw mime +handler in the <filename>/etc/mime.conv</filename> and <filename>/etc/mime.types</filename> +files. Refer to <link linkend="cups-raw"></link>. +</para></note> + </sect2> </sect1> diff --git a/docs/docbook/projdoc/UNIX_INSTALL.xml b/docs/docbook/projdoc/UNIX_INSTALL.xml index 6a38e60c0e..65a26702c4 100644 --- a/docs/docbook/projdoc/UNIX_INSTALL.xml +++ b/docs/docbook/projdoc/UNIX_INSTALL.xml @@ -3,7 +3,8 @@ &author.tridge; &author.jelmer; &author.jht; - <author><firstname>Karl</firstname><surname>Auer</surname></author> + &author.kauer; + &author.danshearer; <!-- Isn't some of this written by others as well? --> </chapterinfo> @@ -11,52 +12,89 @@ <title>How to Install and Test SAMBA</title> <sect1> - <title>Obtaining and installing samba</title> + <title>Obtaining and Installing Samba</title> <para> - Binary packages of samba are included in almost any Linux or + Binary packages of Samba are included in almost any Linux or UNIX distribution. There are also some packages available at - <ulink url="http://samba.org/">the samba homepage</ulink>. + <ulink url="http://samba.org/">the Samba homepage</ulink>. Refer to + the manual of your operating system for details on installing packages + for your specific operating system. </para> - <para>If you need to compile samba from source, check - <link linkend="compiling">the chapter about compiling samba from scratch</link>.</para> - - <para>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.</para> + <para>If you need to compile Samba from source, check + <link linkend="compiling"></link>.</para> </sect1> <sect1> - <title>Configuring samba (smb.conf)</title> + <title>Configuring Samba (smb.conf)</title> <para> - Samba's configuration is stored in the &smb.conf; file, - that usually resides in <filename>/etc/samba/smb.conf</filename> + Samba's configuration is stored in the &smb.conf; file, which + usually resides in <filename>/etc/samba/smb.conf</filename> or <filename>/usr/local/samba/lib/smb.conf</filename>. You can either edit this file yourself or do it using one of the many graphical - tools that are available, such as the web-based interface swat, that - is included with samba. + tools that are available, such as the Web-based interface SWAT, that + is included with Samba. </para> + + <sect2> + <title>Configuration file syntax</title> + + <para>The &smb.conf; file uses the same syntax as the various old + .ini files in Windows 3.1: Each file consists of various sections, + which are started by putting the section name between brackets ([]) + on a new line. Each contains zero or more key/value-pairs seperated by an + equality sign (=). The file is just a plain-text file, so you can + open and edit it with your favorite editing tool.</para> + + <para>Each section in the &smb.conf; file represents a share + on the Samba server. The section <quote>global</quote> is special, since it + contains settings that apply to the whole Samba server and not + to one share in particular.</para> + +<para><link linkend="smbconfminimal"/> contains a very minimal &smb.conf;. + <indexterm><primary>minimal configuration</primary></indexterm> +</para> + + <smbconfexample id="smbconfminimal"> + <title>A minimal smb.conf</title> + + <smbconfsection>[global]</smbconfsection> + <smbconfoption><name>workgroup</name><value>WKG</value></smbconfoption> + <smbconfoption><name>netbios name</name><value>MYNAME</value></smbconfoption> + <smbconfsection>[share1]</smbconfsection> + <smbconfoption><name>path</name><value>/tmp</value></smbconfoption> + + <smbconfsection>[share2]</smbconfsection> + <smbconfoption><name>path</name><value>/my_shared_folder</value></smbconfoption> + <smbconfoption><name>comment</name><value>Some random files</value></smbconfoption> + </smbconfexample> + +</sect2> <sect2> <title>Example Configuration</title> <para> There are sample configuration files in the examples subdirectory in the - distribution. I suggest you read them carefully so you can see how the options - go together in practice. See the man page for all the options. + distribution. It is suggested you read them carefully so you can see how the options + go together in practice. See the man page for all the options. + It might be worthwhile to start out with the smb.conf.default + configuration file and adapt it to your needs. It contains plenty of + comments. </para> <para> - The simplest useful configuration file would be something like this: + The simplest useful configuration file would contain something like shown in + <link linkend="simple-example"></link>. </para> <para> - <smbconfexample> - <title>Simplest possible smb.conf file</title> + <indexterm><primary>simple configuration</primary></indexterm> + <smbconfexample id="simple-example"> + <title>Another simple smb.conf File</title> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption> @@ -68,36 +106,41 @@ <para> This will allow connections by anyone with an account on the server, using either - their login name or <smbconfsection>homes</smbconfsection>" as the service name. - (Note that the workgroup that Samba must also be set.) + their login name or <smbconfsection>homes</smbconfsection> as the service name. + (Note: The workgroup that Samba should appear in must also be set. The default + workgroup name is WORKGROUP.) </para> <para> - Make sure you put the &smb.conf; file in the correct place - (usually in <filename>/etc/samba</filename>). + Make sure you put the &smb.conf; file in the correct place. </para> <para> For more information about security settings for the <smbconfsection>[homes]</smbconfsection> share please refer to - <link linkend="securing-samba">"Securing Samba"</link>. + <link linkend="securing-samba"></link>. </para> <sect3> - <title>Test your config file with <command>testparm</command></title> + <title>Test Your Config File with <command>testparm</command></title> <para> - 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. + It's important to validate the contents of the &smb.conf; file using the &testparm; program. + If testparm runs correctly, it will list the loaded services. If not, it will give an error message. + Make sure it runs correctly and that the services look reasonable before proceeding. Enter the command: </para> - <para> - Make sure it runs OK and that the services look reasonable before proceeding. - </para> + <screen> + &rootprompt; testparm /etc/samba/smb.conf + </screen> + + <para>Testparm will parse your configuration file and report + any unknown parameters or incorrect syntax. </para> + + <para> - Always run testparm again when you change &smb.conf;! + Always run testparm again whenever the &smb.conf; file is changed! </para> </sect3> @@ -107,68 +150,68 @@ <title>SWAT</title> <para> - SWAT is a web-based interface that helps you configure samba. - SWAT might not be available in the samba package on your platform, - but in a separate package. Please read the swat manpage - on compiling, installing and configuring swat from source. + <indexterm><primary>swat</primary></indexterm> + SWAT is a Web-based interface that can be used to facilitate the configuration of Samba. + SWAT might not be available in the Samba package that shipped with your platform, + but in a separate package. Please read the SWAT manpage + on compiling, installing and configuring SWAT from source. </para> <para> - To launch SWAT just run your favorite web browser and - point it at <ulink url="http://localhost:901/" noescape="1">http://localhost:901/</ulink>. Replace - <replaceable>localhost</replaceable> - with the name of the computer you are running samba on if you - are running samba on a different computer than your browser. + To launch SWAT, just run your favorite Web browser and point it to + <ulink url="http://localhost:901/" noescape="1">http://localhost:901/</ulink>. + Replace <replaceable>localhost</replaceable> with the name of the computer on which + Samba is running if that is a different computer than your browser. </para> <para> - Note that you can attach to SWAT from any IP connected - machine but connecting from a remote machine leaves your - connection open to password sniffing as passwords will be sent - in the clear over the wire. + SWAT can be used from a browser on any IP-connected machine, but be aware that connecting from a remote + machine leaves your connection open to password sniffing as passwords will be sent over the wire in the clear. </para> + + <para>More information about SWAT can be found in <link linkend="SWAT"/>.</para> + </sect2> + </sect1> <sect1> - <title>Try listing the shares available on your - server</title> + <title>List Shares Available on the Server</title> + + <para> + To list shares that are available from the configured Samba server execute the + following command: + </para> <para><screen> &prompt;<userinput>smbclient -L <replaceable>yourhostname</replaceable></userinput> </screen></para> - <para>You should get back a list of shares available on - your server. If you don't then something is incorrectly setup. - Note that this method can also be used to see what shares - are available on other LanManager clients (such as WfWg).</para> - - <para>If you choose user level security then you may find - that Samba requests a password before it will list the shares. - See the <command>smbclient</command> man page for details. (you - can force it to list the shares without a password by - adding the option -U% to the command line. This will not work - with non-Samba servers)</para> + <para>You should see a list of shares available on your server. If you do not, then + something is incorrectly configured. This method can also be used to see what shares + are available on other SMB servers, such as Windows 2000.</para> + + <para>If you choose user-level security you may find that Samba requests a password + before it will list the shares. See the <command>smbclient</command> man page for details. + You can force it to list the shares without a password by adding the option + <option>-N</option> to the command line. </para> </sect1> <sect1> - <title>Try connecting with the unix client</title> + <title>Connect with a UNIX Client</title> <para> + Enter the following command: <screen> &prompt;<userinput>smbclient <replaceable> //yourhostname/aservice</replaceable></userinput> </screen></para> - <para>Typically the <replaceable>yourhostname</replaceable> - would be the name of the host where you installed &smbd;. - The <replaceable>aservice</replaceable> is - any service you have defined in the &smb.conf; - file. Try your user name if you just have a <smbconfsection>[homes]</smbconfsection> - section - in &smb.conf;.</para> + <para>Typically <replaceable>yourhostname</replaceable> is the name of the host on which &smbd; + has been installed. The <replaceable>aservice</replaceable> is any service that has been defined in the &smb.conf; + file. Try your user name if you just have a <smbconfsection>[homes]</smbconfsection> section in the &smb.conf; file.</para> - <para>For example if your unix host is <replaceable>bambi</replaceable> - and your login name is <replaceable>fred</replaceable> you would type:</para> + <para>Example: If the UNIX host is called <replaceable>bambi</replaceable> and a valid login name + is <replaceable>fred</replaceable>, you would type:</para> <para><screen> &prompt;<userinput>smbclient //<replaceable>bambi</replaceable>/<replaceable>fred</replaceable></userinput> @@ -176,15 +219,21 @@ </sect1> <sect1> - <title>Try connecting from another SMB client</title> + <title>Connect from a Remote SMB Client</title> + + <para>Now that Samba is working correctly locally, you can try to + access it from other clients. Within a few minutes, the Samba host + should be listed in the Network Neighborhood on all Windows + clients of its subnet. Try browsing the server from another client + or 'mounting' it.</para> - <para>Try mounting disks. from a DOS, Windows or OS/2 client, eg:</para> + <para>Mounting disks from a DOS, Windows or OS/2 client can be done by running a command such as:</para> <para><screen> &dosprompt;<userinput>net use d: \\servername\service</userinput> </screen></para> - <para>Try printing. eg:</para> + <para>Try printing, e.g.</para> <para> <screen> @@ -199,10 +248,12 @@ <sect1> <title>What If Things Don't Work?</title> - <para>Then you might read the file chapter <link linkend="diagnosis">diagnosis</link> - and the FAQ. If you are still stuck then refer to <link linkend="problems">"Analysing and solving problems"</link>. - Samba has been successfully installed at thousands of sites worldwide, - so maybe someone else has hit your problem and has overcome it.</para> + <para>You might want to read <link linkend="diagnosis"></link>. + If you are still stuck, refer to <link linkend="problems"></link>. + Samba has been successfully installed at thousands of sites worldwide. + It is unlikely that your particular problem is unique, so it might be + productive to perform an Internet search to see if someone else has encountered + your problem and has found a way to overcome it.</para> </sect1> @@ -210,55 +261,62 @@ <title>Common Errors</title> <para> -The following questions and issues get raised on the samba mailing list over and over again. +The following questions and issues are raised repeatedly on the Samba mailing list. </para> <sect2> - <title>Large number of smbd processes</title> + <title>Large Number of smbd Processes</title> <para> -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. +Samba consists of three core programs: &nmbd;, &smbd;, and &winbindd;. &nmbd; is the name server message daemon, +&smbd; is the server message daemon, and &winbindd; is the daemon that handles communication with Domain Controllers. </para> <para> -If your system is NOT running as a WINS server, then there will be one (1) single instance of +If Samba is <emphasis>not</emphasis> running as a WINS server, then there will be one single instance of &nmbd; running on your system. If it is running as a WINS server then there will be -two (2) instances - one to handle the WINS requests. +two instances &smbmdash; one to handle the WINS requests. </para> <para> -&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. +&smbd; handles all connection requests. It spawns a new process for each client +connection made. That is why you may see so many of them, one per client connection. </para> <para> &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). +run in <emphasis>split mode</emphasis> (in which case there will be two instances). </para> </sect2> <sect2> - <title>"open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested"</title> - <para>Your loopback device isn't working correctly. Make sure it's configured properly. The loopback device is an internal (virtual) network device with - the ip address 127.0.0.1. Read your OS documentation for details - on how to configure the loopback on your system.</para> + <title>Error Message: open_oplock_ipc</title> + + <para>An error message is observed in the log files when &smbd; is started: <quote>open_oplock_ipc: Failed to get local UDP socket + for address 100007f. Error was Cannot assign requested.</quote></para> + + <para>Your loopback device isn't working correctly. Make sure it is configured correctly. The loopback + device is an internal (virtual) network device with the IP address <emphasis>127.0.0.1</emphasis>. + Read your OS documentation for details on how to configure the loopback on your system.</para> + </sect2> <sect2> - <title>"<errorname>The network name cannot be found</errorname>"</title> + <title><quote><errorname>The network name cannot be found</errorname></quote></title> <para> - This error can be caused by one of these misconfigurations: + This error can be caused by one of these misconfigurations: </para> <itemizedlist> - <listitem><para>You specified an nonexisting <smbconfoption><name>path</name></smbconfoption> for the share in &smb.conf; </para></listitem> + <listitem><para>You specified an nonexisting path + for the share in &smb.conf;.</para></listitem> + <listitem><para>The user you are trying to access the share with does not - have sufficient permissions to access the <smbconfoption><name>path</name></smbconfoption> for the share. Both read (r) and access (x) should be possible.</para></listitem> + have sufficient permissions to access the path for + the share. Both read (r) and access (x) should be possible.</para></listitem> + <listitem><para>The share you are trying to access does not exist.</para></listitem> </itemizedlist> diff --git a/docs/docbook/projdoc/VFS.xml b/docs/docbook/projdoc/VFS.xml index c949055371..58bb64d3ef 100644 --- a/docs/docbook/projdoc/VFS.xml +++ b/docs/docbook/projdoc/VFS.xml @@ -2,7 +2,7 @@ <chapterinfo> &author.jelmer; &author.jht; - <author><firstname>Tim</firstname><surname>Potter</surname></author> + &author.tpot; <author><firstname>Simo</firstname><surname>Sorce</surname><contrib>original vfs_skel README</contrib></author> <author><firstname>Alexander</firstname><surname>Bokovoy</surname><contrib>original vfs_netatalk docs</contrib></author> <author><firstname>Stefan</firstname><surname>Metzmacher</surname><contrib>Update for multiple modules</contrib></author> @@ -13,9 +13,9 @@ <title>Features and Benefits</title> <para> -Since Samba-3, there is support for stackable VFS(Virtual File System) modules. -Samba passes each request to access the unix file system thru the loaded VFS modules. -This chapter covers all the modules that come with the samba source and references to +Since Samba-3, there is support for stackable VFS (Virtual File System) modules. +Samba passes each request to access the UNIX file system through the loaded VFS modules. +This chapter covers all the modules that come with the Samba source and references to some external modules. </para> @@ -27,17 +27,17 @@ some external modules. <para> If not supplied with your platform distribution binary Samba package you may have problems -to compile these modules, as shared libraries are compiled and linked in different ways -on different systems. They currently have been tested against GNU/Linux and IRIX. +compiling these modules, as shared libraries are compiled and linked in different ways +on different systems. They currently have been tested against GNU/Linux and IRIX. </para> <para> -To use the VFS modules, create a share similar to the one below. The +To use the VFS modules, create a share similar to the one below. The important parameter is the <smbconfoption><name>vfs objects</name></smbconfoption> parameter where you can list one or more VFS modules by name. For example, to log all access -to files and put deleted files in a recycle bin: +to files and put deleted files in a recycle bin, see <link linkend="vfsrecyc"/>. -<smbconfexample> +<smbconfexample id="vfsrecyc"> <title>smb.conf with VFS modules</title> <smbconfsection>[audit]</smbconfsection> <smbconfoption><name>comment</name><value>Audited /data directory</value></smbconfoption> @@ -53,17 +53,16 @@ The modules are used in the order in which they are specified. </para> <para> -Samba will attempt to load modules from the <emphasis>lib</emphasis> -directory in the root directory of the samba installation (usually -<filename>/usr/lib/samba/vfs</filename> or <filename>/usr/local/samba/lib/vfs +Samba will attempt to load modules from the <filename>/lib</filename> directory in the root directory of the +Samba installation (usually <filename>/usr/lib/samba/vfs</filename> or <filename>/usr/local/samba/lib/vfs </filename>). </para> <para> Some modules can be used twice for the same share. -This can be done using a configuration similar to the one below. +This can be done using a configuration similar to the one shown in <link linkend="multimodule"/>. -<smbconfexample> +<smbconfexample id="multimodule"> <title>smb.conf with multiple VFS modules</title> <smbconfsection>[test]</smbconfsection> <smbconfoption><name>comment</name><value>VFS TEST</value></smbconfoption> @@ -80,19 +79,19 @@ This can be done using a configuration similar to the one below. </sect1> <sect1> -<title>Included modules</title> +<title>Included Modules</title> <sect2> <title>audit</title> <para> A simple module to audit file access to the syslog - facility. The following operations are logged: + facility. The following operations are logged: <itemizedlist> - <listitem><para>share</para></listitem> - <listitem><para>connect/disconnect</para></listitem> - <listitem><para>directory opens/create/remove</para></listitem> - <listitem><para>file open/close/rename/unlink/chmod</para></listitem> + <listitem>share</listitem> + <listitem>connect/disconnect</listitem> + <listitem>directory opens/create/remove</listitem> + <listitem>file open/close/rename/unlink/chmod</listitem> </itemizedlist> </para> @@ -102,18 +101,17 @@ This can be done using a configuration similar to the one below. <title>extd_audit</title> <para> - This module is identical with the <emphasis>audit</emphasis> module above except - that it sends audit logs to both syslog as well as the smbd log file/s. The - loglevel for this module is set in the smb.conf file. + This module is identical with the <command>audit</command> module above except + that it sends audit logs to both syslog as well as the <command>smbd</command> log files. The + <smbconfoption><name>log level</name></smbconfoption> for this module is set in the &smb.conf; file. </para> <para> - The logging information that will be written to the smbd log file is controlled by - the <smbconfoption><name>log level</name></smbconfoption> parameter in &smb.conf;. The - following information will be recorded: + Valid settings and the information that will be recorded are shown in <link linkend="xtdaudit"/>. </para> - <table frame="all"><title>Extended Auditing Log Information</title> + <table frame="all" id="xtdaudit"> + <title>Extended Auditing Log Information</title> <tgroup cols="2" align="center"> <thead> <row><entry align="center">Log Level</entry><entry>Log Details - File and Directory Operations</entry></row> @@ -128,12 +126,12 @@ This can be done using a configuration similar to the one below. </sect2> - <sect2> + <sect2 id="fakeperms"> <title>fake_perms</title> <para> This module was created to allow Roaming Profile files and directories to be set (on the Samba server - under Unix) as read only. This module will if installed on the Profiles share will report to the client + under UNIX) as read only. This module will, if installed on the Profiles share, report to the client that the Profile files and directories are writable. This satisfies the client even though the files will never be overwritten as the client logs out or shuts down. </para> @@ -144,67 +142,82 @@ This can be done using a configuration similar to the one below. <title>recycle</title> <para> - A recycle-bin like module. When used any unlink call - will be intercepted and files moved to the recycle - directory instead of being deleted. This gives the same - effect as the "Recycle Bin" on Windows computers. + A Recycle Bin-like module. Where used, unlink calls will be intercepted and files moved + to the recycle directory instead of being deleted. This gives the same effect as the + <guiicon>Recycle Bin</guiicon> on Windows computers. + </para> + + <para> + The <guiicon>Recycle Bin</guiicon> will not appear in <application>Windows Explorer</application> views of the network file system + (share) nor on any mapped drive. Instead, a directory called <filename>.recycle</filename> will be + automatically created when the first file is deleted. Users can recover files from the + <filename>.recycle</filename> directory. If the <parameter>recycle:keeptree</parameter> has been + specified, deleted files will be found in a path identical with that from which the file was deleted. </para> - <para>Supported options: + <para>Supported options for the <command>recycle</command> module are as follow: <variablelist> <varlistentry> <term>recycle:repository</term> - <listitem><para>Relative path of the directory where deleted files should be moved to</para></listitem> + <listitem><para> + Relative path of the directory where deleted files should be moved. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:keeptree</term> - <listitem><para>Specifies whether the directory structure should - be kept or if the files in the directory that is being - deleted should be kept seperately in the recycle bin. - </para></listitem> + <listitem><para> + Specifies whether the directory structure should be kept or if the files in the directory that is being + deleted should be kept seperately in the recycle bin. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:versions</term> - <listitem><para>If this option is set, two files - with the same name that are deleted will both - be kept in the recycle bin. Newer deleted versions - of a file will be called "Copy #x of <replaceable>filename</replaceable>".</para></listitem> + <listitem><para> + If this option is set, two files + with the same name that are deleted will both + be kept in the recycle bin. Newer deleted versions + of a file will be called <quote>Copy #x of <replaceable>filename</replaceable></quote>. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:touch</term> - <listitem><para>Specifies whether a file's access - date should be touched when the file is moved to - the recycle bin.</para></listitem> + <listitem><para> + Specifies whether a file's access date should be touched when the file is moved to the recycle bin. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:maxsize</term> - <listitem><para>Files that are larger than the number - of bytes specified by this parameter will - not be put into the recycle bin.</para></listitem> + <listitem><para> + Files that are larger than the number of bytes specified by this parameter will not be put into the recycle bin. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:exclude</term> - <listitem><para>List of files that should not - be put into the recycle bin when deleted, but deleted - in the regular way.</para></listitem> + <listitem><para> + List of files that should not be put into the recycle bin when deleted, but deleted in the regular way. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:exclude_dir</term> - <listitem><para>Contains a list of directories. When files from - these directories are deleted, they are not put into the - recycle bin, but deleted in the regular way. - </para></listitem> + <listitem><para> + Contains a list of directories. When files from these directories are + deleted, they are not put into the + recycle bin but are deleted in the + regular way. + </para></listitem> </varlistentry> <varlistentry> <term>recycle:noversions</term> - <listitem><para>Opposite of <parameter>recycle:versions</parameter>. If both options are specified, this one takes precedence.</para></listitem> + <listitem><para> + Opposite of <parameter>recycle:versions</parameter>. If both options are specified, this one takes precedence. + </para></listitem> </varlistentry> </variablelist> </para> @@ -215,14 +228,13 @@ This can be done using a configuration similar to the one below. <title>netatalk</title> <para> - A netatalk module, that will ease co-existence of samba and - netatalk file sharing services. + A netatalk module will ease co-existence of Samba and netatalk file sharing services. </para> <para>Advantages compared to the old netatalk module: <itemizedlist> - <listitem><para>it doesn't care about creating of .AppleDouble forks, just keeps them in sync</para></listitem> - <listitem><para>if a share in &smb.conf; doesn't contain .AppleDouble item in hide or veto list, it will be added automatically</para></listitem> + <listitem><para>Does not care about creating .AppleDouble forks, just keeps them in sync.</para></listitem> + <listitem><para>If a share in &smb.conf; does not contain .AppleDouble item in hide or veto list, it will be added automatically.</para></listitem> </itemizedlist> </para> @@ -231,12 +243,12 @@ This can be done using a configuration similar to the one below. </sect1> <sect1> -<title>VFS modules available elsewhere</title> +<title>VFS Modules Available Elsewhere</title> <para> This section contains a listing of various other VFS modules that -have been posted but don't currently reside in the Samba CVS -tree for one reason or another (e.g. it is easy for the maintainer +have been posted but do not currently reside in the Samba CVS +tree for one reason or another (e.g., it is easy for the maintainer to have his or her own CVS tree). </para> @@ -252,22 +264,23 @@ should be implied due to its presence here. URL: <ulink noescape="1" url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink> </para> - <para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer</ulink>.</para> + <para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer.</ulink></para> <para> - I have created a VFS module which implements a fairly complete read-only - filesystem. It presents information from a database as a filesystem in + I have created a VFS module that implements a fairly complete read-only + filesystem. It presents information from a database as a filesystem in a modular and generic way to allow different databases to be used (originally designed for organizing MP3s under directories such as - "Artists," "Song Keywords," etc... I have since applied it to a student - roster database very easily). The directory structure is stored in the + <quote>Artists,</quote> <quote>Song Keywords,</quote> and so on. I have since easily + applied it to a student + roster database.) The directory structure is stored in the database itself and the module makes no assumptions about the database structure beyond the table it requires to run. </para> <para> Any feedback would be appreciated: comments, suggestions, patches, - etc... If nothing else, hopefully it might prove useful for someone + and so on. If nothing else, hopefully it might prove useful for someone else who wishes to create a virtual filesystem. </para> @@ -279,10 +292,10 @@ should be implied due to its presence here. <para>URL: <ulink noescape="1" url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para> <para> - samba-vscan is a proof-of-concept module for Samba, which + <filename>samba-vscan</filename> is a proof-of-concept module for Samba, which uses the VFS (virtual file system) features of Samba 2.2.x/3.0 alphaX. Of course, Samba has to be compiled with VFS support. - samba-vscan supports various virus scanners and is maintained + <filename>samba-vscan</filename> supports various virus scanners and is maintained by Rainer Link. </para> diff --git a/docs/docbook/projdoc/locking.xml b/docs/docbook/projdoc/locking.xml index 17dc518226..8bdb06ca8f 100644 --- a/docs/docbook/projdoc/locking.xml +++ b/docs/docbook/projdoc/locking.xml @@ -8,8 +8,8 @@ <title>File and Record Locking</title> <para> -One area which causes trouble for many network administrators is locking. -The extent of the problem is readily evident from searches over the internet. +One area that causes trouble for many network administrators is locking. +The extent of the problem is readily evident from searches over the Internet. </para> <sect1> @@ -17,7 +17,7 @@ The extent of the problem is readily evident from searches over the internet. <para> Samba provides all the same locking semantics that MS Windows clients expect -and that MS Windows NT4 / 200x servers provide also. +and that MS Windows NT4/200x servers also provide. </para> <para> @@ -27,10 +27,10 @@ a range of functions that are all categorized under this one term. <para> Opportunistic locking is a desirable feature when it can enhance the -perceived performance of applications on a networked client. However, the -opportunistic locking protocol is not robust, and therefore can -encounter problems when invoked beyond a simplistic configuration, or -on extended, slow, or faulty networks. In these cases, operating +perceived performance of applications on a networked client. However, the +opportunistic locking protocol is not robust and, therefore, can +encounter problems when invoked beyond a simplistic configuration or +on extended slow or faulty networks. In these cases, operating system management of opportunistic locking and/or recovering from repetitive errors can offset the perceived performance advantage that it is intended to provide. @@ -38,13 +38,13 @@ it is intended to provide. <para> The MS Windows network administrator needs to be aware that file and record -locking semantics (behaviour) can be controlled either in Samba or by way of registry +locking semantics (behavior) can be controlled either in Samba or by way of registry settings on the MS Windows client. </para> <note> <para> -Sometimes it is necessary to disable locking control settings BOTH on the Samba +Sometimes it is necessary to disable locking control settings on both the Samba server as well as on each MS Windows client! </para> </note> @@ -55,45 +55,46 @@ server as well as on each MS Windows client! <title>Discussion</title> <para> -There are two types of locking which need to be performed by a SMB server. -The first is <emphasis>record locking</emphasis> which allows a client to lock -a range of bytes in a open file. The second is the <emphasis>deny modes</emphasis> +There are two types of locking that need to be performed by an SMB server. +The first is <emphasis>record locking</emphasis> that allows a client to lock +a range of bytes in a open file. The second is the <emphasis>deny modes</emphasis> that are specified when a file is open. </para> <para> Record locking semantics under UNIX are very different from record locking under -Windows. Versions of Samba before 2.2 have tried to use the native fcntl() unix +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 +This cannot be fully correct for 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. +depending on the client OS. The UNIX locking only supports byte ranges up to 2^31. So it is not possible to correctly satisfy a lock request above 2^31. There are many more differences, too many to be listed here. </para> <para> Samba 2.2 and above implements record locking completely independent of the -underlying unix system. If a byte range lock that the client requests happens -to fall into the range 0-2^31, Samba hands this request down to the UNIX system. -All other locks can not be seen by unix anyway. +underlying UNIX system. If a byte range lock that the client requests happens +to fall into the range of 0-2^31, Samba hands this request down to the UNIX system. +All other locks cannot be seen by UNIX, anyway. </para> <para> -Strictly an SMB server should check for locks before every read and write call on -a file. Unfortunately with the way fcntl() works this can be slow and may over-stress -the <command>rpc.lockd</command>. 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 <smbconfoption><name>strict locking</name><value>yes</value></smbconfoption> then it -will make lock checking calls on every read and write. +Strictly speaking, an SMB server should check for locks before every read and write call on +a file. Unfortunately with the way fcntl() works, this can be slow and may overstress +the <command>rpc.lockd</command>. This is almost always unnecessary as clients are supposed to +independently make locking calls before reads and writes if locking is +important to them. By default, Samba only makes locking calls when explicitly asked +to by a client, but if you set <smbconfoption><name>strict locking</name><value>yes</value></smbconfoption>, it +will make lock checking calls on <emphasis>every</emphasis> read and write call. </para> <para> -You can also disable byte range locking completely using <smbconfoption><name>locking</name><value>no</value></smbconfoption>. -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. +You can also disable byte range locking completely by using +<smbconfoption><name>locking</name><value>no</value></smbconfoption>. +This is useful for those shares that do not support locking or do not need it +(such as CDROMs). In this case, Samba fakes the return codes of locking calls to +tell clients that everything is okay. </para> <para> @@ -101,7 +102,7 @@ The second class of locking is the <emphasis>deny modes</emphasis>. These are set by an application when it opens a file to determine what types of access should be allowed simultaneously with its open. A client may ask for <constant>DENY_NONE</constant>, <constant>DENY_READ</constant>, -<constant>DENY_WRITE</constant> or <constant>DENY_ALL</constant>. There are also special compatibility +<constant>DENY_WRITE</constant>, or <constant>DENY_ALL</constant>. There are also special compatibility modes called <constant>DENY_FCB</constant> and <constant>DENY_DOS</constant>. </para> @@ -110,57 +111,58 @@ modes called <constant>DENY_FCB</constant> and <constant>DENY_DOS</constant>. <para> Opportunistic locking (Oplocks) is invoked by the Windows file system -(as opposed to an API) via registry entries (on the server AND client) +(as opposed to an API) via registry entries (on the server and the client) for the purpose of enhancing network performance when accessing a file residing on a server. Performance is enhanced by caching the file -locally on the client which allows: +locally on the client that allows: </para> <variablelist> <varlistentry><term>Read-ahead:</term> <listitem><para> - The client reads the local copy of the file, eliminating network latency + The client reads the local copy of the file, eliminating network latency. </para></listitem> </varlistentry> <varlistentry><term>Write caching:</term> <listitem><para> - The client writes to the local copy of the file, eliminating network latency + The client writes to the local copy of the file, eliminating network latency. </para></listitem> </varlistentry> <varlistentry><term>Lock caching:</term> <listitem><para> - The client caches application locks locally, eliminating network latency + The client caches application locks locally, eliminating network latency. </para></listitem> </varlistentry> </variablelist> <para> The performance enhancement of oplocks is due to the opportunity of -exclusive access to the file - even if it is opened with deny-none - +exclusive access to the file &smbmdash; even if it is opened with deny-none &smbmdash; because Windows monitors the file's status for concurrent access from other processes. </para> <variablelist> <title>Windows defines 4 kinds of Oplocks:</title> - <varlistentry><term>Level1 Oplock:</term> + + <varlistentry><term>Level1 Oplock</term> <listitem><para> The redirector sees that the file was opened with deny none (allowing concurrent access), verifies that no other process is accessing the file, checks that oplocks are enabled, then grants deny-all/read-write/exclusive - access to the file. The client now performs + access to the file. The client now performs operations on the cached local file. </para> <para> If a second process attempts to open the file, the open - is deferred while the redirector "breaks" the original - oplock. The oplock break signals the caching client to + is deferred while the redirector <quote>breaks</quote> the original + oplock. The oplock break signals the caching client to write the local file back to the server, flush the - local locks, and discard read-ahead data. The break is + local locks and discard read-ahead data. The break is then complete, the deferred open is granted, and the multiple processes can enjoy concurrent file access as dictated by mandatory or byte-range locking options. @@ -171,60 +173,60 @@ other processes. </para></listitem> </varlistentry> - <varlistentry><term>Level2 Oplock:</term> + <varlistentry><term>Level2 Oplock</term> <listitem><para> - Performs like a level1 oplock, except caching is only + Performs like a Level1 oplock, except caching is only operative for reads. All other operations are performed on the server disk copy of the file. </para></listitem> </varlistentry> - <varlistentry><term>Filter Oplock:</term> + <varlistentry><term>Filter Oplock</term> <listitem><para> - Does not allow write or delete file access + Does not allow write or delete file access. </para></listitem> </varlistentry> - <varlistentry><term>Batch Oplock:</term> + <varlistentry><term>Batch Oplock</term> <listitem><para> - Manipulates file openings and closings - allows caching - of file attributes + Manipulates file openings and closings and allows caching + of file attributes. </para></listitem> </varlistentry> </variablelist> <para> An important detail is that oplocks are invoked by the file system, not -an application API. Therefore, an application can close an oplocked -file, but the file system does not relinquish the oplock. When the +an application API. Therefore, an application can close an oplocked +file, but the file system does not relinquish the oplock. When the oplock break is issued, the file system then simply closes the file in preparation for the subsequent open by the second process. </para> <para> -<emphasis>Opportunistic Locking</emphasis> is actually an improper name for this feature. +<emphasis>Opportunistic locking</emphasis> is actually an improper name for this feature. The true benefit of this feature is client-side data caching, and oplocks is merely a notification mechanism for writing data back to the -networked storage disk. The limitation of opportunistic locking is the +networked storage disk. The limitation of opportunistic locking is the reliability of the mechanism to process an oplock break (notification) -between the server and the caching client. If this exchange is faulty -(usually due to timing out for any number of reasons) then the +between the server and the caching client. If this exchange is faulty +(usually due to timing out for any number of reasons), then the client-side caching benefit is negated. </para> <para> The actual decision that a user or administrator should consider is -whether it is sensible to share amongst multiple users data that will -be cached locally on a client. In many cases the answer is no. +whether it is sensible to share among multiple users data that will +be cached locally on a client. In many cases the answer is no. Deciding when to cache or not cache data is the real question, and thus -"opportunistic locking" should be treated as a toggle for client-side -caching. Turn it "ON" when client-side caching is desirable and -reliable. Turn it "OFF" when client-side caching is redundant, -unreliable, or counter-productive. +<quote>opportunistic locking</quote> should be treated as a toggle for client-side +caching. Turn it <quote>on</quote> when client-side caching is desirable and +reliable. Turn it <quote>off</quote> when client-side caching is redundant, +unreliable or counter-productive. </para> <para> -Opportunistic locking is by default set to "on" by Samba on all +Opportunistic locking is by default set to <quote>on</quote> by Samba on all configured shares, so careful attention should be given to each case to determine if the potential benefit is worth the potential for delays. The following recommendations will help to characterize the environment @@ -232,27 +234,27 @@ where opportunistic locking may be effectively configured. </para> <para> -Windows Opportunistic Locking is a lightweight performance-enhancing -feature. It is not a robust and reliable protocol. Every -implementation of Opportunistic Locking should be evaluated as a -tradeoff between perceived performance and reliability. Reliability -decreases as each successive rule above is not enforced. Consider a +Windows opportunistic locking is a lightweight performance-enhancing +feature. It is not a robust and reliable protocol. Every +implementation of opportunistic locking should be evaluated as a +tradeoff between perceived performance and reliability. Reliability +decreases as each successive rule above is not enforced. Consider a share with oplocks enabled, over a wide area network, to a client on a South Pacific atoll, on a high-availability server, serving a -mission-critical multi-user corporate database, during a tropical -storm. This configuration will likely encounter problems with oplocks. +mission-critical multi-user corporate database during a tropical +storm. This configuration will likely encounter problems with oplocks. </para> <para> Oplocks can be beneficial to perceived client performance when treated -as a configuration toggle for client-side data caching. If the data +as a configuration toggle for client-side data caching. If the data caching is likely to be interrupted, then oplock usage should be -reviewed. Samba enables opportunistic locking by default on all -shares. Careful attention should be given to the client usage of -shared data on the server, the server network reliability, and the +reviewed. Samba enables opportunistic locking by default on all +shares. Careful attention should be given to the client usage of +shared data on the server, the server network reliability and the opportunistic locking configuration of each share. -n mission critical high availability environments, data integrity is -often a priority. Complex and expensive configurations are implemented +In mission critical high availability environments, data integrity is +often a priority. Complex and expensive configurations are implemented to ensure that if a client loses connectivity with a file server, a failover replacement will be available immediately to provide continuous data availability. @@ -260,30 +262,30 @@ continuous data availability. <para> Windows client failover behavior is more at risk of application -interruption than other platforms because it is dependant upon an -established TCP transport connection. If the connection is interrupted -- as in a file server failover - a new session must be established. +interruption than other platforms because it is dependent upon an +established TCP transport connection. If the connection is interrupted +&smbmdash; as in a file server failover &smbmdash; a new session must be established. It is rare for Windows client applications to be coded to recover -correctly from a transport connection loss, therefore most applications -will experience some sort of interruption - at worst, abort and +correctly from a transport connection loss, therefore, most applications +will experience some sort of interruption &smbmdash; at worst, abort and require restarting. </para> <para> If a client session has been caching writes and reads locally due to opportunistic locking, it is likely that the data will be lost when the -application restarts, or recovers from the TCP interrupt. When the TCP -connection drops, the client state is lost. When the file server -recovers, an oplock break is not sent to the client. In this case, the -work from the prior session is lost. Observing this scenario with -oplocks disabled, and the client was writing data to the file server -real-time, then the failover will provide the data on disk as it +application restarts or recovers from the TCP interrupt. When the TCP +connection drops, the client state is lost. When the file server +recovers, an oplock break is not sent to the client. In this case, the +work from the prior session is lost. Observing this scenario with +oplocks disabled and with the client writing data to the file server +real-time, the failover will provide the data on disk as it existed at the time of the disconnect. </para> <para> -In mission critical high availability environments, careful attention -should be given to opportunistic locking. Ideally, comprehensive +In mission-critical high-availability environments, careful attention +should be given to opportunistic locking. Ideally, comprehensive testing should be done with all affected applications with oplocks enabled and disabled. </para> @@ -294,7 +296,7 @@ enabled and disabled. <para> Opportunistic locking is most effective when it is confined to shares that are exclusively accessed by a single user, or by only one user at -a time. Because the true value of opportunistic locking is the local +a time. Because the true value of opportunistic locking is the local client caching of data, any operation that interrupts the caching mechanism will cause a delay. </para> @@ -312,10 +314,10 @@ benefit of opportunistic locking can be safely realized. <para> As each additional user accesses a file in a share with opportunistic locking enabled, the potential for delays and resulting perceived poor -performance increases. When multiple users are accessing a file on a +performance increases. When multiple users are accessing a file on a share that has oplocks enabled, the management impact of sending and -receiving oplock breaks, and the resulting latency while other clients -wait for the caching client to flush data, offset the performance gains +receiving oplock breaks and the resulting latency while other clients +wait for the caching client to flush data offset the performance gains of the caching user. </para> @@ -328,11 +330,11 @@ in a performance bottleneck. </sect3> <sect3> -<title>UNIX or NFS Client Accessed Files</title> +<title>UNIX or NFS Client-Accessed Files</title> <para> Local UNIX and NFS clients access files without a mandatory -file locking mechanism. Thus, these client platforms are incapable of +file-locking mechanism. Thus, these client platforms are incapable of initiating an oplock break request from the server to a Windows client that has a file cached. Local UNIX or NFS file access can therefore write to a file that has been cached by a Windows client, which @@ -341,7 +343,7 @@ exposes the file to likely data corruption. <para> If files are shared between Windows clients, and either local UNIX -or NFS users, then turn opportunistic locking off. +or NFS users, turn opportunistic locking off. </para> </sect3> @@ -354,8 +356,8 @@ The biggest potential performance improvement for opportunistic locking occurs when the client-side caching of reads and writes delivers the most differential over sending those reads and writes over the wire. This is most likely to occur when the network is extremely slow, -congested, or distributed (as in a WAN). However, network latency also -has a very high impact on the reliability of the oplock break +congested, or distributed (as in a WAN). However, network latency also +has a high impact on the reliability of the oplock break mechanism, and thus increases the likelihood of encountering oplock problems that more than offset the potential perceived performance gain. Of course, if an oplock break never has to be sent, then this is @@ -374,11 +376,11 @@ regularly opening the same file. <title>Multi-User Databases</title> <para> -Multi-user databases clearly pose a risk due to their very nature - +Multi-user databases clearly pose a risk due to their very nature &smbmdash; they are typically heavily accessed by numerous users at random -intervals. Placing a multi-user database on a share with opportunistic +intervals. Placing a multi-user database on a share with opportunistic locking enabled will likely result in a locking management bottleneck -on the Samba server. Whether the database application is developed +on the Samba server. Whether the database application is developed in-house or a commercially available product, ensure that the share has opportunistic locking disabled. </para> @@ -389,15 +391,15 @@ has opportunistic locking disabled. <title>PDM Data Shares</title> <para> -Process Data Management (PDM) applications such as IMAN, Enovia, and -Clearcase, are increasing in usage with Windows client platforms, and -therefore SMB data stores. PDM applications manage multi-user -environments for critical data security and access. The typical PDM +Process Data Management (PDM) applications such as IMAN, Enovia and +Clearcase are increasing in usage with Windows client platforms, and +therefore SMB datastores. PDM applications manage multi-user +environments for critical data security and access. The typical PDM environment is usually associated with sophisticated client design -applications that will load data locally as demanded. In addition, the +applications that will load data locally as demanded. In addition, the PDM application will usually monitor the data-state of each client. In this case, client-side data caching is best left to the local -application and PDM server to negotiate and maintain. It is +application and PDM server to negotiate and maintain. It is appropriate to eliminate the client OS from any caching tasks, and the server from any oplock management, by disabling opportunistic locking on the share. @@ -411,11 +413,11 @@ the share. <para> Samba includes an &smb.conf; parameter called <smbconfoption><name>force user</name></smbconfoption> that changes the user accessing a share from the incoming user to whatever user is -defined by the smb.conf variable. If opportunistic locking is enabled +defined by the smb.conf variable. If opportunistic locking is enabled on a share, the change in user access causes an oplock break to be sent -to the client, even if the user has not explicitly loaded a file. In +to the client, even if the user has not explicitly loaded a file. In cases where the network is slow or unreliable, an oplock break can -become lost without the user even accessing a file. This can cause +become lost without the user even accessing a file. This can cause apparent performance degradation as the client continually reconnects to overcome the lost oplock break. </para> @@ -434,7 +436,7 @@ Avoid the combination of the following: </para></listitem> <listitem><para> - Opportunistic Locking Enabled + Opportunistic locking enabled </para></listitem> </itemizedlist> @@ -446,29 +448,29 @@ Avoid the combination of the following: <para> Samba provides opportunistic locking parameters that allow the administrator to adjust various properties of the oplock mechanism to -account for timing and usage levels. These parameters provide good +account for timing and usage levels. These parameters provide good versatility for implementing oplocks in environments where they would -likely cause problems. The parameters are: +likely cause problems. The parameters are: <smbconfoption><name>oplock break wait time</name></smbconfoption>, <smbconfoption><name>oplock contention limit</name></smbconfoption>. </para> <para> -For most users, administrators, and environments, if these parameters +For most users, administrators and environments, if these parameters are required, then the better option is to simply turn oplocks off. -The samba SWAT help text for both parameters reads "DO NOT CHANGE THIS -PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE." +The Samba SWAT help text for both parameters reads: <quote>Do not change +this parameter unless you have read and understood the Samba oplock code.</quote> This is good advice. </para> </sect3> <sect3> -<title>Mission Critical High Availability</title> +<title>Mission-Critical High-Availability</title> <para> -In mission critical high availability environments, data integrity is -often a priority. Complex and expensive configurations are implemented +In mission-critical high-availability environments, data integrity is +often a priority. Complex and expensive configurations are implemented to ensure that if a client loses connectivity with a file server, a failover replacement will be available immediately to provide continuous data availability. @@ -477,11 +479,11 @@ continuous data availability. <para> Windows client failover behavior is more at risk of application interruption than other platforms because it is dependant upon an -established TCP transport connection. If the connection is interrupted -- as in a file server failover - a new session must be established. +established TCP transport connection. If the connection is interrupted +&smbmdash; as in a file server failover &smbmdash; a new session must be established. It is rare for Windows client applications to be coded to recover -correctly from a transport connection loss, therefore most applications -will experience some sort of interruption - at worst, abort and +correctly from a transport connection loss, therefore, most applications +will experience some sort of interruption &smbmdash; at worst, abort and require restarting. </para> @@ -489,18 +491,18 @@ require restarting. If a client session has been caching writes and reads locally due to opportunistic locking, it is likely that the data will be lost when the application restarts, or recovers from the TCP interrupt. When the TCP -connection drops, the client state is lost. When the file server -recovers, an oplock break is not sent to the client. In this case, the -work from the prior session is lost. Observing this scenario with +connection drops, the client state is lost. When the file server +recovers, an oplock break is not sent to the client. In this case, the +work from the prior session is lost. Observing this scenario with oplocks disabled, and the client was writing data to the file server real-time, then the failover will provide the data on disk as it existed at the time of the disconnect. </para> <para> -In mission critical high availability environments, careful attention -should be given to opportunistic locking. Ideally, comprehensive -testing should be done with all affected applications with oplocks +In mission-critical high-availability environments, careful attention +should be given to opportunistic locking. Ideally, comprehensive +testing should be done with all effected applications with oplocks enabled and disabled. </para> @@ -512,20 +514,20 @@ enabled and disabled. <title>Samba Opportunistic Locking Control</title> <para> -Opportunistic Locking is a unique Windows file locking feature. It is +Opportunistic locking is a unique Windows file locking feature. It is not really file locking, but is included in most discussions of Windows file locking, so is considered a de facto locking feature. -Opportunistic Locking is actually part of the Windows client file -caching mechanism. It is not a particularly robust or reliable feature +Opportunistic locking is actually part of the Windows client file +caching mechanism. It is not a particularly robust or reliable feature when implemented on the variety of customized networks that exist in enterprise computing. </para> <para> -Like Windows, Samba implements Opportunistic Locking as a server-side -component of the client caching mechanism. Because of the lightweight +Like Windows, Samba implements opportunistic locking as a server-side +component of the client caching mechanism. Because of the lightweight nature of the Windows feature design, effective configuration of -Opportunistic Locking requires a good understanding of its limitations, +opportunistic locking requires a good understanding of its limitations, and then applying that understanding when configuring data access for each particular customized network and client usage state. </para> @@ -533,13 +535,13 @@ each particular customized network and client usage state. <para> Opportunistic locking essentially means that the client is allowed to download and cache a file on their hard drive while making changes; if a second client wants to access the -file, the first client receives a break and must synchronise the file back to the server. +file, the first client receives a break and must synchronize the file back to the server. This can give significant performance gains in some cases; some programs insist on -synchronising the contents of the entire file back to the server for a single change. +synchronizing the contents of the entire file back to the server for a single change. </para> <para> -Level1 Oplocks (aka just plain "oplocks") is another term for opportunistic locking. +Level1 Oplocks (also known as just plain <quote>oplocks</quote>) is another term for opportunistic locking. </para> <para> @@ -551,18 +553,18 @@ on files that the client has no initial intention to write to at time of opening <para> Kernel Oplocks are essentially a method that allows the Linux kernel to co-exist with Samba's oplocked files, although this has provided better integration of MS Windows network -file locking with the under lying OS, SGI IRIX and Linux are the only two OS's that are -oplock aware at this time. +file locking with the underlying OS, SGI IRIX and Linux are the only two OSs that are +oplock-aware at this time. </para> <para> Unless your system supports kernel oplocks, you should disable oplocks if you are accessing the same files from both UNIX/Linux and SMB clients. Regardless, oplocks should always be disabled if you are sharing a database file (e.g., Microsoft Access) between -multiple clients, as any break the first client receives will affect synchronisation of +multiple clients, as any break the first client receives will affect synchronization of the entire file (not just the single record), which will result in a noticeable performance impairment and, more likely, problems accessing the database in the first place. Notably, -Microsoft Outlook's personal folders (*.pst) react very badly to oplocks. If in doubt, +Microsoft Outlook's personal folders (*.pst) react quite badly to oplocks. If in doubt, disable oplocks and tune your system from that point. </para> @@ -583,7 +585,7 @@ measurable speed benefit on your network, it might not be worth the hassle of de <title>Example Configuration</title> <para> -In the following we examine two distinct aspects of Samba locking controls. +In the following section we examine two distinct aspects of Samba locking controls. </para> <sect3> @@ -602,7 +604,7 @@ You can disable oplocks on a per-share basis with the following: </para> <para> -The default oplock type is Level1. Level2 Oplocks are enabled on a per-share basis +The default oplock type is Level1. Level2 oplocks are enabled on a per-share basis in the &smb.conf; file. </para> @@ -618,52 +620,52 @@ Alternately, you could disable oplocks on a per-file basis within the share: <para> If you are experiencing problems with oplocks as apparent from Samba's log entries, -you may want to play it safe and disable oplocks and level2 oplocks. +you may want to play it safe and disable oplocks and Level2 oplocks. </para> </sect3> <sect3> -<title>Disabling Kernel OpLocks</title> +<title>Disabling Kernel Oplocks</title> <para> -Kernel OpLocks is an &smb.conf; parameter that notifies Samba (if +Kernel oplocks is an &smb.conf; parameter that notifies Samba (if the UNIX kernel has the capability to send a Windows client an oplock break) when a UNIX process is attempting to open the file that is -cached. This parameter addresses sharing files between UNIX and -Windows with Oplocks enabled on the Samba server: the UNIX process +cached. This parameter addresses sharing files between UNIX and +Windows with oplocks enabled on the Samba server: the UNIX process can open the file that is Oplocked (cached) by the Windows client and the smbd process will not send an oplock break, which exposes the file -to the risk of data corruption. If the UNIX kernel has the ability to +to the risk of data corruption. If the UNIX kernel has the ability to send an oplock break, then the kernel oplocks parameter enables Samba -to send the oplock break. Kernel oplocks are enabled on a per-server +to send the oplock break. Kernel oplocks are enabled on a per-server basis in the &smb.conf; file. </para> <para> - <smbconfblock> +<smbconfblock> <smbconfoption><name>kernel oplocks</name><value>yes</value></smbconfoption> </smbconfblock> -The default is "no". +The default is no. </para> <para> -Veto OpLocks is an &smb.conf; parameter that identifies specific files for -which Oplocks are disabled. When a Windows client opens a file that +Veto opLocks is an &smb.conf; parameter that identifies specific files for +which oplocks are disabled. When a Windows client opens a file that has been configured for veto oplocks, the client will not be granted the oplock, and all operations will be executed on the original file on -disk instead of a client-cached file copy. By explicitly identifying -files that are shared with UNIX processes, and disabling oplocks for +disk instead of a client-cached file copy. By explicitly identifying +files that are shared with UNIX processes and disabling oplocks for those files, the server-wide Oplock configuration can be enabled to allow Windows clients to utilize the performance benefit of file -caching without the risk of data corruption. Veto Oplocks can be +caching without the risk of data corruption. Veto Oplocks can be enabled on a per-share basis, or globally for the entire server, in the -&smb.conf; file: +&smb.conf; file as shown in <link linkend="far1"/>. </para> <para> -<smbconfexample> - <title>Share with some files oplocked</title> +<smbconfexample id="far1"> +<title>Share with some files oplocked</title> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>veto oplock files</name><value>/filename.htm/*.txt/</value></smbconfoption> @@ -673,11 +675,10 @@ enabled on a per-share basis, or globally for the entire server, in the </para> <para> - <smbconfoption><name>oplock break wait time</name></smbconfoption> is an &smb.conf; parameter that adjusts the time -interval for Samba to reply to an oplock break request. Samba -recommends "DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND -UNDERSTOOD THE SAMBA OPLOCK CODE." Oplock Break Wait Time can only be -configured globally in the &smb.conf; file: +<smbconfoption><name>oplock break wait time</name></smbconfoption> is an &smb.conf; parameter +that adjusts the time interval for Samba to reply to an oplock break request. Samba recommends: +<quote>Do not change this parameter unless you have read and understood the Samba oplock code.</quote> +Oplock break Wait Time can only be configured globally in the &smb.conf; file as shown below. </para> <para> @@ -689,15 +690,15 @@ configured globally in the &smb.conf; file: <para> <emphasis>Oplock break contention limit</emphasis> is an &smb.conf; parameter that limits the response of the Samba server to grant an oplock if the configured -number of contending clients reaches the limit specified by the -parameter. Samba recommends "DO NOT CHANGE THIS PARAMETER UNLESS YOU -HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE." Oplock Break -Contention Limit can be enable on a per-share basis, or globally for -the entire server, in the &smb.conf; file: +number of contending clients reaches the limit specified by the parameter. Samba recommends +<quote>Do not change this parameter unless you have read and understood the Samba oplock code.</quote> +Oplock break Contention Limit can be enable on a per-share basis, or globally for +the entire server, in the &smb.conf; file as shown in <link linkend="far3"/>. </para> <para> - <smbconfexample> +<smbconfexample id="far3"> + <title>Configuration with oplock break contention limit</title> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>oplock break contention limit</name><value> 2 (default)</value></smbconfoption> @@ -718,11 +719,11 @@ the entire server, in the &smb.conf; file: There is a known issue when running applications (like Norton Anti-Virus) on a Windows 2000/ XP workstation computer that can affect any application attempting to access shared database files across a network. This is a result of a default setting configured in the Windows 2000/XP -operating system known as <emphasis>Opportunistic Locking</emphasis>. When a workstation +operating system known as <emphasis>opportunistic locking</emphasis>. When a workstation attempts to access shared data files located on another Windows 2000/XP computer, the Windows 2000/XP operating system will attempt to increase performance by locking the files and caching information locally. When this occurs, the application is unable to -properly function, which results in an <errorname>Access Denied</errorname> +properly function, which results in an <quote>Access Denied</quote> error message being displayed during network operations. </para> @@ -730,7 +731,7 @@ properly function, which results in an <errorname>Access Denied</errorname> All Windows operating systems in the NT family that act as database servers for data files (meaning that data files are stored there and accessed by other Windows PCs) may need to have opportunistic locking disabled in order to minimize the risk of data file corruption. -This includes Windows 9x/Me, Windows NT, Windows 200x and Windows XP. +This includes Windows 9x/Me, Windows NT, Windows 200x, and Windows XP. </para> <para> @@ -748,7 +749,7 @@ may be used. </para> <para> -You can verify (or change or add, if necessary) this Registry value using the Windows +You can verify (change or add, if necessary) this registry value using the Windows Registry Editor. When you change this registry value, you will have to reboot the PC to ensure that the new setting goes into effect. </para> @@ -802,44 +803,44 @@ files) to allow or deny opportunistic locks on local files. </para></note> <para> -To force closure of open oplocks on close or program exit EnableOpLockForceClose must be set to 1. +To force closure of open oplocks on close or program exit, EnableOpLockForceClose must be set to 1. </para> <para> -An illustration of how level II oplocks work: +An illustration of how Level2 oplocks work: </para> <itemizedlist> <listitem><para> - Station 1 opens the file, requesting oplock. + Station 1 opens the file requesting oplock. </para></listitem> <listitem><para> Since no other station has the file open, the server grants station 1 exclusive oplock. </para></listitem> <listitem><para> - Station 2 opens the file, requesting oplock. + Station 2 opens the file requesting oplock. </para></listitem> <listitem><para> - Since station 1 has not yet written to the file, the server asks station 1 to Break - to Level II Oplock. + Since station 1 has not yet written to the file, the server asks station 1 to break + to Level2 oplock. </para></listitem> <listitem><para> Station 1 complies by flushing locally buffered lock information to the server. </para></listitem> <listitem><para> - Station 1 informs the server that it has Broken to Level II Oplock (alternatively, + Station 1 informs the server that it has Broken to Level2 Oplock (alternately, station 1 could have closed the file). </para></listitem> <listitem><para> - The server responds to station 2's open request, granting it level II oplock. - Other stations can likewise open the file and obtain level II oplock. + The server responds to station 2's open request, granting it Level2 oplock. + Other stations can likewise open the file and obtain Level2 oplock. </para></listitem> <listitem><para> Station 2 (or any station that has the file open) sends a write request SMB. The server returns the write response. </para></listitem> <listitem><para> - The server asks all stations that have the file open to Break to None, meaning no + The server asks all stations that have the file open to break to none, meaning no station holds any oplock on the file. Because the workstations can have no cached writes or locks at this point, they need not respond to the break-to-none advisory; all they need do is invalidate locally cashed read-ahead data. @@ -858,7 +859,7 @@ An illustration of how level II oplocks work: </programlisting></para> <para> -Indicates whether the redirector should use opportunistic-locking (oplock) performance +This indicates whether the redirector should use opportunistic-locking (oplock) performance enhancement. This parameter should be disabled only to isolate problems. </para> @@ -875,9 +876,9 @@ enhancement. This parameter should be disabled only to isolate problems. </programlisting></para> <para> -Specifies whether the server allows clients to use oplocks on files. Oplocks are a +This specifies whether the server allows clients to use oplocks on files. Oplocks are a significant performance enhancement, but have the potential to cause lost cached -data on some networks, particularly wide-area networks. +data on some networks, particularly wide area networks. </para> <para><programlisting> @@ -886,7 +887,7 @@ data on some networks, particularly wide-area networks. </programlisting></para> <para> -Specifies the minimum link throughput allowed by the server before it disables +This specifies the minimum link throughput allowed by the server before it disables raw and opportunistic locks for this connection. </para> @@ -896,7 +897,7 @@ raw and opportunistic locks for this connection. </programlisting></para> <para> -Specifies the maximum time allowed for a link delay. If delays exceed this number, +This specifies the maximum time allowed for a link delay. If delays exceed this number, the server disables raw I/O and opportunistic locking for this connection. </para> @@ -906,7 +907,7 @@ the server disables raw I/O and opportunistic locking for this connection. </programlisting></para> <para> -Specifies the time that the server waits for a client to respond to an oplock break +This specifies the time that the server waits for a client to respond to an oplock break request. Smaller values can allow detection of crashed clients more quickly but can potentially cause loss of cached data. </para> @@ -919,7 +920,7 @@ potentially cause loss of cached data. <para> If you have applied all of the settings discussed in this chapter but data corruption problems -and other symptoms persist, here are some additional things to check out: +and other symptoms persist, here are some additional things to check out. </para> <para> @@ -938,86 +939,84 @@ our Knowledge Base. <title>Common Errors</title> <para> -In some sites locking problems surface as soon as a server is installed, in other sites +In some sites, locking problems surface as soon as a server is installed; in other sites locking problems may not surface for a long time. Almost without exception, when a locking problem does surface it will cause embarrassment and potential data corruption. </para> <para> -Over the past few years there have been a number of complaints on the samba mailing lists -that have claimed that samba caused data corruption. Three causes have been identified +Over the past few years there have been a number of complaints on the Samba mailing lists +that have claimed that Samba caused data corruption. Three causes have been identified so far: </para> <itemizedlist> <listitem><para> Incorrect configuration of opportunistic locking (incompatible with the application - being used. This is a VERY common problem even where MS Windows NT4 or MS Windows 200x - based servers were in use. It is imperative that the software application vendors' + being used. This is a common problem even where MS Windows NT4 or MS Windows + 200x-based servers were in use. It is imperative that the software application vendors' instructions for configuration of file locking should be followed. If in doubt, disable oplocks on both the server and the client. Disabling of all forms of file caching on the MS Windows client may be necessary also. </para></listitem> <listitem><para> - Defective network cards, cables, or HUBs / Switched. This is generally a more - prevalent factor with low cost networking hardware, though occasionally there - have been problems with incompatibilities in more up market hardware also. + Defective network cards, cables, or HUBs/Switched. This is generally a more + prevalent factor with low cost networking hardware, although occasionally there + have also been problems with incompatibilities in more up-market hardware. </para></listitem> <listitem><para> - There have been some random reports of samba log files being written over data - files. This has been reported by very few sites (about 5 in the past 3 years) - and all attempts to reproduce the problem have failed. The Samba-Team has been - unable to catch this happening and thus has NOT been able to isolate any particular - cause. Considering the millions of systems that use samba, for the sites that have - been affected by this as well as for the Samba-Team this is a frustrating and - a vexing challenge. If you see this type of thing happening please create a bug - report on https://bugzilla.samba.org without delay. Make sure that you give as much - information as you possibly can to help isolate the cause and to allow reproduction - of the problem (an essential step in problem isolation and correction). + There have been some random reports of Samba log files being written over data + files. This has been reported by very few sites (about five in the past three years) + and all attempts to reproduce the problem have failed. The Samba Team has been + unable to catch this happening and thus has not been able to isolate any particular + cause. Considering the millions of systems that use Samba, for the sites that have + been affected by this as well as for the Samba Team this is a frustrating and + a vexing challenge. If you see this type of thing happening, please create a bug + report on Samba <ulink url="https://bugzilla.samba.org">Bugzilla</ulink> without delay. + Make sure that you give as much information as you possibly can help isolate the + cause and to allow replication of the problem (an essential step in problem isolation and correction). </para></listitem> </itemizedlist> <sect2> - <title>locking.tdb error messages</title> + <title>locking.tdb Error Messages</title> <para> <quote> - We are seeing lots of errors in the samba logs like: -</quote> + We are seeing lots of errors in the Samba logs, like: <programlisting> tdb(/usr/local/samba_2.2.7/var/locks/locking.tdb): rec_read bad magic 0x4d6f4b61 at offset=36116 </programlisting> -<quote> + What do these mean? </quote> </para> <para> - Corrupted tdb. Stop all instances of smbd, delete locking.tdb, restart smbd. + This error indicated a corrupted tdb. Stop all instances of smbd, delete locking.tdb, and restart smbd. </para> </sect2> <sect2> - <title>Problems saving files in MS Office on Windows XP</title> + <title>Problems Saving Files in MS Office on Windows XP</title> <para>This is a bug in Windows XP. More information can be - found in <ulink url="http://support.microsoft.com/?id=812937">Microsoft Knowledge Base article 812937</ulink>.</para> + found in <ulink url="http://support.microsoft.com/?id=812937">Microsoft Knowledge Base article 812937.</ulink></para> </sect2> <sect2> - <title>Long delays deleting files over network with XP SP1</title> + <title>Long Delays Deleting Files Over Network with XP SP1</title> - <para><quote>It sometimes takes approximately 35 seconds to delete files over the network after XP SP1 has been applied</quote></para> + <para><quote>It sometimes takes approximately 35 seconds to delete files over the network after XP SP1 has been applied.</quote></para> - <para>This is a bug in Windows XP. More information can be - found in <ulink url="http://support.microsoft.com/?id=811492"> - Microsoft Knowledge Base article 811492</ulink>.</para> + <para>This is a bug in Windows XP. More information can be found in <ulink url="http://support.microsoft.com/?id=811492"> + Microsoft Knowledge Base article 811492.</ulink></para> </sect2> </sect1> @@ -1028,7 +1027,7 @@ tdb(/usr/local/samba_2.2.7/var/locks/locking.tdb): rec_read bad magic <para> You may want to check for an updated version of this white paper on our Web site from time to time. Many of our white papers are updated as information changes. For those papers, -the Last Edited date is always at the top of the paper. +the last edited date is always at the top of the paper. </para> <para> @@ -1043,18 +1042,19 @@ Windows Base Services > Files and I/O > SDK Documentation > File Storag </para> <para> -Microsoft Knowledge Base Article Q224992 "Maintaining Transactional Integrity with OPLOCKS", + Microsoft Knowledge Base Article Q224992 <?latex \linebreak ?><quote>Maintaining Transactional Integrity +with OPLOCKS</quote>, Microsoft Corporation, April 1999, <ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992</ulink>. </para> <para> -Microsoft Knowledge Base Article Q296264 "Configuring Opportunistic Locking in Windows 2000", +Microsoft Knowledge Base Article Q296264 <quote>Configuring Opportunistic Locking in Windows 2000</quote>, Microsoft Corporation, April 2001, <ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264</ulink>. </para> <para> -Microsoft Knowledge Base Article Q129202 "PC Ext: Explanation of Opportunistic Locking on Windows NT", - Microsoft Corporation, April 1995, <ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202</ulink>. +Microsoft Knowledge Base Article Q129202 <quote>PC Ext: Explanation of Opportunistic Locking on Windows NT</quote>, +Microsoft Corporation, April 1995, <ulink noescape="1" url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202</ulink>. </para> </sect1> diff --git a/docs/docbook/projdoc/msdfs_setup.xml b/docs/docbook/projdoc/msdfs_setup.xml index 90259f6a51..94241e03f1 100644 --- a/docs/docbook/projdoc/msdfs_setup.xml +++ b/docs/docbook/projdoc/msdfs_setup.xml @@ -10,6 +10,7 @@ </address> </affiliation> </author> + &author.jht; <pubdate>12 Jul 2000</pubdate> </chapterinfo> @@ -20,44 +21,48 @@ <title>Features and Benefits</title> <para> - The Distributed File System (or DFS) provides a means of separating the logical + The Distributed File System (DFS) provides a means of separating the logical view of files and directories that users see from the actual physical locations of these resources on the network. It allows for higher availability, smoother - storage expansion, load balancing etc. + storage expansion, load balancing, and so on. </para> <para> For information about DFS, refer to the <ulink url="http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp">Microsoft documentation</ulink>. - </para> - - <para> This document explains how to host a DFS tree on a UNIX machine (for DFS-aware clients to browse) using Samba. </para> <para> - To enable SMB-based DFS for Samba, configure it with the <option>--with-msdfs</option> + To enable SMB-based DFS for Samba, configure it with the <option>--with-msdfs</option> option. Once built, a Samba server can be made a DFS server by setting the global - boolean <smbconfoption><name>host msdfs</name></smbconfoption> + Boolean <smbconfoption><name>host msdfs</name></smbconfoption> parameter in the &smb.conf; file. You designate a share as a DFS - root using the share level boolean <smbconfoption><name>msdfs root</name></smbconfoption> parameter. A DFS root directory on Samba hosts DFS + root using the Share Level Boolean <smbconfoption><name>msdfs root</name></smbconfoption> parameter. A DFS root directory on Samba hosts DFS links in the form of symbolic links that point to other servers. For example, a symbolic link <filename>junction->msdfs:storage1\share1</filename> in the share directory acts as the DFS junction. When DFS-aware clients attempt to access the junction link, - they are redirected to the storage location (in this case, \\storage1\share1). + they are redirected to the storage location (in this case, <parameter>\\storage1\share1</parameter>). </para> <para> DFS trees on Samba work with all DFS-aware clients ranging from Windows 95 to 200x. - </para> - - <para> - Here's an example of setting up a DFS tree on a Samba server. - </para> + <link linkend="dfscfg"/> shows how to setup a DFS tree on a Samba server. + In the <filename>/export/dfsroot</filename> directory, you set up your DFS links to + other servers on the network. +<screen> +&rootprompt;<userinput>cd /export/dfsroot</userinput> +&rootprompt;<userinput>chown root /export/dfsroot</userinput> +&rootprompt;<userinput>chmod 755 /export/dfsroot</userinput> +&rootprompt;<userinput>ln -s msdfs:storageA\\shareA linka</userinput> +&rootprompt;<userinput>ln -s msdfs:serverB\\share,serverC\\share linkb</userinput> +</screen> +</para> - <para><smbconfexample> - <title>smb.conf with DFS configured</title> +<para> +<smbconfexample id="dfscfg"> +<title>smb.conf with DFS configured</title> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>netbios name</name><value>&example.server.samba;</value></smbconfoption> <smbconfoption><name>host msdfs </name><value>yes</value></smbconfoption> @@ -65,27 +70,16 @@ <smbconfsection>[dfs]</smbconfsection> <smbconfoption><name>path</name><value>/export/dfsroot</value></smbconfoption> <smbconfoption><name>msdfs root</name><value>yes</value></smbconfoption> - </smbconfexample></para> - - - <para>In the /export/dfsroot directory we set up our DFS links to - other servers on the network.</para> - -<screen> -&rootprompt;<userinput>cd /export/dfsroot</userinput> -&rootprompt;<userinput>chown root /export/dfsroot</userinput> -&rootprompt;<userinput>chmod 755 /export/dfsroot</userinput> -&rootprompt;<userinput>ln -s msdfs:storageA\\shareA linka</userinput> -&rootprompt;<userinput>ln -s msdfs:serverB\\share,serverC\\share linkb</userinput> -</screen> +</smbconfexample> +</para> <para>You should set up the permissions and ownership of - the directory acting as the DFS root such that only designated + the directory acting as the DFS root so that only designated users can create, delete or modify the msdfs links. Also note that symlink names should be all lowercase. This limitation exists to have Samba avoid trying all the case combinations to get at - the link name. Finally set up the symbolic links to point to the - network shares you want, and start Samba.</para> + the link name. Finally, set up the symbolic links to point to the + network shares you want and start Samba.</para> <para>Users on DFS-aware clients can now browse the DFS tree on the Samba server at \\samba\dfs. Accessing @@ -97,21 +91,70 @@ <title>Common Errors</title> <itemizedlist> <listitem><para>Windows clients need to be rebooted - if a previously mounted non-dfs share is made a DFS + if a previously mounted non-DFS share is made a DFS root or vice versa. A better way is to introduce a new share and make it the DFS root.</para> </listitem> - <listitem><para>Currently there's a restriction that msdfs + <listitem><para>Currently, there's a restriction that msdfs symlink names should all be lowercase.</para> </listitem> <listitem><para>For security purposes, the directory acting as the root of the DFS tree should have ownership - and permissions set so that only designated users can + and permissions set so only designated users can modify the symbolic links in the directory.</para> </listitem> </itemizedlist> + + <sect2> + <title>MSDFS UNIX Path Is Case-Critical</title> + + <para> + A network administrator sent advice to the Samba mailing list + after a long sessions trying to determine why DFS was not working. + His advice is worth noting. + </para> + + <para><quote> + I spent some time trying to figure out why my particular + dfs root wasn't working. I noted in the documenation that + the symlink should be in all lowercase. It should be + amended that the entire path to the symlink should all be + in lowercase as well. + </quote></para> + + <para> + For example, I had a share defined as such: + + <screen> + [pub] + path = /export/home/Shares/public_share + msdfs root = yes + </screen> + + and I could not make my Windows 9x/Me (with the dfs client installed) + follow this symlink: + + <screen> + damage1 -> msdfs:damage\test-share + </screen> + </para> + + <para> + Running a debug level of 10 reveals: + + <programlisting> + [2003/08/20 11:40:33, 5] msdfs/msdfs.c:is_msdfs_link(176) + is_msdfs_link: /export/home/shares/public_share/* does not exist. + </programlisting> + + Curious. So I changed the directory name from .../Shares/... to + .../shares/... (along with my service definition) and it worked! + </para> + + </sect2> + </sect1> </chapter> diff --git a/docs/docbook/projdoc/printer_driver2.xml b/docs/docbook/projdoc/printer_driver2.xml index 0d0dbb0188..c823de28bf 100644 --- a/docs/docbook/projdoc/printer_driver2.xml +++ b/docs/docbook/projdoc/printer_driver2.xml @@ -9,6 +9,7 @@ </affiliation> </author> &author.jerry; + &author.jht; <pubdate>May 31, 2003</pubdate> </chapterinfo> @@ -18,47 +19,48 @@ <title>Features and Benefits</title> <para> -Printing is often a mission-critical service for the users. Samba can +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. </para> <para> -A Samba 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 command line -or through scripts, making it more efficient in case of large numbers -of printers. If a central accounting of print jobs (tracking every -single page and supplying the raw data for all sorts of statistical -reports) is required, this is best supported by CUPS as the print -subsystem underneath the Samba hood. +A Samba print service may be run on a Stand-alone or 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 +<quote>Point'n'Print</quote> mechanism. Printer installations executed by +<quote>Logon Scripts</quote> are no problem. Administrators can upload and +manage drivers to be used by clients through the familiar <quote>Add Printer +Wizard</quote>. As an additional benefit, driver and printer management may +be run from the command line or through scripts, making it more efficient +in case of large numbers of printers. If a central accounting of print jobs +(tracking every single page and supplying the raw data for all sorts of +statistical reports) is required, this function is best supported by +the newer Common UNIX Printing System (CUPS) +as the print subsystem underneath the Samba hood. </para> <para> -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 to read this chapter too. +This chapter deals with the foundations of Samba printing as they +are implemented by the more traditional UNIX (BSD- and System V-style) +printing systems. Many things covered in this chapter apply also to CUPS. +If you use CUPS, you may be tempted +to jump to the next chapter but you will certainly miss a few things if +you do. It is recommended that you read this chapter as well as <link +linkend="CUPS-printing"/>. </para> <note> <para> -Most of the given examples have been verified on Windows XP +Most of the following examples have been verified on Windows XP Professional clients. Where this document describes the responses to -commands given, bear in mind that Windows 2000 clients are very -similar, but may differ in details. Windows NT is somewhat different +commands given, bear in mind that Windows 200x/XP clients are quite +similar, but may differ in minor details. Windows NT is somewhat different again. </para> </note> @@ -69,52 +71,68 @@ again. <title>Technical Introduction</title> <para> -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 -<emphasis>Common UNIX Printing System</emphasis> -(CUPS). +Samba's printing support always relies on the installed print subsystem +of the UNIX OS it runs on. Samba is a <quote>middleman.</quote> It takes +print files from Windows (or other SMB) clients and passes them to the real +printing system for further processing, therefore, it needs to communicate with +both sides: the Windows print clients and the UNIX printing system. Hence, we +must differentiate between the various client OS types, each of which behave +differently, as well as the various UNIX print subsystems, which themselves +have different features and are accessed differently. +</para> + +<para> +This deals with the traditional way of UNIX printing. The next chapter +covers in great detail the more modern <emphasis>Common UNIX Printing +System</emphasis> (CUPS). +</para> + +<important><para>CUPS users, be warned: do not just jump on to the next +chapter. You might miss important information only found here! +</para></important> -<important><para>CUPS users, be warned: don't just jump on to the next -chapter. You might miss important information contained only -here!</para></important> +<para> +It is apparent from postings on the Samba mailing list that print configuration +is one of the most problematic aspects of Samba administration today. Many +new Samba administrators have the impression that Samba performs some sort +of print processing. Rest assured, Samba does not peform any type of print +processing. It does not do any form of print filtering. +</para> + +<para> +Samba obtains from its clients a data stream (print job) that it spools to a +local spool area. When the entire print job has been received, Samba invokes +a local UNIX/Linux print command and passes the spooled file to it. It is +up to the local system printing subsystems to correctly process the print +job and to submit it to the printer. </para> <sect2> -<title>What happens if you send a Job from a Client</title> +<title>Client to Samba Print Job Processing</title> <para> -To successfully print a job from a Windows client via a Samba -print server to a UNIX printer, there are 6 (potentially 7) -stages: +Successful printing from a Windows client via a Samba print server to a UNIX +printer involves six (potentially seven) stages: </para> <orderedlist> -<listitem><para>Windows opens a connection to the printer share</para></listitem> +<listitem><para>Windows opens a connection to the printer share.</para></listitem> -<listitem><para>Samba must authenticate the user</para></listitem> +<listitem><para>Samba must authenticate the user.</para></listitem> -<listitem><para>Windows sends a copy of the printfile over the network -into Samba's spooling area</para></listitem> +<listitem><para>Windows sends a copy of the print file over the network +into Samba's spooling area.</para></listitem> -<listitem><para>Windows closes the connection again</para></listitem> +<listitem><para>Windows closes the connection.</para></listitem> <listitem><para>Samba invokes the print command to hand the file over -to the UNIX print subsystem's spooling area</para></listitem> +to the UNIX print subsystem's spooling area.</para></listitem> -<listitem><para>The UNIX print subsystem processes the print -job</para></listitem> +<listitem><para>The UNIX print subsystem processes the print job.</para></listitem> -<listitem><para>The printfile may need to be explicitly deleted -from the Samba spooling area.</para></listitem> +<listitem><para>The print file may need to be explicitly deleted +from the Samba spooling area. This item depends on your print spooler +configuration settings.</para></listitem> </orderedlist> </sect2> @@ -123,97 +141,52 @@ from the Samba spooling area.</para></listitem> <title>Printing Related Configuration Parameters</title> <para> -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 "<emphasis>G</emphasis>" in the listings) and -Service Level ("<emphasis>S</emphasis>") parameters. +There are a number of configuration parameters to control Samba's +printing behavior. Please refer to the man page for &smb.conf; for an +overview of these. As with other parameters, there are Global Level +(tagged with a <emphasis>G</emphasis> in the listings) and Service Level +(<emphasis>S</emphasis>) parameters. </para> <variablelist> -<varlistentry><term>Service Level Parameters</term> -<listitem><para>These <emphasis>may</emphasis> go into the -<smbconfsection>[global]</smbconfsection> section of &smb.conf;. -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).</para></listitem> -</varlistentry> - -<varlistentry><term>Global Parameters</term> -<listitem><para>These <emphasis>may not</emphasis> go into individual -shares. If they go in by error, the "testparm" utility can discover -this (if you run it) and tell you so.</para></listitem> -</varlistentry> + <varlistentry><term>Global Parameters</term> + <listitem><para> These <emphasis>may not</emphasis> go into + individual share definitions. If they go in by error, + the <command>testparm</command> utility can discover this + (if you run it) and tell you so. + </para></listitem> + </varlistentry> + + <varlistentry><term>Service Level Parameters</term> + <listitem><para> These may be specified in the + <smbconfsection>[global]</smbconfsection> section of &smb.conf;. + In this case they define the default behavior of all individual + or service level shares (provided they do not have a different + setting defined for the same parameter, thus overriding the + global default). + </para></listitem> + </varlistentry> </variablelist> </sect2> -<sect2> -<title>Parameters Recommended for Use</title> - -<para>The following &smb.conf; parameters directly -related to printing are used in Samba. See also the -&smb.conf; man page for detailed explanations: -</para> - -<para>Global level parameters: <smbconfoption><name>addprinter command</name></smbconfoption>, -<smbconfoption><name>deleteprinter command</name></smbconfoption>, -<smbconfoption><name>disable spoolss</name></smbconfoption>, -<smbconfoption><name>enumports command</name></smbconfoption>, -<smbconfoption><name>load printers</name></smbconfoption>, -<smbconfoption><name>lpq cache time</name></smbconfoption>, -<smbconfoption><name>os2 driver map</name></smbconfoption>, -<smbconfoption><name>printcap name</name></smbconfoption>, <smbconfoption><name>printcap</name></smbconfoption>, -<smbconfoption><name>show add printer wizard</name></smbconfoption>, -<smbconfoption><name>total print jobs</name></smbconfoption>, -<smbconfoption><name>use client driver</name></smbconfoption>. -</para> - -<para>Service level parameters: <smbconfoption><name>hosts allow</name></smbconfoption>, -<smbconfoption><name>hosts deny</name></smbconfoption>, -<smbconfoption><name>lppause command</name></smbconfoption>, -<smbconfoption><name>lpq command</name></smbconfoption>, -<smbconfoption><name>lpresume command</name></smbconfoption>, -<smbconfoption><name>lprm command</name></smbconfoption>, -<smbconfoption><name>max print jobs</name></smbconfoption>, -<smbconfoption><name>min print space</name></smbconfoption>, -<smbconfoption><name>print command</name></smbconfoption>, -<smbconfoption><name>printable</name></smbconfoption>, <smbconfoption><name>print ok </name></smbconfoption>, -<smbconfoption><name>printer name</name></smbconfoption>, <smbconfoption><name>printer</name></smbconfoption>, -<smbconfoption><name>printer admin</name></smbconfoption>, -<smbconfoption><name>printing</name><value>[cups|bsd|lprng...]</value></smbconfoption>, -<smbconfoption><name>queuepause command</name></smbconfoption>, -<smbconfoption><name>queueresume command</name></smbconfoption>, -<smbconfoption><name>total print jobs</name></smbconfoption>. -</para> - -<para> -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. -</para> -</sect2> - </sect1> <sect1> -<title>A simple Configuration to Print</title> +<title>Simple Print Configuration</title> <para> -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. +<link linkend="simpleprc"/> shows a simple printing configuration. +If you compare this with your own, you may find +additional parameters that have been pre-configured by your OS +vendor. Below is a discussion and explanation of the +parameters. This example does not use many parameters. However, in many environments these are enough to provide a valid -&smb.conf; file which enables all clients to print. +&smb.conf; file that enables all clients to print. </para> -<para><smbconfexample> - <title>Simple configuration with BSD printing</title> +<para> +<smbconfexample id="simpleprc"> +<title>Simple configuration with BSD printing</title> <smbconfsection>[global]</smbconfsection> <smbconfoption><name>printing</name><value>bsd</value></smbconfoption> <smbconfoption><name>load printers</name><value>yes</value></smbconfoption> @@ -226,44 +199,44 @@ However, in many environments these are enough to provide a valid </smbconfexample></para> <para> -This is only an example configuration. Samba assigns default values to all -configuration parameters. On the whole the defaults are conservative and -sensible. When a parameter is specified in the &smb.conf; file this overwrites -the default value. The <command>testparm</command> utility when run as root -is capable of reporting all setting, both default as well as &smb.conf; file -settings. <command>Testparm</command> gives warnings for all mis-configured -settings. The complete output is easily 340 lines and more, so you may want -to pipe it through a pager program. +This is only an example configuration. Samba assigns default values to +all configuration parameters. The defaults are conservative +and sensible. When a parameter is specified in the &smb.conf; file, this +overwrites the default value. The <command>testparm</command> utility when +run as root is capable of reporting all setting, both default as well as +&smb.conf; file settings. <command>Testparm</command> gives warnings for all +misconfigured settings. The complete output is easily 340 lines and more, +so you may want to pipe it through a pager program. </para> <para> 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 +know that is not very picky about its syntax. As has been explained +elsewhere in this document, Samba tolerates some spelling errors (such +as <smbconfoption><name>browsable</name></smbconfoption> instead of +<smbconfoption><name>browseable</name></smbconfoption>), and spelling is +case-insensitive. It is permissible to use <parameter>Yes/No</parameter> +or <parameter>True/False</parameter> for Boolean settings. Lists of names may be separated by commas, spaces or tabs. </para> <sect2> -<title>Verification of "Settings in Use" with <command>testparm</command></title> +<title>Verifing Configuration with <command>testparm</command></title> <para> -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: +To see all (or at least most) printing-related settings in Samba, including +the implicitly used ones, try the command outlined below. This command greps +for all occurrences of <constant>lp, print, spool, driver, ports</constant> +and <constant>[</constant> in testparms output. This provides a convenient +overview of the running <command>smbd</command> print configuration. This +command does not show individually created printer shares or the spooling +paths they may use. Here is the output of my Samba setup, with settings +shown in <link linkend="simpleprc"/>: </para> <para><screen> -&rootprompt;<userinput>testparm -v | egrep "(lp|print|spool|driver|ports|\[)"</userinput> - Load smb config files from /etc/samba/smb.conf.simpleprinting +&rootprompt;<userinput>testparm -s -v | egrep "(lp|print|spool|driver|ports|\[)"</userinput> + Load smb config files from /etc/samba/smb.conf Processing section "[homes]" Processing section "[printers]" @@ -297,104 +270,95 @@ as shown above: [printers] path = /var/spool/samba printable = Yes - -</screen></para> +</screen> +</para> <para> You can easily verify which settings were implicitly added by Samba's -default behaviour. <emphasis>Don't forget about this point: it may +default behavior. <emphasis>Remember: it may be important in your future dealings with Samba.</emphasis> </para> -<note><para> testparm in samba 3 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.</para></note> +<note><para> testparm in Samba-3 behaves differently from that in 2.2.x: used +without the <quote>-v</quote> switch it only shows you the settings actually +written into! To see the complete +configuration used, add the <quote>-v</quote> parameter to testparm.</para></note> </sect2> <sect2> -<title>A little Experiment to warn you</title> +<title>Rapid Configuration Validation</title> <para> 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 <smbconfoption><name>load printers</name></smbconfoption>" +to this point first and verify if <command>testparm</command> shows the parameters you +expect. To give you a warning from personal experience, +try to just comment out the <smbconfoption><name>load printers</name></smbconfoption> parameter. If your 2.2.x system behaves like mine, you'll see this: </para> <para><screen> &rootprompt;grep "load printers" /etc/samba/smb.conf - # load printers = Yes - # This setting is commented ooouuuuut!! + # load printers = Yes + # This setting is commented out!! &rootprompt;testparm -v /etc/samba/smb.conf | egrep "(load printers)" load printers = Yes - </screen></para> <para> -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 ;-) +I assumed that commenting out of this setting should prevent Samba from +publishing my printers, but it still did. It took some time to figure out +the reason. But I am no longer fooled ... at least not by this. </para> <para><screen> &rootprompt;<userinput>grep -A1 "load printers" /etc/samba/smb.conf</userinput> load printers = No - # This setting is what I mean!! - # load printers = Yes - # This setting is commented ooouuuuut!! + # The above setting is what I want! + # load printers = Yes + # This setting is commented out! -&rootprompt;<userinput>testparm -v smb.conf.simpleprinting | egrep "(load printers)"</userinput> +&rootprompt;<userinput>testparm -s -v smb.conf.simpleprinting | egrep "(load printers)"</userinput> load printers = No </screen></para> <para> -Only when setting the parameter explicitly to -"<smbconfoption><name>load printers</name><value>No</value></smbconfoption>" -would Samba recognize my intentions. So my strong advice is: +Only when the parameter is explicitly set to +<smbconfoption><name>load printers</name><value>No</value></smbconfoption> +would Samba conform with my intentions. So, my strong advice is: </para> <itemizedlist> -<listitem><para>Never rely on "commented out" parameters!</para></listitem> +<listitem><para>Never rely on commented out parameters.</para></listitem> -<listitem><para>Always set it up explicitly as you intend it to +<listitem><para>Always set parameters explicitly as you intend them to behave.</para></listitem> <listitem><para>Use <command>testparm</command> to uncover hidden -settings which might not reflect your intentions.</para></listitem> +settings that might not reflect your intentions.</para></listitem> </itemizedlist> <para> -You can have a working Samba print configuration with this -minimal : -</para> - -<para><screen> +The following is the most minimal configuration file: +<screen> &rootprompt;<userinput>cat /etc/samba/smb.conf-minimal</userinput> [printers] - </screen></para> <para> -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 <emphasis>not</emphasis> 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 <command>testparm</command> what the Samba print configuration -would be, if you used this minimalistic file as your real -: +This example should show that you can use testparm to test any Samba +configuration file. Actually, we encourage you <emphasis>not</emphasis> +to change your working system (unless you know exactly what you are +doing). Don't rely on the assumption that changes will only take effect after +you re-start smbd! This is not the case. Samba re-reads it every 60 seconds +and on each new client connection. You might have to face changes for your +production clients that you didn't intend to apply. You will now +note a few more interesting things; <command>testparm</command> is useful to +identify what the Samba print configuration would be if you used this minimalistic +configuration. Here is what you can expect to find: </para> <para><screen> @@ -422,71 +386,69 @@ would be, if you used this minimalistic file as your real lpq command = lpq -P%p printer name = use client driver = No + [printers] printable = Yes </screen></para> <para> -testparm issued 2 warnings: +testparm issued two warnings: </para> <itemizedlist> -<listitem><para>because we didn't specify the -<smbconfsection>[printers]</smbconfsection> section as printable, -and</para></listitem> - -<listitem><para>because we didn't tell it which spool directory to -use.</para></listitem> - + <listitem><para>We did not specify the <smbconfsection>[printers]</smbconfsection> section as printable.</para></listitem> + <listitem><para>We did not tell Samba which spool directory to use.</para></listitem> </itemizedlist> <para> -However, this was not fatal, and samba will default to values that -will work here. 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. -<emphasis>Warning:</emphasis> don't put a comment sign <emphasis>at -the end</emphasis> 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: <quote>Internal whitespace -in a parameter value is retained verbatim.</quote> This means that a -line consisting of, for example, +However, this was not fatal and Samba will default to values that will +work. Please, do not rely on this and do not use this example. This was +included to encourage you to be careful to design and specify your setup to do +precisely what you require. The outcome on your system may vary for some +parameters given, since Samba may have been built with different compile-time +options. <emphasis>Warning:</emphasis> do not put a comment sign +<emphasis>at the end</emphasis> of a valid line. It will cause the parameter +to be ignored (just as if you had put the comment sign at the front). At first +I regarded this as a bug in my Samba versions. But the man page clearly says: +<quote>Internal whitespace in a parameter value is retained verbatim.</quote> +This means that a line consisting of, for example: </para> <para><smbconfblock> -<smbconfcomment>This defines LPRng as the printing system"</smbconfcomment> +<smbconfcomment>This defines LPRng as the printing system</smbconfcomment> <smbconfoption><name>printing</name><value>lprng</value></smbconfoption> </smbconfblock></para> <para> -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.] +will regard the whole of the string after the +<quote><constant>=</constant></quote> sign as the value you want to +define. This is an invalid value that will be ignored and a default +value will be +used in its place. </para> </sect2> </sect1> <sect1> -<title>Extended Sample Configuration to Print</title> +<title>Extended Printing Configuration</title> <para> - In <link linkend="extbsdpr">the extended BSD configuration example</link> we show a more verbose example configuration for print related - settings in BSD-printing style environment . 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 specified because they are set by default. You -might be able to do with a leaner &smb.conf; file.</para> +In <link linkend="extbsdpr"/> we show a more verbose example configuration +for print-related settings in a BSD-style printing environment. What follows +is a discussion and explanation of the various parameters. We chose to +use BSD-style printing here because it is still the most commonly used +system on legacy UNIX/Linux installations. New installations predominantly +use CUPS, which is discussed in a separate chapter. <link linkend="extbsdpr"/> explicitly +names many parameters that do not need to be specified because they are set +by default. You could use a much leaner &smb.conf; file. Alternately, you can use +<command>testparm</command> or <command>SWAT</command> to optimize the &smb.conf; +file to remove all parameters that are set at default. +</para> <para><smbconfexample id="extbsdpr"> - <title>Extended configuration with BSD printing</title> - <smbconfsection>[global]</smbconfsection> + <title>Extended BSD Printing Configuration</title> +<smbconfsection>[global]</smbconfsection> <smbconfoption><name>printing</name><value>bsd</value></smbconfoption> <smbconfoption><name>load printers</name><value>yes</value></smbconfoption> <smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> @@ -519,532 +481,485 @@ might be able to do with a leaner &smb.conf; file.</para> </smbconfexample></para> <para> -This <emphasis>also</emphasis> 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 <command>testparm</command> -utility. <command>testparm</command> also gives warnings if you have -mis-configured certain things.. +This is an example configuration. You may not find all the settings that are in +the confioguration file that was provided by the OS vendor. Samba configuration +parameters, if not explicitly set default to a sensible value. +To see all settings, as <constant>root</constant> use the <command>testparm</command> +utility. <command>testparm</command> gives warnings for misconfigured settings. </para> -</sect1> -<sect1> -<title>Detailed Explanation of the Example's Settings</title> +<sect2> +<title>Detailed Explanation Settings</title> <para> -Following is a discussion of the settings from above shown example. +The following is a discussion of the settings from above shown example. </para> -<sect2> +<sect3> <title>The [global] Section</title> <para> -The <smbconfsection>[global]</smbconfsection> section is one of 4 special +The <smbconfsection>[global]</smbconfsection> section is one of four special sections (along with [<smbconfsection>[homes]</smbconfsection>, -<smbconfsection>[printers]</smbconfsection> and -<smbconfsection>[print$]</smbconfsection>...) It contains all parameters which -apply to the server as a whole. It is the place for parameters which -have only a "global" meaning. It may also contain service level -parameters 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). +<smbconfsection>[printers]</smbconfsection> +and <smbconfsection>[print$]</smbconfsection>...). The +<smbconfsection>[global]</smbconfsection> contains all parameters which apply +to the server as a whole. It is the place for parameters that have only a +global meaning. It may also contain service level parameters that 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 settings and specify other values). </para> <variablelist> -<varlistentry><term><smbconfoption><name>printing</name><value>bsd</value></smbconfoption></term> -<listitem><para> 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 <smbconfoption><name>print command</name></smbconfoption> (and other queue control -commands).</para> -<caution><para>The <smbconfoption><name>printing</name></smbconfoption> parameter is -normally a service level parameter. Since it is included here in the -<smbconfsection>[global]</smbconfsection> section, it will take effect for all -printer shares that are not defined differently. Samba 3 no longer -supports the SOFTQ printing system.</para></caution> -</listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>load printers</name><value>yes</value></smbconfoption></term> -<listitem><para> 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 -<smbconfsection>[printers]</smbconfsection> section. (A <parameter>load printers -= no</parameter> 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). </para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> </term><listitem><para> this setting is normally -enabled by default (even if the parameter is not written into the -). It makes the <guiicon>Add Printer Wizard</guiicon> icon -show up in the <guiicon>Printers</guiicon> folder of the Samba host's -share listing (as shown in <guiicon>Network Neighbourhood</guiicon> or -by the <command>net view</command> command). To disable it, you need to -explicitly set it to <constant>no</constant> (commenting it out -will not suffice!). The Add Printer Wizard lets you upload printer -drivers to the <smbconfsection>[print$]</smbconfsection> 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. </para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>total print jobs</name><value>100</value></smbconfoption></term> -<listitem><para> 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 <quote>no more space -available on server</quote> type of error message will be returned by -Samba to the client. A setting of "0" (the default) means there is -<emphasis>no</emphasis> limit at all! -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>printcap name</name><value>/etc/printcap</value></smbconfoption></term> - -<listitem><para> 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 -<filename>cupsd.conf</filename>). -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>printer admin</name><value>@ntadmin</value></smbconfoption></term> -<listitem><para> 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 -<smbconfoption><name>printer admin</name></smbconfoption>. 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 <smbconfoption><name>printer admin</name></smbconfoption> -parameter is normally a share level parameter, so you may associate -different groups to different printer shares in larger installations, -if you use the <smbconfoption><name>printer admin</name></smbconfoption> parameter on the -share levels). -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>lpq cache time</name><value>20</value></smbconfoption></term> -<listitem><para> 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. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>use client driver</name><value>no</value></smbconfoption></term> -<listitem><para> if set to <constant>yes</constant>, this setting only -takes effect for Win NT/2k/XP clients (and not for Win 95/98/ME). Its -default value is <constant>No</constant> (or <constant>False</constant>). -It must <emphasis>not</emphasis> be enabled on print shares -(with a <constant>yes</constant> or <constant>true</constant> setting) which -have valid drivers installed on the Samba server! For more detailed -explanations see the man page of &smb.conf;. -</para></listitem></varlistentry> + <varlistentry><term><smbconfoption><name>printing</name><value>bsd </value></smbconfoption></term> + <listitem><para>Causes Samba to use default print commands + applicable for the BSD (also known as RFC 1179 style or LPR/LPD) printing + system. In general, the <parameter>printing</parameter> parameter informs Samba about the + print subsystem it should expect. Samba supports CUPS, LPD, LPRNG, + SYSV, HPUX, AIX, QNX, and PLP. Each of these systems defaults to a + different <smbconfoption><name>print command</name></smbconfoption> (and other queue control + commands).</para> + + <caution><para>The <smbconfoption><name>printing</name></smbconfoption> parameter is + normally a service level parameter. Since it is included here in the + <smbconfsection>[global]</smbconfsection> section, it will take effect for all + printer shares that are not defined differently. Samba-3 no longer + supports the SOFTQ printing system.</para></caution> + </listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>load printers</name><value>yes </value></smbconfoption></term> + <listitem><para>Tells Samba to create automatically all + available printer shares. Available printer shares are discovered by + scanning the printcap file. All created printer shares are also loaded + for browsing. If you use this parameter, you do not need to specify + separate shares for each printer. Each automatically created printer + share will clone the configuration options found in the + <smbconfsection>[printers]</smbconfsection> section. (The <parameter>load printers + = no</parameter> setting will allow you to specify each UNIX printer + you want to share separately, leaving out some you do not want to be + publicly visible and available).</para> + </listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>show add printer wizard</name><value>yes </value></smbconfoption></term> + <listitem><para>Setting is normally enabled by default (even if the parameter is not specified in &smb.conf;). + It causes the <guiicon>Add Printer Wizard</guiicon> icon to appear + in the <guiicon>Printers</guiicon> folder of the Samba host's + share listing (as shown in <guiicon>Network Neighborhood</guiicon> or + by the <command>net view</command> command). To disable it, you need to + explicitly set it to <constant>no</constant> (commenting it out + will not suffice). The <parameter>Add Printer Wizard</parameter> lets you upload printer + drivers to the <smbconfsection>[print$]</smbconfsection> share and associate it + with a printer (if the respective queue exists before the + action), or exchange a printer's driver against any other previously + uploaded driver.</para> + </listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>total print jobs</name><value>100 </value></smbconfoption></term> + <listitem><para>Sets the upper limit to 100 print jobs + being active on the Samba server at any one time. Should a client + submit a job that exceeds this number, a <quote>no more space + available on server</quote> type of error message will be returned by + Samba to the client. A setting of zero (the default) means there is + <emphasis>no</emphasis> limit at all. + </para></listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>printcap name</name><value>/etc/printcap </value></smbconfoption></term> + <listitem><para>Tells Samba where to look for a list of + available printer names. Where CUPS is used, make sure that a printcap + file is written. This is controlled by the <constant>Printcap</constant> directive in the + <filename>cupsd.conf</filename> file. + </para></listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>printer admin</name><value>@ntadmin </value></smbconfoption></term> + <listitem><para>Members of the ntadmin group should be able to add + drivers and set printer properties (<constant>ntadmin</constant> is only an example name, + it needs to be a valid UNIX group name); root is implicitly always a + <smbconfoption><name>printer admin</name></smbconfoption>. The @ sign precedes group names in the + <filename>/etc/group</filename>. A printer admin can do anything to + printers via the remote administration interfaces offered by MS-RPC + (see below). In larger installations, the <smbconfoption><name>printer admin</name></smbconfoption> + parameter is normally a per-share parameter. This permits different groups to administer each printer share. + </para></listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>lpq cache time</name><value>20 </value></smbconfoption></term> + <listitem><para>Controls the cache time for the results of the + lpq command. It prevents the lpq command being called too often and + reduces the load on a heavily used print server. + </para></listitem></varlistentry> + + <varlistentry><term><smbconfoption><name>use client driver</name><value>no </value></smbconfoption></term> + <listitem><para>If set to <constant>yes</constant>, only + takes effect for Windows NT/200x/XP clients (and not for Win 95/98/ME). Its + default value is <constant>No</constant> (or <constant>False</constant>). + It must <emphasis>not</emphasis> be enabled on print shares + (with a <constant>yes</constant> or <constant>true</constant> setting) that + have valid drivers installed on the Samba server. For more detailed + explanations see the &smb.conf; man page. + </para></listitem></varlistentry> </variablelist> -</sect2> +</sect3> -<sect2> +<sect3 id="ptrsect"> <title>The [printers] Section</title> <para> -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. +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 that 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. </para> <variablelist> -<varlistentry><term><smbconfoption><name>comment</name><value>All printers</value></smbconfoption></term> -<listitem><para> the <smbconfoption><name>comment</name></smbconfoption> is shown next to -the share if a client queries the server, either via <guiicon>Network -Neighbourhood</guiicon> or with the <command>net view</command> command to list -available shares. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>printable</name><value>yes</value></smbconfoption></term> -<listitem><para> please note well, that the -<smbconfsection>[printers]</smbconfsection> service <emphasis>must</emphasis> be -declared as printable. If you specify otherwise, smbd will refuse to -load at startup. This parameter allows -connected clients to open, write to and submit spool files into the -directory specified with the <smbconfoption><name>path</name></smbconfoption> parameter for -this service. It is used by Samba to differentiate printer shares from -file shares. </para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>path</name><value>/var/spool/samba</value></smbconfoption></term> -<listitem><para>this must point to a directory used by Samba to spool -incoming print files. <emphasis>It must not be the same as the spool -directory specified in the configuration of your UNIX print -subsystem!</emphasis> The path would typically point to a directory -which is world writeable, with the "sticky" bit set to it. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>browseable</name><value>no</value></smbconfoption></term> -<listitem><para> this is always set to <constant>no</constant> if -<smbconfoption><name>printable</name><value>yes</value></smbconfoption>. It makes the -<smbconfsection>[printer]</smbconfsection> share itself invisible in the -list of available shares in a <command>net view</command> command or -in the Explorer browse list. (Note that you will of course see the -individual printers). -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>guest ok</name><value>yes</value></smbconfoption></term> - -<listitem><para> -if set to <constant>yes</constant>, then no password is required to -connect to the printers service. Access will be granted with the -privileges of the <smbconfoption><name>guest account</name></smbconfoption>. 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 <command>su - guest</command> and run a system print -command like -</para> - -<para><userinput>lpr -P printername /etc/motd</userinput></para> - -</listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>public</name><value>yes</value></smbconfoption></term> - <listitem><para> this is a synonym for <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption>. Since we have <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption>, -it really doesn't need to be here! (This leads to the interesting -question: <quote>What, if I by accident have to contradictory settings -for the same share?</quote> The answer is: the last one encountered by -Samba 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.) -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>read only</name><value>yes</value></smbconfoption></term> -<listitem><para>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 <emphasis>always</emphasis> allowed to -write to the directory (if user privileges allow the connection), but -only via print spooling operations. "Normal" write operations are not -allowed. </para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>writeable</name><value>no</value></smbconfoption></term> -<listitem><para> -synonym for <smbconfoption><name>read only</name><value>yes</value></smbconfoption> -</para></listitem></varlistentry> + <varlistentry><term><smbconfoption><name>comment</name><value>All printers </value></smbconfoption></term> + <listitem><para> + The <smbconfoption><name>comment</name></smbconfoption> is shown next to the share if + a client queries the server, either via <guiicon>Network Neighborhood</guiicon> or with + the <command>net view</command> command to list available shares. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>printable</name><value>yes </value></smbconfoption></term> + <listitem><para> + The <smbconfsection>[printers]</smbconfsection> service <emphasis>must</emphasis> + be declared as printable. If you specify otherwise, smbd will refuse to load at + startup. This parameter allows connected clients to open, write to and submit spool files + into the directory specified with the <smbconfoption><name>path</name></smbconfoption> + parameter for this service. It is used by Samba to differentiate printer shares from + file shares. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>path</name><value>/var/spool/samba </value></smbconfoption></term> + <listitem><para> + Must point to a directory used by Samba to spool incoming print files. <emphasis>It + must not be the same as the spool directory specified in the configuration of your UNIX + print subsystem!</emphasis> The path typically points to a directory that is world + writeable, with the <quote>sticky</quote> bit set to it. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>browseable</name><value>no </value></smbconfoption></term> + <listitem><para> + Is always set to <constant>no</constant> if + <smbconfoption><name>printable</name><value>yes</value></smbconfoption>. It makes + the <smbconfsection>[printer]</smbconfsection> share itself invisible in the list of + available shares in a <command>net view</command> command or in the Explorer browse + list. (You will of course see the individual printers). + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>guest ok</name><value>yes </value></smbconfoption></term> + <listitem><para> + If this parameter is set to <constant>yes</constant>, no password is required to + connect to the printer's service. Access will be granted with the privileges of the + <smbconfoption><name>guest account</name></smbconfoption>. On many systems the guest + account will map to a user named <quote>nobody</quote>. This user will usually be found + in the UNIX passwd file with an empty password, but with no valid UNIX login. (On some + systems the guest account might not have the privilege to be able to print. Test this + by logging in as your guest user using <command>su - guest</command> and run a system + print command like: + </para> + + <para> + <userinput>lpr -P printername /etc/motd</userinput> + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>public</name><value>yes </value></smbconfoption></term> + <listitem><para> + Is a synonym for <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption>. + Since we have <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption>, it + really does not need to be here. (This leads to the interesting question: <quote>What if I + by accident have two contradictory settings for the same share?</quote> The answer is the + last one encountered by Samba wins. Testparm does not complain about different settings + of the same parameter for the same share. You can test this by setting up multiple + lines for the <parameter>guest account</parameter> parameter with different usernames, + and then run testparm to see which one is actually used by Samba.) + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>read only</name><value>yes </value></smbconfoption></term> + <listitem><para> + Normally (for other types of shares) prevents users from creating or modifying files + in the service's directory. However, in a <quote>printable</quote> service, it is + <emphasis>always</emphasis> allowed to write to the directory (if user privileges allow the + connection), but only via print spooling operations. Normal write operations are not permitted. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>writeable</name><value>no </value></smbconfoption></term> + <listitem><para> + Is a synonym for <smbconfoption><name>read only</name><value>yes</value></smbconfoption>. + </para></listitem> + </varlistentry> </variablelist> -</sect2> +</sect3> -<sect2> +<sect3> <title>Any [my_printer_name] Section</title> <para> -If a section appears in the , which is -tagged as <smbconfoption><name>printable</name><value>yes</value></smbconfoption>, 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! +If a section appears in the &smb.conf; file, which when given the parameter +<smbconfoption><name>printable</name><value>yes</value></smbconfoption> causes Samba to configure it +as a printer share. Windows 9x/Me clients may have problems with connecting or loading printer drivers +if the share name has more than eight characters. Do not name a printer share with a name that may conflict +with an existing user or file share name. On Client connection requests, Samba always tries to find file +shares with that name first. If it finds one, it will connect to this and will not connect +to a printer with the same name! </para> <variablelist> -<varlistentry><term><smbconfoption><name>comment</name><value>Printer with Restricted Access</value></smbconfoption></term> -<listitem><para> the comment says it all. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>path</name><value>/var/spool/samba_my_printer</value></smbconfoption></term> -<listitem><para> 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. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>printer admin</name><value>kurt</value></smbconfoption></term> -<listitem><para> the printer admin definition is different for this -explicitly defined printer share from the general -<smbconfsection>[printers]</smbconfsection> share. It is not a requirement; we -did it to show that it is possible if you want it. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>browseable</name><value>yes</value></smbconfoption></term> -<listitem><para> we also made this printer browseable (so that the -clients may conveniently find it when browsing the <guiicon>Network -Neighbourhood</guiicon>). -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>printable</name><value>yes</value></smbconfoption></term> -<listitem><para>see explanation in last subsection. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>writeable</name><value>no</value></smbconfoption></term> -<listitem><para>see explanation in last subsection. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>hosts allow</name><value>10.160.50.,10.160.51.</value></smbconfoption></term> -<listitem><para>here we exercise a certain degree of access control -by using the <smbconfoption><name>hosts allow</name></smbconfoption> and <smbconfoption><name>hosts deny</name></smbconfoption> 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 -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>hosts deny</name><value>turbo_xp,10.160.50.23,10.160.51.60</value></smbconfoption></term> -<listitem><para>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. -</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>guest ok</name><value>no</value></smbconfoption></term> -<listitem><para>this printer is not open for the guest account! -</para></listitem></varlistentry> - + <varlistentry><term><smbconfoption><name>comment</name><value>Printer with Restricted Access </value></smbconfoption></term> + <listitem><para> + The comment says it all. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>path</name><value>/var/spool/samba_my_printer </value></smbconfoption></term> + <listitem><para> + Sets the spooling area for this printer to a directory other than the default. It is not + necessary to set it differently, but the option is available. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>printer admin</name><value>kurt </value></smbconfoption></term> + <listitem><para> + The printer admin definition is different for this explicitly defined printer share from the general + <smbconfsection>[printers]</smbconfsection> share. It is not a requirement; we + did it to show that it is possible. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>browseable</name><value>yes </value></smbconfoption></term> + <listitem><para> + This makes the printer browseable so the clients may conveniently find it when browsing the + <guiicon>Network Neighborhood</guiicon>. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>printable</name><value>yes </value></smbconfoption></term> + <listitem><para> + See <link linkend="ptrsect"/>. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>writeable</name><value>no </value></smbconfoption></term> + <listitem><para> + See <link linkend="ptrsect"/>. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>hosts allow</name><value>10.160.50.,10.160.51. </value></smbconfoption></term> + <listitem><para> + Here we exercise a certain degree of access control by using the <smbconfoption><name>hosts allow</name></smbconfoption> and <smbconfoption><name>hosts deny</name></smbconfoption> + parameters. This is not by any means a safe bet. It is not a way to secure your + printers. This line accepts all clients from a certain subnet in a first evaluation of + access control. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>hosts deny</name><value>turbo_xp,10.160.50.23,10.160.51.60 </value></smbconfoption></term> + <listitem><para> + 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. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>guest ok</name><value>no </value></smbconfoption></term> + <listitem><para> + This printer is not open for the guest account. + </para></listitem> + </varlistentry> </variablelist> -</sect2> +</sect3> -<sect2> +<sect3> <title>Print Commands</title> <para> -In each section defining a printer (or in the -<smbconfsection>[printers]</smbconfsection> section), a <parameter>print -command</parameter> 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 <smbconfoption><name>path</name></smbconfoption> -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. -</para> -</sect2> - -<sect2> -<title>Default Print Commands for various UNIX Print Subsystems</title> - -<para> -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 -<smbconfoption><name>print command</name></smbconfoption>. The default print command varies -depending on the <smbconfoption><name>printing</name></smbconfoption> parameter -setting. In the commands listed below, you will notice some parameters -of the form <emphasis>%X</emphasis> where <emphasis>X</emphasis> is -<emphasis>p, s, J</emphasis> 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): -</para> - -<informaltable frame='all'> -<tgroup cols='2' align='left' colsep='1' rowsep='1'> -<thead> -<row> -<entry>If this setting is active...</entry> -<entry>...this is used in lieu of an explicit command:</entry> -</row> -</thead> -<tbody> -<row> -<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> -<entry>print command is <command>lpr -r -P%p %s</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> -<entry>print command is <command>lp -c -P%p %s; rm %s</command></entry> -</row> -<row> -<entry> <smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> -<entry>print command is <command>lp -r -P%p -s %s</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> -<entry>lpq command is <command>lpq -P%p</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> -<entry>lpq command is <command>lpstat -o%p</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> -<entry>lpq command is <command>lpq -P%p</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> -<entry>lprm command is <command>lprm -P%p %j</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> -<entry>lprm command is <command>cancel %p-%j</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> -<entry>lprm command is <command>cancel %p-%j</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> -<entry>lppause command is <command>lp -i %p-%j -H hold</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> -<entry>lppause command (...is empty)</entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> -<entry>lppause command (...is empty)</entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> -<entry>lpresume command is <command>lp -i %p-%j -H resume</command></entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> -<entry>lpresume command (...is empty)</entry> -</row> -<row> -<entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> -<entry>lpresume command (...is empty)</entry> -</row> -</tbody> -</tgroup> -</informaltable> - -<para> -We excluded the special CUPS case here, because it is discussed in the -next chapter. Just a short summary. For <parameter>printing = -CUPS</parameter>: If SAMBA is compiled against libcups, it uses the -CUPS API to submit jobs, etc. (It is a good idea also to set -<smbconfoption><name>printcap</name><value>cups</value></smbconfoption> in case your -<filename>cupsd.conf</filename> 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 -<command>lp -c -d%p -oraw; rm %s</command> With <parameter>printing = -cups</parameter> , and if SAMBA is compiled against libcups, any -manually set print command will be ignored! -</para> - -<!-- FIXME: This information is for 2.2 --> -<para> -Having listed the above mappings here, you should note that there used -to be a <emphasis>bug</emphasis> 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 <command>print</command> command, the -<command>lpq</command> command and the <command>lprm</command> -command). The <command>lppause</command> command and the -<command>lpresume</command> 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 <command>testparm -v</command> 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. +In each section defining a printer (or in the <smbconfsection>[printers]</smbconfsection> section), +a <parameter>print command</parameter> parameter may be defined. It sets a command to process the files +that have been placed into the Samba print spool directory for that printer. (That spool directory was, +if you remember, set up with the <smbconfoption><name>path</name></smbconfoption> parameter). Typically, +this command will submit the spool file to the Samba host's print subsystem, using the suitable system +print command. But there is no requirement that this needs to be the case. For debugging or +some other reason, you may want to do something completely different than print the file. An example is a +command that just copies the print file to a temporary location for further investigation when you need +to debug printing. If you craft your own print commands (or even develop print command shell scripts), +make sure you pay attention to the need to remove the files from the Samba spool directory. Otherwise, +your hard disk may soon suffer from shortage of free space. </para> -</sect2> +</sect3> -<sect2> -<title>Setting up your own Print Commands</title> - -<para> -After a print job has finished spooling to a service, the -<smbconfoption><name>print command</name></smbconfoption> will be used by Samba via a -<emphasis>system()</emphasis> 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. -</para> - -<para> -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 <emphasis>%X</emphasis> These are -<emphasis>macros</emphasis>, 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: +<sect3> +<title>Default UNIX System Printing Commands</title> + +<para> +You learned earlier on that Samba, in most cases, uses its built-in settings for many parameters +if it cannot find an explicitly stated one in its configuration file. The same is true for the +<smbconfoption><name>print command</name></smbconfoption>. The default print command varies depending +on the <smbconfoption><name>printing</name></smbconfoption> parameter setting. In the commands listed +below, you will notice some parameters of the form <emphasis>%X</emphasis> where <emphasis>X</emphasis> is +<emphasis>p, s, J</emphasis>, and so on. These letters stand for printer name, spoolfile and job ID, respectively. +They are explained in more detail further below. <link linkend="printOptions"/> presents an overview of key +printing options but excludes the special case of CUPS that is discussed in <link linkend="CUPS-printing"/>. +</para> + +<table frame='all' id="printOptions"> + <title>Default Printing Settings</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec align="left"/> + <colspec align="left"/> + <thead> + <row> + <entry>Setting</entry> + <entry>Default Printing Commands</entry> + </row> + </thead> + <tbody> + <row> + <entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> + <entry>print command is <command>lpr -r -P%p %s</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>print command is <command>lp -c -P%p %s; rm %s</command></entry> + </row> + <row> + <entry> <smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>print command is <command>lp -r -P%p -s %s</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> + <entry>lpq command is <command>lpq -P%p</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lpq command is <command>lpstat -o%p</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lpq command is <command>lpq -P%p</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> + <entry>lprm command is <command>lprm -P%p %j</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lprm command is <command>cancel %p-%j</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lprm command is <command>cancel %p-%j</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> + <entry>lppause command is <command>lp -i %p-%j -H hold</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lppause command (...is empty)</entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lppause command (...is empty)</entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>bsd|aix|lprng|plp</value></smbconfoption></entry> + <entry>lpresume command is <command>lp -i %p-%j -H resume</command></entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>sysv|hpux</value></smbconfoption></entry> + <entry>lpresume command (...is empty)</entry> + </row> + <row> + <entry><smbconfoption><name>printing</name><value>qnx</value></smbconfoption></entry> + <entry>lpresume command (...is empty)</entry> + </row> + </tbody> + </tgroup> +</table> + +<para> +We excluded the special case of CUPS here, because it is discussed in the next chapter. For +<parameter>printing = CUPS</parameter>, if Samba is compiled against libcups, it uses the CUPS API to submit +jobs. (It is a good idea also to set <smbconfoption><name>printcap</name><value>cups</value></smbconfoption> +in case your <filename>cupsd.conf</filename> 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 <command>lp -c -d%p -oraw; rm %s</command>. With <parameter>printing = cups</parameter>, +and if Samba is compiled against libcups, any manually set print command will be ignored! </para> -<itemizedlist> -<listitem><para><parameter>%s, %f</parameter> - the path to the spool -file name</para></listitem> - -<listitem><para><parameter>%p</parameter> - the appropriate printer -name</para></listitem> +</sect3> -<listitem><para><parameter>%J</parameter> - the job name as -transmitted by the client.</para></listitem> +<sect3> +<title>Custom Print Commands</title> -<listitem><para><parameter>%c</parameter> - the number of printed -pages of the spooled job (if known).</para></listitem> +<para> +After a print job has finished spooling to a service, the <smbconfoption><name>print command</name></smbconfoption> + will be used by Samba via a <emphasis>system()</emphasis> call to process the +spool file. Usually the command specified will submit the spool file to the host's printing subsystem. But +there is no requirement at all that this must be the case. The print subsystem may not remove the spool +file on its own. So whatever command you specify, you should ensure that the spool file is deleted after +it has been processed. +</para> -<listitem><para><parameter>%z</parameter> - the size of the spooled -print job (in bytes)</para></listitem> +<para> +There is no difficulty with using your own customized print commands with the traditional printing +systems. However, if you do not wish to roll your own, you should be well informed about the default +built-in commands that Samba uses for each printing subsystem (see +Table 17.1). In all the +commands listed in the last paragraphs, you see parameters of the form <emphasis>%X</emphasis>. These are +<emphasis>macros</emphasis>, or shortcuts, used as placeholders for the names of real objects. At the time +of running a command with such a placeholder, Samba will insert the appropriate value automatically. Print +commands can handle all Samba macro substitutions. In regard to printing, the following ones do have +special relevance: +</para> +<itemizedlist> + <listitem><para><parameter>%s, %f</parameter> &smbmdash; the path to the spool file name.</para></listitem> + <listitem><para><parameter>%p</parameter> &smbmdash; the appropriate printer name.</para></listitem> + <listitem><para><parameter>%J</parameter> &smbmdash; the job name as transmitted by the client.</para></listitem> + <listitem><para><parameter>%c</parameter> &smbmdash; the number of printed pages of the spooled job (if known).</para></listitem> + <listitem><para><parameter>%z</parameter> &smbmdash; the size of the spooled print job (in bytes).</para></listitem> </itemizedlist> <para> -The print command MUST contain at least one occurrence of -<parameter>%s</parameter> or <parameter>%f</parameter>. -- The -<parameter>%p</parameter> is optional. If no printer name is supplied, -the <parameter>%p</parameter> will be silently removed from the print -command. In this case the job is sent to the default printer. +The print command must contain at least one occurrence of <parameter>%s</parameter> or +the <parameter>%f</parameter>. The <parameter>%p</parameter> is optional. If no printer name is supplied, +the <parameter>%p</parameter> will be silently removed from the print command. In this case, the job is +sent to the default printer. </para> <para> -If specified in the <smbconfsection>[global]</smbconfsection> 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. +If specified in the <smbconfsection>[global]</smbconfsection> section, the print command given will be +used for any printable service that does not have its own print command specified. If there is neither a +specified print command for a printable service nor a global print command, spool files will be created +but not processed! Most importantly, print files will not be removed, so they will consume disk space. </para> <para> -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 <smbconfsection>[global]</smbconfsection> section with the <parameter>guest -account</parameter> parameter. +Printing may fail on some UNIX systems when using the <quote>nobody</quote> account. If this happens, create an +alternative guest account and give it the privilege to print. Set up this guest account in the +<smbconfsection>[global]</smbconfsection> section with the <parameter>guest account</parameter> parameter. </para> <para> -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 <parameter>$variable</parameter> -in or in the Samba print command is -<parameter>%$variable</parameter>.) To give you a working -<smbconfoption><name>print command</name></smbconfoption> example, the following will log a -print job to <filename>/tmp/print.log</filename>, print the file, then -remove it. Note that ';' is the usual separator for commands in shell -scripts: +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 <parameter>$variable</parameter> +in the Samba print command is <parameter>%$variable</parameter>.) To give you a working +<smbconfoption><name>print command</name></smbconfoption> example, the following will log a print job +to <filename>/tmp/print.log</filename>, print the file, then remove it. The semicolon (<quote>;</quote> +is the usual separator for commands in shell scripts: </para> <para><smbconfblock> @@ -1052,30 +967,28 @@ scripts: </smbconfblock></para> <para> -You may have to vary your own command considerably from this example -depending on how you normally print files on your system. The default -for the <smbconfoption><name>print command</name></smbconfoption> parameter varies depending on the setting of -the <smbconfoption><name>printing</name></smbconfoption> parameter. Another example is: +You may have to vary your own command considerably from this example depending on how you normally print +files on your system. The default for the <smbconfoption><name>print command</name></smbconfoption> +parameter varies depending on the setting of the <smbconfoption><name>printing</name></smbconfoption> +parameter. Another example is: </para> <para><smbconfblock> <smbconfoption><name>print command</name><value>/usr/local/samba/bin/myprintscript %p %s</value></smbconfoption> </smbconfblock></para> +</sect3> </sect2> </sect1> <sect1> -<title>Innovations in Samba Printing since 2.2</title> +<title>Printing Developments Since Samba-2.2</title> <para> -Before version 2.2.0, Samba's print server support for Windows clients -was limited to the level of <emphasis>LanMan</emphasis> 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 <emphasis>MS-RPC</emphasis> (RPC = <emphasis>Remote -Procedure Calls</emphasis> ). MS-RPCs use the -<emphasis>SPOOLSS</emphasis> named pipe for all printing. +Prior to Samba-2.2.x, print server support for Windows clients was limited to <emphasis>LanMan</emphasis> +printing calls. This is the same protocol level as Windows 9x/Me PCs offer when they share printers. +Beginning with the 2.2.0 release, Samba started to support the native Windows NT printing mechanisms. These +are implemented via <emphasis>MS-RPC</emphasis> (RPC = <emphasis>Remote Procedure Calls</emphasis> +). MS-RPCs use the <emphasis>SPOOLSS</emphasis> named pipe for all printing. </para> <para> @@ -1083,182 +996,170 @@ The additional functionality provided by the new SPOOLSS support includes: </para> <itemizedlist> -<listitem><para>Support for downloading printer driver files to Windows -95/98/NT/2000 clients upon demand (<emphasis>Point'n'Print</emphasis>); -</para></listitem> - -<listitem><para>Uploading of printer drivers via the Windows NT -<emphasis>Add Printer Wizard</emphasis> (APW) or the -<ulink url="http://imprints.sourceforge.net/">Imprints</ulink> tool set. -</para></listitem> + <listitem><para> + Support for downloading printer driver files to Windows 95/98/NT/2000 clients upon + demand (<emphasis>Point'n'Print</emphasis>). + </para></listitem> -<listitem><para>Support for the native MS-RPC printing calls such as - StartDocPrinter, EnumJobs(), etc... (See the <ulink url="http://msdn.microsoft.com/">MSDN documentation</ulink> for more information on the Win32 printing API);</para></listitem> + <listitem><para> + Uploading of printer drivers via the Windows NT <emphasis>Add Printer Wizard</emphasis> (APW) + or the <ulink url="http://imprints.sourceforge.net/">Imprints</ulink> tool set. + </para></listitem> -<listitem><para>Support for NT <emphasis>Access Control -Lists</emphasis> (ACL) on printer objects;</para></listitem> + <listitem><para> + Support for the native MS-RPC printing calls such as + StartDocPrinter, EnumJobs(), and so on. (See the + <ulink url="http://msdn.microsoft.com/">MSDN documentation</ulink> for more information on the + Win32 printing API). + </para></listitem> -<listitem><para>Improved support for printer queue manipulation -through the use of internal databases for spooled job information -(implemented by various <filename>*.tdb</filename> -files).</para></listitem> + <listitem><para> + Support for NT <emphasis>Access Control Lists</emphasis> (ACL) on printer objects. + </para></listitem> + <listitem><para> + Improved support for printer queue manipulation through the use of internal databases for spooled + job information (implemented by various <filename>*.tdb</filename> files). + </para></listitem> </itemizedlist> <para> -One other benefit of an update is this: Samba 3 is able to publish -all its printers in Active Directory (or LDAP)! +A benefit of updating is that Samba-3 is able to publish its printers to Active Directory (or LDAP). </para> <para> -One slight difference is here: it is possible on a Windows NT print -server to have printers listed in the Printers folder which are -<emphasis>not</emphasis> 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/200x/XP Professional -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 <emphasis>Everyone</emphasis> -group. (The older clients of type Win9x can only print to "shared" +A fundamental difference exists between MS Windows NT print servers and Samba operation. Windows NT +permits the installation of local printers that are not shared. This is an artifact of the fact that +any Windows NT machine (server or client) may be used by a user as a workstation. Samba will publish all +printers that are made available, either by default or by specific declaration via printer-specific shares. +</para> + +<para> +Windows NT/200x/XP Professional clients do not have to use the standard SMB printer share; they can +print directly to any printer on another Windows NT host using MS-RPC. This, of course, assumes that +the client has the necessary privileges on the remote host that serves the printer resource. The +default permissions assigned by Windows NT to a printer gives the Print permissions to the well-known +<emphasis>Everyone</emphasis> group. (The older clients of type Windows 9x/Me can only print to shared printers). </para> <sect2> -<title>Client Drivers on Samba Server for <emphasis>Point'n'Print</emphasis></title> +<title>Point'n'Print Client Drivers on Samba Servers</title> <para> -There is still confusion about what all this means: <emphasis>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?</emphasis> The -answer to this is: No, it is not a -<emphasis>requirement</emphasis>. Windows NT/2000 clients can, of -course, also run their APW to install drivers -<emphasis>locally</emphasis> (which then connect to a Samba served -print queue). This is the same method as used by Windows 9x -clients. (However, a <emphasis>bug</emphasis> 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). +There is much confusion about what all this means. The question is often asked, <quote>Is it or is +it not necessary for printer drivers to be installed on a Samba host in order to support printing from +Windows clients?</quote> The answer to this is no, it is not necessary. </para> <para> -But it is a new <emphasis>option</emphasis> to install the printer -drivers into the <smbconfsection>[print$]</smbconfsection> share of the Samba -server, and a big convenience too. Then <emphasis>all</emphasis> -clients (including 95/98/ME) get the driver installed when they first -connect to this printer share. The <emphasis>uploading</emphasis> or -<emphasis>depositing</emphasis> of the driver into this -<smbconfsection>[print$]</smbconfsection> share, and the following binding of -this driver to an existing Samba printer share can be achieved by -different means: +Windows NT/2000 clients can, of course, also run their APW to install drivers <emphasis>locally</emphasis> +(which then connect to a Samba-served print queue). This is the same method used by Windows 9x/Me +clients. (However, a <emphasis>bug</emphasis> existed in Samba 2.2.0 that made Windows NT/2000 clients +require that the Samba server possess a valid driver for the printer. This was fixed in Samba 2.2.1). </para> -<itemizedlist> -<listitem><para>running the <emphasis>APW</emphasis> on an -NT/200x/XP Professional client (this doesn't work from 95/98/ME -clients);</para></listitem> +<para> +But it is a new capability to install the printer drivers into the <smbconfsection>[print$]</smbconfsection> +share of the Samba server, and a big convenience, too. Then <emphasis>all</emphasis> clients +(including 95/98/ME) get the driver installed when they first connect to this printer share. The +<emphasis>uploading</emphasis> or <emphasis>depositing</emphasis> of the driver into this +<smbconfsection>[print$]</smbconfsection> share and the following binding of this driver to an existing +Samba printer share can be achieved by different means: +</para> -<listitem><para>using the <emphasis>Imprints</emphasis> -toolset;</para></listitem> +<itemizedlist> + <listitem><para> + Running the <emphasis>APW</emphasis> on an NT/200x/XP Professional client (this does not work from 95/98/ME clients). + </para></listitem> -<listitem><para>using the <emphasis>smbclient</emphasis> and -<emphasis>rpcclient</emphasis> commandline tools;</para></listitem> + <listitem><para> + Using the <emphasis>Imprints</emphasis> toolset. + </para></listitem> -<listitem><para>using <emphasis>cupsaddsmb</emphasis>(only works for -the CUPS printing system, not for LPR/LPD, LPRng -etc.).</para></listitem> + <listitem><para> + Using the <emphasis>smbclient</emphasis> and <emphasis>rpcclient</emphasis> commandline tools. + </para></listitem> + <listitem><para> + Using <emphasis>cupsaddsmb</emphasis> (only works for the CUPS + printing system, not for LPR/LPD, LPRng, and so on). + </para></listitem> </itemizedlist> <para> -Please take additional note of the following fact: <emphasis>Samba -does not use these uploaded drivers in any way to process spooled -files</emphasis>. 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. +Samba does not use these uploaded drivers in any way to process spooled files. These drivers are utilized +entirely by the clients who download and install them via the <quote>Point'n'Print</quote> mechanism +supported by Samba. The clients use these drivers to generate print files in the format the printer +(or the UNIX print system) requires. Print files received by Samba are handed over to the UNIX printing +system, which is responsible for all further processing, as needed. </para> </sect2> <sect2> -<title>The [printer$] Section is removed from Samba 3</title> - -<formalpara><title> -<smbconfsection>[print$]</smbconfsection> vs. <smbconfsection>[printer$]</smbconfsection> -</title> - -<para> -Versions of Samba prior to 2.2 made it possible to use a share -named <emphasis>[printer$]</emphasis>. 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 -<smbconfsection>[printer$]</smbconfsection> 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 <parameter>printer driver location</parameter> to be -used on a per share basis. This specified the location of the driver -files associated with that printer. Another parameter named -<parameter>printer driver</parameter> provided a means of defining the -printer driver name to be sent to the client. These parameters, -including the <parameter>printer driver file</parameter> parameter, -are now removed and can not be used in installations of samba-3. -Now the share name <smbconfsection>[print$]</smbconfsection> is used for the -location of downloadable printer drivers. It is taken from the -<smbconfsection>[print$]</smbconfsection> service created by Windows NT PCs when -a printer is shared by them. Windows NT print servers always have a -<smbconfsection>[print$]</smbconfsection> 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 -<smbconfsection>[print$]</smbconfsection> share support just fine. -</para></formalpara> +<title>The Obsoleted [printer$] Section</title> + + <para> + Versions of Samba prior to 2.2 made it possible to use a share named + <parameter>[printer$]</parameter>. This name was taken from the same named service created by + Windows 9x/Me clients when a printer was shared by them. Windows 9x/Me printer servers always + have a <smbconfsection>[printer$]</smbconfsection> service that provides read-only access (with + no password required) to support printer driver downloads. However, Samba's initial + implementation allowed for a parameter named <parameter>printer driver location</parameter> to + be used on a per share basis. This specified the location of the driver files associated with + that printer. Another parameter named <parameter>printer driver</parameter> provided a means of + defining the printer driver name to be sent to the client. + </para> + + <para> + These parameters, including the <parameter>printer driver file</parameter> parameter, + are now removed and cannot be used in installations of Samba-3. The share name + <smbconfsection>[print$]</smbconfsection> is now used for the location of downloadable printer + drivers. It is taken from the <smbconfsection>[print$]</smbconfsection> service created + by Windows NT PCs when a printer is shared by them. Windows NT print servers always have a + <smbconfsection>[print$]</smbconfsection> service that provides read-write access (in the context + of its ACLs) to support printer driver downloads and uploads. This does not mean Windows + 9x/Me clients are now thrown aside. They can use Samba's <smbconfsection>[print$]</smbconfsection> + share support just fine. + </para> </sect2> <sect2> <title>Creating the [print$] Share</title> <para> -In order to support the up- and downloading of printer driver files, -you must first configure a file share named -<smbconfsection>[print$]</smbconfsection>. The "public" name of this share is -hard coded in Samba's internals (because it is hard coded 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. +In order to support the uploading and downloading of printer driver files, you must first configure a +file share named <smbconfsection>[print$]</smbconfsection>. The public name of this share is hard coded +in the MS Windows clients. It cannot be renamed since Windows clients are programmed to search for a +service of exactly this name if they want to retrieve printer driver files. </para> <para> -You should modify the server's file to -add the global parameters and create the -<smbconfsection>[print$]</smbconfsection> file share (of course, some of the -parameter values, such as 'path' are arbitrary and should be replaced -with appropriate values for your site): +You should modify the server's file to add the global parameters and create the +<smbconfsection>[print$]</smbconfsection> file share (of course, some of the parameter values, such +as <smbconfoption><name>path</name></smbconfoption> are arbitrary and should be replaced with appropriate values for your +site). See <link linkend="prtdollar"/>. </para> -<para><smbconfexample> - <title>[print\$] example</title> - <smbconfsection>[global]</smbconfsection> - <smbconfcomment>members of the ntadmin group should be able to add drivers and set</smbconfcomment> - <smbconfcomment>printer properties. root is implicitly always a 'printer admin'.</smbconfcomment> - <smbconfoption><name>printer admin</name><value>@ntadmin</value></smbconfoption> - <member>...</member> - <smbconfsection>[printers]</smbconfsection> - <member>...</member> - - <smbconfsection>[print$]</smbconfsection> +<para> +<smbconfexample id="prtdollar"> +<title>[print\$] example</title> +<smbconfsection>[global]</smbconfsection> +<smbconfcomment>members of the ntadmin group should be able to add drivers and set</smbconfcomment> +<smbconfcomment>printer properties. root is implicitly always a 'printer admin'.</smbconfcomment> +<smbconfoption><name>printer admin</name><value>@ntadmin</value></smbconfoption> +<member>...</member> +<smbconfsection>[printers]</smbconfsection> +<member>...</member> +<smbconfsection>[print$]</smbconfsection> <smbconfoption><name>comment</name><value>Printer Driver Download Area</value></smbconfoption> <smbconfoption><name>path</name><value>/etc/samba/drivers</value></smbconfoption> <smbconfoption><name>browseable</name><value>yes</value></smbconfoption> <smbconfoption><name>guest ok</name><value>yes</value></smbconfoption> <smbconfoption><name>read only</name><value>yes</value></smbconfoption> <smbconfoption><name>write list</name><value>@ntadmin, root</value></smbconfoption> -</smbconfexample></para> +</smbconfexample> +</para> <para> Of course, you also need to ensure that the directory named by the @@ -1268,143 +1169,139 @@ Of course, you also need to ensure that the directory named by the </sect2> <sect2> -<title>Parameters in the [print$] Section</title> +<title>[print$] Section Parameters</title> <para> -<smbconfsection>[print$]</smbconfsection> is a special section in -. It contains settings relevant to -potential printer driver download and local installation by clients. +The <smbconfsection>[print$]</smbconfsection> is a special section in &smb.conf;. It contains settings relevant to +potential printer driver download and is used by windows clients for local print driver installation. +The following parameters are frequently needed in this share section: </para> <variablelist> - <varlistentry><term><smbconfoption><name>comment</name><value>Printer Driver - Download Area</value></smbconfoption></term> -<listitem><para> 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 <command>smbclient -L sambaserver -</command> output). </para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>path</name><value>/etc/samba/printers</value></smbconfoption></term> -<listitem><para> this is the path to the location of the Windows -driver file deposit from the UNIX point of -view.</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>browseable</name><value>no</value></smbconfoption></term> -<listitem><para> this makes the <smbconfsection>[print$]</smbconfsection> share -"invisible" in Network Neighbourhood to clients. However, you can -still "mount" it from any client using the <command>net use -g:\\sambaserver\print$</command> command in a "DOS box" or the -"Connect network drive" menu from Windows -Explorer.</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>guest ok</name><value>yes</value></smbconfoption></term> -<listitem><para>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 <parameter>guest ok = -yes</parameter> 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.</para> - -<note><para> -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 <smbconfoption><name>map to guest</name><value>Bad User</value></smbconfoption> in the -<smbconfsection>[global]</smbconfsection> section -as well. Make sure you understand what this parameter does before -using it. -</para></note> </listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>read only</name><value>yes</value></smbconfoption></term> -<listitem><para>as we don't want everybody to upload driver files (or -even change driver settings) we tagged this share as not -writeable.</para></listitem></varlistentry> - -<varlistentry><term><smbconfoption><name>write list</name><value>@ntadmin,root</value></smbconfoption></term> -<listitem><para>since the <smbconfsection>[print$]</smbconfsection> 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 -<smbconfoption><name>printer admin </name></smbconfoption> parameter. See the - man page for more information on -configuring file shares. </para></listitem></varlistentry> - + <varlistentry><term><smbconfoption><name>comment</name><value>Printer Driver Download Area </value></smbconfoption></term> + <listitem><para> + The comment appears next to the share name if it is listed in a share list (usually Windows + clients will not see it, but it will also appear up in a <command>smbclient -L sambaserver + </command> output). + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>path</name><value>/etc/samba/printers </value></smbconfoption></term> + <listitem><para> + Is the path to the location of the Windows driver file deposit from the UNIX point of view. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>browseable</name><value>no </value></smbconfoption></term> + <listitem><para> + Makes the <smbconfsection>[print$]</smbconfsection> share invisible to clients from the + <guimenu>Network Neighborhood</guimenu>. However, you can still mount it from any client + using the <command>net use g:\\sambaserver\print$</command> command in a DOS-box or the + <guimenu>Connect network drive menu></guimenu> from Windows Explorer. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>guest ok</name><value>yes </value></smbconfoption></term> + <listitem><para> + Gives read-only access to this share for all guest users. Access may be granted to + download and install printer drivers on clients. The requirement for <parameter>guest ok + = yes</parameter> depends on how your site is configured. If users will be guaranteed + to have an account on the Samba host, then this is a non-issue. + </para> + + <note><para> + If all your Windows NT users are guaranteed to be authenticated by the Samba server + (for example, if Samba authenticates via an NT domain server and the user has already been + validated by the Domain Controller in order to logon to the Windows NT session), then guest + access is not necessary. Of course, in a workgroup environment where you just want + to print without worrying about silly accounts and security, then configure the share for + guest access. You should consider adding <smbconfoption><name>map to guest</name><value>Bad + User</value></smbconfoption> in the <smbconfsection>[global]</smbconfsection> section + as well. Make sure you understand what this parameter does before using it. + </para></note> + </listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>read only</name><value>yes </value></smbconfoption></term> + <listitem><para> + Because we do not want everybody to upload driver files (or even change driver settings), + we tagged this share as not writeable. + </para></listitem> + </varlistentry> + + <varlistentry><term><smbconfoption><name>write list</name><value>@ntadmin, root </value></smbconfoption></term> + <listitem><para> + The <smbconfsection>[print$]</smbconfsection> was made read-only by the previous + setting so we should create a <parameter>write list</parameter> entry also. UNIX + groups (denoted with a leading <quote>@</quote> character). Users listed here are allowed + write-access (as an exception to the general public's read-only access), which they need to + update files on the share. Normally, you will want to only name administrative-level user + account in this setting. Check the file system permissions to make sure these accounts + can copy files to the share. If this is a non-root account, then the account should also + be mentioned in the global <smbconfoption><name>printer admin</name></smbconfoption> + parameter. See the &smb.conf; man page for more information on configuring file shares. + </para></listitem> + </varlistentry> </variablelist> </sect2> <sect2> -<title>Subdirectory Structure in [print$]</title> +<title>The [print$] Share Directory</title> <para> -In order for a Windows NT print server to support the downloading of -driver files by multiple client architectures, you must create several -subdirectories within the <smbconfsection>[print$]</smbconfsection> service -(i.e. the UNIX directory named by the <smbconfoption><name>path</name></smbconfoption> -parameter). These correspond to each of the supported client -architectures. Samba follows this model as well. Just like the name of -the <smbconfsection>[print$]</smbconfsection> 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). +In order for a Windows NT print server to support the downloading of driver files by multiple client +architectures, you must create several subdirectories within the <smbconfsection>[print$]</smbconfsection> +service (i.e., the UNIX directory named by the <smbconfoption><name>path</name></smbconfoption> +parameter). These correspond to each of the supported client architectures. Samba follows this model as +well. Just like the name of the <smbconfsection>[print$]</smbconfsection> share itself, the subdirectories +must be exactly the names listed below (you may leave out the subdirectories of architectures you do +not need to support). </para> <para> Therefore, create a directory tree below the <smbconfsection>[print$]</smbconfsection> share for each architecture you wish -to support. +to support like this: </para> -<!-- FIXME: diagram--> <para><programlisting> -[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" -</programlisting></para> - -<important><title>Required permissions</title> - -<para> -In order to add a new driver to your Samba host, one of two conditions -must hold true: +[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 +</programlisting> </para> -<itemizedlist> -<listitem><para>The account used to connect to the Samba host must -have a UID of 0 (i.e. a root account)</para></listitem> - -<listitem><para>The account used to connect to the Samba host must be -named in the <emphasis>printer admin</emphasis>list.</para></listitem> - -</itemizedlist> - -<para> -Of course, the connected account must still possess access to add -files to the subdirectories beneath -<smbconfsection>[print$]</smbconfsection>. Remember that all file shares are set -to 'read only' by default. -</para> +<important><title>Required permissions</title> + <para> + In order to add a new driver to your Samba host, one of two conditions must hold true: + </para> + + <itemizedlist> + <listitem><para> + The account used to connect to the Samba host must have a UID of 0 (i.e., a root account). + </para></listitem> + + <listitem><para> + The account used to connect to the Samba host must be named in the <emphasis>printer admin</emphasis>list. + </para></listitem> + </itemizedlist> + + <para> + Of course, the connected account must still have write access to add files to the subdirectories beneath + <smbconfsection>[print$]</smbconfsection>. Remember that all file shares are set to <quote>read-only</quote> by default. + </para> </important> <para> -Once you have created the required <smbconfsection>[print$]</smbconfsection> -service and associated subdirectories, go to a Windows NT 4.0/2k/XP -client workstation. Open <guiicon>Network Neighbourhood</guiicon> or -<guiicon>My Network Places</guiicon> and browse for the Samba host. -Once you have located the server, navigate to its <guiicon>Printers and -Faxes</guiicon> folder. You should see an initial listing of printers -that matches the printer shares defined on your Samba host. +Once you have created the required <smbconfsection>[print$]</smbconfsection> service and +associated subdirectories, go to a Windows NT 4.0/200x/XP client workstation. Open <guiicon>Network +Neighborhood</guiicon> or <guiicon>My Network Places</guiicon> and browse for the Samba host. Once you +have located the server, navigate to its <guiicon>Printers and Faxes</guiicon> folder. You should see +an initial listing of printers that matches the printer shares defined on your Samba host. </para> </sect2> </sect1> @@ -1413,191 +1310,163 @@ that matches the printer shares defined on your Samba host. <title>Installing Drivers into [print$]</title> <para> -You have successfully created the <smbconfsection>[print$]</smbconfsection> -share in ? And Samba has re-read its -configuration? Good. But you are not yet ready to take off. The -<emphasis>driver files</emphasis> need to be present in this share, -too! So far it is still an empty share. Unfortunately, it is not enough -to just copy the driver files over. They need to be <emphasis>set -up</emphasis> too. And that is a bit tricky, to say the least. We -will now discuss two alternative ways to install the drivers into -<smbconfsection>[print$]</smbconfsection>: +Have you successfully created the <smbconfsection>[print$]</smbconfsection> share in &smb.conf;, and have your forced Samba +to re-read its &smb.conf; file? Good. But you are not yet ready to use the new facility. The client driver +files need to be installed into this share. So far it is still an empty share. Unfortunately, it is +not enough to just copy the driver files over. They need to be +correctly installed so that appropriate +records for each driver will exist in the Samba internal databases so it can provide the correct +drivers as they are requested from MS Windows clients. And that is a bit tricky, to say the least. We +now discuss two alternative ways to install the drivers into <smbconfsection>[print$]</smbconfsection>: </para> <itemizedlist> + <listitem><para> + Using the Samba commandline utility <command>rpcclient</command> with its various subcommands (here: + <command>adddriver</command> and <command>setdriver</command>) from any UNIX workstation. + </para></listitem> -<listitem><para>using the Samba commandline utility -<command>rpcclient</command> with its various subcommands (here: -<command>adddriver</command> and <command>setdriver</command>) from -any UNIX workstation;</para></listitem> - -<listitem><para>running a GUI (<emphasis>Printer -Properties</emphasis> and <emphasis>Add Printer Wizard</emphasis>) -from any Windows NT/2k/XP client workstation.</para></listitem> - + <listitem><para> + Running a GUI (<guiicon>Printer Properties</guiicon> and <guiicon>Add Printer Wizard</guiicon>) + from any Windows NT/200x/XP client workstation. + </para></listitem> </itemizedlist> <para> -The latter option is probably the easier one (even if the only -entrance to this realm seems a little bit weird at first). +The latter option is probably the easier one (even if the process may seem a little bit weird at first). </para> <sect2> -<title>Setting Drivers for existing Printers with a Client GUI</title> +<title>Add Printer Wizard Driver Installation</title> <para> -The initial listing of printers in the Samba host's -<guiicon>Printers</guiicon> folder accessed from a client's Explorer -will have no real printer driver assigned to them. By default -this driver name is set to a NULL -string. This must be changed now. The local <emphasis>Add Printer -Wizard</emphasis>, run from NT/2000/XP clients, will help us in this -task. +The initial listing of printers in the Samba host's <guiicon>Printers</guiicon> folder accessed from a +client's Explorer will have no real printer driver assigned to them. By default this driver name is set +to a null string. This must be changed now. The local <guiicon>Add Printer Wizard</guiicon> (APW), run from +NT/2000/XP clients, will help us in this task. </para> <para> -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 <guiicon>Printers</guiicon> folder, right-click the printer icon and -select <guimenu>Properties...</guimenu>. You are now trying to view printer and driver -properties for a queue which has this default <constant>NULL</constant> driver -assigned. This will result in an error message (this is normal here): +Installation of a valid printer driver is not straightforward. You must attempt +to view the printer properties for the printer to which you want the driver assigned. Open the Windows +Explorer, open <guiicon>Network Neighborhood</guiicon>, browse to the Samba host, open Samba's <guiicon>Printers</guiicon> +folder, right-click on the printer icon and select <guimenu>Properties...</guimenu>. You are now trying to +view printer and driver properties for a queue that has this default <constant>NULL</constant> driver +assigned. This will result in the following error message: </para> -<para><errorname> 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?</errorname></para> + <para><errorname> + 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? + </errorname></para> <para> -<emphasis>Important:</emphasis>Don't click <guibutton>Yes</guibutton>! Instead, -<emphasis>click <guibutton>No</guibutton></emphasis> 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: +Do not click on <guibutton>Yes</guibutton>! Instead, click on <guibutton>No</guibutton> 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 now have the choice of: </para> <itemizedlist> -<listitem><para>select a driver from the pop-up list of installed -drivers. <emphasis>Initially this list will be empty.</emphasis> -Or</para></listitem> + <listitem><para> + Select a driver from the pop-up list of installed drivers. Initially this list will be empty. + </para></listitem> -<listitem><para>use the <guibutton>New Driver...</guibutton> button to -install a new printer driver (which will in fact start up the -APW).</para></listitem> + <listitem><para> + Click on <guibutton>New Driver</guibutton> to install a new printer driver (which will + start up the APW). + </para></listitem> </itemizedlist> <para> -Once the APW is started, the procedure is exactly the same as the one -you are familiar with in Windows (we assume here that you are -familiar with the printer driver installations procedure on Windows -NT). Make sure your connection is in fact setup as a user with -<smbconfoption><name>printer admin</name></smbconfoption> privileges (if in doubt, use -<command>smbstatus</command> to check for this). If you wish to -install printer drivers for client operating systems other than -<application>Windows NT x86</application>, you will need to use the -<guilabel>Sharing</guilabel> tab of the printer properties dialog. +Once the APW is started, the procedure is exactly the same as the one you are familiar with in Windows (we +assume here that you are familiar with the printer driver installations procedure on Windows NT). Make sure +your connection is, in fact, setup as a user with <smbconfoption><name>printer admin</name></smbconfoption> +privileges (if in doubt, use <command>smbstatus</command> to check for this). If you wish to install +printer drivers for client operating systems other than <application>Windows NT x86</application>, +you will need to use the <guilabel>Sharing</guilabel> tab of the printer properties dialog. </para> <para> -Assuming you have connected with an administrative (or root) account -(as named by the <smbconfoption><name>printer admin</name></smbconfoption> 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. +Assuming you have connected with an administrative (or root) account (as named by the +<smbconfoption><name>printer admin</name></smbconfoption> parameter), you will also be able to modify +other printer properties such as ACLs and default device settings using this dialog. For the default +device settings, please consider the advice given further in <link linkend="inst-rpc"/>. </para> </sect2> -<sect2> -<title>Setting Drivers for existing Printers with -<command>rpcclient</command></title> +<sect2 id="inst-rpc"> +<title>Installing Print Drivers Using <command>rpcclient</command></title> <para> -The second way to install printer drivers into -<smbconfsection>[print$]</smbconfsection> and set them up in a valid way can be -done from the UNIX command line. This involves four distinct steps: +The second way to install printer drivers into <smbconfsection>[print$]</smbconfsection> and set them +up in a valid way is to do it from the UNIX command line. This involves four distinct steps: </para> <orderedlist> -<listitem><para>gathering the info about the required driver files -and collecting the files together;</para></listitem> + <listitem><para> + Gather info about required driver files and collect the files. + </para></listitem> -<listitem><para>deposit the driver files into the -<smbconfsection>[print$]</smbconfsection> share's correct subdirectories -(possibly by using <command>smbclient</command>);</para></listitem> + <listitem><para> + Deposit the driver files into the <smbconfsection>[print$]</smbconfsection> share's correct subdirectories + (possibly by using <command>smbclient</command>). + </para></listitem> -<listitem><para>running the <command>rpcclient</command> -commandline utility once with the <command>adddriver</command> -subcommand,</para></listitem> + <listitem><para> + Run the <command>rpcclient</command> command line utility once with the <command>adddriver</command> + subcommand. + </para></listitem> -<listitem><para>running <command>rpcclient</command> a second -time with the <command>setdriver</command> -subcommand.</para></listitem> + <listitem><para> + Run <command>rpcclient</command> a second time with the <command>setdriver</command> subcommand. + </para></listitem> </orderedlist> <para> -We will provide detailed hints for each of these steps in the next few -paragraphs. +We provide detailed hints for each of these steps in the paragraphs that follow. </para> <sect3> -<title>Identifying the Driver Files</title> - -<para> -To find out about the driver files, you have two options: you could -investigate the driver CD which comes with your printer. Study the -<filename>*.inf</filename> 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. -</para> - -<para> -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 <application>W32X86</application> platform only, a -name used by Microsoft for all WinNT/2k/XP clients...) -</para> - -<para> -A good method to recognize the driver files this is to print the test -page from the driver's <guilabel>Properties</guilabel> Dialog -(<guilabel>General</guilabel> 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 <guilabel>Driver File</guilabel> , the -<guilabel>Data File</guilabel>, the <guilabel>Config File</guilabel>, -the <guilabel>Help File</guilabel> and (optionally) the -<guilabel>Dependent Driver Files</guilabel> (this may vary slightly -for Windows NT). You need to remember all names (or better take a -note) for the next steps. -</para> - -<para> -Another method to quickly test the driver filenames and related paths -is provided by the <command>rpcclient</command> utility. Run it with -<command>enumdrivers</command> or with the -<command>getdriver</command> subcommand, each in the -<emphasis>3</emphasis> level. In the following example, -<emphasis>TURBO_XP</emphasis> 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 <emphasis>kde-bitshop</emphasis> is -the name of the Linux host from which I am working. We could run an -<emphasis>interactive</emphasis> <command>rpcclient</command> session; -then we'd get an <emphasis>rpcclient /></emphasis> prompt and would -type the subcommands at this prompt. This is left as a good exercise -to the reader. For now we use <command>rpcclient</command> with the -<option>-c</option> 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: +<title>Identifying Driver Files</title> + +<para> +To find out about the driver files, you have two options. You could check the contents of the driver +CDROM that came with your printer. Study the <filename>*.inf</filename> files lcoated on the CDROM. This +may not be possible, since the <filename>*.inf</filename> file might be missing. Unfortunately, vendors have now started +to use their own installation programs. These installations packages are often in some Windows platform +archive format. Additionally, the files may be re-named during the installation process. This makes it +extremely difficult to identify the driver files required. +</para> + +<para> +Then you only have the second option. Install the driver locally on a Windows client and +investigate which file names and paths it uses after they are installed. (You need to repeat +this procedure for every client platform you want to support. We show it here for the +<application>W32X86</application> platform only, a name used by Microsoft for all Windows NT/200x/XP +clients.) +</para> + +<para> +A good method to recognize the driver files is to print the test page from the driver's +<guilabel>Properties</guilabel> dialog (<guilabel>General</guilabel> 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 +<guilabel>Driver File</guilabel>, <guilabel>Data File</guilabel>, <guilabel>Config File</guilabel>, +<guilabel>Help File</guilabel> and (optionally) the <guilabel>Dependent Driver Files</guilabel> +(this may vary slightly for Windows NT). You need to take a note of all file names for the next steps. +</para> + +<para> +Another method to quickly test the driver filenames and related paths is provided by the +<command>rpcclient</command> utility. Run it with <command>enumdrivers</command> or with the +<command>getdriver</command> subcommand, each at the <filename>3</filename> info level. In the following example, +<emphasis>TURBO_XP</emphasis> is the name of the Windows PC (in this case it was a Windows XP Professional +laptop). I installed the driver locally to TURBO_XP, from a Samba server called <constant>KDE-BITSHOP</constant>. +We could run an interactive <command>rpcclient</command> session; then we would get an +<command>rpcclient /></command> prompt and would type the subcommands at this prompt. This is left as +a good exercise to the reader. For now, we use <command>rpcclient</command> with the <option>-c</option> +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: </para> <para><screen> @@ -1617,14 +1486,12 @@ Printer Driver Info 3: 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] @@ -1633,56 +1500,47 @@ Printer Driver Info 3: </screen></para> <para> -You may notice, that this driver has quite a big number of -<guilabel>Dependentfiles</guilabel> (I know worse cases however). Also, -strangely, the <guilabel>Driver File</guilabel> is here tagged as -<guilabel>Driver Path</guilabel>.... oh, well. Here we don't have yet -support for the so-called <application>WIN40</application> 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 <application>W32X86</application> -(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. +You may notice that this driver has quite a large number of <guilabel>Dependent files</guilabel> +(there are worse cases, however). Also, strangely, the +<guilabel>Driver File</guilabel> is tagged here +<guilabel>Driver Path</guilabel>. We do not yet have support for the so-called +<application>WIN40</application> architecture installed. This name is used by Microsoft for the Windows +9x/Me platforms. If we want to support these, we need to install the Windows 9x/Me driver files in +addition to those for <application>W32X86</application> (i.e., the Windows NT72000/XP clients) onto a +Windows PC. This PC can also host the Windows 9x/Me drivers, even if it runs on Windows NT, 2000 or XP. </para> <para> -Since the <smbconfsection>[print$]</smbconfsection> share is usually accessible -through the <guiicon>Network Neighbourhood</guiicon>, 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 -<filename>\\WINDOWSHOST\print$\WIN40\0\</filename>. +Since the <smbconfsection>[print$]</smbconfsection> share is usually accessible through the <guiicon>Network +Neighborhood</guiicon>, you can also use the UNC notation from Windows Explorer to poke at it. The Windows +9x/Me driver files will end up in subdirectory <filename>0</filename> of the <filename>WIN40</filename> +directory. The full path to access them will be <filename>\\WINDOWSHOST\print$\WIN40\0\</filename>. </para> -<note><para> more recent drivers on Windows 2000 and Windows XP are -installed into the "3" subdirectory instead of the "2". The version 2 -of drivers, as used in Windows NT, were running in Kernel Mode. -Windows 2000 changed this. While it still can use the Kernel Mode -drivers (if this is enabled by the Admin), its native mode for printer -drivers is User Mode execution. This requires drivers designed for -this. These type of drivers install into the "3" subdirectory. +<note><para> +More recent drivers on Windows 2000 and Windows XP are installed into the <quote>3</quote> subdirectory +instead of the <quote>2</quote>. 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 types of drivers install into the <quote>3</quote> subdirectory. </para></note> </sect3> <sect3> -<title>Collecting the Driver Files from a Windows Host's -[print$] Share</title> +<title>Obtaining Driver Files from Windows Client [print$] Shares</title> <para> -Now we need to collect all the driver files we identified. in our -previous step. Where do we get them from? Well, why not retrieve them -from the very PC and the same <smbconfsection>[print$]</smbconfsection> share -which we investigated in our last step to identify the files? We can -use <command>smbclient</command> to do this. We will use the paths and -names which were leaked to us by <command>getdriver</command>. The +Now we need to collect all the driver files we identified in our previous step. Where do we get them +from? Well, why not retrieve them from the very PC and the same <smbconfsection>[print$]</smbconfsection> +share that we investigated in our last step to identify the files? We can use <command>smbclient</command> +to do this. We will use the paths and names that were leaked to us by <command>getdriver</command>. The listing is edited to include linebreaks for readability: </para> <para><screen> -&rootprompt;<userinput>smbclient //TURBO_XP/print\$ -U'Danka%xxxx' \ - -c 'cd W32X86/2;mget HD*_de.* \ - hd*ppd Hd*_de.* Hddm*dll HDN*Aux.DLL'</userinput> +&rootprompt;<userinput>smbclient //TURBO_XP/print\$ -U'Danka%xxxx' \ + -c 'cd W32X86/2;mget HD*_de.* hd*ppd Hd*_de.* Hddm*dll HDN*Aux.DLL'</userinput> + 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] @@ -1692,63 +1550,58 @@ getting file \W32X86\2\Hddm91c1_de.def of size 428 as Hddm91c1_de.def <prompt>Get file Hddm91c1_de.DLL? </prompt><userinput>y</userinput> getting file \W32X86\2\Hddm91c1_de.DLL of size 876544 as Hddm91c1_de.DLL [...] - </screen></para> <para> -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 <option>-c</option> parameter, separated by semi-colons. This -effects that all commands are executed in sequence on the remote -Windows server before smbclient exits again. +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 <option>-c</option> parameter, separated by semi-colons. +This effects that all commands are executed in sequence on the remote Windows server before smbclient +exits again. </para> <para> -Don't forget to repeat the procedure for the <application>WIN40</application> -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 <command>smbclient ... put</command> to store -the collected files on the Samba server's -<smbconfsection>[print$]</smbconfsection> share. +Remember to repeat the procedure for the <application>WIN40</application> architecture should +you need to support Windows 9x/Me/XP clients. Remember too, the files for these architectures are in the +<filename>WIN40/0/</filename> subdirectory. Once this is complete, we can run <command>smbclient ... +put</command> to store the collected files on the Samba server's <smbconfsection>[print$]</smbconfsection> +share. </para> </sect3> <sect3> -<title>Depositing the Driver Files into [print$]</title> +<title>Installing Driver Files into [print$]</title> <para> -So, now we are going to put the driver files into the -<smbconfsection>[print$]</smbconfsection> 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 <smbconfsection>[print$]</smbconfsection> share maps to the UNIX path -<filename>/etc/samba/drivers/</filename>, your driver files should now -go here: +We are now going to locate the driver files into the <smbconfsection>[print$]</smbconfsection> +share. Remember, the UNIX path to this share has been defined +previously in your words missing here. You +also have created subdirectories for the different Windows client types you want to +support. Supposing your <smbconfsection>[print$]</smbconfsection> share maps to the UNIX path +<filename>/etc/samba/drivers/</filename>, your driver files should now go here: </para> <itemizedlist> -<listitem><para>for all Windows NT, 2000 and XP clients into -<filename>/etc/samba/drivers/W32X86/</filename> <emphasis>but -*not*(yet) into the "2" subdir</emphasis>!</para></listitem> + <listitem><para> + For all Windows NT, 2000 and XP clients into <filename>/etc/samba/drivers/W32X86/</filename> but + not (yet) into the <filename>2</filename> subdirectory. + </para></listitem> -<listitem><para>for all Windows 95, 98 and ME clients into -<filename>/etc/samba/drivers/WIN40/</filename> -- <emphasis>but *not* -(yet) into the "0" subdir</emphasis>!</para></listitem> + <listitem><para> + For all Windows 95, 98 and ME clients into <filename>/etc/samba/drivers/WIN40/</filename> but not + (yet) into the <filename>0</filename> subdirectory. + </para></listitem> </itemizedlist> <para> -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 <command>getdriver</command> against the original -<emphasis>Windows</emphasis> install. However, now we are going to -store the files into a <emphasis>Samba/UNIX</emphasis> print server's -<smbconfsection>[print$]</smbconfsection> share... +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 <command>getdriver</command> against the original +<emphasis>Windows</emphasis> install. However, now we are going to store the files into a +<emphasis>Samba/UNIX</emphasis> print server's <smbconfsection>[print$]</smbconfsection> share. </para> <para><screen> - &rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -U'root%xxxx' -c \ - 'cd W32X86; put HDNIS01_de.DLL; \ +&rootprompt;<userinput>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; \ @@ -1757,6 +1610,7 @@ store the files into a <emphasis>Samba/UNIX</emphasis> print server's put Hddm91c1_de.vnd; put Hddm91c1_de.hlp; \ put Hddm91c1_de_reg.HLP; put HDNIS01Aux.dll; \ put HDNIS01_de.NTF'</userinput> + 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] @@ -1776,29 +1630,23 @@ putting file Hddm91c1_de.hlp as \W32X86\Hddm91c1_de.hlp putting file Hddm91c1_de_reg.HLP as \W32X86\Hddm91c1_de_reg.HLP putting file HDNIS01Aux.dll as \W32X86\HDNIS01Aux.dll putting file HDNIS01_de.NTF as \W32X86\HDNIS01_de.NTF -</screen></para> +</screen> -<para> -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 <emphasis>don't</emphasis> -put them (for now) in this same subdirectory of the Samba box! This -re-location will automatically be done by the -<command>adddriver</command> command which we will run shortly (and -don't forget to also put the files for the Win95/98/ME architecture -into the <filename>WIN40/</filename> subdirectory should you need -them). +Whew &smbmdash; that was a lot of typing! Most drivers are a lot smaller &smbmdash; many only having three generic +PostScript driver files plus one PPD. While we did retrieve the files from the <filename>2</filename> +subdirectory of the <filename>W32X86</filename> directory from the Windows box, we do not put them +(for now) in this same subdirectory of the Samba box. This relocation will automatically be done by the +<command>adddriver</command> command, which we will run shortly (and do not forget to also put the files +for the Windows 9x/Me architecture into the <filename>WIN40/</filename> subdirectory should you need them). </para> </sect3> <sect3> -<title>Check if the Driver Files are there (with smbclient)</title> +<title><command>smbclient</command> to Confirm Driver Installation</title> <para> -For now we verify that our files are there. This can be done with -<command>smbclient</command> too (but of course you can log in via SSH -also and do this through a standard UNIX shell access too): +For now we verify that our files are there. This can be done with <command>smbclient</command>, too +(but, of course, you can log in via SSH also and do this through a standard UNIX shell access): </para> <para><screen> @@ -1806,11 +1654,11 @@ also and do this through a standard UNIX shell access too): -c 'cd W32X86; pwd; dir; cd 2; pwd; dir'</userinput> 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] +Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.8a] Current directory is \\SAMBA-CUPS\print$\W32X86\ -. D 0 Sun May 4 03:56:35 2003 -.. D 0 Thu Apr 10 23:47:40 2003 +. 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 @@ -1830,8 +1678,8 @@ 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 +. 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 @@ -1841,94 +1689,82 @@ PDFcreator2.PPD A 15746 Sun Apr 20 22:24:07 2003 </screen></para> <para> -Notice that there are already driver files present in the -<filename>2</filename> 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 <emphasis>printer driver -files</emphasis> and it doesn't know yet to which print queue(s) these -driver files belong. +Notice that there are already driver files present in the <filename>2</filename> subdirectory (probably +from a previous installation). Once the files for the new driver are there too, you are still a few +steps away from being able to use them on the clients. The only thing you could do now is 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 does not yet know that +these files are something special, namely <emphasis>printer driver files</emphasis> and it does not know +to which print queue(s) these driver files belong. </para> </sect3> <sect3> -<title>Running <command>rpcclient</command> with -<command>adddriver</command></title> +<title>Running <command>rpcclient</command> with <command>adddriver</command></title> <para> -So, next you must tell Samba about the special category of the files -you just uploaded into the <smbconfsection>[print$]</smbconfsection> share. This -is done by the <command>adddriver</command> 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: +Next, you must tell Samba about the special category of the files you just uploaded into the +<smbconfsection>[print$]</smbconfsection> share. This is done by the <command>adddriver</command> +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: </para> <para><screen> - &rootprompt;<userinput>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</userinput> +&rootprompt;<userinput>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</userinput> 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" + "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. - </screen></para> <para> -After this step the driver should be recognized by Samba on the print -server. You need to be very careful when typing the command. Don't -exchange the order of the fields. Some changes would lead to a -<computeroutput>NT_STATUS_UNSUCCESSFUL</computeroutput> 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. +After this step, the driver should be recognized by Samba on the print server. You need to be very +careful when typing the command. Don't exchange the order of the fields. Some changes would lead to +an <computeroutput>NT_STATUS_UNSUCCESSFUL</computeroutput> 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 +provides a more detailed description, should you need it. </para> </sect3> <sect3> -<title>Check how Driver Files have been moved after -<command>adddriver</command> finished</title> +<title>Checking <command>adddriver</command> Completion</title> <para> -One indication for Samba's recognition of the files as driver files is -the <computeroutput>successfully installed</computeroutput> message. -Another one is the fact, that our files have been moved by the -<command>adddriver</command> command into the <filename>2</filename> -subdirectory. You can check this again with -<command>smbclient</command>: +One indication for Samba's recognition of the files as driver files is the <computeroutput>successfully +installed</computeroutput> message. Another one is the fact that our files have been moved by the +<command>adddriver</command> command into the <filename>2</filename> subdirectory. You can check this +again with <command>smbclient</command>: </para> <para><screen> -&rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -Uroot%xx -c 'cd W32X86;dir;pwd;cd 2;dir;pwd'</userinput> +&rootprompt;<userinput>smbclient //SAMBA-CUPS/print\$ -Uroot%xx \ + -c 'cd W32X86;dir;pwd;cd 2;dir;pwd'</userinput> 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 + . 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 + . 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 @@ -1951,93 +1787,85 @@ subdirectory. You can check this again with 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 - </screen></para> <para> -Another verification is that the timestamp of the printing TDB files -is now updated (and possibly their filesize has increased). +Another verification is that the timestamp of the printing TDB files is now updated +(and possibly their file size has increased). </para> </sect3> <sect3> -<title>Check if the Driver is recognized by Samba</title> +<title>Check Samba for Driver Recognition</title> <para> -Now the driver should be registered with Samba. We can easily verify -this, and will do so in a moment. However, this driver is -<emphasis>not yet</emphasis> associated with a particular -<emphasis>printer</emphasis>. We may check the driver status of the -files by at least three methods: +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: </para> <itemizedlist> -<listitem><para>from any Windows client browse Network Neighbourhood, -find the Samba host and open the Samba <guiicon>Printers and -Faxes</guiicon> folder. Select any printer icon, right-click and -select the printer <guimenuitem>Properties</guimenuitem>. Click on the -<guilabel>Advanced</guilabel> tab. Here is a field indicating the -driver for that printer. A drop down menu allows you to change that -driver (be careful 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.)</para></listitem> - -<listitem><para>from a Windows 2000 or XP client (not WinNT) browse -<guiicon>Network Neighbourhood</guiicon>, search for the Samba -server and open the server's <guiicon>Printers</guiicon> folder, -right-click the white background (with no printer highlighted). Select -<guimenuitem>Server Properties</guimenuitem>. On the -<guilabel>Drivers</guilabel> tab you will see the new driver listed -now. This view enables you to also inspect the list of files belonging -to that driver<emphasis> (this doesn't work on Windows NT, but only on -Windows 2000 and Windows XP. WinNT doesn't provide the "Drivers" -tab).</emphasis>. 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 <replaceable>SAMBA-CUPS</replaceable>): -</para> - -<para><userinput> rundll32 printui.dll,PrintUIEntry /s /t2 /n\\<replaceable>SAMBA-CUPS</replaceable></userinput></para> -</listitem> - -<listitem><para>from a UNIX prompt run this command (or a variant -thereof), where <replaceable>SAMBA-CUPS</replaceable> is the name of the Samba -host and "xxxx" represents the actual Samba password assigned to root: -</para> - -<para><userinput>rpcclient -U'root%xxxx' -c 'enumdrivers' <replaceable>SAMBA-CUPS</replaceable></userinput></para> - -<para> -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 <parameter>[Windows NT -x86]</parameter> heading, not under <smbconfsection>[Windows 4.0]</smbconfsection>, -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 <emphasis>dm9110</emphasis>. Note that the 3rd column -shows the other installed drivers twice, for each supported architecture one -time. Our new driver only shows up for -<application>Windows NT 4.0 or 2000</application>. To -have it present for <application>Windows 95, 98 and ME</application> you'll -have to repeat the whole procedure with the WIN40 architecture and subdirectory. -</para></listitem> + <listitem><para> + From any Windows client browse Network Neighborhood, find the Samba host and open the Samba + <guiicon>Printers and Faxes</guiicon> folder. Select any printer icon, right-click and select + the printer <guimenuitem>Properties</guimenuitem>. Click the <guilabel>Advanced</guilabel> + tab. Here is a field indicating the driver for that printer. A drop-down menu allows you to + change that driver (be careful not to do this unwittingly). You can use this list to view + all drivers known to Samba. Your new one should be among them. (Each type of client will only + see his own architecture's list. If you do not have every driver installed for each platform, + the list will differ if you look at it from Windows95/98/ME or WindowsNT/2000/XP.) + </para></listitem> + + <listitem><para> + From a Windows 200x/XP client (not Windows NT) browse <guiicon>Network Neighborhood</guiicon>, + search for the Samba server and open the server's <guiicon>Printers</guiicon> folder, + right-click on the white background (with no printer highlighted). Select <guimenuitem>Server + Properties</guimenuitem>. On the <guilabel>Drivers</guilabel> tab you will see the new driver + listed. This view enables you to also inspect the list of files belonging to that driver + (this does not work on Windows NT, but only on Windows 2000 and Windows XP; Windows NT does not + provide the <guimenuitem>Drivers</guimenuitem> tab). An + alternative and much quicker method for + Windows 2000/XP to start this dialog is by typing into a DOS box (you must of course adapt the + name to your Samba server instead of <replaceable>SAMBA-CUPS</replaceable>): + </para> + + <para><userinput>rundll32 printui.dll,PrintUIEntry /s /t2 /n\\<replaceable>SAMBA-CUPS</replaceable></userinput></para> + </listitem> + + <listitem><para> + From a UNIX prompt, run this command (or a variant thereof) where + <replaceable>SAMBA-CUPS</replaceable> is the name of the Samba host and xxxx represents the + actual Samba password assigned to root: + </para> + + <para><userinput>rpcclient -U'root%xxxx' -c 'enumdrivers' <replaceable>SAMBA-CUPS</replaceable></userinput></para> + + <para> + You will see a listing of all drivers Samba knows about. Your new one should be among + them. But it is only listed under the <parameter>[Windows NT x86]</parameter> heading, not under + <smbconfsection>[Windows 4.0]</smbconfsection>, since you didn't install that part. Or did you? + You will see a listing of all drivers Samba knows about. Your new one should be among them. In + our example it is named <constant>dm9110</constant>. Note that the third column shows the other + installed drivers twice, one time for each supported architecture. Our new driver only shows up + for <application>Windows NT 4.0 or 2000</application>. To have it present for <application>Windows + 95, 98 and ME</application>, you'll have to repeat the whole procedure with the WIN40 architecture + and subdirectory. + </para></listitem> </itemizedlist> </sect3> <sect3> -<title>A side note: you are not bound to specific driver names</title> +<title>Specific Driver Name Flexibility</title> <para> -You can name the driver as you like. If you repeat the -<command>adddriver</command> step, with the same files as before, but -with a different driver name, it will work the same: +You can name the driver as you like. If you repeat the <command>adddriver</command> step with the same +files as before but with a different driver name, it will work the same: </para> <para><screen> -&rootprompt;<userinput>rpcclient -Uroot%xxxx \ +&rootprompt;<userinput>rpcclient -Uroot%xxxx \ -c 'adddriver "Windows NT x86" \ - "myphantasydrivername:HDNIS01_de.DLL: \ + "mydrivername:HDNIS01_de.DLL: \ Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP: \ NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ @@ -2045,297 +1873,283 @@ with a different driver name, it will work the same: HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP' SAMBA-CUPS </userinput> - 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. +cmd = adddriver "Windows NT x86" \ + "mydrivername:HDNIS01_de.DLL:Hddm91c1_de.ppd:HDNIS01U_de.DLL:\ + HDNIS01U_de.HLP:NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \ + Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre, \ + Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \ + HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP" +Printer Driver mydrivername successfully installed. </screen></para> <para> -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 -<command>rpcclient</command> <command>adddriver</command> command -repeatedly. Each run "consumes" the files you had put into the -<smbconfsection>[print$]</smbconfsection> share by moving them into the -respective subdirectories. So you <emphasis>must</emphasis> precede an -<command>smbclient ... put</command> command before each -<command>rpcclient ... adddriver</command>" command. +You will be able to bind that driver to any print queue (however, you are responsible that +you associate drivers to queues that make sense with respect to target printers). You cannot run the +<command>rpcclient</command> <command>adddriver</command> command repeatedly. Each run consumes the +files you had put into the <smbconfsection>[print$]</smbconfsection> share by moving them into the +respective subdirectories. So you must execute an <command>smbclient ... put</command> command before +each <command>rpcclient ... adddriver</command> command. </para> </sect3> <sect3> -<title>Running <command>rpcclient</command> with -<command>setdriver</command></title> +<title>Running <command>rpcclient</command> with the <command>setdriver</command></title> <para> -Samba still needs to know <emphasis>which</emphasis> 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 <command>rpcclient -setdriver</command> command achieves exactly this: +Samba needs to know which printer owns which driver. Create a mapping of the driver to a printer, and +store this info in Samba's memory, the TDB files. The <command>rpcclient setdriver</command> command +achieves exactly this: </para> <para><screen> -&rootprompt;<userinput>rpcclient -U'root%xxxx' -c 'setdriver dm9110 myphantasydrivername' <replaceable>SAMBA-CUPS</replaceable></userinput> - cmd = setdriver dm9110 myphantasydrivername - Successfully set dm9110 to driver myphantasydrivername. +&rootprompt;<userinput>rpcclient -U'root%xxxx' -c 'setdriver dm9110 mydrivername' <replaceable>SAMBA-CUPS</replaceable></userinput> + cmd = setdriver dm9110 mydrivername + +Successfully set dm9110 to driver mydrivername. </screen></para> <para> -Ahhhhh -- no, I didn't want to do that. Repeat, this time with the -name I intended: +Ah, no, I did not want to do that. Repeat, this time with the name I intended: </para> <para><screen> &rootprompt;<userinput>rpcclient -U'root%xxxx' -c 'setdriver dm9110 dm9110' <replaceable>SAMBA-CUPS</replaceable></userinput> cmd = setdriver dm9110 dm9110 - Successfully set dm9110 to driver dm9110. +Successfully set dm9110 to driver dm9110. </screen></para> <para> -The syntax of the command is <userinput>rpcclient --U'root%<replaceable>sambapassword</replaceable>' -c 'setdriver -"<replaceable>printername</replaceable>" -"<replaceable>drivername</replaceable>' -<replaceable>SAMBA-Hostname</replaceable></userinput> . -- -Now we have done *most* of the work. But not yet all.... +The syntax of the command is: +<screen> +<userinput>rpcclient -U'root%<replaceable>sambapassword</replaceable>' -c 'setdriver <replaceable>printername</replaceable> \ + <replaceable>drivername</replaceable>' <replaceable>SAMBA-Hostname</replaceable></userinput>. +</screen> +Now we have done most of the work, but not all of it. </para> <note><para> -the <command>setdriver</command> 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: -<userinput>kill -HUP `pidof smbd`</userinput>. </para></note> +The <command>setdriver</command> command will only succeed if the +printer is already known to Samba. A +bug in 2.2.x prevented Samba from recognizing freshly installed printers. You had to restart Samba, +or at least send an HUP signal to all running smbd processes to work around this: <userinput>kill -HUP +`pidof smbd`</userinput>. +</para></note> </sect3> </sect2> </sect1> <sect1> -<title>Client Driver Install Procedure</title> +<title>Client Driver Installation Procedure</title> <para> -A famous philosopher said once: <quote>The Proof of the Pudding lies -in the Eating</quote>. 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. +As Don Quixote said: <quote>The proof of the pudding is in the eating.</quote> 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. </para> <sect2> -<title>The first Client Driver Installation</title> +<title>First Client Driver Installation</title> <para> -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 -<emphasis>bad user</emphasis> "nobody". In a DOS box type: +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. You should guarantee that your connection is not unwittingly mapped to <emphasis>bad +user</emphasis> nobody. In a DOS box type: </para> <para><userinput>net use \\<replaceable>SAMBA-SERVER</replaceable>\print$ /user:root</userinput></para> <para> -Replace root, if needed, by another valid -<replaceable>printer admin</replaceable> 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 -<emphasis>all</emphasis> 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 -<command>smbstatus</command> command on Samba) do this from the -Windows workstation: +Replace root, if needed, by another valid <smbconfoption><name>printer admin</name></smbconfoption> user as given in +the definition. Should you already be connected as a different user, you will get an error message. There +is no easy way to get rid of that connection, because Windows does not seem to know a concept of logging +off from a share connection (do not confuse this with logging off from the local workstation; that is +a different matter). You can try to close all Windows file explorer +and Internet Explorer for Windows. As +a last resort, you may have to reboot. Make sure there is no automatic reconnection set up. It may be +easier to go to a different workstation and try from there. After you have made sure you are connected +as a printer admin user (you can check this with the <command>smbstatus</command> command on Samba), +do this from the Windows workstation: </para> -<itemizedlist> -<listitem><para>Open <guiicon>Network -Neighbourhood</guiicon></para></listitem> +<procedure> + <step><para> + Open <guiicon>Network Neighborhood</guiicon>. + </para></step> -<listitem><para>Browse to Samba server</para></listitem> + <step><para> + Browse to Samba server. + </para></step> -<listitem><para>Open its <guiicon>Printers and -Faxes</guiicon> folder</para></listitem> + <step><para> + Open its <guiicon>Printers and Faxes</guiicon> folder. + </para></step> -<listitem><para>Highlight and right-click the printer</para></listitem> + <step><para> + Highlight and right-click on the printer. + </para></step> -<listitem><para>Select <guimenuitem>Connect...</guimenuitem> (for WinNT4/2K -it is possibly <guimenuitem>Install...</guimenuitem>)</para></listitem> -</itemizedlist> + <step><para> + Select <guimenuitem>Connect</guimenuitem> (for Windows NT4/200x + it is possibly <guimenuitem>Install</guimenuitem>). + </para></step> +</procedure> <para> -A new printer (named <replaceable>printername</replaceable> on -samba-server) should now have appeared in your -<emphasis>local</emphasis> Printer folder (check <guimenu>Start</guimenu> -- -<guimenuitem>Settings</guimenuitem> -- <guimenuitem>Control Panel</guimenuitem> --- <guiicon>Printers and Faxes</guiicon>). +A new printer (named <replaceable>printername</replaceable> on Samba-server) should now have +appeared in your <emphasis>local</emphasis> Printer folder (check <guimenu>Start</guimenu> -- +<guimenuitem>Settings</guimenuitem> -- <guimenuitem>Control Panel</guimenuitem> -- <guiicon>Printers +and Faxes</guiicon>). </para> <para> -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 <errorname>Unable to print Test -Page</errorname>. 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. +Most likely you are now tempted to try to print a test page. After all, you now can open the printer +properties, and on the <guimenu>General</guimenu> tab there is a button offering to do just that. But +chances are that you get an error message saying <errorname>Unable to print Test Page</errorname>. The +reason might be that there is not yet a valid Device Mode set for the driver, or that the <quote>Printer +Driver Data</quote> set is still incomplete. </para> <para> -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. +You must make sure that a valid <parameter>Device Mode</parameter> is set for the +driver. We now explain what that means. </para> </sect2> <sect2> -<title>IMPORTANT! Setting Device Modes on new Printers</title> +<title>Setting Device Modes on New Printers</title> <para> -In order for a printer to be truly usable by a Windows NT/2K/XP -client, it must possess: +For a printer to be truly usable by a Windows NT/200x/XP client, it must possess: </para> <itemizedlist> -<listitem><para>a valid <emphasis>Device Mode</emphasis> generated by -the driver for the printer (defining things like paper size, -orientation and duplex settings), and</para></listitem> + <listitem><para> + A valid <emphasis>Device Mode</emphasis> generated by the driver for the printer (defining things + like paper size, orientation and duplex settings). + </para></listitem> -<listitem><para>a complete set of -<emphasis>Printer Driver Data</emphasis> generated by the -driver.</para></listitem> + <listitem><para> + A complete set of <emphasis>Printer Driver Data</emphasis> generated by the driver. + </para></listitem> </itemizedlist> <para> -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 -<filename>(ntprinters.tdb</filename>, -<filename>ntdrivers.tdb</filename>, <filename>printing.tdb</filename> -and <filename>ntforms.tdb</filename>). +If either of these is incomplete, the clients can produce less than optimal output at best. In the +worst cases, unreadable garbage or nothing at all comes from the printer or it produces a harvest of +error messages when attempting to print. Samba stores the named values and all printing related information in +its internal TDB database files <filename>(ntprinters.tdb</filename>, <filename>ntdrivers.tdb</filename>, +<filename>printing.tdb</filename> and <filename>ntforms.tdb</filename>). </para> <para> -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. +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 (the Samba host) to healthy +values so the clients can start to use them immediately. How do we set these initial healthy values? +This can be achieved by accessing the drivers remotely from an NT (or 200x/XP) client, as is discussed +in the following paragraphs. </para> <para> -Be aware, that a valid Device Mode can only be initiated by a -<smbconfoption><name>printer admin</name></smbconfoption>, 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 <smbconfsection>[print$]</smbconfsection> share with the -help of the APW or rpcclient. +Be aware that a valid Device Mode can only be initiated by a +<smbconfoption><name>printer admin</name></smbconfoption>, or root +(the reason should be obvious). Device Modes can only be correctly +set by executing the printer driver program itself. Since Samba cannot execute this Win32 platform driver +code, it sets this field initially to NULL (which is not a valid setting for clients to use). Fortunately, +most drivers automatically generate the Printer Driver Data that is needed when they are uploaded to the +<smbconfsection>[print$]</smbconfsection> share with the help of the APW or rpcclient. </para> <para> -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: +The generation and setting of a first valid Device Mode, however, requires some tickling from a client, +to set it on the Samba server. The easiest means of doing so is to simply change the page orientation on +the server's printer. This executes enough of the printer driver program on the client for the desired +effect to happen, and feeds back the new Device Mode to our Samba server. You can use the native Windows +NT/200x/XP printer properties page from a Window client for this: </para> -<itemizedlist> - <listitem><para>Browse the <guiicon>Network Neighbourhood</guiicon></para></listitem> +<procedure> + <step><para> + Browse the <guiicon>Network Neighborhood.</guiicon> + </para></step> -<listitem><para>Find the Samba server</para></listitem> + <step><para> + Find the Samba server. + </para></step> -<listitem><para>Open the Samba server's <guiicon>Printers and - Faxes</guiicon> folder</para></listitem> + <step><para> + Open the Samba server's <guiicon>Printers and Faxes</guiicon> folder. + </para></step> -<listitem><para>Highlight the shared printer in question</para></listitem> + <step><para> + Highlight the shared printer in question. + </para></step> -<listitem><para>Right-click the printer (you may already be here, if you -followed the last section's description)</para></listitem> + <step><para> + Right-click on the printer (you may already be here, if you followed the last section's description). + </para></step> -<listitem><para>At the bottom of the context menu select -<guimenu>Properties....</guimenu> (if the menu still offers the -<guimenuitem>Connect...</guimenuitem> entry -further above, you need to click that one first to achieve the driver -installation as shown in the last section)</para></listitem> + <step><para> + At the bottom of the context menu select <guimenu>Properties</guimenu> (if the menu still offers the + <guimenuitem>Connect</guimenuitem> entry further above, you + need to click on that one first to achieve the driver + installation as shown in the last section). + </para></step> -<listitem><para>Go to the <guilabel>Advanced</guilabel> tab; click on -<guibutton>Printing Defaults...</guibutton></para></listitem> + <step><para> + Go to the <guilabel>Advanced</guilabel> tab; click on <guibutton>Printing Defaults</guibutton>. + </para></step> -<listitem><para>Change the "Portrait" page setting to "Landscape" (and -back)</para></listitem> + <step><para> + Change the <guimenuitem>Portrait</guimenuitem> page setting to <guimenuitem>Landscape</guimenuitem> (and back). + </para></step> -<listitem><para>(Oh, and make sure to <emphasis>apply</emphasis> -changes between swapping the page orientation to cause the change to -actually take effect...).</para></listitem> + <step><para> + Make sure to apply changes between swapping the page orientation to cause the change to actually take effect. + </para></step> -<listitem><para>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.</para></listitem> -</itemizedlist> + <step><para> + While you are at it, you may also want to set the desired printing defaults here, which then apply to all future + client driver installations on the remaining from now on. + </para></step> +</procedure> <para> -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 -<emphasis>local</emphasis> <guiicon>Printers</guiicon> folder too if you are -a Samba printer admin user. From now on printing should work as expected. +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 <emphasis>local</emphasis> <guiicon>Printers</guiicon> +folder, too, if you are a Samba printer admin user. From now on, printing should work as expected. </para> <para> -Samba also includes a service level parameter name <parameter>default -devmode</parameter> 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. +Samba includes a service level parameter name <parameter>default devmode</parameter> 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. </para> </sect2> <sect2> -<title>Further Client Driver Install Procedures</title> +<title>Additional Client Driver Installation</title> <para> -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 <guimenuitem>Connect...</guimenuitem>. 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 <guiicon>Printers and -Faxes</guiicon> folder. +Every additional driver may be installed, along the lines described +above. Browse network, open the +<guiicon>Printers</guiicon> folder on Samba server, right-click on <guiicon>Printer</guiicon> and choose +<guimenuitem>Connect...</guimenuitem>. 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 <guiicon>Printers and Faxes</guiicon> folder. </para> <para> You can also open your local <guiicon>Printers and Faxes</guiicon> folder by -using this command on Windows 2000 and Windows XP Professional workstations: +using this command on Windows 200x/XP Professional workstations: </para> -<para><userinput>rundll32 shell32.dll,SHHelpShortcuts_RunDLL PrintersFolder -</userinput></para> +<para><userinput>rundll32 shell32.dll,SHHelpShortcuts_RunDLL PrintersFolder</userinput></para> <para> or this command on Windows NT 4.0 workstations: @@ -2346,45 +2160,40 @@ rundll32 shell32.dll,Control_RunDLL MAIN.CPL @2 </userinput></para> <para> -You can enter the commands either inside a <guilabel>DOS box</guilabel> window -or in the <guimenuitem>Run command...</guimenuitem> field from the -<guimenu>Start</guimenu> menu. +You can enter the commands either inside a <guilabel>DOS box</guilabel> window or in the <guimenuitem>Run +command...</guimenuitem> field from the <guimenu>Start</guimenu> menu. </para> </sect2> <sect2> -<title>Always make first Client Connection as root or "printer admin"</title> +<title>Always Make First Client Connection as root or <quote>printer admin</quote></title> <para> -After you installed the driver on the Samba server (in its -<smbconfsection>[print$]</smbconfsection> 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 -<smbconfoption><name>printer admin</name></smbconfoption>. This is to make sure that: +After you installed the driver on the Samba server (in its <smbconfsection>[print$]</smbconfsection> +share, you should always make sure that your first client installation completes correctly. Make it a +habit for yourself to build the very first connection from a client as <smbconfoption><name>printer admin</name></smbconfoption>. This is to make sure that: </para> <itemizedlist> + <listitem><para> + A first valid <emphasis>Device Mode</emphasis> is really initialized (see above for more + explanation details). + </para></listitem> -<listitem><para> a first valid <emphasis>Device Mode</emphasis> is -really initialized (see above for more explanation details), and -that</para></listitem> - -<listitem><para> the default print settings of your printer for all -further client installations are as you want them</para></listitem> + <listitem><para> + The default print settings of your printer for all further client installations are as you want them. + </para></listitem> </itemizedlist> <para> -Do this by changing the orientation to landscape, click -<emphasis>Apply</emphasis>, and then change it back again. Then modify -the other settings (for example, you don't want the default media size -set to <emphasis>Letter</emphasis>, when you are all using -<emphasis>A4</emphasis>, right? You may want to set the printer for -<emphasis>duplex</emphasis> as the default; etc.). +Do this by changing the orientation to landscape, click on <guiicon>Apply</guiicon>, and then change it +back again. Next, modify the other settings (for example, you do not want the default media size set to +<guiicon>Letter</guiicon> when you are all using <guiicon>A4</guiicon>, right? You may want to set the +printer for <guiicon>duplex</guiicon> as the default, and so on). </para> <para> -To connect as root to a Samba printer, try this command from a Windows -2K/XP DOS box command prompt: +To connect as root to a Samba printer, try this command from a Windows 200x/XP DOS box command prompt: </para> <para><screen> @@ -2395,18 +2204,15 @@ To connect as root to a Samba printer, try this command from a Windows <para> You will be prompted for root's Samba-password; type it, wait a few -seconds, click on <guibutton>Printing Defaults...</guibutton> 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 <smbconfoption><name>printer admin</name></smbconfoption> from the setting. +seconds, click on <guibutton>Printing +Defaults</guibutton>, and proceed to set the job options that should be used as defaults by all +clients. Alternately, instead of root you can name one other member of the <smbconfoption><name>printer admin</name></smbconfoption> from the setting. </para> <para> -Now all the other users downloading and installing the driver -the same way (called <emphasis>Point'n'Print</emphasis>) 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.... ;-) + Now all the other users downloading and installing the driver the same way <?latex \linebreak ?>(called +<quote>Point'n'Print</quote>) will have the same defaults set for them. If you miss this step +you'll get a lot of Help Desk calls from your users, but maybe you like to talk to people. </para> </sect2> </sect1> @@ -2415,137 +2221,112 @@ talk to people.... ;-) <title>Other Gotchas</title> <para> -Your driver is installed. It is ready for -<emphasis>Point'n'Print</emphasis> installation by the clients -now. You <emphasis>may</emphasis> 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 preceding paragraphs? And your users -complain about various issues (such as <quote>We need to set the paper -size for each job from Letter to A4 and it won't store it!</quote>) +Your driver is installed. It is now ready for Point'n'Print +installation by the clients. You may have tried to download and use it +onto your first client machine, but +wait. Let's make sure you are acquainted first with a few tips and tricks you may find useful. For example, +suppose you did not set the defaults on the printer, as advised in the preceding +paragraphs. Your users complain about various issues (such as, <quote>We need to set the paper size +for each job from Letter to A4 and it will not store it.</quote>) </para> <sect2> -<title>Setting Default Print Options for the Client Drivers</title> +<title>Setting Default Print Options for Client Drivers</title> <para> 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 -<guimenuitem>Properties...</guimenuitem>, 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": +admins. They have struggled for hours and could not arrive at a point +where their settings seemed to be saved. It is not their fault. The confusing +thing is that in the multi-tabbed dialog that pops up when you right-click +on the printer name and select <guimenuitem>Properties</guimenuitem>, you +can arrive at two dialogs that appear identical, each claiming that they help +you to set printer options in three different ways. Here is the definite +answer to the Samba default driver setting FAQ: </para> -<formalpara><title><quote>I can't set and save default print options -for all users on Win2K/XP! Why not?</quote></title> +<formalpara><title><quote>I can not set and save default print options +for all users on Windows 200x/XP. Why not?</quote></title> <para> -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 <emphasis>seems</emphasis> to set everything. All three -dialogs <emphasis>look</emphasis> the same. Only one of them -<emphasis>does</emphasis> what you intend. -<emphasis>Important:</emphasis> you need to be Administrator or Print -Administrator to do this for all users. Here is how I reproduce it in -on XP Professional: - -<orderedlist numeration="upperalpha"> - -<listitem><para>The first "wrong" way: - -<orderedlist numeration="arabic"> -<listitem><para>Open the <guiicon>Printers</guiicon> -folder.</para></listitem> - -<listitem><para>Right-click on the printer -(<emphasis>remoteprinter on cupshost</emphasis>) and -select in context menu <guimenu>Printing -Preferences...</guimenu></para></listitem> - -<listitem><para>Look at this dialog closely and remember what it looks -like.</para></listitem> -</orderedlist> +How are you doing it? I bet the wrong way. (It is not easy to find out, though). There are three different +ways to bring you to a dialog that seems to set everything. All three +dialogs look the same, but only one +of them does what you intend. You need to be Administrator or Print Administrator to do this for all +users. Here is how I reproduce it in an XP Professional: </para> -</listitem> - -<listitem><para>The second "wrong" way: - -<orderedlist numeration="arabic"> - <listitem><para>Open the <guimenu>Printers</guimenu> -folder.</para></listitem> +The following list needs periods after the letters and numbers::::::::: +<orderedlist numeration="upperalpha"> + <listitem><para>The first <quote>wrong</quote> way: + <orderedlist numeration="arabic"> + <listitem><para>Open the <guiicon>Printers</guiicon> folder.</para></listitem> -<listitem><para>Right-click on the printer (<emphasis>remoteprinter on -cupshost</emphasis>) and select in the context menu -<guimenuitem>Properties</guimenuitem></para></listitem> + <listitem><para>Right-click on the printer (<emphasis>remoteprinter on cupshost</emphasis>) and + select in context menu <guimenu>Printing Preferences...</guimenu></para></listitem>. -<listitem><para>Click on the <guilabel>General</guilabel> -tab</para></listitem> + <listitem><para>Look at this dialog closely and remember what it looks like.</para></listitem> + </orderedlist></para></listitem> -<listitem><para>Click on the button <guibutton>Printing -Preferences...</guibutton></para></listitem> + <listitem><para>The second <quote>wrong</quote> way: + <orderedlist numeration="arabic"> + <listitem><para>Open the <guimenu>Printers</guimenu> folder.</para></listitem> -<listitem><para>A new dialog opens. Keep this dialog open and go back -to the parent dialog.</para></listitem> -</orderedlist> -</para> -</listitem> + <listitem><para>Right-click on the printer (<emphasis>remoteprinter on + cupshost</emphasis>) and select in the context menu + <guimenuitem>Properties</guimenuitem></para></listitem> -<listitem><para>The third, the "correct" way: (should you do -this from the beginning, just carry out steps 1. and 2. from second -"way" above) + <listitem><para>Click on the <guilabel>General</guilabel> + tab</para></listitem>. -<orderedlist numeration="arabic"> -<listitem><para>Click on the <guilabel>Advanced</guilabel> -tab. (Hmmm... if everything is "Grayed Out", then you are not logged -in as a user with enough privileges).</para></listitem> + <listitem><para>Click on the <guibutton>Printing + Preferences...</guibutton></para></listitem> button. -<listitem><para>Click on the <guibutton>Printing -Defaults...</guibutton> button.</para></listitem> - -<listitem><para>On any of the two new tabs, click on the -<guilabel>Advanced...</guilabel> button.</para></listitem> + <listitem><para>A new dialog opens. Keep this dialog open and go back + to the parent dialog.</para></listitem> + </orderedlist> + </para></listitem> -<listitem><para>A new dialog opens. Compare this one to the other, -identical looking one from "B.5" or A.3".</para></listitem> -</orderedlist> -</para> -</listitem> + <listitem><para> + The third and correct way: (should you do this from the beginning, just carry out steps 1 + and 2 from the second method above). + </para> + + <orderedlist numeration="arabic"> + <listitem><para>Click on the <guilabel>Advanced</guilabel> + tab. (If everything is <quote>grayed out,</quote> then you are not logged + in as a user with enough privileges).</para></listitem> + + <listitem><para>Click on the <guibutton>Printing + Defaults</guibutton> button.</para></listitem> + + <listitem><para>On any of the two new tabs, + click on the + <guilabel>Advanced</guilabel> button.</para></listitem> + + <listitem><para>A new dialog opens. Compare + this one to the other. Are they + identical looking comparing one from + <quote>B.5</quote> and one from A.3".</para></listitem> + </orderedlist> + </listitem> </orderedlist> -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 -(<smbconfoption><name>printer admin</name></smbconfoption> in ) -<emphasis>before</emphasis> a client downloads the driver (the clients -can later set their own <emphasis>per-user defaults</emphasis> by -following the procedures <emphasis>A.</emphasis> -or <emphasis>B.</emphasis> above...). (This is new: Windows 2000 and -Windows XP allow <emphasis>per-user</emphasis> 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 -<computeroutput>Default Print Values for Printer Foo on Server -Bar"</computeroutput> (which is the one you need) and the other is -called "<computeroutput>Print Settings for Printer Foo on Server -Bar</computeroutput>". The last one is the one you arrive at when you -right-click on the printer and select <guimenuitem>Print -Settings...</guimenuitem>. 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! +<para> +Do you see any difference in the two settings dialogs? I do not either. However, only the last one, which +you arrived at with steps C.1 through 6 will permanently save any settings which will then become the defaults +for new users. If you want all clients to have the same defaults, you need to conduct these steps as +administrator (<smbconfoption><name>printer admin</name></smbconfoption> in ) before +a client downloads the driver (the clients can later set their own per-user defaults +by following procedures A or B above). Windows 200x/XP allow per-user default settings and the ones the +administrator gives them, before they set up their own. The parents of the identically-looking dialogs have a slight difference in their window names; one is called <computeroutput>Default Print +Values for Printer Foo on Server Bar"</computeroutput> (which is the one you need) and the other is called +<quote><computeroutput>Print Settings for Printer Foo on Server Bar</computeroutput></quote>. The last one is the one you +arrive at when you right-click on the printer and select <guimenuitem>Print Settings...</guimenuitem>. This +is the one that you were taught to use back in the days of Windows NT, so it is only natural to try the +same way with Windows 200x/XP. You would not dream that there is now a different path to arrive at an +identically looking, but functionally different, dialog to set defaults for all users. </para></formalpara> -<tip><para>Try (on Win2000 and WinXP) to run this command (as a user -with the right privileges): +<tip><para>Try (on Windows 200x/XP) to run this command (as a user with the right privileges): </para> <para><userinput> @@ -2553,8 +2334,7 @@ rundll32 printui.dll,PrintUIEntry /p /t3 /n\\<replaceable>SAMBA-SERVER</replacea </userinput></para> <para> -to see the tab with the <guilabel>Printing Defaults...</guilabel> -button (the one you need). Also run this command: +To see the tab with the <guilabel>Printing Defaults</guilabel> button (the one you need),also run this command: </para> <para><userinput> @@ -2562,36 +2342,31 @@ rundll32 printui.dll,PrintUIEntry /p /t0 /n\\<replaceable>SAMBA-SERVER</replacea </userinput></para> <para> -to see the tab with the <guilabel>Printing Preferences...</guilabel> -button (the one which doesn't set system-wide defaults). You can -start the commands from inside a DOS box" or from the <guimenu>Start</guimenu> --- <guimenuitem>Run...</guimenuitem> menu. +To see the tab with the <guilabel>Printing Preferences</guilabel> +button (the one which does not set system-wide defaults), you can +start the commands from inside a DOS box" or from <guimenu>Start</guimenu> -> <guimenuitem>Run</guimenuitem>. </para> </tip> </sect2> <sect2> -<title>Supporting large Numbers of Printers</title> +<title>Supporting Large Numbers of Printers</title> <para> -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. +One issue that has arisen during the recent development phase of Samba is the need to support driver +downloads for hunderds of printers. Using Windows NT APW here is somewhat awkward (to say the least). If +you do not want to acquire RSS pains from the printer installation clicking orgy alone, you need +to think about a non-interactive script. </para> <para> -If more than one printer is using the same driver, the -<command>rpcclient setdriver</command> command can be used to set the -driver associated with an installed queue. If the driver is uploaded -to <smbconfsection>[print$]</smbconfsection> once and registered with the -printing TDBs, it can be used by multiple print queues. In this case -you just need to repeat the <command>setprinter</command> subcommand -of <command>rpcclient</command> for every queue (without the need to -conduct the <command>adddriver</command> again and again). The -following is an example of how this could be accomplished: +If more than one printer is using the same driver, the <command>rpcclient setdriver</command> +command can be used to set the driver associated with an installed queue. If the driver is uploaded to +<smbconfsection>[print$]</smbconfsection> once and registered with the printing TDBs, it can be used by +multiple print queues. In this case, you just need to repeat the <command>setprinter</command> subcommand of +<command>rpcclient</command> for every queue (without the need to conduct the <command>adddriver</command> +repeatedly). The following is an example of how this could be accomplished: </para> <para><screen> @@ -2612,7 +2387,7 @@ following is an example of how this could be accomplished: Driver Name: [dm9110] Printer Driver Info 1: - Driver Name: [myphantasydrivername] + Driver Name: [mydrivername] [....] </screen> @@ -2646,9 +2421,9 @@ following is an example of how this could be accomplished: </screen> <screen> -&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'setdriver <replaceable>dm9110</replaceable> <replaceable>myphantasydrivername</replaceable>'</userinput> - cmd = setdriver dm9110 myphantasydrivername - Successfully set dm9110 to myphantasydrivername. +&rootprompt;<userinput>rpcclient <replaceable>SAMBA-CUPS</replaceable> -U root%<replaceable>secret</replaceable> -c 'setdriver <replaceable>dm9110</replaceable> <replaceable>mydrivername</replaceable>'</userinput> + cmd = setdriver dm9110 mydrivername + Successfully set dm9110 to mydrivername. </screen> <screen> @@ -2656,54 +2431,48 @@ following is an example of how this could be accomplished: cmd = enumprinters flags:[0x800000] name:[\\SAMBA-CUPS\dm9110] - description:[\\SAMBA-CUPS\dm9110,myphantasydrivername,\ + description:[\\SAMBA-CUPS\dm9110,mydrivername,\ 110ppm HiVolume DANKA Stuttgart] comment:[110ppm HiVolume DANKA Stuttgart] [....] </screen></para> <para> -It may be not easy to recognize: but the first call to -<command>enumprinters</command> 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 -<command>setdriver</command> command succeeded, all is well. (The -CUPS Printing chapter has more info about the installation of printer -drivers with the help of <command>rpcclient</command>). +It may not be easy to recognize that the first call to <command>enumprinters</command> showed the +<quote>dm9110</quote> printer with an empty string where the driver should have been listed (between +the 2 commas in the description field). After the <command>setdriver</command> command +succeeded, all is well. </para> </sect2> <sect2> -<title>Adding new Printers with the Windows NT APW</title> +<title>Adding New Printers with the Windows NT APW</title> <para> -By default, Samba exhibits all printer shares defined in -&smb.conf; in the -<guiicon>Printers...</guiicon> folder. Also located in this folder -is the Windows NT Add Printer Wizard icon. The APW will be shown only -if: +By default, Samba exhibits all printer shares defined in &smb.conf; in the <guiicon>Printers</guiicon> +folder. Also located in this folder is the Windows NT Add Printer Wizard icon. The APW will be shown only if: </para> <itemizedlist> -<listitem><para>...the connected user is able to successfully execute -an <command>OpenPrinterEx(\\server)</command> with administrative -privileges (i.e. root or <smbconfoption><name>printer admin</name></smbconfoption>). -</para> + <listitem><para> + The connected user is able to successfully execute an <command>OpenPrinterEx(\\server)</command> with + administrative privileges (i.e., root or <smbconfoption><name>printer admin</name></smbconfoption>). + </para> -<tip><para> Try this from a Windows 2K/XP DOS box command prompt: -</para> + <tip><para> Try this from a Windows 200x/XP DOS box command prompt: + </para> -<para><userinput> -runas /netonly /user:root rundll32 printui.dll,PrintUIEntry /p /t0 /n \\<replaceable>SAMBA-SERVER</replaceable>\<replaceable>printersharename</replaceable> -</userinput></para> + <para><userinput> + runas /netonly /user:root rundll32 printui.dll,PrintUIEntry /p /t0 /n \\<replaceable>SAMBA-SERVER</replaceable>\<replaceable>printersharename</replaceable> + </userinput></para> -<para> -and click on <guibutton>Printing Preferences...</guibutton> -</para></tip></listitem> + <para> + Click on <guibutton>Printing Preferences</guibutton>. + </para></tip></listitem> -<listitem><para>... contains the setting -<smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> (the -default).</para></listitem> + <listitem><para>... contains the setting + <smbconfoption><name>show add printer wizard</name><value>yes</value></smbconfoption> (the + default).</para></listitem> </itemizedlist> <para> @@ -2711,122 +2480,104 @@ The APW can do various things: </para> <itemizedlist> -<listitem><para>upload a new driver to the Samba -<smbconfsection>[print$]</smbconfsection> share;</para></listitem> + <listitem><para> + Upload a new driver to the Samba <smbconfsection>[print$]</smbconfsection> share. + </para></listitem> -<listitem><para>associate an uploaded driver with an existing (but -still "driverless") print queue;</para></listitem> + <listitem><para> + Associate an uploaded driver with an existing (but still driverless) print queue. + </para></listitem> -<listitem><para>exchange the currently used driver for an existing -print queue with one that has been uploaded before;</para></listitem> + <listitem><para> + Exchange the currently used driver for an existing print queue with one that has been uploaded before. + </para></listitem> -<listitem><para>add an entirely new printer to the Samba host (only in -conjunction with a working <smbconfoption><name>add printer command</name></smbconfoption>; -a corresponding <smbconfoption><name>delete printer command</name></smbconfoption> for -removing entries from the <guiicon>Printers...</guiicon> folder -may be provided too)</para></listitem> + <listitem><para> + Add an entirely new printer to the Samba host (only in conjunction with a working + <smbconfoption><name>add printer command</name></smbconfoption>. A corresponding + <smbconfoption><name>delete printer command</name></smbconfoption> for removing entries from the + <guiicon>Printers</guiicon> folder may also be provided). + </para></listitem> </itemizedlist> <para> -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 <smbconfoption><name>add printer command</name></smbconfoption> must -have a defined value. The program hook must successfully add the -printer to the UNIX print system (i.e. to -<filename>/etc/printcap</filename>, -<filename>/etc/cups/printers.conf</filename> or other appropriate -files) and to if necessary. +The last one (add a new printer) requires more effort than the previous ones. To use +the APW to successfully add a printer to a Samba server, the <smbconfoption><name>add printer command</name></smbconfoption> must have a defined value. The program hook must successfully +add the printer to the UNIX print system (i.e., to <filename>/etc/printcap</filename>, +<filename>/etc/cups/printers.conf</filename> or other appropriate files) and to &smb.conf; if necessary. </para> <para> -When using the APW from a client, if the named printer share does not -exist, smbd will execute the <parameter>add printer -command</parameter> and reparse to the -to attempt to locate the new printer share. If the share is still not -defined, an error of <errorname>Access Denied</errorname> is -returned to the client. Note that the <smbconfoption><name>add printer command</name></smbconfoption> is executed under the context of the connected -user, not necessarily a root account. A <smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption> may have connected you unwittingly under the wrong -privilege; you should check it by using the -<command>smbstatus</command> command. +When using the APW from a client, if the named printer share does not exist, smbd will execute the +<smbconfoption><name>add printer command</name></smbconfoption> and reparse to the to attempt to locate the new printer +share. If the share is still not defined, an error of <errorname>Access Denied</errorname> is returned to +the client. The <smbconfoption><name>add printer command</name></smbconfoption> is executed +under the context of the connected user, not necessarily a root account. A <smbconfoption><name>map to guest</name><value>bad user</value></smbconfoption> may have connected you unwittingly under the wrong +privilege. You should check it by using the <command>smbstatus</command> command. </para> + </sect2> <sect2> -<title>Weird Error Message <errorname>Cannot connect under a -different Name</errorname></title> +<title>Error Message: <quote><errorname>Cannot connect under a different Name</errorname></quote></title> <para> -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. +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. </para> <itemizedlist> -<listitem><para>The <command>net use \\SAMBA-SERVER\sharename -/user:root</command> gives you an error message: <computeroutput>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.</computeroutput></para></listitem> - -<listitem><para>Every attempt to "connect a network drive" to -<filename>\\SAMBASERVER\\print$</filename> to z: is countered by the -pertinacious message. <computeroutput>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</computeroutput>.</para></listitem> + <listitem><para> + The <command>net use \\SAMBA-SERVER\sharename /user:root</command> gives you an error message: + <quote>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.</quote> + </para></listitem> + + <listitem><para> + Every attempt to <quote>connect a network drive</quote> to <filename>\\SAMBASERVER\\print$</filename> + to <constant>z:</constant> is countered by the pertinacious message: <quote>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</quote>. + </para></listitem> </itemizedlist> <para> -So you close all connections. You try again. You get the same -message. You check from the Samba side, using -<command>smbstatus</command>. 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). +So you close all connections. You try again. You get the same message. You check from the Samba side, +using <command>smbstatus</command>. Yes, there are more connections. You kill them all. The client +still gives you the same error message. You watch the smbd.log file on a high debug level and try +reconnect. Same error message, but not a single line in the log. You start to wonder if there was a +connection attempt at all. You run ethereal and tcpdump while you try to connect. Result: not a single +byte goes on the wire. Windows still gives the error message. You close all Explorer windows and start it +again. You try to connect &smbmdash; and this times it works! Windows seems to cache connection informtion somewhere and +does not keep it up-to-date (if you are unlucky you might need to reboot to get rid of the error message). </para> </sect2> <sect2> -<title>Be careful when assembling Driver Files</title> - -<para> -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 -<filename>[print$]/WIN/0/</filename>), driver version "2" (Kernel Mode -driver for WinNT, going into <filename>[print$]/W32X86/2/</filename> -<emphasis>may</emphasis> be used on Win2K/XP too), and driver version -"3" (non-Kernel Mode driver going into -<filename>[print$]/W32X86/3/</filename> <emphasis>can not</emphasis> -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 -<filename>%WINDOWS%\system32\spool\drivers\W32X86\</filename>) 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 -<command>rpcclient</command> 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 <computeroutput>This -server has no appropriate driver for the printer</computeroutput>. -</para> - -<para> -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 (!) -<parameter>Dependentfiles</parameter>, so I left it out for space -reasons: +<title>Take Care When Assembling Driver Files</title> + +<para> +You need to be extremely careful when you take notes about the files and belonging to a particular +driver. Don't confuse the files for driver version <quote>0</quote> (for Windows 9x/Me, going into +<filename>[print$]/WIN/0/</filename>), driver version <filename>2</filename> (Kernel Mode driver for Windows NT, +going into <filename>[print$]/W32X86/2/</filename> may be used on Windows 200x/XP also), and +driver version <quote>3</quote> (non-Kernel Mode driver going into <filename>[print$]/W32X86/3/</filename> +cannot be used on Windows NT). Quite often these different driver versions contain +files that have the same name but actually are very different. If you look at them from +the Windows Explorer (they reside in <filename>%WINDOWS%\system32\spool\drivers\W32X86\</filename>), +you will probably see names in capital letters, while an <command>enumdrivers</command> command from Samba +would show mixed or lower case letters. So it is easy to confuse them. If you install them manually using +<command>rpcclient</command> 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 <computeroutput>This server +has no appropriate driver for the printer</computeroutput>. +</para> + +<para> +Here is an example. You are invited to look closely at the various files, compare their names and +their spelling, and discover the differences in the composition of the version 2 and 3 sets. Note: the +version 0 set contained 40 <parameter>Dependentfiles</parameter>, so I left it out for space reasons: </para> <para><screen> @@ -2890,7 +2641,7 @@ reasons: </screen></para> <para> -If we write the "version 2" files and the "version 3" files +If we write the <quote>version 2</quote> files and the <quote>version 3</quote> files into different text files and compare the result, we see this picture: </para> @@ -2923,10 +2674,9 @@ picture: > cpcqm407.cnt > cns3ggr.dll ]]> -</screen></para> +</screen> -<para> -Don't be fooled though! Driver files for each version with identical +Do not be fooled! Driver files for each version with identical names may be different in their content, as you can see from this size comparison: </para> @@ -2945,13 +2695,12 @@ comparison: CNS3G.DLL A 1145088 Thu May 30 02:31:00 2002 CNS3G.DLL A 15872 Thu May 30 02:31:00 2002 - </screen></para> <para> -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 +In my example were even more differences than shown here. Conclusion: you must be careful to select +the correct driver files for each driver version. Don't rely on the +names alone and don't interchange files belonging to different driver versions. </para> </sect2> @@ -2960,43 +2709,36 @@ belonging to different driver versions. <title>Samba and Printer Ports</title> <para> -Windows NT/2000 print servers associate a port with each -printer. These normally take the form of <filename>LPT1:</filename>, -<filename>COM1:</filename>, <filename>FILE:</filename>, 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 +Windows NT/2000 print servers associate a port with each printer. These normally take the form of +<filename>LPT1:</filename>, <filename>COM1:</filename>, +<filename>FILE:</filename>, and so on. Samba must also +support the concept of ports associated with a printer. By default, only one printer port, named <quote>Samba +Printer Port</quote>, exists on a system. Samba does not really need such a <quote>port</quote> in order +to print; rather it is a requirement of Windows clients. They insist on being told about an available +port when they request this information, otherwise they throw an error message at you. So Samba fakes the port information to keep the Windows clients happy. </para> <para> -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. +Samba does not support the concept of <constant>Printer Pooling</constant> internally either. Printer +Pooling assigns a logical printer to multiple ports as a form of load balancing or fail over. </para> <para> -If you require that multiple ports be defined for some reason or -another (<quote>My users and my Boss should not know that they are -working with Samba</quote>), possesses a -<smbconfoption><name>enumports command</name></smbconfoption> which can be used to define -an external program that generates a listing of ports on a system. +If you require multiple ports be defined for some reason or another (my users and my boss should not know +that they are working with Samba), configure <smbconfoption><name>enumports command</name></smbconfoption> +which can be used to define an external program that generates a listing of ports on a system. </para> </sect2> <sect2> -<title>Avoiding the most common Misconfigurations of the Client Driver</title> +<title>Avoiding Common Client Driver Misconfiguration</title> <para> -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. +So now the printing works, but there are still problems. Most jobs print well, some do not print at +all. Some jobs have problems with fonts, which do not look good. Some jobs print fast and some +are dead-slow. We cannot cover it all, but we want to encourage you to read the brief paragraph about +<quote>Avoiding the Wrong PostScript Driver Settings</quote> in the CUPS Printing part of this document. </para> </sect2> </sect1> @@ -3005,27 +2747,22 @@ Settings" in the CUPS Printing part of this document. <title>The Imprints Toolset</title> <para> -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 <ulink noescape="1" url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> -as well as the documentation included with the imprints source -distribution. This section will only provide a brief introduction -to the features of Imprints. +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 <ulink noescape="1" +url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> as well as the documentation +included with the imprints source distribution. This section only provides a brief introduction to +the features of Imprints. </para> -<formalpara><title>Attention! Maintainer required</title> - <para> -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.</para></formalpara> +Unfortunately, the Imprints toolset is no longer maintained. As of December 2000, the project is in +need of a new maintainer. The most important skill to have is Perl coding and an interest in MS-RPC-based +printing used in Samba. If you wish to volunteer, please coordinate +your efforts on the Samba technical +mailing list. The toolset is still in usable form, but only for a series of older printer models where +there are prepared packages to use. Packages for more up-to-date print devices are needed if Imprints +should have a future. +</para> <sect2> <title>What is Imprints?</title> @@ -3035,16 +2772,18 @@ Imprints is a collection of tools for supporting these goals: </para> <itemizedlist> -<listitem><para>Providing a central repository information regarding -Windows NT and 95/98 printer driver packages</para></listitem> + <listitem><para> + Providing a central repository of information regarding Windows NT and 95/98 printer driver packages. + </para></listitem> -<listitem><para>Providing the tools necessary for creating the -Imprints printer driver packages.</para></listitem> + <listitem><para> + Providing the tools necessary for creating the Imprints printer driver packages. + </para></listitem> -<listitem><para>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.</para></listitem> + <listitem><para> + Providing an installation client that will obtain printer drivers from a central Internet (or intranet) Imprints Server + repository and install them on remote Samba and Windows NT4 print servers. + </para></listitem> </itemizedlist> </sect2> @@ -3052,11 +2791,10 @@ servers.</para></listitem> <title>Creating Printer Driver Packages</title> <para> -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 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. </para> </sect2> @@ -3064,13 +2802,12 @@ files, and a control file needed by the installation client. <title>The Imprints Server</title> <para> -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 +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 -<emphasis>not</emphasis> be disabled. +the package downloaded is actually +the one referred in the Imprints database. It is strongly recommended that this security check +not be disabled. </para> </sect2> @@ -3078,59 +2815,49 @@ database. It is strongly recommended that this security check <title>The Installation Client</title> <para> -More information regarding the Imprints installation client is -available in the <filename>Imprints-Client-HOWTO.ps</filename> file -included with the imprints source package. +More information regarding the Imprints installation client is available from the the documentation file +<filename>Imprints-Client-HOWTO.ps</filename> that is included with the Imprints source package. The Imprints +installation client comes in two forms: </para> -<para> -The Imprints installation client comes in two forms. -</para> <itemizedlist> -<listitem><para>a set of command line Perl scripts</para></listitem> - -<listitem><para>a GTK+ based graphical interface to the command line Perl -scripts</para></listitem> + <listitem><para>A set of command line Perl scripts.</para></listitem> + <listitem><para>A GTK+ based graphical interface to the command line Perl scripts.</para></listitem> </itemizedlist> <para> -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 +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. </para> <para> -The basic installation process is in four steps and perl code is -wrapped around smbclient and rpcclient +The basic installation process is in four steps and Perl code is wrapped around smbclient and rpcclient. </para> <itemizedlist> <listitem><para> - foreach (supported architecture for a given driver) + For each supported architecture for a given driver: <orderedlist> - <listitem><para>rpcclient: Get the appropriate upload directory on the remote server</para></listitem> - <listitem><para>smbclient: Upload the driver files</para></listitem> - <listitem><para>rpcclient: Issues an AddPrinterDriver() MS-RPC</para></listitem> + <listitem><para>rpcclient: Get the appropriate upload directory on the remote server.</para></listitem> + <listitem><para>smbclient: Upload the driver files.</para></listitem> + <listitem><para>rpcclient: Issues an AddPrinterDriver() MS-RPC.</para></listitem> </orderedlist> </para></listitem> - <listitem><para>rpcclient: Issue an AddPrinterEx() MS-RPC to actually create the printer</para></listitem> + <listitem><para>rpcclient: Issue an AddPrinterEx() MS-RPC to actually create the printer.</para></listitem> </itemizedlist> <para> -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" +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 <quote>Apple LaserWriter +II NTX v51.8</quote> and Windows 95 calls its version of this driver <quote>Apple LaserWriter II NTX</quote>. </para> <para> -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 +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: </para> <para><filename> @@ -3138,56 +2865,46 @@ quick look in the Windows NT 4.0 system registry at </filename></para> <para> -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? +will reveal that Windows NT always uses the NT driver name. This is okay as Windows NT always requires +that at least the Windows NT version of the printer driver is present. Samba does not have the +requirement internally, therefore, <quote>How can you use the NT driver name if it has not already been installed?</quote> </para> <para> -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. +The way of sidestepping this limitation is to require that all Imprints printer driver packages include both the Intel Windows NT and +95/98 printer drivers and that the NT driver is installed first. </para> </sect2> </sect1> <sect1> -<title>Add Network Printers at Logon without User Interaction</title> +<title>Adding Network Printers without User Interaction</title> <para> -The following MS Knowledge Base article may be of some help if you -need to handle Windows 2000 clients: <emphasis>How to Add Printers -with No User Interaction in Windows 2000.</emphasis> ( <ulink -url="http://support.microsoft.com/default.aspx?scid=kb;en-us;189105">http://support.microsoft.com/default.aspx?scid=kb;en-us;189105</ulink> -). It also applies to Windows XP Professional clients. -</para> - -<para> -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: +The following MS Knowledge Base article may be of some help if you need to handle Windows 2000 +clients: <emphasis>How to Add Printers with No User Interaction in Windows 2000,</emphasis> (<ulink +url="http://support.microsoft.com/default.aspx?scid=kb;en-us;189105">http://support.microsoft.com/default.aspx?scid=kb;en-us;189105</ulink>). +It also applies to Windows XP Professional clients. +The ideas sketched out in this section are inspired by this article, which describes a commandline method that can be +applied to install network and local printers and their drivers. This is most useful if integrated in Logon +Scripts. You can see what options are available by typing in the command prompt (<command>DOS box</command>): </para> <para><userinput>rundll32 printui.dll,PrintUIEntry /?</userinput></para> <para> -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): +A window pops up that shows you all of the commandline switches available. An extensive list of examples +is also provided. This is only for Win 200x/XP, it does not work on +Windows NT. Windows NT probably has +some other tools in the respective Resource Kit. Here is a suggestion about what a client logon script +might contain, with a short explanation of what the lines actually do (it works if 200x/XP Windows +clients access printers via Samba, and works for Windows-based print servers too): </para> <para><screen> -<userinput>rundll32 printui.dll,PrintUIEntry /dn /n "\\sambacupsserver\infotec2105-IPDS" /q</userinput> -<userinput>rundll32 printui.dll,PrintUIEntry /in /n "\\sambacupsserver\infotec2105-PS"</userinput> -<userinput>rundll32 printui.dll,PrintUIEntry /y /n "\\sambacupsserver\infotec2105-PS"</userinput> +<userinput>rundll32 printui.dll,PrintUIEntry /dn /n "\\cupsserver\infotec2105-IPDS" /q</userinput> +<userinput>rundll32 printui.dll,PrintUIEntry /in /n "\\cupsserver\infotec2105-PS"</userinput> +<userinput>rundll32 printui.dll,PrintUIEntry /y /n "\\cupsserver\infotec2105-PS"</userinput> </screen></para> <para> @@ -3195,66 +2912,62 @@ Here is a list of the used commandline parameters: </para> <variablelist> -<varlistentry><term>/dn</term> -<listitem><para>deletes a network printer</para></listitem> -</varlistentry> -<varlistentry><term>/q</term> -<listitem><para>quiet modus</para></listitem> -</varlistentry> -<varlistentry><term>/n</term> -<listitem><para>names a printer</para></listitem> -</varlistentry> -<varlistentry><term>/in</term> -<listitem><para>adds a network printer connection</para></listitem> -</varlistentry> -<varlistentry><term>/y</term> -<listitem><para>sets printer as default printer</para></listitem> -</varlistentry> + <varlistentry><term>/dn</term> + <listitem><para>deletes a network printer</para></listitem> + </varlistentry> + <varlistentry><term>/q</term> + <listitem><para>quiet modus</para></listitem> + </varlistentry> + <varlistentry><term>/n</term> + <listitem><para>names a printer</para></listitem> + </varlistentry> + <varlistentry><term>/in</term> + <listitem><para>adds a network printer connection</para></listitem> + </varlistentry> + <varlistentry><term>/y</term> + <listitem><para>sets printer as default printer</para></listitem> + </varlistentry> </variablelist> <itemizedlist> -<listitem><para>Line 1 deletes a possibly existing previous network -printer <emphasis>infotec2105-IPDS</emphasis> (which had used native -Windows drivers with LPRng that were removed from the server which was -converted to CUPS). The <command>/q</command> at the end eliminates -"Confirm" or error dialog boxes popping up. They should not be -presented to the user logging on.</para></listitem> - -<listitem><para>Line 2 adds the new printer -<emphasis>infotec2105-PS</emphasis> (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 -<emphasis>must</emphasis> 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 <command>cupsaddsmb</command>). The driver is now -auto-downloaded to the client PC where the user is about to log -in.</para></listitem> - -<listitem><para>Line 3 sets the default printer to this new network -printer (there might be several other printers installed with this -same method and some may be local as well -- so we decide for a -default printer). The default printer selection may of course be -different for different users.</para></listitem> + <listitem><para> + Line 1 deletes a possibly existing previous network printer <emphasis>infotec2105-IPDS</emphasis> + (which had used native Windows drivers with LPRng that were removed from the server that was + converted to CUPS). The <command>/q</command> at the end eliminates Confirm + or error dialog boxes from popping up. They should not be presented to the user logging on. + </para></listitem> + + <listitem><para> + Line 2 adds the new printer + <emphasis>infotec2105-PS</emphasis> (which actually is the same + physical device but is now run by the new CUPS printing system and associated with the + CUPS/Adobe PS drivers). The printer and its driver must have been added to Samba prior to + the user logging in (e.g., by a procedure as discussed earlier in this chapter, or by running + <command>cupsaddsmb</command>). The driver is now auto-downloaded to the client PC where the + user is about to log in. + </para></listitem> + + <listitem><para> + Line 3 sets the default printer to this new network printer (there might be several other + printers installed with this same method and some may be local as well, so we decide for a + default printer). The default printer selection may, of course, be different for different users. + </para></listitem> </itemizedlist> <para> -Note that the second line only works if the printer -<emphasis>infotec2105-PS</emphasis> has an already working print queue -on "sambacupsserver", and if the printer drivers have successfully been -uploaded (via <command>APW</command> , -<command>smbclient/rpcclient</command> or -<command>cupsaddsmb</command>) into the -<smbconfsection>[print$]</smbconfsection> 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. +The second line only works if the printer <emphasis>infotec2105-PS</emphasis> has an already working +print queue on the <constant>cupsserver</constant>, and if the +printer drivers have been successfully uploaded +(via the <command>APW</command>, <command>smbclient/rpcclient</command>, or <command>cupsaddsmb</command>) +into the <smbconfsection>[print$]</smbconfsection> driver repository of Samba. 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. </para> <para> -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). +Since there no easy way to test for the existence of an installed network printer from the logon script, +do not bother checking, just allow the deinstallation/reinstallation to occur every time a user logs in; +it's really quick anyway (1 to 2 seconds). </para> <para> @@ -3262,96 +2975,91 @@ The additional benefits for this are: </para> <itemizedlist> -<listitem><para>It puts in place any printer default setup changes -automatically at every user logon.</para></listitem> + <listitem><para> + It puts in place any printer default setup changes automatically at every user logon. + </para></listitem> -<listitem><para>It allows for "roaming" users' login into the domain from -different workstations.</para></listitem> + <listitem><para> + It allows for <quote>roaming</quote> users' login into the domain from different workstations. + </para></listitem> </itemizedlist> <para> -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). +Since network printers are installed per user, this much simplifies the process of keeping the installation +up-to-date. The few extra seconds at logon time will not really be noticeable. Printers can be centrally +added, changed and deleted at will on the server with no user intervention required from the clients +(you just need to keep the logon scripts up-to-date). </para> </sect1> <sect1> -<title>The <command>addprinter</command> command</title> +<title>The <command>addprinter</command> Command</title> <para> -The <command>addprinter</command> 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 <command>lpadmin</command> 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! +The <command>addprinter</command> command can be configured to be a shell script or program executed by +Samba. It is triggered by running the APW from a client against the Samba print server. The APW asks +the user to fill in several fields (such as printer name, driver to be used, comment, port monitor, +and so on). These parameters are passed on to Samba by the APW. If the addprinter command is designed in a +way that it can create a new printer (through writing correct printcap entries on legacy systems, or +execute the <command>lpadmin</command> 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! </para> </sect1> <sect1> -<title>Migration of "Classical" printing to Samba</title> +<title>Migration of Classical Printing to Samba</title> <para> -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: +The basic NT-style printer driver management has not changed considerably in 3.0 over the 2.2.x releases +(apart from many small improvements). Here migration should be quite easy, especially if you followed +previous advice to stop using deprecated parameters in your setup. For migrations from an existing 2.0.x +setup, or if you continued Windows 9x/Me-style printing in your Samba 2.2 installations, it is more of +an effort. Please read the appropriate release notes and the HOWTO Collection for Samba-2.2.x. You can +follow several paths. Here are possible scenarios for migration: </para> <itemizedlist> -<listitem><para>You need to study and apply the new Windows NT printer -and driver support. Previously used parameters <parameter>printer -driver file</parameter>, <parameter>printer driver</parameter> and -<parameter>printer driver location</parameter> are no longer -supported.</para></listitem> - -<listitem><para>If you want to take advantage of WinNT printer driver -support you also need to migrate the Win9x/ME drivers to the new -setup.</para></listitem> - -<listitem><para>An existing <filename>printers.def</filename> file - (the one specified in the now removed parameter <parameter>printer driver file</parameter>) will work no longer with samba 3. In -3.0, smbd attempts to locate a Win9x/ME driver files for the printer -in <smbconfsection>[print$]</smbconfsection> and additional settings in the TDB -and only there; if it fails it will <emphasis>not</emphasis> (as 2.2.x -used to do) drop down to using a <filename>printers.def</filename> -(and all associated parameters). The make_printerdef tool is removed -and there is no backwards compatibility for this.</para></listitem> - -<listitem><para>You need to install a Windows 9x driver into the -<smbconfsection>[print$]</smbconfsection> share for a printer on your Samba -host. The driver files will be stored in the "WIN40/0" subdirectory of -<smbconfsection>[print$]</smbconfsection>, and some other settings and info go -into the printing-related TDBs.</para></listitem> + <listitem><para> + You need to study and apply the new Windows NT printer and driver support. Previously used + parameters <parameter>printer driver file</parameter>, <parameter>printer driver</parameter> + and <parameter>printer driver location</parameter> are no longer supported. + </para></listitem> -<listitem><para>If you want to migrate an existing -<filename>printers.def</filename> 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: -</para> + <listitem><para> + If you want to take advantage of Windows NT printer driver support, you also need to migrate the + Windows 9x/Me drivers to the new setup. + </para></listitem> -<para> - <ulink noescape="1" url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> -</para> + <listitem><para> + An existing <filename>printers.def</filename> file (the one specified in the now removed parameter + <parameter>printer driver file</parameter>) will no longer work with Samba-3. In 3.0, smbd attempts + to locate a Windows 9x/Me driver files for the printer in <smbconfsection>[print$]</smbconfsection> + and additional settings in the TDB and only there; if it fails, it will <emphasis>not</emphasis> + (as 2.2.x used to do) drop down to using a <filename>printers.def</filename> (and all associated + parameters). The make_printerdef tool is removed and there is no backward compatibility for this. + </para></listitem> -<para> -for an example. See also the discussion of rpcclient usage in the -"CUPS Printing" section.</para></listitem> + <listitem><para>You need to install a Windows 9x/Me driver into the + <smbconfsection>[print$]</smbconfsection> share for a printer on your Samba + host. The driver files will be stored in the <quote>WIN40/0</quote> subdirectory of + <smbconfsection>[print$]</smbconfsection>, and some other settings and information go + into the printing-related TDBs.</para></listitem> + + <listitem><para>If you want to migrate an existing + <filename>printers.def</filename> file into the new setup, the + only current + solution is to use the Windows NT APW to install the NT drivers + and the 9x/Me drivers. This can be scripted using smbclient and + rpcclient. See the Imprints installation client at: + </para> + + <para> + <ulink noescape="1" url="http://imprints.sourceforge.net/">http://imprints.sourceforge.net/</ulink> + </para> + + <para> + for an example. See also the discussion of rpcclient usage in the + <quote>CUPS Printing</quote> section.</para></listitem> </itemizedlist> </sect1> @@ -3359,7 +3067,8 @@ for an example. See also the discussion of rpcclient usage in the <title>Publishing Printer Information in Active Directory or LDAP</title> <para> -We will publish an update to this section shortly. +This will be addressed in a later update of this document. If you wish to volunteer your services to help +document this, please contact <ulink url="mail://jht@samba.org">John H Terpstra.</ulink> </para> </sect1> @@ -3367,26 +3076,30 @@ We will publish an update to this section shortly. <title>Common Errors</title> <sect2> -<title>I give my root password but I don't get access</title> +<title>I Give My Root Password but I Do Not Get Access</title> <para> -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 <filename>/etc/shadow</filename>) 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 -<command>smbpasswd</command> command. +Do not confuse the root password which is valid for the UNIX system (and in most cases stored in the +form of a one-way hash in a file named <filename>/etc/shadow</filename>), with the password used to +authenticate against Samba. Samba does not know the UNIX password. Root access to Samba resources +requires that a Samba account for root must first be created. This is done with the <command>smbpasswd</command> +command as follows: </para> + +<para><screen> +&rootprompt; smbpasswd -a root +New SMB password: secret +Retype new SMB password: secret +</screen></para> + </sect2> <sect2> -<title>My printjobs get spooled into the spooling directory, but then get lost</title> +<title>My Print Jobs Get Spooled into the Spooling Directory, but Then Get Lost</title> <para> -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 <emphasis>must</emphasis> be separate. +Do not use the existing UNIX print system spool directory for the Samba spool directory. It may seem +convenient and a savings of space, but it only leads to problems. The two must be separate. </para> </sect2> diff --git a/docs/docbook/projdoc/securing-samba.xml b/docs/docbook/projdoc/securing-samba.xml index d59b0f381e..52e07f2206 100644 --- a/docs/docbook/projdoc/securing-samba.xml +++ b/docs/docbook/projdoc/securing-samba.xml @@ -12,18 +12,20 @@ <title>Introduction</title> <para> This note was attached to the Samba 2.2.8 release notes as it contained an -important security fix. The information contained here applies to Samba +important security fix. The information contained here applies to Samba installations in general. </para> +<blockquote> <para> -A new apprentice reported for duty to the Chief Engineer of a boiler house. He said, "Here I am, -if you will show me the boiler I'll start working on it." Then engineer replied, "You're leaning -on it!" +A new apprentice reported for duty to the chief engineer of a boiler house. He said, <quote>Here I am, +if you will show me the boiler I'll start working on it.</quote> Then engineer replied, <quote>You're leaning +on it!</quote> </para> +</blockquote> <para> -Security concerns are just like that: You need to know a little about the subject to appreciate +Security concerns are just like that. You need to know a little about the subject to appreciate how obvious most of it really is. The challenge for most of us is to discover that first morsel of knowledge with which we may unlock the secrets of the masters. </para> @@ -34,9 +36,9 @@ of knowledge with which we may unlock the secrets of the masters. <title>Features and Benefits</title> <para> -There are three level at which security principals must be observed in order to render a site -at least moderately secure. These are: the perimeter firewall, the configuration of the host -server that is running Samba, and Samba itself. +There are three levels at which security principals must be observed in order to render a site +at least moderately secure. They are the perimeter firewall, the configuration of the host +server that is running Samba and Samba itself. </para> <para> @@ -46,18 +48,17 @@ the latest protocols to permit more secure MS Windows file and print operations. <para> Samba may be secured from connections that originate from outside the local network. This may be -done using <emphasis>host based protection</emphasis> (using samba's implementation of a technology -known as "tcpwrappers", or it may be done be using <emphasis>interface based exclusion</emphasis> -so that &smbd; will bind only to specifically permitted interfaces. It is also -possible to set specific share or resource based exclusions, eg: on the <smbconfsection>[IPC$]</smbconfsection> +done using <emphasis>host-based protection</emphasis> (using samba's implementation of a technology +known as <quote>tcpwrappers,</quote> or it may be done be using <emphasis>interface-based exclusion</emphasis> +so &smbd; will bind only to specifically permitted interfaces. It is also +possible to set specific share or resource-based exclusions, for example on the <smbconfsection>[IPC$]</smbconfsection> auto-share. The <smbconfsection>[IPC$]</smbconfsection> share is used for browsing purposes as well as to establish TCP/IP connections. </para> <para> -Another method by which Samba may be secured is by way of setting Access Control Entries in an Access -Control List on the shares themselves. This is discussed in the chapter on File, Directory and Share Access -Control. +Another method by which Samba may be secured is by setting Access Control Entries (ACEs) in an Access +Control List (ACL) on the shares themselves. This is discussed in <link linkend="AccessControls"/>. </para> </sect1> @@ -74,11 +75,11 @@ before someone will find yet another vulnerability. </para> <sect2> - <title>Using host based protection</title> + <title>Using Host-Based Protection</title> <para> - In many installations of Samba the greatest threat comes for outside - your immediate network. By default Samba will accept connections from + In many installations of Samba, the greatest threat comes from outside + your immediate network. By default, Samba will accept connections from any host, which means that if you run an insecure version of Samba on a host that is directly connected to the Internet you can be especially vulnerable. @@ -87,8 +88,7 @@ before someone will find yet another vulnerability. <para> One of the simplest fixes in this case is to use the <smbconfoption><name>hosts allow</name></smbconfoption> and <smbconfoption><name>hosts deny</name></smbconfoption> options in the Samba &smb.conf; configuration file to only - allow access to your server from a specific range of hosts. An example - might be: + allow access to your server from a specific range of hosts. An example might be: </para> <para><smbconfblock> @@ -97,20 +97,19 @@ before someone will find yet another vulnerability. </smbconfblock></para> <para> - The above will only allow SMB connections from 'localhost' (your own - computer) and from the two private networks 192.168.2 and - 192.168.3. All other connections will be refused as soon - as the client sends its first packet. The refusal will be marked as a - <errorname>not listening on called name</errorname> error. + The above will only allow SMB connections from <constant>localhost</constant> (your own + computer) and from the two private networks 192.168.2 and 192.168.3. All other + connections will be refused as soon as the client sends its first packet. The refusal + will be marked as <errorname>not listening on called name</errorname> error. </para> </sect2> <sect2> - <title>User based protection</title> + <title>User-Based Protection</title> <para> - If you want to restrict access to your server to valid users only then the following + If you want to restrict access to your server to valid users only, then the following method may be of use. In the &smb.conf; <smbconfsection>[global]</smbconfsection> section put: </para> @@ -119,7 +118,7 @@ before someone will find yet another vulnerability. </smbconfblock></para> <para> - What this does is, it restricts all server access to either the user <emphasis>jacko</emphasis> + This restricts all server access to either the user <emphasis>jacko</emphasis> or to members of the system group <emphasis>smbusers</emphasis>. </para> @@ -127,17 +126,17 @@ before someone will find yet another vulnerability. <sect2> - <title>Using interface protection</title> + <title>Using Interface Protection</title> <para> - By default Samba will accept connections on any network interface that + By default, Samba will accept connections on any network interface that it finds on your system. That means if you have a ISDN line or a PPP connection to the Internet then Samba will accept connections on those links. This may not be what you want. </para> <para> - You can change this behaviour using options like the following: + You can change this behavior using options like this: </para> <para><smbconfblock> @@ -147,35 +146,35 @@ before someone will find yet another vulnerability. <para> This tells Samba to only listen for connections on interfaces with a - name starting with 'eth' such as eth0, eth1, plus on the loopback - interface called 'lo'. The name you will need to use depends on what - OS you are using, in the above I used the common name for Ethernet + name starting with <constant>eth</constant> such as <constant>eth0, eth1</constant> plus on the loopback + interface called <constant>lo</constant>. The name you will need to use depends on what + OS you are using. In the above, I used the common name for Ethernet adapters on Linux. </para> <para> - If you use the above and someone tries to make a SMB connection to - your host over a PPP interface called 'ppp0' then they will get a TCP - connection refused reply. In that case no Samba code is run at all as + If you use the above and someone tries to make an SMB connection to + your host over a PPP interface called <constant>ppp0,</constant> then they will get a TCP + connection refused reply. In that case, no Samba code is run at all as the operating system has been told not to pass connections from that - interface to any samba process. + interface to any Samba process. </para> </sect2> <sect2> - <title>Using a firewall</title> + <title>Using a Firewall</title> <para> - Many people use a firewall to deny access to services that they don't - want exposed outside their network. This can be a very good idea, - although I would recommend using it in conjunction with the above - methods so that you are protected even if your firewall is not active + Many people use a firewall to deny access to services they do not + want exposed outside their network. This can be a good idea, + although I recommend using it in conjunction with the above + methods so you are protected even if your firewall is not active for some reason. </para> <para> - If you are setting up a firewall then you need to know what TCP and + If you are setting up a firewall, you need to know what TCP and UDP ports to allow and block. Samba uses the following: </para> @@ -195,7 +194,7 @@ before someone will find yet another vulnerability. </sect2> <sect2> - <title>Using a IPC$ share deny</title> + <title>Using IPC$ Share-Based Denials </title> <para> If the above methods are not suitable, then you could also place a @@ -206,34 +205,29 @@ before someone will find yet another vulnerability. </para> <para> - To do that you could use: + To do this you could use: </para> <para><smbconfblock> -<smbconfsection>[ipc$]</smbconfsection> +<smbconfsection>[IPC$]</smbconfsection> <smbconfoption><name>hosts allow</name><value>192.168.115.0/24 127.0.0.1</value></smbconfoption> <smbconfoption><name>hosts deny</name><value>0.0.0.0/0</value></smbconfoption> </smbconfblock></para> <para> - this would tell Samba that IPC$ connections are not allowed from - anywhere but the two listed places (localhost and a local - subnet). Connections to other shares would still be allowed. As the - IPC$ share is the only share that is always accessible anonymously + This instructs Samba that IPC$ connections are not allowed from + anywhere except from the two listed network addresses (localhost and the 192.168.115 + subnet). Connections to other shares are still allowed. As the + IPC$ share is the only share that is always accessible anonymously, this provides some level of protection against attackers that do not - know a username/password for your host. + know a valid username/password for your host. </para> <para> - If you use this method then clients will be given a <errorname>access denied</errorname> - reply when they try to access the IPC$ share. That means that those - clients will not be able to browse shares, and may also be unable to - access some other resources. - </para> - - <para> - This is not recommended unless you cannot use one of the other - methods listed above for some reason. + If you use this method, then clients will be given an <errorname>`access denied'</errorname> + reply when they try to access the IPC$ share. Those clients will not be able to + browse shares, and may also be unable to access some other resources. This is not + recommended unless you cannot use one of the other methods listed above for some reason. </para> </sect2> @@ -242,7 +236,7 @@ before someone will find yet another vulnerability. <title>NTLMv2 Security</title> <para> - To configure NTLMv2 authentication the following registry keys are worth knowing about: + To configure NTLMv2 authentication, the following registry keys are worth knowing about: </para> <para> @@ -253,9 +247,9 @@ before someone will find yet another vulnerability. </para> <para> - 0x3 - Send NTLMv2 response only. Clients will use NTLMv2 authentication, - use NTLMv2 session security if the server supports it. Domain - controllers accept LM, NTLM and NTLMv2 authentication. + The value 0x00000003 means send NTLMv2 response only. Clients will use NTLMv2 authentication, + use NTLMv2 session security if the server supports it. Domain Controllers accept LM, + NTLM and NTLMv2 authentication. </para> <para> @@ -266,9 +260,9 @@ before someone will find yet another vulnerability. </para> <para> - 0x80000 - NTLMv2 session security. If either NtlmMinClientSec or - NtlmMinServerSec is set to 0x80000, the connection will fail if NTLMv2 - session security is not negotiated. + The value 0x00080000 means permit only NTLMv2 session security. If either NtlmMinClientSec or + NtlmMinServerSec is set to 0x00080000, the connection will fail if NTLMv2 + session security is not negotiated. </para> </sect2> </sect1> @@ -278,7 +272,7 @@ before someone will find yet another vulnerability. <para> Please check regularly on <ulink noescape="1" url="http://www.samba.org/">http://www.samba.org/</ulink> for updates and -important announcements. Occasionally security releases are made and +important announcements. Occasionally security releases are made and it is highly recommended to upgrade Samba when a security vulnerability is discovered. Check with your OS vendor for OS specific upgrades. </para> @@ -289,81 +283,75 @@ is discovered. Check with your OS vendor for OS specific upgrades. <title>Common Errors</title> <para> -If all of samba and host platform configuration were really as intuitive as one might like then this +If all of Samba and host platform configuration were really as intuitive as one might like them to be, this section would not be necessary. Security issues are often vexing for a support person to resolve, not -because of the complexity of the problem, but for reason that most administrators who post what turns +because of the complexity of the problem, but for the reason that most administrators who post what turns out to be a security problem request are totally convinced that the problem is with Samba. </para> <sect2> - <title>Smbclient works on localhost, but the network is dead</title> + <title>Smbclient Works on Localhost, but the Network Is Dead</title> <para> - This is a very common problem. Red Hat Linux (as do others) will install a default firewall. - With the default firewall in place only traffic on the loopback adapter (IP address 127.0.0.1) - will be allowed through the firewall. + This is a common problem. Red Hat Linux (and others) installs a default firewall. + With the default firewall in place, only traffic on the loopback adapter (IP address 127.0.0.1) + is allowed through the firewall. </para> <para> - The solution is either to remove the firewall (stop it) or to modify the firewall script to + The solution is either to remove the firewall (stop it) or modify the firewall script to allow SMB networking traffic through. See section above in this chapter. </para> </sect2> <sect2> - <title>Why can users access home directories of other users?</title> + <title>Why Can Users Access Home Directories of Other Users?</title> <para> <quote> We are unable to keep individual users from mapping to any other user's home directory once they have supplied a valid password! They only need - to enter their own password. I have not found *any* method that I can - use to configure samba to enforce that only a user may map their own - home directory. + to enter their own password. I have not found any method to configure + Samba so that users may map only their own home directory. </quote> </para> <para><quote> User xyzzy can map his home directory. Once mapped user xyzzy can also map - *anyone* else's home directory! + anyone else's home directory. </quote></para> <para> - This is not a security flaw, it is by design. Samba allows - users to have *exactly* the same access to the UNIX filesystem - as they would if they were logged onto the UNIX box, except - that it only allows such views onto the file system as are - allowed by the defined shares. + This is not a security flaw, it is by design. Samba allows users to have + exactly the same access to the UNIX file system as when they were logged + onto the UNIX box, except that it only allows such views onto the file + system as are allowed by the defined shares. </para> <para> - This means that if your UNIX home directories are set up - such that one user can happily cd into another users - directory and do an ls, the UNIX security solution is to - change the UNIX file permissions on the users home directories - such that the cd and ls would be denied. + If your UNIX home directories are set up so that one user can happily <command>cd</command> + into another users directory and execute <command>ls</command>, the UNIX security solution is to change file + permissions on the user's home directories such that the <command>cd</command> and <command>ls</command> are denied. </para> <para> - Samba tries very hard not to second guess the UNIX administrators - security policies, and trusts the UNIX admin to set - the policies and permissions he or she desires. + Samba tries very hard not to second guess the UNIX administrators security policies, and + trusts the UNIX admin to set the policies and permissions he or she desires. </para> <para> - Samba does allow the setup you require when you have set the - <smbconfoption><name>only user</name><value>yes</value></smbconfoption> option on the share, is that you have not set the - valid users list for the share. + Samba allows the behavior you require. Simply put the <smbconfoption><name>only user</name><value>%S</value></smbconfoption> + option in the <smbconfsection>[homes]</smbconfsection> share definition. </para> <para> - Note that only user works in conjunction with the users= list, + The <smbconfoption><name>only user</name><value></value></smbconfoption> works in conjunction with the <smbconfoption><name>users</name><value>list</value></smbconfoption>, so to get the behavior you require, add the line : <smbconfblock> <smbconfoption><name>users</name><value>%S</value></smbconfoption> </smbconfblock> - this is equivalent to: + this is equivalent to adding <smbconfblock> <smbconfoption><name>valid users</name><value>%S</value></smbconfoption> </smbconfblock> diff --git a/docs/docbook/projdoc/unicode.xml b/docs/docbook/projdoc/unicode.xml index 28d6f76cdf..699f29f1ba 100644 --- a/docs/docbook/projdoc/unicode.xml +++ b/docs/docbook/projdoc/unicode.xml @@ -1,6 +1,7 @@ <chapter id="unicode"> <chapterinfo> &author.jelmer; + &author.jht; <author> <firstname>TAKAHASHI</firstname><surname>Motonobu</surname> <affiliation> @@ -25,62 +26,65 @@ origin. <para> Of all the effort that has been brought to bear on providing native language support -for all computer users, the efforts of the <ulink url="http://www.openi18n.org/">Openi18n organisation</ulink> is deserving of +for all computer users, the efforts of the <ulink url="http://www.openi18n.org/">Openi18n organization</ulink> is deserving of special mention. </para> <para> Samba-2.x supported a single locale through a mechanism called <emphasis>codepages</emphasis>. Samba-3 is destined to become a truly trans-global -file and printer sharing platform. +file and printer-sharing platform. </para> </sect1> <sect1> -<title>What are charsets and unicode?</title> +<title>What Are Charsets and Unicode?</title> <para> Computers communicate in numbers. In texts, each number will be translated to a corresponding letter. The meaning that will be assigned -to a certain number depends on the <emphasis>character set(charset) +to a certain number depends on the <emphasis>character set (charset) </emphasis> that is used. +</para> + +<para> A charset can be seen as a table that is used to translate numbers to letters. Not all computers use the same charset (there are charsets -with German umlauts, Japanese characters, etc). Usually a charset contains +with German umlauts, Japanese characters, and so on). Usually a charset contains 256 characters, which means that storing a character with it takes exactly one byte. </para> <para> There are also charsets that support even more characters, -but those need twice(or even more) as much storage space. These +but those need twice as much storage space (or more). These charsets can contain <command>256 * 256 = 65536</command> characters, which -is more then all possible characters one could think of. They are called -multibyte charsets (because they use more then one byte to -store one character). +is more than all possible characters one could think of. They are called +multibyte charsets because they use more then one byte to +store one character. </para> <para> - A standardised multibyte charset is <ulink url="http://www.unicode.org/">unicode</ulink>. +A standardized multibyte charset is <ulink url="http://www.unicode.org/">unicode</ulink>. A big advantage of using a multibyte charset is that you only need one; there is no need to make sure two computers use the same charset when they are communicating. </para> -<para>Old windows clients use single-byte charsets, named -'codepages' by Microsoft. However, there is no support for -negotiating the charset to be used in the smb protocol. Thus, you +<para>Old Windows clients use single-byte charsets, named +<parameter>codepages</parameter>, by Microsoft. However, there is no support for +negotiating the charset to be used in the SMB/CIFS protocol. Thus, you have to make sure you are using the same charset when talking to an older client. -Newer clients (Windows NT, 2K, XP) talk unicode over the wire. +Newer clients (Windows NT, 200x, XP) talk unicode over the wire. </para> </sect1> <sect1> -<title>Samba and charsets</title> +<title>Samba and Charsets</title> <para> -As of samba 3.0, samba can (and will) talk unicode over the wire. Internally, -samba knows of three kinds of character sets: +As of Samba-3.0, Samba can (and will) talk unicode over the wire. Internally, +Samba knows of three kinds of character sets: </para> <variablelist> @@ -89,21 +93,21 @@ samba knows of three kinds of character sets: <listitem><para> This is the charset used internally by your operating system. The default is <constant>UTF-8</constant>, which is fine for most - systems. The default in previous samba releases was <constant>ASCII</constant>. + systems, which covers all characters in all languages. The default in previous Samba releases was <constant>ASCII</constant>. </para></listitem> </varlistentry> <varlistentry> <term><smbconfoption><name>display charset</name></smbconfoption></term> - <listitem><para>This is the charset samba will use to print messages - on your screen. It should generally be the same as the <command>unix charset</command>. + <listitem><para>This is the charset Samba will use to print messages + on your screen. It should generally be the same as the <parameter>unix charset</parameter>. </para></listitem> </varlistentry> <varlistentry> <term><smbconfoption><name>dos charset</name></smbconfoption></term> - <listitem><para>This is the charset samba uses when communicating with - DOS and Windows 9x clients. It will talk unicode to all newer clients. + <listitem><para>This is the charset Samba uses when communicating with + DOS and Windows 9x/Me clients. It will talk unicode to all newer clients. The default depends on the charsets you have installed on your system. Run <command>testparm -v | grep "dos charset"</command> to see what the default is on your system. @@ -114,42 +118,38 @@ samba knows of three kinds of character sets: </sect1> <sect1> -<title>Conversion from old names</title> +<title>Conversion from Old Names</title> -<para>Because previous samba versions did not do any charset conversion, -characters in filenames are usually not correct in the unix charset but only +<para>Because previous Samba versions did not do any charset conversion, +characters in filenames are usually not correct in the UNIX charset but only for the local charset used by the DOS/Windows clients.</para> -<para>Bjoern Jacke has written a utility named <ulink url="http://j3e.de/linux/convmv/">convm</ulink> that can convert whole directory - structures to different charsets with one single command. -</para> - </sect1> <sect1> -<title>Japanese charsets</title> +<title>Japanese Charsets</title> -<para>Samba doesn't work correctly with Japanese charsets yet. Here are +<para>Samba does not work correctly with Japanese charsets yet. Here are points of attention when setting it up:</para> <itemizedlist> <listitem><para>You should set <smbconfoption><name>mangling method</name><value>hash</value></smbconfoption></para></listitem> -<listitem><para>There are various iconv() implementations around and not -all of them work equally well. glibc2's iconv() has a critical problem -in CP932. libiconv-1.8 works with CP932 but still has some problems and -does not work with EUC-JP.</para></listitem> + <listitem><para>There are various iconv() implementations around and not + all of them work equally well. glibc2's iconv() has a critical problem + in CP932. libiconv-1.8 works with CP932 but still has some problems and + does not work with EUC-JP.</para></listitem> -<listitem><para>You should set <smbconfoption><name>dos charset</name><value>CP932</value></smbconfoption>, not -Shift_JIS, SJIS...</para></listitem> + <listitem><para>You should set <smbconfoption><name>dos charset</name><value>CP932</value></smbconfoption>, not + Shift_JIS, SJIS.</para></listitem> -<listitem><para>Currently only <smbconfoption><name>unix charset</name><value>CP932</value></smbconfoption> -will work (but still has some problems...) because of iconv() issues. -<smbconfoption><name>unix charset</name><value>EUC-JP</value></smbconfoption> doesn't work well because of -iconv() issues.</para></listitem> + <listitem><para>Currently only <smbconfoption><name>UNIX charset</name><value>CP932</value></smbconfoption> + will work (but still has some problems...) because of iconv() issues. + <smbconfoption><name>UNIX charset</name><value>EUC-JP</value></smbconfoption> does not work well because of + iconv() issues.</para></listitem> -<listitem><para>Currently Samba 3.0 does not support <smbconfoption><name>unix charset</name><value>UTF8-MAC/CAP/HEX/JIS*</value></smbconfoption></para></listitem> + <listitem><para>Currently Samba-3.0 does not support <smbconfoption><name>UNIX charset</name><value>UTF8-MAC/CAP/HEX/JIS*</value></smbconfoption>.</para></listitem> </itemizedlist> @@ -158,16 +158,19 @@ iconv() issues.</para></listitem> </sect1> <sect1> - <title>Common errors</title> + <title>Common Errors</title> <sect2> - <title>CP850.so can't be found</title> + <title>CP850.so Can't Be Found</title> - <para><quote>Samba is complaining about a missing <filename>CP850.so</filename> file</quote>.</para> + <para><quote>Samba is complaining about a missing <filename>CP850.so</filename> file.</quote></para> - <para>CP850 is the default <smbconfoption><name>dos charset</name></smbconfoption>. The <smbconfoption><name>dos charset</name></smbconfoption> is used to convert data to the codepage used by your dos clients. If you don't have any dos clients, you can safely ignore this message. </para> + <para><emphasis>Answer:</emphasis> CP850 is the default <smbconfoption><name>dos charset</name></smbconfoption>. + The <smbconfoption><name>dos charset</name></smbconfoption> is used to convert data to the codepage used by your dos clients. + If you do not have any dos clients, you can safely ignore this message. </para> - <para>CP850 should be supported by your local iconv implementation. Make sure you have all the required packages installed. If you compiled samba from source, make sure configure found iconv.</para> + <para>CP850 should be supported by your local iconv implementation. Make sure you have all the required packages installed. + If you compiled Samba from source, make sure to configure found iconv.</para> </sect2> </sect1> diff --git a/docs/docbook/projdoc/upgrading-to-3.0.xml b/docs/docbook/projdoc/upgrading-to-3.0.xml index 74af0cbb9e..4461f0fdcb 100644 --- a/docs/docbook/projdoc/upgrading-to-3.0.xml +++ b/docs/docbook/projdoc/upgrading-to-3.0.xml @@ -8,83 +8,123 @@ <title>Upgrading from Samba-2.x to Samba-3.0.0</title> +<para> +This chapter deals exclusively with the differences between Samba-3.0.0 and Samba-2.2.8a. +It points out where configuration parameters have changed, and provides a simple guide for +the move from 2.2.x to 3.0.0. +</para> + +<sect1> +<title>Quick Migration Guide</title> + +<para> +Samba-3.0.0 default behavior should be approximately the same as Samba-2.2.x. +The default behavior when the new parameter <smbconfoption><name>passdb backend</name></smbconfoption> +is not defined in the &smb.conf; file provides the same default behviour as Samba-2.2.x +with <smbconfoption><name>encrypt passwords</name><value>Yes</value></smbconfoption>, and +will use the <filename>smbpasswd</filename> database. +</para> + +<para> +So why say that <emphasis>behavior should be approximately the same as Samba-2.2.x?</emphasis> Because +Samba-3.0.0 can negotiate new protocols, such as support for native Unicode, that may result in +differing protocol code paths being taken. The new behavior under such circumstances is not +exactly the same as the old one. The good news is that the domain and machine SIDs will be +preserved across the upgrade. +</para> + +<para> +If the Samba-2.2.x system was using an LDAP backend, and there is no time to update the LDAP +database, then make sure that <smbconfoption><name>passdb backend</name><value>ldapsam_compat</value></smbconfoption> +is specified in the &smb.conf; file. For the rest, behavior should remain more or less the same. +At a later date, when there is time to implement a new Samba-3 compatible LDAP backend, it is possible +to migrate the old LDAP database to the new one through use of the <command>pdbedit</command>. +See <link linkend="pdbeditthing"/>. +</para> + +</sect1> <sect1> <title>New Features in Samba-3</title> <para> -Major new features: +The major new features are: </para> -<orderedlist> +<orderedlist numberation="arabic"> <listitem><para> - Active Directory support. This release is able to join a ADS realm + Active Directory support. This release is able to join an ADS realm as a member server and authenticate users using LDAP/kerberos. </para></listitem> <listitem><para> - Unicode support. Samba will now negotiate UNICODE on the wire and - internally there is now a much better infrastructure for multi-byte - and UNICODE character sets. + Unicode support. Samba will now negotiate unicode on the wire and + internally there is a much better infrastructure for multi-byte + and unicode character sets. </para></listitem> <listitem><para> New authentication system. The internal authentication system has been almost completely rewritten. Most of the changes are internal, - but the new auth system is also very configurable. + but the new authoring system is also very configurable. </para></listitem> <listitem><para> New filename mangling system. The filename mangling system has been completely rewritten. An internal database now stores mangling maps - persistently. This needs lots of testing. + persistently. </para></listitem> <listitem><para> - New "net" command. A new "net" command has been added. It is - somewhat similar to the "net" command in windows. Eventually we + New <quote>net</quote> command. A new <quote>net</quote> command has been added. It is + somewhat similar to the <quote>net</quote> command in Windows. Eventually, we plan to replace a bunch of other utilities (such as smbpasswd) - with subcommands in "net", at the moment only a few things are - implemented. + with subcommands in <quote>net</quote>. </para></listitem> <listitem><para> Samba now negotiates NT-style status32 codes on the wire. This - improves error handling a lot. + considerably improves error handling. </para></listitem> <listitem><para> - Better Windows 2000/XP/2003 printing support including publishing - printer attributes in active directory + Better Windows 200x/XP printing support including publishing + printer attributes in Active Directory. </para></listitem> <listitem><para> - New loadable RPC modules + New loadable RPC modules for passdb backends and character sets. </para></listitem> <listitem><para> - New dual-daemon winbindd support (-B) for better performance + New default dual-daemon winbindd support for better performance. </para></listitem> <listitem><para> Support for migrating from a Windows NT 4.0 domain to a Samba - domain and maintaining user, group and domain SIDs + domain and maintaining user, group and domain SIDs. </para></listitem> <listitem><para> Support for establishing trust relationships with Windows NT 4.0 - domain controllers + Domain Controllers. </para></listitem> <listitem><para> Initial support for a distributed Winbind architecture using - an LDAP directory for storing SID to uid/gid mappings + an LDAP directory for storing SID to UID/GID mappings. </para></listitem> <listitem><para> Major updates to the Samba documentation tree. </para></listitem> + + <listitem><para> + Full support for client and server SMB signing to ensure + compatibility with default Windows 2003 security settings. + </para></listitem> </orderedlist> + <para> Plus lots of other improvements! </para> @@ -95,15 +135,15 @@ Plus lots of other improvements! <title>Configuration Parameter Changes</title> <para> -This section contains a brief listing of changes to smb.conf options -in the 3.0.0 release. Please refer to the smb.conf(5) man page for +This section contains a brief listing of changes to &smb.conf; options +in the 3.0.0 release. Please refer to the smb.conf(5) man page for complete descriptions of new or modified parameters. </para> <sect2> <title>Removed Parameters</title> -<para>(order alphabetically):</para> +<para>(Ordered Alphabetically):</para> <itemizedlist> <listitem><para>admin log </para></listitem> @@ -121,6 +161,7 @@ complete descriptions of new or modified parameters. <listitem><para>printer driver file </para></listitem> <listitem><para>printer driver location </para></listitem> <listitem><para>status </para></listitem> + <listitem><para>stip dot </para></listitem> <listitem><para>total print jobs </para></listitem> <listitem><para>use rhosts </para></listitem> <listitem><para>valid chars </para></listitem> @@ -132,16 +173,16 @@ complete descriptions of new or modified parameters. <sect2> <title>New Parameters</title> -<para>(new parameters have been grouped by function):</para> +<para>(New parameters have been grouped by function):</para> -<para>Remote management</para> +<para>Remote Management</para> <itemizedlist> <listitem><para>abort shutdown script </para></listitem> <listitem><para>shutdown script </para></listitem> </itemizedlist> -<para>User and Group Account Management</para> +<para>User and Group Account Management:</para> <itemizedlist> <listitem><para>add group script </para></listitem> @@ -154,15 +195,14 @@ complete descriptions of new or modified parameters. <listitem><para>set primary group script </para></listitem> </itemizedlist> -<para>Authentication</para> +<para>Authentication:</para> <itemizedlist> <listitem><para>auth methods </para></listitem> - <listitem><para>ads server </para></listitem> <listitem><para>realm </para></listitem> </itemizedlist> -<para>Protocol Options</para> +<para>Protocol Options:</para> <itemizedlist> <listitem><para>client lanman auth </para></listitem> @@ -174,11 +214,12 @@ complete descriptions of new or modified parameters. <listitem><para>ntlm auth </para></listitem> <listitem><para>paranoid server security </para></listitem> <listitem><para>server schannel </para></listitem> + <listitem><para>server signing </para></listitem> <listitem><para>smb ports </para></listitem> <listitem><para>use spnego </para></listitem> </itemizedlist> -<para>File Service</para> +<para>File Service:</para> <itemizedlist> <listitem><para>get quota command </para></listitem> @@ -187,38 +228,42 @@ complete descriptions of new or modified parameters. <listitem><para>hostname lookups </para></listitem> <listitem><para>kernel change notify </para></listitem> <listitem><para>mangle prefix </para></listitem> + <listitem><para>map acl inherit </para></listitem> <listitem><para>msdfs proxy </para></listitem> <listitem><para>set quota command </para></listitem> <listitem><para>use sendfile </para></listitem> <listitem><para>vfs objects </para></listitem> </itemizedlist> -<para>Printing</para> +<para>Printing:</para> <itemizedlist> <listitem><para>max reported print jobs </para></listitem> </itemizedlist> -<para>UNICODE and Character Sets</para> +<para>Unicode and Character Sets:</para> <itemizedlist> <listitem><para>display charset </para></listitem> <listitem><para>dos charset </para></listitem> <listitem><para>unicode </para></listitem> - <listitem><para>unix charset </para></listitem> + <listitem><para>UNIX charset </para></listitem> </itemizedlist> -<para>SID to uid/gid Mappings</para> +<para>SID to UID/GID Mappings:</para> <itemizedlist> <listitem><para>idmap backend </para></listitem> <listitem><para>idmap gid </para></listitem> - <listitem><para>idmap only </para></listitem> <listitem><para>idmap uid </para></listitem> + <listitem><para>winbind enable local accounts </para></listitem> + <listitem><para>winbind trusted domains only </para></listitem> + <listitem><para>template primary group </para></listitem> + <listitem><para>enable rid algorithm </para></listitem> </itemizedlist> -<para>LDAP</para> +<para>LDAP:</para> <itemizedlist> <listitem><para>ldap delete dn </para></listitem> @@ -230,7 +275,7 @@ complete descriptions of new or modified parameters. <listitem><para>ldap user suffix </para></listitem> </itemizedlist> -<para>General Configuration</para> +<para>General Configuration:</para> <itemizedlist> <listitem><para>preload modules </para></listitem> @@ -240,19 +285,20 @@ complete descriptions of new or modified parameters. </sect2> <sect2> -<title>Modified Parameters (changes in behavior):</title> +<title>Modified Parameters (Changes in Behavior):</title> <itemizedlist> <listitem><para>encrypt passwords (enabled by default) </para></listitem> - <listitem><para>mangling method (set to 'hash2' by default) </para></listitem> + <listitem><para>mangling method (set to hash2 by default) </para></listitem> <listitem><para>passwd chat </para></listitem> <listitem><para>passwd program </para></listitem> + <listitem><para>password server </para></listitem> <listitem><para>restrict anonymous (integer value) </para></listitem> - <listitem><para>security (new 'ads' value) </para></listitem> + <listitem><para>security (new ads value) </para></listitem> <listitem><para>strict locking (enabled by default) </para></listitem> <listitem><para>winbind cache time (increased to 5 minutes) </para></listitem> - <listitem><para>winbind uid (deprecated in favor of 'idmap uid') </para></listitem> - <listitem><para>winbind gid (deprecated in favor of 'idmap gid') </para></listitem> + <listitem><para>winbind uid (deprecated in favor of idmap uid) </para></listitem> + <listitem><para>winbind gid (deprecated in favor of idmap gid) </para></listitem> </itemizedlist> </sect2> @@ -267,17 +313,21 @@ complete descriptions of new or modified parameters. <para> This section contains brief descriptions of any new databases - introduced in Samba 3.0. Please remember to backup your existing - ${lock directory}/*tdb before upgrading to Samba 3.0. Samba will + introduced in Samba-3. Please remember to backup your existing + ${lock directory}/*tdb before upgrading to Samba-3. Samba will upgrade databases as they are opened (if necessary), but downgrading from 3.0 to 2.2 is an unsupported path. </para> + <para> + The new tdb files are described in <link linkend="tdbfiledesc"/>. + </para> + - <table frame='all'><title>TDB File Descriptions</title> + <table frame='all' id="tdbfiledesc"><title>TDB File Descriptions</title> <tgroup cols='3'> <colspec align="left"/> - <colspec align="justify"/> + <colspec align="justify" width="1*"/> <colspec align="left"/> <thead> <row> @@ -299,12 +349,12 @@ complete descriptions of new or modified parameters. </row> <row> <entry>group_mapping</entry> - <entry><para>Mapping table from Windows groups/SID to unix groups</para></entry> + <entry><para>Mapping table from Windows groups/SID to UNIX groups</para></entry> <entry>yes</entry> </row> <row> <entry>idmap</entry> - <entry><para>new ID map table from SIDS to UNIX uids/gids</para></entry> + <entry><para>new ID map table from SIDS to UNIX UIDs/GIDs</para></entry> <entry>yes</entry> </row> <row> @@ -320,14 +370,14 @@ complete descriptions of new or modified parameters. </row> <row> <entry>printing/*.tdb</entry> - <entry><para>Cached output from 'lpq command' created on a per print + <entry><para>Cached output from `lpq command' created on a per print service basis</para></entry> <entry>no</entry> </row> <row> <entry>registry</entry> - <entry><para>Read-only samba registry skeleton that provides support for + <entry><para>Read-only Samba registry skeleton that provides support for exporting various db tables via the winreg RPCs</para></entry> <entry>no</entry> </row> @@ -341,26 +391,26 @@ complete descriptions of new or modified parameters. <title>Changes in Behavior</title> <para> - The following issues are known changes in behavior between Samba 2.2 and - Samba 3.0 that may affect certain installations of Samba. + The following issues are known changes in behavior between Samba-2.2 and + Samba-3 that may affect certain installations of Samba. </para> <orderedlist> <listitem><para> - When operating as a member of a Windows domain, Samba 2.2 would - map any users authenticated by the remote DC to the 'guest account' - if a uid could not be obtained via the getpwnam() call. Samba 3.0 - rejects the connection as NT_STATUS_LOGON_FAILURE. There is no - current work around to re-establish the 2.2 behavior. + When operating as a member of a Windows domain, Samba-2.2 would + map any users authenticated by the remote DC to the <quote>guest account</quote> + if a uid could not be obtained via the getpwnam() call. Samba-3 + rejects the connection as <?latex \linebreak ?>NT_STATUS_LOGON_FAILURE. There is no + current work around to re-establish the Samba-2.2 behavior. </para></listitem> <listitem><para> - When adding machines to a Samba 2.2 controlled domain, the - 'add user script' was used to create the UNIX identity of the - machine trust account. Samba 3.0 introduces a new 'add machine - script' that must be specified for this purpose. Samba 3.0 will - not fall back to using the 'add user script' in the absence of - an 'add machine script' + When adding machines to a Samba-2.2 controlled domain, the + <quote>add user script</quote> was used to create the UNIX identity of the + Machine Trust Account. Samba-3 introduces a new <quote>add machine + script</quote> that must be specified for this purpose. Samba-3 will + not fall back to using the <quote>add user script</quote> in the absence of + an <quote>add machine script</quote>. </para></listitem> </orderedlist> @@ -371,8 +421,7 @@ complete descriptions of new or modified parameters. <para> You might experience problems with special characters when communicating with old DOS - clients. Codepage support has changed in samba 3.0. Read the chapter - <link linkend="unicode">Unicode support</link> for details. + clients. Codepage support has changed in Samba-3. Read <link linkend="unicode"/>, for details. </para> </sect2> @@ -382,52 +431,41 @@ complete descriptions of new or modified parameters. <para> There have been a few new changes that Samba administrators should be - aware of when moving to Samba 3.0. + aware of when moving to Samba-3. </para> <orderedlist> <listitem><para> Encrypted passwords have been enabled by default in order to - inter-operate better with out-of-the-box Windows client - installations. This does mean that either (a) a samba account - must be created for each user, or (b) 'encrypt passwords = no' - must be explicitly defined in smb.conf. + interoperate better with out-of-the-box Windows client + installations. This does mean that either (a) a Samba account + must be created for each user, or (b) <quote>encrypt passwords = no</quote> + must be explicitly defined in &smb.conf;. </para></listitem> <listitem><para> - Inclusion of new <smbconfoption><name>security</name><value>ads</value></smbconfoption> option for integration - with an Active Directory domain using the native Windows - Kerberos 5 and LDAP protocols. + Inclusion of new <smbconfoption><name>security</name><value>ads</value></smbconfoption> option for integration + with an Active Directory domain using the native Windows Kerberos 5 and LDAP protocols. </para></listitem> </orderedlist> <para> - Samba 3.0 also includes the possibility of setting up chains + Samba-3 also includes the possibility of setting up chains of authentication methods (<smbconfoption><name>auth methods</name></smbconfoption>) and account storage backends (<smbconfoption><name>passdb backend</name></smbconfoption>). Please refer to the &smb.conf; - man page and <link linkend="passdb">the chapter about account information databases</link> for details. While both parameters assume sane default + man page and <link linkend="passdb"/>, for details. While both parameters assume sane default values, it is likely that you will need to understand what the values actually mean in order to ensure Samba operates correctly. </para> <para> - Certain functions of the smbpasswd(8) tool have been split between the - new smbpasswd(8) utility, the net(8) tool, and the new pdbedit(8) - utility. See the respective man pages for details. - </para> - - </sect2> - - <sect2> - <title>Charsets</title> - - <para> - You might experience problems with special characters when communicating with old DOS - clients. Codepage support has changed in samba 3.0. Read the chapter - <link linkend="unicode">Unicode support</link> for details. +<indexterm><primary>pdbedit</primary></indexterm> + Certain functions of the <command>smbpasswd</command> tool have been split between the + new <command>smbpasswd</command> utility, the <command>net</command> tool and the new <command>pdbedit</command> + utility. See the respective man pages for details. </para> </sect2> @@ -436,7 +474,7 @@ complete descriptions of new or modified parameters. <title>LDAP</title> <para> - This section outlines the new features affecting Samba / LDAP integration. + This section outlines the new features effecting Samba/LDAP integration. </para> <sect3> @@ -444,14 +482,14 @@ complete descriptions of new or modified parameters. <para> A new object class (sambaSamAccount) has been introduced to replace - the old sambaAccount. This change aids us in the renaming of attributes - to prevent clashes with attributes from other vendors. There is a - conversion script (examples/LDAP/convertSambaAccount) to modify and LDIF + the old sambaAccount. This change aids us in the renaming of attributes + to prevent clashes with attributes from other vendors. There is a + conversion script (examples/LDAP/convertSambaAccount) to modify an LDIF file to the new schema. </para> <para> - Example: + Example: </para> <para><screen> &prompt;ldapsearch .... -b "ou=people,dc=..." > old.ldif @@ -459,17 +497,20 @@ complete descriptions of new or modified parameters. </screen></para> <para> - The <DOM SID> can be obtained by running 'net getlocalsid <DOMAINNAME> + The <DOM SID> can be obtained by running +<screen> +&prompt;<userinput>net getlocalsid <DOMAINNAME></userinput> +</screen> on the Samba PDC as root. </para> <para> The old sambaAccount schema may still be used by specifying the - "ldapsam_compat" passdb backend. However, the sambaAccount and + <parameter>ldapsam_compat</parameter> passdb backend. However, the sambaAccount and associated attributes have been moved to the historical section of the schema file and must be uncommented before use if needed. - The 2.2 object class declaration for a sambaAccount has not changed - in the 3.0 samba.schema file. + The Samba-2.2 object class declaration for a sambaAccount has not changed + in the Samba-3 samba.schema file. </para> <para> @@ -478,29 +519,29 @@ complete descriptions of new or modified parameters. <itemizedlist> <listitem><para> - sambaDomain - domain information used to allocate rids - for users and groups as necessary. The attributes are added - in 'ldap suffix' directory entry automatically if - an idmap uid/gid range has been set and the 'ldapsam' + sambaDomain &smbmdash; domain information used to allocate RIDs + for users and groups as necessary. The attributes are added + in <quote>ldap suffix</quote> directory entry automatically if + an idmap UID/GID range has been set and the <quote>ldapsam</quote> passdb backend has been selected. </para></listitem> <listitem><para> - sambaGroupMapping - an object representing the + sambaGroupMapping &smbmdash; an object representing the relationship between a posixGroup and a Windows - group/SID. These entries are stored in the 'ldap - group suffix' and managed by the 'net groupmap' command. + group/SID. These entries are stored in the <quote>ldap + group suffix</quote> and managed by the <quote>net groupmap</quote> command. </para></listitem> <listitem><para> - sambaUnixIdPool - created in the 'ldap idmap suffix' entry - automatically and contains the next available 'idmap uid' and - 'idmap gid' + sambaUNIXIdPool &smbmdash; created in the <quote>ldap idmap suffix</quote> entry + automatically and contains the next available <quote>idmap UID</quote> and + <quote>idmap GID</quote>. </para></listitem> <listitem><para> - sambaIdmapEntry - object storing a mapping between a - SID and a UNIX uid/gid. These objects are created by the + sambaIdmapEntry &smbmdash; object storing a mapping between a + SID and a UNIX UID/GID. These objects are created by the idmap_ldap module as needed. </para></listitem> </itemizedlist> @@ -512,55 +553,54 @@ complete descriptions of new or modified parameters. <para> The following new smb.conf parameters have been added to aid in directing - certain LDAP queries when 'passdb backend = ldapsam://...' has been + certain LDAP queries when <parameter>passdb backend = ldapsam://...</parameter> has been specified. </para> <itemizedlist> - <listitem><para>ldap suffix - used to search for user and computer accounts</para></listitem> - <listitem><para>ldap user suffix - used to store user accounts</para></listitem> - <listitem><para>ldap machine suffix - used to store machine trust accounts</para></listitem> - <listitem><para>ldap group suffix - location of posixGroup/sambaGroupMapping entries</para></listitem> - <listitem><para>ldap idmap suffix - location of sambaIdmapEntry objects</para></listitem> + <listitem><para>ldap suffix &smbmdash; used to search for user and computer accounts.</para></listitem> + <listitem><para>ldap user suffix &smbmdash; used to store user accounts.</para></listitem> + <listitem><para>ldap machine suffix &smbmdash; used to store Machine Trust Accounts.</para></listitem> + <listitem><para>ldap group suffix &smbmdash; location of posixGroup/sambaGroupMapping entries.</para></listitem> + <listitem><para>ldap idmap suffix &smbmdash; location of sambaIdmapEntry objects.</para></listitem> </itemizedlist> <para> - If an 'ldap suffix' is defined, it will be appended to all of the - remaining sub-suffix parameters. In this case, the order of the suffix - listings in smb.conf is important. Always place the 'ldap suffix' first + If an <parameter>ldap suffix</parameter> is defined, it will be appended to all of the + remaining sub-suffix parameters. In this case, the order of the suffix + listings in smb.conf is important. Always place the <parameter>ldap suffix</parameter> first in the list. </para> <para> - Due to a limitation in Samba's smb.conf parsing, you should not surround - the DN's with quotation marks. + Due to a limitation in Samba's &smb.conf; parsing, you should not surround + the DNs with quotation marks. </para> </sect3> <sect3> - <title>IdMap LDAP support</title> + <title>IdMap LDAP Support</title> <para> - Samba 3.0 supports an ldap backend for the idmap subsystem. The - following options would inform Samba that the idmap table should be - stored on the directory server onterose in the "ou=idmap,dc=plainjoe, - dc=org" partition. + Samba-3 supports an ldap backend for the idmap subsystem. The + following options inform Samba that the idmap table should be + stored on the directory server onterose in the "ou=idmap,dc=quenya,dc=org" partition. </para> <smbconfblock> <smbconfsection>[global]</smbconfsection> <member>...</member> <smbconfoption><name>idmap backend</name><value>ldap:ldap://onterose/</value></smbconfoption> - <smbconfoption><name>ldap idmap suffix</name><value>ou=idmap,dc=plainjoe,dc=org</value></smbconfoption> + <smbconfoption><name>ldap idmap suffix</name><value>ou=idmap,dc=quenya,dc=org</value></smbconfoption> <smbconfoption><name>idmap uid</name><value>40000-50000</value></smbconfoption> <smbconfoption><name>idmap gid</name><value>40000-50000</value></smbconfoption> </smbconfblock> <para> - This configuration allows winbind installations on multiple servers to - share a uid/gid number space, thus avoiding the interoperability problems - with NFS that were present in Samba 2.2. + This configuration allows Winbind installations on multiple servers to + share a UID/GID number space, thus avoiding the interoperability problems + with NFS that were present in Samba-2.2. </para> </sect3> diff --git a/docs/docbook/projdoc/winbind.xml b/docs/docbook/projdoc/winbind.xml index 001b2f16c1..d460694496 100644 --- a/docs/docbook/projdoc/winbind.xml +++ b/docs/docbook/projdoc/winbind.xml @@ -1,7 +1,6 @@ <chapter id="winbind"> <chapterinfo> - <authorgroup> <author> <firstname>Tim</firstname><surname>Potter</surname> <affiliation> @@ -20,14 +19,13 @@ <author> <firstname>John</firstname><surname>Trostel</surname> <affiliation> - <orgname>SNAP</orgname> <address><email>jtrostel@snapserver.com</email></address> + <orgname>SNAP</orgname> </affiliation> </author> &author.jelmer; &author.jht; - </authorgroup> <pubdate>27 June 2002</pubdate> </chapterinfo> @@ -38,7 +36,7 @@ <para> Integration of UNIX and Microsoft Windows NT through a unified logon has - been considered a "holy grail" in heterogeneous computing environments for + been considered a <quote>holy grail</quote> in heterogeneous computing environments for a long time. </para> @@ -50,11 +48,11 @@ </para> <para> - <emphasis>winbind</emphasis> is a component of the Samba suite of programs + <emphasis>winbind</emphasis> is a component of the Samba suite of programs that solves the unified logon problem. Winbind uses a UNIX implementation of Microsoft RPC calls, Pluggable Authentication Modules, and the Name Service Switch to allow Windows NT domain users to appear and operate as UNIX users on a UNIX - machine. This chapter describes the winbind system, explaining the functionality + machine. This chapter describes the Winbind system, explaining the functionality it provides, how it is configured, and how it works internally. </para> @@ -64,27 +62,27 @@ <itemizedlist> <listitem><para> - Authentication of user credentials (via PAM) + Authentication of user credentials (via PAM). </para></listitem> <listitem><para> - Identity resolution (via NSS)` + Identity resolution (via NSS). </para></listitem> <listitem><para> - Windindd maintains a database called winbind_idmap.tdb in which it stores + Winbind maintains a database called winbind_idmap.tdb in which it stores mappings between UNIX UIDs / GIDs and NT SIDs. This mapping is used only for users and groups that do not have a local UID/GID. It stored the UID/GID allocated from the idmap uid/gid range that it has mapped to the NT SID. If <parameter>idmap backend</parameter> has been specified as ldapsam:url - then instead of using a local mapping winbindd will obtain this information + then instead of using a local mapping Winbind will obtain this information from the LDAP database. </para></listitem> </itemizedlist> <note><para> - If winbindd is not running, then smbd (which calls winbindd) will fall back to - using purely local information from /etc/passwd and /etc/group and no dynamic + If <command>winbindd</command> is not running, smbd (which calls <command>winbindd</command>) will fall back to + using purely local information from <filename>/etc/passwd</filename> and <filename>/etc/group</filename> and no dynamic mapping will be used. </para></note> @@ -94,7 +92,7 @@ <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap_winbind_no_loop" scale="50" scalefit="1"/></imageobject> <imageobject><imagedata fileref="projdoc/imagefiles/idmap_winbind_no_loop.png" scale="50" scalefit="1"/></imageobject> </mediaobject> -</figure>--> + </figure>--> </sect1> @@ -111,9 +109,9 @@ <para>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 + 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 + and two sets of passwords are required &smbmdash; both of which can lead to synchronization problems between the UNIX and Windows systems and confusion for users.</para> @@ -121,13 +119,13 @@ three smaller problems:</para> <itemizedlist> - <listitem><para>Obtaining Windows NT user and group information + <listitem><para>Obtaining Windows NT user and group information. </para></listitem> - <listitem><para>Authenticating Windows NT users + <listitem><para>Authenticating Windows NT users. </para></listitem> - <listitem><para>Password changing for Windows NT users + <listitem><para>Password changing for Windows NT users. </para></listitem> </itemizedlist> @@ -136,7 +134,7 @@ 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 + groups on either system. The Winbind system provides a simple and elegant solution to all three components of the unified logon problem.</para> </sect1> @@ -146,53 +144,53 @@ <title>What Winbind Provides</title> <para>Winbind unifies UNIX and Windows NT account management by - allowing a UNIX box to become a full member of a NT domain. Once + allowing a UNIX box to become a full member of an NT domain. Once this is done the UNIX box will see NT users and groups as if - they were native UNIX users and groups, allowing the NT domain + they were <quote>native</quote> UNIX users and groups, allowing the NT domain to be used in much the same manner that NIS+ is used within UNIX-only environments.</para> <para>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. + 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 + (via the NSS name resolution modules in the C library), this + redirection to the NT Domain Controller is completely transparent.</para> <para>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 + names as they would <quote>native</quote> UNIX names. They can chown files + so they are owned by NT domain users or even login to the UNIX machine and run a UNIX X-Window session as a domain user.</para> <para>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 + that user and group names take the form <constant>DOMAIN\user</constant> and + <constant>DOMAIN\group</constant>. 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.</para> <para>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 + to provide authentication via an NT domain to any PAM-enabled applications. This capability solves the problem of synchronizing passwords between systems since all passwords are stored in a single - location (on the domain controller).</para> + location (on the Domain Controller).</para> <sect2> <title>Target Uses</title> <para>Winbind is targeted at organizations that have an - existing NT based domain infrastructure into which they wish + 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.</para> + workstations into an NT-based organization.</para> <para>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 + 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.</para> </sect2> @@ -203,13 +201,13 @@ <sect1> <title>How Winbind Works</title> - <para>The winbind system is designed around a client/server + <para>The Winbind system is designed around a client/server architecture. A long running <command>winbindd</command> 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.</para> + clients and is processed sequentially.</para> - <para>The technologies used to implement winbind are described + <para>The technologies used to implement Winbind are described in detail below.</para> <sect2> @@ -218,18 +216,18 @@ <para>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 + system is used for most network-related operations between Windows NT machines including remote management, user authentication and print spooling. Although initially this work was done to aid the implementation of Primary Domain Controller (PDC) - functionality in Samba, it has also yielded a body of code which + functionality in Samba, it has also yielded a body of code that can be used for other purposes.</para> <para>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 + a Windows PDC for user and group information, Winbind maps the NT account information onto UNIX user and group names.</para> </sect2> @@ -238,13 +236,12 @@ <para> 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. + interact with Microsoft Windows 2000 using its <quote>Native + Mode</quote> protocols, rather than the NT4 RPC services. + Using LDAP and Kerberos, a Domain Member running + Winbind can enumerate users and groups in exactly the + same way as a Windows 200x client would, and in so doing + provide a much more efficient and effective Winbind implementation. </para> </sect2> @@ -258,45 +255,45 @@ UNIX workstation may resolve system information from a series of flat files stored on the local filesystem. A networked workstation may first attempt to resolve system information from local files, - and then consult a NIS database for user information or a DNS server + and then consult an NIS database for user information or a DNS server for hostname information.</para> - <para>The NSS application programming interface allows winbind + <para>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, + resolving UNIX usernames and groups. Winbind uses this interface, and information obtained from a Windows NT server using MSRPC - calls to provide a new source of account enumeration. Using standard + calls to provide a new source of account enumeration. Using standard UNIX library calls, one can enumerate the users and groups on - a UNIX machine running winbind and see all users and groups in + a UNIX machine running Winbind and see all users and groups in a NT domain plus any trusted domain as though they were local users and groups.</para> <para>The primary control file for NSS is <filename>/etc/nsswitch.conf</filename>. - When a UNIX application makes a request to do a lookup + When a UNIX application makes a request to do a lookup, the C library looks in <filename>/etc/nsswitch.conf</filename> - for a line which matches the service type being requested, for - example the "passwd" service type is used when user or group names - are looked up. This config line specifies which implementations + for a line that matches the service type being requested, for + example the <quote>passwd</quote> service type is used when user or group names + are looked up. This config line specifies which implementations of that service should be tried and in what order. If the passwd config line is:</para> - <para><programlisting> -passwd: files example - </programlisting></para> + <para><screen> + passwd: files example + </screen></para> <para>then the C library will first load a module called <filename>/lib/libnss_files.so</filename> followed by the module <filename>/lib/libnss_example.so</filename>. 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 + the request. Once the request is resolved, the C library returns the result to the application.</para> - <para>This NSS interface provides a very easy way for Winbind + <para>This NSS interface provides an easy way for Winbind to hook into the operating system. All that needs to be done is to put <filename>libnss_winbind.so</filename> in <filename>/lib/</filename> - then add "winbind" into <filename>/etc/nsswitch.conf</filename> at + then add <quote>winbind</quote> into <filename>/etc/nsswitch.conf</filename> at the appropriate place. The C library will then call Winbind to resolve user and group names.</para> </sect2> @@ -325,33 +322,33 @@ passwd: files example <para>PAM is configured by providing control files in the directory <filename>/etc/pam.d/</filename> 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 + 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 + a new authentication service for Winbind very easy. All that needs to be done is that the <filename>pam_winbind.so</filename> module is copied to <filename>/lib/security/</filename> and the PAM control files for relevant services are updated to allow - authentication via winbind. See the PAM documentation - for more details.</para> + authentication via Winbind. See the PAM documentation + in <link linkend="pam"/> for more information.</para> </sect2> <sect2> <title>User and Group ID Allocation</title> - <para>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 + <para>When a user or group is created under Windows NT/200x + it is allocated a numerical relative identifier (RID). This is + slightly different from UNIX which has a range of numbers that are used to identify users, and the same range in which to identify - groups. It is winbind's job to convert RIDs to UNIX id numbers and - vice versa. When winbind is configured it is given part of the UNIX - user id space and a part of the UNIX group id space in which to + groups. It is Winbind's job to convert RIDs to UNIX ID numbers and + vice versa. When Winbind is configured, it is given part of the UNIX + user ID space and a part of the UNIX group ID space in which to store Windows NT users and groups. If a Windows NT user is - resolved for the first time, it is allocated the next UNIX id from + resolved for the first time, it is allocated the next UNIX ID from the range. The same process applies for Windows NT groups. Over - time, winbind will have mapped all Windows NT users and groups - to UNIX user ids and group ids.</para> + time, Winbind will have mapped all Windows NT users and groups + to UNIX user IDs and group IDs.</para> <para>The results of this mapping are stored persistently in an ID mapping database held in a tdb database). This ensures that @@ -362,17 +359,19 @@ passwd: files example <sect2> <title>Result Caching</title> - <para>An active system can generate a lot of user and group - name lookups. To reduce the network cost of these lookups winbind + <para> +<indexterm><primary>SAM</primary></indexterm> + 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 - by a PDC is cached by winbind along with a sequence number also + by NT Domain Controllers. User or group information returned + by a PDC is cached by Winbind along with a sequence number also returned by the PDC. This sequence number is incremented by Windows NT whenever any user or group information is modified. If a cached entry has expired, the sequence number is requested from the PDC and compared against the sequence number of the cached entry. If the sequence numbers do not match, then the cached information - is discarded and up to date information is requested directly + is discarded and up-to-date information is requested directly from the PDC.</para> </sect2> </sect1> @@ -385,23 +384,23 @@ passwd: files example <title>Introduction</title> <para> -This section describes the procedures used to get winbind up and -running. Winbind is capable of providing access +This section describes the procedures used to get Winbind up and +running. Winbind is capable of providing access and authentication control for Windows Domain users through an NT -or Win2K PDC for 'regular' services, such as telnet a nd ftp, as -well for SAMBA services. +or Windows 200x PDC for regular services, such as telnet and ftp, as +well for Samba services. </para> <itemizedlist> <listitem> <para> - <emphasis>Why should I to this?</emphasis> + <emphasis>Why should I do this?</emphasis> </para> - <para>This allows the SAMBA administrator to rely on the - authentication mechanisms on the NT/Win2K PDC for the authentication - of domain members. NT/Win2K users no longer need to have separate - accounts on the SAMBA server. + <para>This allows the Samba administrator to rely on the + authentication mechanisms on the Windows NT/200x PDC for the authentication + of Domain Members. Windows NT/200x users no longer need to have separate + accounts on the Samba server. </para> </listitem> @@ -411,12 +410,10 @@ well for SAMBA services. </para> <para> - This HOWTO is designed for system administrators. If you are - implementing SAMBA on a file server and wish to (fairly easily) - integrate existing NT/Win2K users from your PDC onto the - SAMBA server, this HOWTO is for you. That said, I am no NT or PAM - expert, so you may find a better or easier way to accomplish - these tasks. + This document is designed for system administrators. If you are + implementing Samba on a file server and wish to (fairly easily) + integrate existing Windows NT/200x users from your PDC onto the + Samba server, this document is for you. </para> </listitem> </itemizedlist> @@ -427,38 +424,29 @@ well for SAMBA services. <title>Requirements</title> <para> -If you have a Samba configuration file that you are currently -using... <emphasis>BACK IT UP!</emphasis> If your system already uses PAM, -<emphasis>back up the <filename>/etc/pam.d</filename> directory -contents!</emphasis> If you haven't already made a boot disk, -<emphasis>MAKE ONE NOW!</emphasis> +If you have a Samba configuration file that you are currently using, <emphasis>BACK IT UP!</emphasis> +If your system already uses PAM, <emphasis>back up the <filename>/etc/pam.d</filename> directory +contents!</emphasis> If you haven't already made a boot disk, <emphasis>MAKE ONE NOW!</emphasis> </para> <para> -Messing with the PAM configuration files can make it nearly impossible -to log in to your machine. That's why you want to be able to boot back -into your machine in single user mode and restore your -<filename>/etc/pam.d</filename> back to the original state they were in if -you get frustrated with the way things are going. ;-) +Messing with the PAM configuration files can make it nearly impossible to log in to your machine. That's +why you want to be able to boot back into your machine in single user mode and restore your +<filename>/etc/pam.d</filename> back to the original state they were in if you get frustrated with the +way things are going. </para> <para> -The latest version of SAMBA (version 3.0 as of this writing), now -includes a functioning winbindd daemon. Please refer to the -<ulink url="http://samba.org/">main SAMBA web page</ulink> or, -better yet, your closest SAMBA mirror site for instructions on -downloading the source code. +The latest version of Samba-3 includes a functioning winbindd daemon. Please refer to the <ulink +url="http://samba.org/">main Samba Web page</ulink> or, better yet, your closest Samba mirror site for +instructions on downloading the source code. </para> <para> -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 <filename>pam-0.74-22</filename>. For best results, it is helpful to also -install the development packages in <filename>pam-devel-0.74-22</filename>. +To allow domain users the ability to access Samba shares and files, as well as potentially other services +provided by your Samba machine, PAM must be set up properly on your +machine. In order to compile the Winbind modules, you should have at least the PAM development libraries installed +on your system. Please refer the PAM web site <ulink url="http://www.kernel.org/pub/linux/libs/pam/"/>. </para> </sect2> @@ -466,25 +454,29 @@ install the development packages in <filename>pam-devel-0.74-22</filename>. <title>Testing Things Out</title> <para> -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 which supplies the <filename>/etc/pam.d</filename> -directory structure, including the pam modules are used by pam-aware -services, several pam libraries, and the <filename>/usr/doc</filename> -and <filename>/usr/man</filename> 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. +Before starting, it is probably best to kill off all the Samba-related daemons running on your server. +Kill off all &smbd;, &nmbd;, and &winbindd; processes that may be running. To use PAM, +make sure that you have the standard PAM package that supplies the <filename>/etc/pam.d</filename> +directory structure, including the PAM modules that are used by PAM-aware services, several pam libraries, +and the <filename>/usr/doc</filename> and <filename>/usr/man</filename> entries for pam. Winbind built +better in Samba if the pam-devel package is also installed. This package includes the header files +needed to compile PAM-aware applications. </para> <sect3> -<title>Configure <filename>nsswitch.conf</filename> and the -winbind libraries on Linux and Solaris</title> +<title>Configure <filename>nsswitch.conf</filename> and the Winbind Libraries on Linux and Solaris</title> + +<para> +PAM is a standard component of most current generation UNIX/Linux systems. Unfortunately, few systems install +the <filename>pam-devel</filename> libraries that are needed to build PAM-enabled Samba. Additionally, Samba-3 +may auto-install the Winbind files into their correct locations on your system, so before you get too far down +the track be sure to check if the following configuration is really +necessary. You may only need to configure +<filename>/etc/nsswitch.conf</filename>. +</para> <para> -The libraries needed to run the &winbindd; daemon -through nsswitch need to be copied to their proper locations, so +The libraries needed to run the &winbindd; daemon through nsswitch need to be copied to their proper locations: </para> <para> @@ -511,7 +503,7 @@ I also found it necessary to make the following symbolic link: <para> Now, as root you need to edit <filename>/etc/nsswitch.conf</filename> to allow user and group entries to be visible from the &winbindd; -daemon. My <filename>/etc/nsswitch.conf</filename> file look like +daemon. My <filename>/etc/nsswitch.conf</filename> file look like this after editing: </para> @@ -522,10 +514,9 @@ this after editing: </programlisting></para> <para> -The libraries needed by the winbind daemon will be automatically +The libraries needed by the <command>winbindd</command> daemon will be automatically entered into the <command>ldconfig</command> cache the next time -your system reboots, but it -is faster (and you don't need to reboot) if you do it manually: +your system reboots, but it is faster (and you do not need to reboot) if you do it manually: </para> <para> @@ -542,13 +533,12 @@ and echos back a check to you. <sect3> <title>NSS Winbind on AIX</title> -<para>(This section is only for those running AIX)</para> +<para>(This section is only for those running AIX.)</para> <para> -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: +The Winbind AIX identification module gets built as <filename>libnss_winbind.so</filename> in the +nsswitch directory of the Samba source. This file can be copied to <filename>/usr/lib/security</filename>, +and the AIX naming convention would indicate that it should be named WINBIND. A stanza like the following: </para> <para><programlisting> @@ -557,19 +547,19 @@ WINBIND: options = authonly </programlisting></para> -<para>can then be added to -<filename>/usr/lib/security/methods.cfg</filename>. 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": <ulink +<para> +can then be added to <filename>/usr/lib/security/methods.cfg</filename>. 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 since you can make +it impossible to logon to the system. More information about the AIX authentication module API can +be found at <quote>Kernel Extensions and Device Support Programming Concepts for AIX</quote><ulink url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixprggd/kernextc/sec_load_mod.htm"> -Chapter 18. Loadable Authentication Module Programming Interface</ulink> -and more information on administering the modules at <ulink -url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixbman/baseadmn/iandaadmin.htm"> -"System Management Guide: Operating System and Devices"</ulink>. +in Chapter 18(John, there is no section like this in 18). Loadable Authentication Module Programming +Interface</ulink> and more information on administering the modules +can be found at <ulink +url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixbman/baseadmn/iandaadmin.htm"> <quote>System +Management Guide: Operating System and Devices.</quote></ulink> </para> </sect3> @@ -577,19 +567,16 @@ url="http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixbman/baseadmn/ia <title>Configure smb.conf</title> <para> -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 <citerefentry><refentrytitle>winbindd</refentrytitle> -<manvolnum>8</manvolnum></citerefentry> man page. My -&smb.conf; file was modified to -include the following entries in the [global] section: +Several parameters are needed in the &smb.conf; file to control the behavior of &winbindd;. These +are described in more detail in the <citerefentry><refentrytitle>winbindd</refentrytitle> +<manvolnum>8</manvolnum></citerefentry> man page. My &smb.conf; file, as shown in <link +linkend="winbindcfg"/>, was modified to include the necessary entries in the [global] section. </para> -<para><smbconfexample> - <title>smb.conf for winbind set-up</title> +<para><smbconfexample id="winbindcfg"> + <title>smb.conf for Winbind set-up</title> <smbconfsection>[global]</smbconfsection> -<member>...</member> + <...> <smbconfcomment> separate domain and username with '+', like DOMAIN+username</smbconfcomment> <smbconfoption><name>winbind separator</name><value>+</value></smbconfoption> <smbconfcomment> use uids from 10000 to 20000 for domain users</smbconfcomment> @@ -608,10 +595,10 @@ include the following entries in the [global] section: <sect3> -<title>Join the SAMBA server to the PDC domain</title> +<title>Join the Samba Server to the PDC Domain</title> <para> -Enter the following command to make the SAMBA server join the +Enter the following command to make the Samba server join the PDC domain, where <replaceable>DOMAIN</replaceable> is the name of your Windows domain and <replaceable>Administrator</replaceable> is a domain user who has administrative privileges in the domain. @@ -624,22 +611,21 @@ a domain user who has administrative privileges in the domain. <para> -The proper response to the command should be: "Joined the domain -<replaceable>DOMAIN</replaceable>" where <replaceable>DOMAIN</replaceable> +The proper response to the command should be: <quote>Joined the domain +<replaceable>DOMAIN</replaceable></quote> where <replaceable>DOMAIN</replaceable> is your DOMAIN name. </para> </sect3> - <sect3> -<title>Start up the winbindd daemon and test it!</title> +<title>Starting and Testing the <command>winbindd</command> Daemon</title> <para> -Eventually, you will want to modify your smb startup script to +Eventually, you will want to modify your Samba startup script to automatically invoke the winbindd daemon when the other parts of -SAMBA start, but it is possible to test out just the winbind -portion first. To start up winbind services, enter the following +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: </para> @@ -647,12 +633,18 @@ command as root: &rootprompt;<userinput>/usr/local/samba/bin/winbindd</userinput> </para> +<note><para> +The above assumes that Samba has been installed in the <filename>/usr/local/samba</filename> +directory tree. You may need to search for the location of Samba files if this is not the +location of <command>winbindd</command> on your system. +</para></note> + <para> -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, +Winbindd can now also run in <quote>dual daemon modei</quote>. This will make it +run as two 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. +The advantage of this is that responses stay accurate and are faster. You can enable dual daemon mode by adding <option>-B</option> to the commandline: </para> @@ -661,23 +653,22 @@ You can enable dual daemon mode by adding <option>-B</option> to the commandline </para> <para> -I'm always paranoid and like to make sure the daemon -is really running... +I'm always paranoid and like to make sure the daemon is really running. </para> <para> &rootprompt;<userinput>ps -ae | grep winbindd</userinput> </para> <para> -This command should produce output like this, if the daemon is running +This command should produce output like this, if the daemon is running you would expect +to see a report something like this: </para> <screen> 3025 ? 00:00:00 winbindd </screen> <para> -Now... for the real test, try to get some information about the -users on your PDC +Now, for the real test, try to get some information about the users on your PDC: </para> <para> @@ -686,7 +677,7 @@ users on your PDC <para> This should echo back a list of users on your Windows users on -your PDC. For example, I get the following response: +your PDC. For example, I get the following response: </para> <para><screen> @@ -699,12 +690,11 @@ your PDC. For example, I get the following response: </screen></para> <para> - Obviously, I have named my domain 'CEO' and my <smbconfoption><name>winbind separator</name></smbconfoption> is '+'. +Obviously, I have named my domain <quote>CEO</quote> and my <smbconfoption><name>winbind separator</name></smbconfoption> is <quote>+</quote>. </para> <para> -You can do the same sort of thing to get group information from -the PDC: +You can do the same sort of thing to get group information from the PDC: </para> <para><screen> @@ -721,9 +711,8 @@ the PDC: </screen></para> <para> -The function 'getent' can now be used to get unified -lists of both local and PDC users and groups. -Try the following command: +The function <command>getent</command> can now be used to get unified +lists of both local and PDC users and groups. Try the following command: </para> <para> @@ -732,12 +721,12 @@ Try the following command: <para> You should get a list that looks like your <filename>/etc/passwd</filename> -list followed by the domain users with their new uids, gids, home +list followed by the domain users with their new UIDs, GIDs, home directories and default shells. </para> <para> -The same thing can be done for groups with the command +The same thing can be done for groups with the command: </para> <para> @@ -748,20 +737,19 @@ The same thing can be done for groups with the command <sect3> -<title>Fix the init.d startup scripts</title> +<title>Fix the init.d Startup Scripts</title> <sect4> <title>Linux</title> <para> -The &winbindd; daemon needs to start up after the -&smbd; and &nmbd; daemons are running. +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 <filename>/etc/init.d/smb</filename> in RedHat and -<filename>/etc/init.d/samba</filename> in Debian. -script to add commands to invoke this daemon in the proper sequence. My +They are located at <filename>/etc/init.d/smb</filename> in Red Hat Linux and they are located in +<filename>/etc/init.d/samba</filename> in Debian Linux. Edit your +script to add commands to invoke this daemon in the proper sequence. My startup script starts up &smbd;, &nmbd;, and &winbindd; from the -<filename>/usr/local/samba/bin</filename> directory directly. The 'start' +<filename>/usr/local/samba/bin</filename> directory directly. The <command>start</command> function in the script looks like this: </para> @@ -789,7 +777,7 @@ start() { </programlisting></para> <para>If you would like to run winbindd in dual daemon mode, replace -the line +the line : <programlisting> daemon /usr/local/samba/bin/winbindd </programlisting> @@ -802,7 +790,7 @@ in the example above with: </para> <para> -The 'stop' function has a corresponding entry to shut down the +The <command>stop</command> function has a corresponding entry to shut down the services and looks like this: </para> @@ -833,13 +821,14 @@ stop() { <sect4> <title>Solaris</title> -<para>Winbind doesn't work on Solaris 9, see the <link linkend="winbind-solaris9">Portability</link> chapter for details.</para> +<para> +Winbind does not work on Solaris 9, see <link linkend="winbind-solaris9"/> for details. +</para> -<para>On Solaris, you need to modify the -<filename>/etc/init.d/samba.server</filename> startup script. It usually -only starts smbd and nmbd but should now start winbindd too. If you -have samba installed in <filename>/usr/local/samba/bin</filename>, -the file could contains something like this: +<para> +On Solaris, you need to modify the <filename>/etc/init.d/samba.server</filename> startup script. It +usually only starts smbd and nmbd but should now start winbindd, too. If you have Samba installed in +<filename>/usr/local/samba/bin</filename>, the file could contains something like this: </para> <para><programlisting> @@ -859,7 +848,7 @@ the file could contains something like this: [ "$pid" != "" ] && kill $pid } - # Start/stop processes required for samba server + # Start/stop processes required for Samba server case "$1" in @@ -892,13 +881,11 @@ the file could contains something like this: </programlisting></para> <para> -Again, if you would like to run samba in dual daemon mode, replace +Again, if you would like to run Samba in dual daemon mode, replace: <programlisting> /usr/local/samba/bin/winbindd </programlisting> - in the script above with: - <programlisting> /usr/local/samba/bin/winbindd -B </programlisting> @@ -910,7 +897,7 @@ in the script above with: <title>Restarting</title> <para> 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 +should be able to connect to the Samba server as a Domain Member just as if you were a local user. </para> </sect4> @@ -920,17 +907,17 @@ if you were a local user. <title>Configure Winbind and PAM</title> <para> -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 +If you have made it this far, you know that <command>winbindd</command> 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 <filename>/etc/pam.d</filename> files? If not, do it now.) </para> <para> -You will need a pam module to use winbindd with these other services. This +You will need a PAM module to use winbindd with these other services. This module will be compiled in the <filename>../source/nsswitch</filename> directory -by invoking the command +by invoking the command: </para> <para> @@ -938,10 +925,10 @@ by invoking the command </para> <para> -from the <filename>../source</filename> directory. The +from the <filename>../source</filename> directory. The <filename>pam_winbind.so</filename> file should be copied to the location of -your other pam security modules. On my RedHat system, this was the -<filename>/lib/security</filename> directory. On Solaris, the pam security +your other PAM security modules. On my RedHat system, this was the +<filename>/lib/security</filename> directory. On Solaris, the PAM security modules reside in <filename>/usr/lib/security</filename>. </para> @@ -964,25 +951,21 @@ just left this file as it was: </programlisting></para> <para> -The other services that I modified to allow the use of winbind +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 +session), telnet logins, and ftp service. In order to enable these services, you may first need to change the entries in -<filename>/etc/xinetd.d</filename> (or <filename>/etc/inetd.conf</filename>). -RedHat 7.1 uses the new xinetd.d structure, in this case you need +<filename>/etc/xinetd.d</filename> (or <filename>/etc/inetd.conf</filename>). +Red Hat Linux 7.1 and later uses the new xinetd.d structure, in this case you need to change the lines in <filename>/etc/xinetd.d/telnet</filename> and <filename>/etc/xinetd.d/wu-ftp</filename> from </para> <para><programlisting> enable = no -</programlisting></para> - -<para> -to -</para> - -<para><programlisting> +</programlisting> +to: +<programlisting> enable = yes </programlisting></para> @@ -990,51 +973,51 @@ to 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 +directory for all domain users. These can be easily set using the &smb.conf; global entry <smbconfoption><name>template homedir</name></smbconfoption>. </para> <para> The <filename>/etc/pam.d/ftp</filename> file can be changed -to allow winbind ftp access in a manner similar to the -samba file. My <filename>/etc/pam.d/ftp</filename> file was +to allow Winbind ftp access in a manner similar to the +samba file. My <filename>/etc/pam.d/ftp</filename> file was changed to look like this: </para> <para><programlisting> - 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 +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 </programlisting></para> <para> The <filename>/etc/pam.d/login</filename> file can be changed nearly the -same way. It now looks like this: +same way. It now looks like this: </para> <para><programlisting> - 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 +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 </programlisting></para> <para> In this case, I added the <programlisting>auth sufficient /lib/security/pam_winbind.so</programlisting> lines as before, but also added the <programlisting>required pam_securetty.so</programlisting> -above it, to disallow root logins over the network. I also added a +above it, to disallow root logins over the network. I also added a <programlisting>sufficient /lib/security/pam_unix.so use_first_pass</programlisting> line after the <command>winbind.so</command> line to get rid of annoying double prompts for passwords. @@ -1046,78 +1029,78 @@ double prompts for passwords. <title>Solaris-specific configuration</title> <para> -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 +The <filename>/etc/pam.conf</filename> needs to be changed. I changed this file so my Domain +users can logon both locally as well as telnet. The following are the changes +that I made. You can customize the <filename>pam.conf</filename> 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. </para> <para><programlisting> - # - #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 +# +#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 </programlisting></para> <para> -I also added a try_first_pass line after the winbind.so line to get rid of -annoying double prompts for passwords. +I also added a <parameter>try_first_pass</parameter> line after the <filename>winbind.so</filename> +line to get rid of annoying double prompts for passwords. </para> <para> @@ -1136,12 +1119,12 @@ configured in the pam.conf. <sect1> <title>Conclusion</title> - <para>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.</para> +<para>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.</para> </sect1> @@ -1154,23 +1137,23 @@ configured in the pam.conf. <itemizedlist> <listitem><para>Winbind is currently only available for - the Linux, Solaris, AIX and IRIX operating systems, although ports to other operating + the Linux, Solaris, AIX, and IRIX operating systems, although ports to other operating systems are certainly possible. For such ports to be feasible, we require the C library of the target operating system to support the Name Service Switch and Pluggable Authentication Modules systems. This is becoming more common as NSS and PAM gain support among UNIX vendors.</para></listitem> - <listitem><para>The mappings of Windows NT RIDs to UNIX ids + <listitem><para>The mappings of Windows NT RIDs to UNIX IDs is not made algorithmically and depends on the order in which - unmapped users or groups are seen by winbind. It may be difficult - to recover the mappings of rid to UNIX id mapping if the file + unmapped users or groups are seen by Winbind. It may be difficult + to recover the mappings of RID to UNIX ID mapping if the file containing this information is corrupted or destroyed.</para> </listitem> - <listitem><para>Currently the winbind PAM module does not take + <listitem><para>Currently the Winbind PAM module does not take into account possible workstation and logon time restrictions - that may be been set for Windows NT users, this is + that may be set for Windows NT users, this is instead up to the PDC to enforce.</para></listitem> </itemizedlist> @@ -1179,19 +1162,67 @@ configured in the pam.conf. <?latex \nopagebreak ?> - <note><para> - Do NOT under ANY circumstances run <command>nscd</command> on any system - on which <command>winbind</command> is running. - </para></note> + <warning><para> + Do not under any circumstances run <command>nscd</command> on any system + on which <command>winbindd</command> is running. + </para></warning> <para> If <command>nscd</command> is running on the UNIX/Linux system, then - even though NSSWITCH is correctly configured it will NOT be possible to resolve + even though NSSWITCH is correctly configured it will not be possible to resolve domain users and groups for file and directory controls. </para> </sect2> + + <sect2> + <title>Winbind Is Not Resolving Users and Groups</title> + + <para><quote> + My &smb.conf; file is correctly configured. I have specified + <smbconfoption><name>idmap uid</name><value>12000</value></smbconfoption>, + and <smbconfoption><name>idmap gid</name><value>3000-3500</value></smbconfoption> + and <command>winbind</command> is running. When I do the following it all works fine. + </quote></para> + +<para><screen> +&rootprompt;<userinput>wbinfo -u</userinput> +MIDEARTH+maryo +MIDEARTH+jackb +MIDEARTH+ameds +... +MIDEARTH+root + +&rootprompt;<userinput>wbinfo -g</userinput> +MIDEARTH+Domain Users +MIDEARTH+Domain Admins +MIDEARTH+Domain Guests +... +MIDEARTH+Accounts + +&rootprompt;<userinput>getent passwd</userinput> +root:x:0:0:root:/root:/bin/bash +bin:x:1:1:bin:/bin:/bin/bash +... +maryo:x:15000:15003:Mary Orville:/home/MIDEARTH/maryo:/bin/false +</screen></para> + +<para><quote> +But the following command just fails: +<screen> +&rootprompt;<userinput>chown maryo a_file</userinput> +chown: `maryo': invalid user +</screen> +This is driving me nuts! What can be wrong? +</quote></para> + +<para> +Same problem as the one above. +Your system is likely running <command>nscd</command>, the name service +caching daemon. Shut it down, do not restart it! You will find your problem resolved. +</para> + +</sect2> </sect1> </chapter> - |