/*
- * 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 "error.h"
-/** \cond holds information about one encrypted connection */
+/** 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;
};
-static unsigned cda_size = 0;
+/** array holding per fd crypt data per */
static struct crypt_data *crypt_data_array;
-/** \endcond */
+/** current size of the crypt data array */
+static unsigned cda_size = 0;
/**
/**
* 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)
{
/*
* 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)
{
/**
* 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
+ *
+ * \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)
{
/**
* 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)
{
/**
* 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, ...)
{
/**
* 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 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)
/**
* 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;
* 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)
/**
* 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)
* \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).
*/
int para_accept(int fd, void *addr, socklen_t size)
{
int new_fd;
- do
+ do
new_fd = accept(fd, (struct sockaddr *) addr, &size);
while (new_fd < 0 && errno == EINTR);
return new_fd < 0? -E_ACCEPT : new_fd;
*
* 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)
*
* \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)
*/
/**
* create a socket, bind it and listen
+ *
* \param port the tcp port to listen on
*
* \return The file descriptor of the created socket, negative
* 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)
*/
projects / paraslash.git / blobdiff