1 files changed, 51 insertions, 0 deletions
diff --git a/libcmix/cmix.h b/libcmix/cmix.h
new file mode 100644
index 0000000..5fe2e13
--- /dev/null
+++ b/libcmix/cmix.h
@@ -0,0 +1,51 @@
+/**
+ * \file
+ */
+
+struct message {
+	char buffer[2048/8];
+};
+
+/**
+ * \struct
+ * \brief The CMixBuffer struct is the temporary storage of messages in each Node.
+ * On this buffer, operations like decrypt and permute are performed.
+ */
+struct CMixBuffer {
+	char* buffer; ///< The actual buffer
+	unsigned int nr_messages; ///< The number of messages in the buffer
+	unsigned int message_length; ///< The length of each message in the buffer
+};
+
+/**
+ * \brief The cmix_error enum describes the output state of a each of the cmix functions
+ */
+enum cmix_error {
+	no_error = 0,
+	index_out_of_range = 1000
+};
+
+/**
+ * \brief permutate mixes the messages before sending the messages.
+ * \param[in,out] b A buffer of \p nr_messages messages, each message of length *message_len*
+ * \return no_error
+ */
+enum cmix_error permute(struct CMixBuffer b);
+ 
+/**
+ * \brief get_message takes the \p index message of the buffer \p b copies it into \p message 
+ * \param[out] message is the output buffer that has to hold at least \p b.message_length bytes.
+ * \param[in] b is the buffer from which to copy the message.
+ * \param[in] index is the index of the message to copy.
+ * \return index_out_of_range if \p index is greater than or equal to \p b.nr_messages , otherwise no_error.
+ */
+enum cmix_error get_message(char* message, struct CMixBuffer b, unsigned int index);
+
+/**
+ * \brief set_message set the \p index message of the buffer to a copy of \p message.
+ * \param[in] message The message to set the part of the buffer to.
+ * \param[in,out] b The buffer
+ * \param[in] index The index into the buffer
+ * \return index_out_of_range if \p index is greater than or equal to \p b.nr_messages , otherwise no_error.
+ */
+enum cmix_error set_message(char const* message, struct CMixBuffer b, unsigned int index);
+\ No newline at end of file