doc/DEVELOPER

   1 Information for Netatalk 2.0.4 Developers
   2 =========================================
   3
   4 For basic installation instructions, see the INSTALL file.
   5
   6 Netatalk is an implementation of the AppleTalk Protocol Suite and
   7 the Apple Filing Protocol (AFP).  The current release contains support
   8 for EtherTalk Phase I and II, DDP, RTMP, NBP, ZIP, AEP, ATP, PAP, ASP
   9  and AFP.  The complete stack looks like this on a BSD-derived system:
  10
  11     AFP                          AFP
  12      |                            |
  13     ASP    PAP                   DSI
  14       \   /                       |
  15        ATP RTMP NBP ZIP AEP       |
  16         |    |   |   |   |        |
  17    -+---------------------------------------------------+- (kernel boundary)
  18     |                    Socket                         |
  19     +-----------------------+------------+--------------+
  20     |                       |     TCP    |    UDP       |
  21     |          DDP          +------------+--------------+
  22     |                       |           IP              |
  23     +-----------------------+---------------------------+
  24     |                Network-Interface                  |
  25     +---------------------------------------------------+
  26
  27 DDP is in the kernel.  "atalkd" implements RTMP, NBP, ZIP, and AEP.  It
  28 is the AppleTalk equivalent of Unix "routed".  There is also a
  29 client-stub library for NBP.  ATP and ASP are implemented as
  30 libraries.  "papd" allows Macs to spool to "lpd", and "pap" allows Unix
  31 machines to print to AppleTalk connected printers.  "psf" is a
  32 PostScript printer filter for "lpd", designed to use "pap".  "psorder"
  33 is a PostScript reverser, called by "psf" to reverse pages printed to
  34 face-up stacking printers.  "afpd" provides Macs with an interface to
  35 the Unix file system.  Refer to the appropriate man pages for
  36 operational information.
  37
  38
  39 Compilation
  40 ===========
  41    The `configure' shell script attempts to guess correct values for
  42 various system-dependent variables used during compilation.  It uses
  43 those values to create a `Makefile' in each directory of the package.
  44 It may also create one or more `.h' files containing system-dependent
  45 definitions.  Finally, it creates a shell script `config.status' that
  46 you can run in the future to recreate the current configuration, a file
  47 `config.cache' that saves the results of its tests to speed up
  48 reconfiguring, and a file `config.log' containing compiler output
  49 (useful mainly for debugging `configure').
  50
  51    If you need to do unusual things to compile the package, please try
  52 to figure out how `configure' could check whether to do them, and mail
  53 diffs or instructions to the address given in the `README' so they can
  54 be considered for the next release.  If at some point `config.cache'
  55 contains results you don't want to keep, you may remove or edit it.
  56
  57    The file `configure.in' is used to create `configure' by a program
  58 called `autoconf'.  You only need `configure.in' if you want to change
  59 it or regenerate `configure' using a newer version of `autoconf'.
  60
  61
  62 Tools for Developers
  63 ====================
  64 1. Libtool
  65 Libtool encapsulates the platform specific dependencies for the
  66 creation of libraries. It determines if the local platform can support
  67 shared libraries or if it only supports static libraries.
  68
  69 Netatalk currently requires libtool 1.4 or higher (1.4b for OpenBSD).
  70 If you are using Tru64 you must apply the following patch to the file
  71 acinclude.m4 (normally found in /usr/share/libtool/libltdl).
  72
  73 --- acinclude.m4.old    Tue Nov 20 15:30:23 2001
  74 +++ acinclude.m4        Tue Nov 20 15:31:54 2001
  75 @@ -2226,6 +2226,7 @@
  76
  77  osf3* | osf4* | osf5*)
  78    version_type=osf
  79 +  need_lib_prefix=no
  80    need_version=no
  81    soname_spec='${libname}${release}.so'
  82    library_names_spec='${libname}${release}.so$versuffix ${libname}${release}.so $libname.so'
  83
  84 Documentation: http://www.gnu.org/software/libtool/
  85 Program: (see the GNU mirrors) /gnu/libtool/libtool-1.4.tar.gz
  86
  87 2. GNU m4
  88 GNU m4 is an implementation of the Unix macro processor. It reads
  89 stdin and copies to stdout expanding defined macros as it processes
  90 the text.
  91
  92 Documentation: http://www.gnu.org/software/m4/
  93 Program: (see the GNU mirrors) /gnu/m4/m4-1.4.tar.gz
  94
  95 3. Autoconf
  96 Autoconf is a package of m4 macros that produce shell scripts to
  97 configure source code packages.
  98
  99 Documentation: http://www.gnu.org/software/autoconf/
 100 Program: (see the GNU mirrors) /gnu/autoconf/autoconf-2.52.tar.gz
 101
 102 4. Automake
 103 Automake is a tool that generates  'Makefile.in' files.
 104
 105 Documentation: http://www.gnu.org/software/automake/
 106 Program: (see the GNU mirrors) /gnu/automake/automake-1.5.tar.gz
 107
 108 Optional
 109 ========
 110 5. OpenSSL and/or Libgcrypt
 111 The OpenSSL Project is a collaborative effort to develop a robust,
 112 commercial-grade, full-featured, and Open Source toolkit implementing
 113 the Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS
 114 v1) protocols as well as a full-strength general purpose cryptography
 115 library.
 116 This is required to enable DHX login support.
 117
 118 Get everything at http://www.openssl.org/
 119
 120 The Libgcrypt is a general purpose cryptographic library based on
 121 the code from GnuPG.
 122 This is required to enable DHX2 login support.
 123
 124 Get everything at http://directory.fsf.org/project/libgcrypt/
 125
 126 6. TCP Wrappers
 127 Wietse Venema's network logger, also known as TCPD or LOG_TCP. These
 128 programs log the client host name of incoming telnet, ftp, rsh,
 129 rlogin, finger etc. requests. Security options are: access control per
 130 host, domain and/or service; detection of host name spoofing or host
 131 address spoofing; booby traps to implement an early-warning system.
 132 TCP Wrappers can be gotten at ftp://ftp.porcupine.org/pub/security/
 133 Netatalk uses TCP Wrappers to authorize host access when using
 134 afpovertcp. It should be noted that if DDP is in use, the connection
 135 will still be allowed as TCP Wrappers do not impact DDP connections.
 136
 137 7. PAM (Pluggable Authentication Modules)
 138 PAM provides a flexible mechanism for authenticating
 139 users. PAM was invented by SUN Microsystems.
 140
 141 Author: Andrew Morgan <morgan@linux.kernel.org>
 142
 143 Linux-PAM is a suite of shared libraries that enable the local system
 144 administrator to choose how applications authenticate users.
 145
 146 You can get the Linux PAM documentation and sources from
 147 http://www.kernel.org/pub/linux/libs/pam/
 148
 149 Netatalk also supports other standard PAM implementations such as OpenPAM.
 150
 151 8 Berkeley DB
 152 Berkeley DB is a programmatic toolkit that provides fast, reliable,
 153 scalable, and mission-critical database support to software
 154 developers. BDB can downloaded from
 155 http://www.oracle.com/database/berkeley-db/index.html
 156 Netatalk's CNID database uses the library and header files from BDB.
 157 Currently, Netatalk supports BDB 4.1.25 and later.