]> arthur.barton.de Git - netatalk.git/blobdiff - doc/DEVELOPER
small clean up, use of_ad when we can
[netatalk.git] / doc / DEVELOPER
index 60a5ec7e28206618710f84c3b7afcb8c0cde876a..39eecd248a42ba5fea316b2ec44eb1b2c1168622 100644 (file)
@@ -1,20 +1,20 @@
-Information for Netatalk 1.5 Developers
-=======================================
+Information for Netatalk Developers
+===================================
 
 For basic installation instructions, see the INSTALL file.
 
-
-netatalk is an implementation of the AppleTalk Protocol Suite.  The
-current release contains support for EtherTalk Phase I and II, DDP,
-RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, and AFP.  The complete stack looks
-like this on a BSD-derived system:
-
-    AFP
-     |
-    ASP    PAP
-      \   /
-       ATP RTMP NBP ZIP AEP
-       |    |   |   |   |
+Netatalk is an implementation of "AFP over TCP".
+Netatalk also support the AppleTalk Protocol Suite for legacy Macs.
+The current release contains support for EtherTalk Phase I and II, 
+DDP, RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, AFP and DSI.
+The complete stack looks like this on a BSD-derived system:
+
+    AFP                          AFP
+     |                            |
+    ASP    PAP                   DSI
+      \   /                       |
+       ATP RTMP NBP ZIP AEP       |
+        |    |   |   |   |        |
    -+---------------------------------------------------+- (kernel boundary)
     |                    Socket                         |
     +-----------------------+------------+--------------+
@@ -25,6 +25,7 @@ like this on a BSD-derived system:
     |                Network-Interface                  |
     +---------------------------------------------------+
 
+DSI is a session layer used to carry AFP over TCP.
 DDP is in the kernel.  "atalkd" implements RTMP, NBP, ZIP, and AEP.  It
 is the AppleTalk equivalent of Unix "routed".  There is also a
 client-stub library for NBP.  ATP and ASP are implemented as
@@ -67,8 +68,23 @@ Libtool encapsulates the platform specific dependencies for the
 creation of libraries. It determines if the local platform can support
 shared libraries or if it only supports static libraries.
 
+Netatalk currently requires libtool 1.4 or higher (1.4b for OpenBSD).
+If you are using Tru64 you must apply the following patch to the file
+acinclude.m4 (normally found in /usr/share/libtool/libltdl).
+
+--- acinclude.m4.old   Tue Nov 20 15:30:23 2001
++++ acinclude.m4       Tue Nov 20 15:31:54 2001
+@@ -2226,6 +2226,7 @@
+ osf3* | osf4* | osf5*)
+   version_type=osf
++  need_lib_prefix=no
+   need_version=no
+   soname_spec='${libname}${release}.so'
+   library_names_spec='${libname}${release}.so$versuffix ${libname}${release}.so $libname.so'
+
 Documentation: http://www.gnu.org/software/libtool/
-Program: (see the GNU mirrors) /gnu/libtool/libtool-1.3.5.tar.gz
+Program: (see the GNU mirrors) /gnu/libtool/libtool-1.4.tar.gz
 
 2. GNU m4
 GNU m4 is an implementation of the Unix macro processor. It reads
@@ -83,17 +99,17 @@ Autoconf is a package of m4 macros that produce shell scripts to
 configure source code packages.
 
 Documentation: http://www.gnu.org/software/autoconf/
-Program: (see the GNU mirrors) /gnu/autoconf/autoconf-2.13.tar.gz
+Program: (see the GNU mirrors) /gnu/autoconf/autoconf-2.52.tar.gz
 
 4. Automake
 Automake is a tool that generates  'Makefile.in' files.
 
 Documentation: http://www.gnu.org/software/automake/
-Program: (see the GNU mirrors) /gnu/automake/automake-1.4.tar.gz
+Program: (see the GNU mirrors) /gnu/automake/automake-1.5.tar.gz
 
 Optional
 ========
-5. OpenSSL
+5. OpenSSL and/or Libgcrypt
 The OpenSSL Project is a collaborative effort to develop a robust,
 commercial-grade, full-featured, and Open Source toolkit implementing
 the Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS
@@ -103,17 +119,25 @@ This is required to enable DHX login support.
 
 Get everything at http://www.openssl.org/ 
 
+The Libgcrypt is a general purpose cryptographic library based on
+the code from GnuPG.
+This is required to enable DHX2 login support.
+
+Get everything at http://directory.fsf.org/project/libgcrypt/
+
 6. TCP Wrappers 
 Wietse Venema's network logger, also known as TCPD or LOG_TCP. These
 programs log the client host name of incoming telnet, ftp, rsh,
 rlogin, finger etc. requests. Security options are: access control per
 host, domain and/or service; detection of host name spoofing or host
 address spoofing; booby traps to implement an early-warning system.
-
 TCP Wrappers can be gotten at ftp://ftp.porcupine.org/pub/security/
+Netatalk uses TCP Wrappers to authorize host access when using
+afpovertcp. It should be noted that if DDP is in use, the connection
+will still be allowed as TCP Wrappers do not impact DDP connections.
 
-7. PAM (Pluggable Authentication Modules for Linux
-Linux-PAM provides a flexible mechanism for authenticating
+7. PAM (Pluggable Authentication Modules) 
+PAM provides a flexible mechanism for authenticating
 users. PAM was invented by SUN Microsystems.
 
 Author: Andrew Morgan <morgan@linux.kernel.org>
@@ -123,3 +147,13 @@ administrator to choose how applications authenticate users.
 
 You can get the Linux PAM documentation and sources from
 http://www.kernel.org/pub/linux/libs/pam/
+
+Netatalk also supports other standard PAM implementations such as OpenPAM.
+
+8 Berkeley DB
+Berkeley DB is a programmatic toolkit that provides fast, reliable,
+scalable, and mission-critical database support to software
+developers. BDB can downloaded from
+http://www.oracle.com/database/berkeley-db/index.html
+Netatalk's CNID database uses the library and header files from BDB.
+Currently, Netatalk supports BDB 4.6 and later.