From: Andre Noll <maan@systemlinux.org>
Date: Sat, 11 Jul 2009 11:19:08 +0000 (+0200)
Subject: Add documentation to struct rc4_context.
X-Git-Tag: v0.4.0~51^2~7
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=05ac3a8322555355fac0e224305a4a10a5d7caa2;hp=8ea8abb73199b32fdd7afdf8825afa42ed8de244

Add documentation to struct rc4_context.
---

diff --git a/crypt.h b/crypt.h
index 019b643e..8edff413 100644
--- a/crypt.h
+++ b/crypt.h
@@ -17,9 +17,19 @@ void rsa_free(RSA *rsa);
 void get_random_bytes_or_die(unsigned char *buf, int num);
 void init_random_seed_or_die(void);
 
+/**
+ * Used on the server-side for client-server communication encryption.
+ *
+ * The traffic between (the forked child of) para_server and the remote
+ * client process is crypted by a RC4 session key. This structure contains
+ * the RC4 keys and the file descriptor for which these keys should be used.
+ */
 struct rc4_context {
+	/** The socket file descriptor. */
 	int fd;
+	/** Key used for sending data. */
 	RC4_KEY recv_key;
+	/** Key used for receiving data. */
 	RC4_KEY send_key;
 };
 int rc4_send_bin_buffer(struct rc4_context *rc4c, const char *buf, size_t len);