aac: fix some signedness warnings
[paraslash.git] / net.c
diff --git a/net.c b/net.c
index 28bc777d4dde6f56be5414d4d8d92aeb0d47ab6e..6a8eea3b261c3dadb8df2c73d25626150cd5ad00 100644 (file)
--- a/net.c
+++ b/net.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * 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
 #include "string.h"
 #include "error.h"
 
+
+/** holds information about one encrypted connection */
 struct crypt_data {
+       /** function used to decrypt received data */
        crypt_function *recv;
+       /** function used to encrypt data to be sent */
        crypt_function *send;
+       /** context-dependent data, passed to \a recv() and \a send() */
        void *private_data;
 };
-
+/** array holding per fd crypt data per */
 static struct crypt_data *crypt_data_array;
+/** current size of the crypt data array */
 static unsigned cda_size = 0;
 
-void enable_crypt(int fd, crypt_function *recv, crypt_function *send,
+
+/**
+ * activate encryption for one file descriptor
+ *
+ * \param fd the file descriptor
+ * \param recv_f the function used for decrypting received data
+ * \param send_f the function used for encrypting before sending
+ * \param private_data user data supplied by the caller
+ */
+void enable_crypt(int fd, crypt_function *recv_f, crypt_function *send_f,
        void *private_data)
 {
        if (fd + 1 > cda_size) {
                crypt_data_array = para_realloc(crypt_data_array,
                        (fd + 1) * sizeof(struct crypt_data));
-               memset(crypt_data_array + cda_size * sizeof(struct crypt_data), 0,
+               memset(crypt_data_array + cda_size, 0,
                        (fd + 1 - cda_size) * sizeof(struct crypt_data));
                cda_size = fd + 1;
        }
-       crypt_data_array[fd].recv = recv;
-       crypt_data_array[fd].send = send;
+       crypt_data_array[fd].recv = recv_f;
+       crypt_data_array[fd].send = send_f;
        crypt_data_array[fd].private_data = private_data;
        PARA_INFO_LOG("rc4 encryption activated for fd %d\n", fd);
 }
 
+/**
+ * deactivate encryption for a given fd
+ *
+ * \param fd the file descriptor
+ *
+ * This must be called if and only if \p fd was activated via enable_crypt().
+ */
 void disable_crypt(int fd)
 {
        if (cda_size < fd + 1)
@@ -60,12 +82,13 @@ void disable_crypt(int fd)
 
 /**
  * initialize a struct sockaddr_in
- * @param addr A pointer to the struct to be initialized
- * @param port The port number to use
- * @param he The address to use
  *
- * If \a he is null (server mode), \a addr->sin_addr is initialized with \p INADDR_ANY.
- * Otherwise, the address given by \a he is copied to addr.
+ * \param addr A pointer to the struct to be initialized
+ * \param port The port number to use
+ * \param he The address to use
+ *
+ * If \a he is null (server mode), \a addr->sin_addr is initialized with \p
+ * INADDR_ANY.  Otherwise, the address given by \a he is copied to addr.
  */
 void init_sockaddr(struct sockaddr_in *addr, int port, const struct hostent *he)
 {
@@ -83,13 +106,17 @@ void init_sockaddr(struct sockaddr_in *addr, int port, const struct hostent *he)
 
 /*
  * send out a buffer, resend on short writes
- * @param fd the file descriptor
- * @param buf The buffer to be sent
- * @len The length of \a buf
+ *
+ * \param fd the file descriptor
+ * \param buf The buffer to be sent
+ * \param len The length of \a buf
  *
  * Due to circumstances beyond your control, the kernel might not send all the
  * data out in one chunk, and now, my friend, it's up to us to get the data out
  * there (Beej's Guide to Network Programming).
+ *
+ * \return This function returns 1 on success and \a -E_SEND on errors. The
+ * number of bytes actually sent is stored upon successful return in \a len.
  */
 static int sendall(int fd, const char *buf, size_t *len)
 {
@@ -113,15 +140,16 @@ static int sendall(int fd, const char *buf, size_t *len)
 
 /**
  * encrypt and send buffer
- * @param fd:  the file descriptor
- * @param buf the buffer to be encrypted and sent
- * @param len the length of \a buf
  *
- * Check if encrytion is available. If yes, encrypt the given buffer.  Send out
+ * \param fd:  the file descriptor
+ * \param buf the buffer to be encrypted and sent
+ * \param len the length of \a buf
+ *
+ * Check if encrytpion is available. If yes, encrypt the given buffer.  Send out
  * the buffer, encrypted or not, and try to resend the remaing part in case of
  * short writes.
  *
- * @return Positive on success, \p -E_SEND on errors.
+ * \return Positive on success, \p -E_SEND on errors.
  */
 int send_bin_buffer(int fd, const char *buf, size_t len)
 {
@@ -145,12 +173,13 @@ int send_bin_buffer(int fd, const char *buf, size_t len)
 
 /**
  * encrypt and send null terminated buffer.
- * @param fd the file descriptor
- * @param buf the null-terminated buffer to be send
+ *
+ * \param fd the file descriptor
+ * \param buf the null-terminated buffer to be send
  *
  * This is equivalent to send_bin_buffer(fd, buf, strlen(buf)).
  *
- * @return Positive on success, \p -E_SEND on errors.
+ * \return Positive on success, \p -E_SEND on errors.
  */
 int send_buffer(int fd, const char *buf)
 {
@@ -160,10 +189,11 @@ int send_buffer(int fd, const char *buf)
 
 /**
  * send and encrypt a buffer given by a format string
- * @param fd the file descriptor
- * @param fmt a format string
  *
- * @return Positive on success, \p -E_SEND on errors.
+ * \param fd the file descriptor
+ * \param fmt a format string
+ *
+ * \return Positive on success, \p -E_SEND on errors.
  */
 __printf_2_3 int send_va_buffer(int fd, const char *fmt, ...)
 {
@@ -179,16 +209,17 @@ __printf_2_3 int send_va_buffer(int fd, const char *fmt, ...)
 /**
  * receive and decrypt.
  *
- * @param fd the file descriptor
- * @param buf the buffer to write the decrypted data to
- * @param size the size of @param buf
+ * \param fd the file descriptor
+ * \param buf the buffer to write the decrypted data to
+ * \param size the size of \a buf
  *
- * Receive at most \a size bytes from filedescriptor fd. If encrytion is
+ * Receive at most \a size bytes from filedescriptor fd. If encryption is
  * available, decrypt the received buffer.
  *
- * @return the number of bytes received on success. On receive errors, -E_RECV
+ * \return The number of bytes received on success. On receive errors, -E_RECV
  * is returned. On crypt errors, the corresponding crypt error number is
  * returned.
+ *
  * \sa recv(2)
  */
 __must_check int recv_bin_buffer(int fd, char *buf, ssize_t size)
@@ -215,14 +246,17 @@ __must_check int recv_bin_buffer(int fd, char *buf, ssize_t size)
 /**
  * receive, decrypt and write terminating NULL byte
  *
- * @param fd the file descriptor
- * @param buf the buffer to write the decrypted data to
- * @param size the size of \a buf
+ * \param fd the file descriptor
+ * \param buf the buffer to write the decrypted data to
+ * \param size the size of \a buf
+ *
+ * Read and decrypt at most \a size - 1 bytes from file descriptor \a fd and
+ * write a NULL byte at the end of the received data.
  *
- * Read and decrypt at most size - 1 bytes from file descriptor \a fd and write
- * a NULL byte at the end of the received data.
+ * \return: The return value of the underlying call to \a recv_bin_buffer().
  *
-*/
+ * \sa recv_bin_buffer()
+ */
 int recv_buffer(int fd, char *buf, ssize_t size)
 {
        int n;
@@ -260,7 +294,8 @@ int get_host_info(char *host, struct hostent **ret)
  * Create an IPv4 socket for sequenced, reliable, two-way, connection-based
  * byte streams.
  *
- * @return The socket fd on success, -E_SOCKET on errors.
+ * \return The socket fd on success, -E_SOCKET on errors.
+ *
  * \sa socket(2)
  */
 int get_socket(void)
@@ -275,10 +310,11 @@ int get_socket(void)
 /**
  * a wrapper around connect(2)
  *
- * @param fd the file descriptor
- * @param their_addr the address to connect
+ * \param fd the file descriptor
+ * \param their_addr the address to connect
+ *
+ * \return \p -E_CONNECT on errors, 1 on success
  *
- * @return \p -E_CONNECT on errors, 1 on success
  * \sa connect(2)
  */
 int para_connect(int fd, struct sockaddr_in *their_addr)
@@ -294,9 +330,13 @@ int para_connect(int fd, struct sockaddr_in *their_addr)
 /**
  * paraslash's wrapper around the accept system call
  *
- * @param fd the listening socket
- * @param addr structure which is filled in with the address of the peer socket
- * @param size should contain the size of the structure pointed to by \a addr
+ * \param fd the listening socket
+ * \param addr structure which is filled in with the address of the peer socket
+ * \param size should contain the size of the structure pointed to by \a addr
+ *
+ * Accept incoming connections on \a addr. Retry if interrupted.
+ *
+ * \return The new file descriptor on success, \a -E_ACCEPT on errors.
  *
  * \sa accept(2).
  */
@@ -304,8 +344,10 @@ int para_accept(int fd, void *addr, socklen_t size)
 {
        int new_fd;
 
-       new_fd = accept(fd, (struct sockaddr *) addr, &size);
-       return new_fd == -1? -E_ACCEPT : new_fd;
+       do
+               new_fd = accept(fd, (struct sockaddr *) addr, &size);
+       while (new_fd < 0 && errno == EINTR);
+       return new_fd < 0? -E_ACCEPT : new_fd;
 }
 
 static int setserversockopts(int socket_fd)
@@ -348,6 +390,9 @@ int init_unix_addr(struct sockaddr_un *u, const char *name)
  *
  * This functions creates a local socket for sequenced, reliable,
  * two-way, connection-based byte streams.
+ *
+ * \return The file descriptor, on success, negative on errors.
+ *
  * \sa socket(2)
  * \sa bind(2)
  * \sa chmod(2)
@@ -371,9 +416,6 @@ int create_pf_socket(const char *name, struct sockaddr_un *unix_addr, int mode)
 }
 
 #ifndef HAVE_UCRED
-       struct ucred {
-       uid_t uid, pid, gid;
-};
 ssize_t send_cred_buffer(int sock, char *buf)
 {
        return send_buffer(sock, buf);
@@ -391,6 +433,7 @@ int recv_cred_buffer(int fd, char *buf, size_t size)
  *
  * \return On success, this call returns the number of characters sent.  On
  * error, \p -E_SENDMSG ist returned.
+ *
  * \sa  okir's Black Hats Manual
  * \sa sendmsg(2)
  */
@@ -494,6 +537,7 @@ int recv_cred_buffer(int fd, char *buf, size_t size)
 
 /**
  * create a socket, bind it and listen
+ *
  * \param port the tcp port to listen on
  *
  * \return The file descriptor of the created socket, negative
@@ -545,6 +589,7 @@ err:
  * to receive at most \a bufsize bytes from file descriptor \a fd.
  * If at least \p strlen(\a pattern) bytes were received, the beginning of
  * the received buffer is compared with \a pattern, ignoring case.
+ *
  * \sa recv_buffer()
  * \sa strncasecmp(3)
  */
@@ -560,8 +605,11 @@ int recv_pattern(int fd, const char *pattern, size_t bufsize)
                goto out;
        ret = 1;
 out:
-       if (ret < 0)
-               PARA_NOTICE_LOG("did not receive pattern '%s'\n", pattern);
+       if (ret < 0) {
+               PARA_NOTICE_LOG("n = %d, did not receive pattern '%s'\n", n, pattern);
+               if (n > 0)
+                       PARA_NOTICE_LOG("recvd: %s\n", buf);
+       }
        free(buf);
        return ret;
 }