net.c: Improve documentation of struct crypt_data.

[paraslash.git] / net.c

diff --git a/net.c b/net.c
index 6248de5506eb131828bc4a63f5a55a88c4bc30b4..bc7d234bfa2ec01619d8bc698dfb2841053b0eca 100644 (file)
--- a/net.c
+++ b/net.c
@@ -1,19 +1,7 @@
 /*
  * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file net.c networking-related helper functions */
@@ -24,21 +12,23 @@
 #include "error.h"
 
 
-/** holds information about one encrypted connection */
+/** Information about one encrypted connection. */
 struct crypt_data {
-       /** function used to decrypt received data */
+       /** Function used to decrypt received data. */
        crypt_function *recv;
-       /** function used to encrypt data to be sent */
+       /** Function used to encrypt data to be sent. */
        crypt_function *send;
-       /** context-dependent data, passed to \a recv() and \a send() */
+       /**
+        * Context-dependent data (crypt keys), passed verbatim to the above
+        * crypt functions.
+        */
        void *private_data;
 };
-/** array holding per fd crypt data per */
+/** Array holding per fd crypt data. */
 static struct crypt_data *crypt_data_array;
-/** current size of the crypt data array */
+/** Current size of the crypt data array. */
 static unsigned cda_size = 0;
 
-
 /**
  * activate encryption for one file descriptor
  *
@@ -386,11 +376,11 @@ int init_unix_addr(struct sockaddr_un *u, const char *name)
 }
 
 /**
- * prepare, create, and bind and socket for local communication
+ * Prepare, create, and bind a socket for local communication.
  *
- * \param name the socket pathname
- * \param unix_addr pointer to the \p AF_UNIX socket structure
- * \param mode the desired mode of the socket
+ * \param name The socket pathname.
+ * \param unix_addr Pointer to the \p AF_UNIX socket structure.
+ * \param mode The desired mode of the socket.
  *
  * This functions creates a local socket for sequenced, reliable,
  * two-way, connection-based byte streams.
@@ -401,23 +391,27 @@ int init_unix_addr(struct sockaddr_un *u, const char *name)
  * \sa bind(2)
  * \sa chmod(2)
  */
-int create_pf_socket(const char *name, struct sockaddr_un *unix_addr,
+int create_local_socket(const char *name, struct sockaddr_un *unix_addr,
                mode_t mode)
 {
        int fd, ret;
 
-       fd = socket(PF_UNIX, SOCK_STREAM, 0);
-       if (fd < 0)
-               return -E_SOCKET;
-//     unlink(name);
        ret = init_unix_addr(unix_addr, name);
        if (ret < 0)
                return ret;
+       fd = socket(PF_UNIX, SOCK_STREAM, 0);
+       if (fd < 0)
+               return -E_SOCKET;
+       ret = -E_BIND;
        if (bind(fd, (struct sockaddr *) unix_addr, UNIX_PATH_MAX) < 0)
-               return -E_BIND;
+               goto err;
+       ret = -E_CHMOD;
        if (chmod(name, mode) < 0)
-               return -E_CHMOD;
+               goto err;
        return fd;
+err:
+       close(fd);
+       return ret;
 }
 
 #ifndef HAVE_UCRED