-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 |
+-----------------------+------------+--------------+
| 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
shared libraries or if it only supports static libraries.
Documentation: http://www.gnu.org/software/libtool/
-Program: (see the GNU mirrors) /gnu/libtool/libtool-1.3.5.tar.gz
2. GNU m4
GNU m4 is an implementation of the Unix macro processor. It reads
the text.
Documentation: http://www.gnu.org/software/m4/
-Program: (see the GNU mirrors) /gnu/m4/m4-1.4.tar.gz
3. Autoconf
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
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
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
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>
Linux-PAM is a suite of shared libraries that enable the local system
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.
+
+Error checking and logging
+==========================
+We wan't rigid error checking and concise log messages. This often leads
+to signifant code bloat where the relevant function call is buried in error
+checking and logging statements.
+In order to alleviate error checking and code readability, we provide a set
+of error checking macros in <atalk/errchk.h>. These macros compare the return
+value of statements againt 0, NULL, -1 (and maybe more, check it out).
+Every macro comes in four flavours: EC_CHECK, EC_CHECK_LOG, EC_CHECK_LOG_ERR
+and EC_CHECK_CUSTOM:
+- EC_CHECK just checks the CHECK
+- EC_CHECK_LOG additionally logs the stringified function call.
+- EC_CHECK_LOG_ERR allows specifying the return value
+- EC_CHECK_CUSTOM allows custom actions
+The macros EC_CHECK* unconditionally jump to a cleanup label where the
+neccessary cleanup can be done alongside controlling the return value.
+EC_CHECK_CUSTOM doesn't do that, so an extra "goto EC_CLEANUP" may be
+performed as appropiate.
+
+Example:
+- stat() without EC macro:
+ static int func(const char *name) {
+ int ret = 0;
+ ...
+ if ((ret = stat(name, &some_struct_stat)) != 0) {
+ LOG(...);
+ ret = -1; /* often needed to explicitly set the error indicating return value */
+ goto cleanup;
+ }
+
+ return ret;
+
+ cleanup:
+ ...
+ return ret;
+ }
+
+- stat() with EC macro:
+ static int func(const char *name) {
+ EC_INIT; /* expands to int ret = 0; */
+
+ char *uppername = NULL
+ EC_NULL(uppername = strdup(name));
+ EC_ZERO(strtoupper(uppername));
+
+ EC_ZERO(stat(uppername, &some_struct_stat)); /* expands to complete if block from above */
+
+ EC_STATUS(0);
+
+EC_CLEANUP:
+ if (uppername) free(uppername);
+ EC_EXIT;
+ }
+
+A boileplate function template is:
+
+int func(void)
+{
+ EC_INIT;
+
+ ...your code here...
+
+ EC_STATUS(0);
+
+EC_CLEANUP:
+ EC_EXIT;
+}
+
+Ini Parser
+==========
+
+The ini parser is taken from <http://ndevilla.free.fr/iniparser/>.
+It has been slightly modified:
+- case-sensitive
+- "include" directive added
+- iniparser_getstrdup() to complemnt iniparser_getstring(), it return allocated strings
+ which the caller must free as necessary
+- the API has been modifed such that all iniparser_get* funcs take a section and a parameter
+ as sepereta args instead of one string of the form "section:parameter" in the original
+ library
+
projects / netatalk.git / blobdiff