1 Information for Netatalk Developers
2 ===================================
4 For basic installation instructions, see the INSTALL file.
6 Netatalk is an implementation of "AFP over TCP".
7 Netatalk also support the AppleTalk Protocol Suite for legacy Macs.
8 The current release contains support for EtherTalk Phase I and II,
9 DDP, RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, AFP and DSI.
10 The complete stack looks like this on a BSD-derived system:
16 ATP RTMP NBP ZIP AEP |
18 -+---------------------------------------------------+- (kernel boundary)
20 +-----------------------+------------+--------------+
22 | DDP +------------+--------------+
24 +-----------------------+---------------------------+
26 +---------------------------------------------------+
28 DSI is a session layer used to carry AFP over TCP.
29 DDP is in the kernel. "atalkd" implements RTMP, NBP, ZIP, and AEP. It
30 is the AppleTalk equivalent of Unix "routed". There is also a
31 client-stub library for NBP. ATP and ASP are implemented as
32 libraries. "papd" allows Macs to spool to "lpd", and "pap" allows Unix
33 machines to print to AppleTalk connected printers. "psf" is a
34 PostScript printer filter for "lpd", designed to use "pap". "psorder"
35 is a PostScript reverser, called by "psf" to reverse pages printed to
36 face-up stacking printers. "afpd" provides Macs with an interface to
37 the Unix file system. Refer to the appropriate man pages for
38 operational information.
43 The `configure' shell script attempts to guess correct values for
44 various system-dependent variables used during compilation. It uses
45 those values to create a `Makefile' in each directory of the package.
46 It may also create one or more `.h' files containing system-dependent
47 definitions. Finally, it creates a shell script `config.status' that
48 you can run in the future to recreate the current configuration, a file
49 `config.cache' that saves the results of its tests to speed up
50 reconfiguring, and a file `config.log' containing compiler output
51 (useful mainly for debugging `configure').
53 If you need to do unusual things to compile the package, please try
54 to figure out how `configure' could check whether to do them, and mail
55 diffs or instructions to the address given in the `README' so they can
56 be considered for the next release. If at some point `config.cache'
57 contains results you don't want to keep, you may remove or edit it.
59 The file `configure.in' is used to create `configure' by a program
60 called `autoconf'. You only need `configure.in' if you want to change
61 it or regenerate `configure' using a newer version of `autoconf'.
67 Libtool encapsulates the platform specific dependencies for the
68 creation of libraries. It determines if the local platform can support
69 shared libraries or if it only supports static libraries.
71 Netatalk currently requires libtool 1.4 or higher (1.4b for OpenBSD).
72 If you are using Tru64 you must apply the following patch to the file
73 acinclude.m4 (normally found in /usr/share/libtool/libltdl).
75 --- acinclude.m4.old Tue Nov 20 15:30:23 2001
76 +++ acinclude.m4 Tue Nov 20 15:31:54 2001
79 osf3* | osf4* | osf5*)
83 soname_spec='${libname}${release}.so'
84 library_names_spec='${libname}${release}.so$versuffix ${libname}${release}.so $libname.so'
86 Documentation: http://www.gnu.org/software/libtool/
87 Program: (see the GNU mirrors) /gnu/libtool/libtool-1.4.tar.gz
90 GNU m4 is an implementation of the Unix macro processor. It reads
91 stdin and copies to stdout expanding defined macros as it processes
94 Documentation: http://www.gnu.org/software/m4/
95 Program: (see the GNU mirrors) /gnu/m4/m4-1.4.tar.gz
98 Autoconf is a package of m4 macros that produce shell scripts to
99 configure source code packages.
101 Documentation: http://www.gnu.org/software/autoconf/
102 Program: (see the GNU mirrors) /gnu/autoconf/autoconf-2.52.tar.gz
105 Automake is a tool that generates 'Makefile.in' files.
107 Documentation: http://www.gnu.org/software/automake/
108 Program: (see the GNU mirrors) /gnu/automake/automake-1.5.tar.gz
112 5. OpenSSL and/or Libgcrypt
113 The OpenSSL Project is a collaborative effort to develop a robust,
114 commercial-grade, full-featured, and Open Source toolkit implementing
115 the Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS
116 v1) protocols as well as a full-strength general purpose cryptography
118 This is required to enable DHX login support.
120 Get everything at http://www.openssl.org/
122 The Libgcrypt is a general purpose cryptographic library based on
124 This is required to enable DHX2 login support.
126 Get everything at http://directory.fsf.org/project/libgcrypt/
129 Wietse Venema's network logger, also known as TCPD or LOG_TCP. These
130 programs log the client host name of incoming telnet, ftp, rsh,
131 rlogin, finger etc. requests. Security options are: access control per
132 host, domain and/or service; detection of host name spoofing or host
133 address spoofing; booby traps to implement an early-warning system.
134 TCP Wrappers can be gotten at ftp://ftp.porcupine.org/pub/security/
135 Netatalk uses TCP Wrappers to authorize host access when using
136 afpovertcp. It should be noted that if DDP is in use, the connection
137 will still be allowed as TCP Wrappers do not impact DDP connections.
139 7. PAM (Pluggable Authentication Modules)
140 PAM provides a flexible mechanism for authenticating
141 users. PAM was invented by SUN Microsystems.
143 Author: Andrew Morgan <morgan@linux.kernel.org>
145 Linux-PAM is a suite of shared libraries that enable the local system
146 administrator to choose how applications authenticate users.
147 You can get the Linux PAM documentation and sources from
148 http://www.kernel.org/pub/linux/libs/pam/
149 Netatalk also supports other standard PAM implementations such as OpenPAM.
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.6 and later.
159 Error checking and logging
160 ==========================
161 We wan't rigid error checking and concise log messages. This often leads
162 to signifant code bloat where the relevant function call is buried in error
163 checking and logging statements.
164 In order to alleviate error checking and code readability, we provide a set
165 of error checking macros in <atalk/errchk.h>. These macros compare the return
166 value of statements againt 0, NULL, -1 (and maybe more, check it out).
167 Every macro comes in four flavours: EC_CHECK, EC_CHECK_LOG, EC_CHECK_LOG_ERR
169 - EC_CHECK just checks the CHECK
170 - EC_CHECK_LOG additionally logs the stringified function call.
171 - EC_CHECK_LOG_ERR allows specifying the return value
172 - EC_CHECK_CUSTOM allows custom actions
173 The macros EC_CHECK* unconditionally jump to a cleanup label where the
174 neccessary cleanup can be done alongside controlling the return value.
175 EC_CHECK_CUSTOM doesn't do that, so an extra "goto EC_CLEANUP" may be
176 performed as appropiate.
179 - stat() without EC macro:
180 static int func(const char *name) {
183 if ((ret = stat(name, &some_struct_stat)) != 0) {
185 ret = -1; /* often needed to explicitly set the error indicating return value */
196 - stat() with EC macro:
197 static int func(const char *name) {
198 EC_INIT; /* expands to int ret = 0; */
200 char *uppername = NULL
201 EC_NULL(uppername = strdup(name));
202 EC_ZERO(strtoupper(uppername));
204 EC_ZERO(stat(uppername, &some_struct_stat)); /* expands to complete if block from above */
209 if (uppername) free(uppername);
213 A boileplate function template is: