aboutsummaryrefslogtreecommitdiff
path: root/libcmix-crypto/keypair.h
diff options
context:
space:
mode:
Diffstat (limited to 'libcmix-crypto/keypair.h')
-rw-r--r--libcmix-crypto/keypair.h18
1 files changed, 14 insertions, 4 deletions
diff --git a/libcmix-crypto/keypair.h b/libcmix-crypto/keypair.h
index 9587db3..838291d 100644
--- a/libcmix-crypto/keypair.h
+++ b/libcmix-crypto/keypair.h
@@ -1,16 +1,26 @@
#pragma once
+/*!
+ * \file
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
#include <stdlib.h>
+/*!
+ * \brief The KeyPair struct contains the private and public key, and the private and public key lengths.
+ *
+ * Is used as a generic storage container for multiple implementations. So the implementations are
+ * responsible for memory meanagement. See the Api struct for examples of this.
+ */
struct KeyPair {
- unsigned char* sec;
- unsigned char* pub;
- unsigned int sec_len;
- unsigned int pub_len;
+ unsigned char* sec; ///< Private key
+ unsigned char* pub; ///< Public key
+ unsigned int sec_len; ///< Private key length
+ unsigned int pub_len; ///< Public key length
};