server: Include git version in output of com_si().
[paraslash.git] / crypt.h
diff --git a/crypt.h b/crypt.h
index 019b643..6bd8179 100644 (file)
--- a/crypt.h
+++ b/crypt.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -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);