Documentation to apps.h, documentation/renaming to iclass

[proxmark3-svn] / client / loclass / ikeys.h

diff --git a/client/loclass/ikeys.h b/client/loclass/ikeys.h
index 0b943d6be4241357c93750d283426508524e7105..1de46b62c50680b2ef1d7a6084e33282b6a18497 100644 (file)
--- a/client/loclass/ikeys.h
+++ b/client/loclass/ikeys.h
@@ -1,8 +1,32 @@
 #ifndef IKEYS_H
 #define IKEYS_H
 #ifndef IKEYS_H
 #define IKEYS_H

-int testKeyDiversification();
-int doKeyTests();
-void hash0(uint64_t c, uint8_t *k);
-void pushbackSixBitByte(uint64_t *c, uint8_t z, int n);
-uint8_t getSixBitByte(uint64_t c, int n);
+
+
+/**
+ * @brief
+ *Definition 11. Let the function hash0 : F 82 × F 82 × (F 62 ) 8 → (F 82 ) 8 be defined as
+ *     hash0(x, y, z [0] . . . z [7] ) = k [0] . . . k [7] where
+ * z'[i] = (z[i] mod (63-i)) + i       i =  0...3
+ * z'[i+4] = (z[i+4] mod (64-i)) + i   i =  0...3
+ * ẑ = check(z');
+ * @param c
+ * @param k this is where the diversified key is put (should be 8 bytes)
+ * @return
+ */
+void hash0(uint64_t c, uint8_t k[8]);
+int doKeyTests(uint8_t debuglevel);
+/**
+ * @brief Performs Elite-class key diversification
+ * @param csn
+ * @param key
+ * @param div_key
+ */
+
+void diversifyKey(uint8_t csn[8], uint8_t key[8], uint8_t div_key[8]);
+/**
+ * @brief Permutes a key from standard NIST format to Iclass specific format
+ * @param key
+ * @param dest
+ */
+

 #endif // IKEYS_H
 #endif // IKEYS_H