aboutsummaryrefslogtreecommitdiff
path: root/libcmix-crypto/sharedkey.h
diff options
context:
space:
mode:
Diffstat (limited to 'libcmix-crypto/sharedkey.h')
-rw-r--r--libcmix-crypto/sharedkey.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/libcmix-crypto/sharedkey.h b/libcmix-crypto/sharedkey.h
index 9c959fe..c37ae41 100644
--- a/libcmix-crypto/sharedkey.h
+++ b/libcmix-crypto/sharedkey.h
@@ -1,12 +1,21 @@
#pragma once
+/*!
+ * \file
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
+/*!
+ * \brief The SharedKey struct.
+ *
+ * Stored the derived shared secret after for instance Diffie-Hellman.
+ */
struct SharedKey {
- unsigned char* shared;
- unsigned int shared_len;
+ unsigned char* shared; ///< The Shared key.
+ unsigned int shared_len; ///< The shared key length.
};
#ifdef __cplusplus