From 3a02a06775b70d11023c32278988ce2c5dab5eb4 Mon Sep 17 00:00:00 2001 From: darky Date: Mon, 1 Dec 2014 17:04:42 +0100 Subject: [PATCH 01/32] added RPi support --- MD5.h | 13 +++++++-- Makefile | 60 +++++++++++++++++++++++++++++++++++++++ examples_Rpi/MD5_Hash.cpp | 14 +++++++++ examples_Rpi/Makefile | 39 +++++++++++++++++++++++++ 4 files changed, 124 insertions(+), 2 deletions(-) create mode 100644 Makefile create mode 100644 examples_Rpi/MD5_Hash.cpp create mode 100644 examples_Rpi/Makefile diff --git a/MD5.h b/MD5.h index 0d86ce5..94a9ccc 100644 --- a/MD5.h +++ b/MD5.h @@ -1,8 +1,17 @@ #ifndef MD5_h #define MD5_h -#include "Arduino.h" - +#if (defined(__linux) || defined(linux)) && !defined(__ARDUINO_X86__) + + #define RF24_LINUX + + #include + #include + #include + #include +#else + #include +#endif /* * This is an OpenSSL-compatible implementation of the RSA Data Security, * Inc. MD5 Message-Digest Algorithm (RFC 1321). diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..6e4a77c --- /dev/null +++ b/Makefile @@ -0,0 +1,60 @@ +############################################################################# +# +# Makefile for MD5 on Raspberry Pi +# +# License: GPL (General Public License) +# Author: Charles-Henri Hallard +# Date: 2013/03/13 +# +# Description: +# ------------ +# use make all and mak install to install the library +# You can change the install directory by editing the LIBDIR line +# +PREFIX=/usr/local + +# Library parameters +# where to put the lib +LIBDIR=$(PREFIX)/lib +# lib name +LIB=libMD5 +# shared library name +LIBNAME=$(LIB).so.1.0 + +# Where to put the header files +HEADER_DIR=${PREFIX}/include/MD5 + +# The recommended compiler flags for the Raspberry Pi +CCFLAGS=-Ofast -mfpu=vfp -mfloat-abi=hard -march=armv6zk -mtune=arm1176jzf-s + +# make all +# reinstall the library after each recompilation +all: libMD5 + +# Make the library +libMD5: MD5.o + g++ -shared -Wl,-soname,$@.so.1 ${CCFLAGS} -o ${LIBNAME} $^ + +# Library parts +MD5.o: MD5.cpp + g++ -Wall -fPIC ${CCFLAGS} -c $^ + +# clear build files +clean: + rm -rf *.o ${LIB}.* + +install: all install-libs install-headers + +# Install the library to LIBPATH +install-libs: + @echo "[Installing Libs]" + @if ( test ! -d $(PREFIX)/lib ) ; then mkdir -p $(PREFIX)/lib ; fi + @install -m 0755 ${LIBNAME} ${LIBDIR} + @ln -sf ${LIBDIR}/${LIBNAME} ${LIBDIR}/${LIB}.so.1 + @ln -sf ${LIBDIR}/${LIBNAME} ${LIBDIR}/${LIB}.so + @ldconfig + +install-headers: + @echo "[Installing Headers]" + @if ( test ! -d ${HEADER_DIR} ) ; then mkdir -p ${HEADER_DIR} ; fi + @install -m 0644 *.h ${HEADER_DIR} diff --git a/examples_Rpi/MD5_Hash.cpp b/examples_Rpi/MD5_Hash.cpp new file mode 100644 index 0000000..c129de5 --- /dev/null +++ b/examples_Rpi/MD5_Hash.cpp @@ -0,0 +1,14 @@ +#include + +int main(int argc, char** argv) +{ + //generate the MD5 hash for our string + unsigned char* hash=MD5::make_hash("hello world"); + //generate the digest (hex encoding) of our hash + char *md5str = MD5::make_digest(hash, 16); + free(hash); + printf("%s\n",md5str); + free(md5str); + return 0; +} + diff --git a/examples_Rpi/Makefile b/examples_Rpi/Makefile new file mode 100644 index 0000000..fae5404 --- /dev/null +++ b/examples_Rpi/Makefile @@ -0,0 +1,39 @@ +############################################################################# +# +# Makefile for MD5 examples on Raspberry Pi +# +# License: GPL (General Public License) +# Author: gnulnulf +# Date: 2013/02/07 (version 1.0) +# +# Description: +# ------------ +# use make all and make install to install the examples +# You can change the install directory by editing the prefix line +# +prefix := /usr/local + +# The recommended compiler flags for the Raspberry Pi +CCFLAGS=-Ofast -mfpu=vfp -mfloat-abi=hard -march=armv6zk -mtune=arm1176jzf-s +#CCFLAGS= + +# define all programs +PROGRAMS = MD5_Hash +SOURCES = ${PROGRAMS:=.cpp} + +all: ${PROGRAMS} + +${PROGRAMS}: ${SOURCES} + g++ ${CCFLAGS} -Wall -I../ -lMD5 $@.cpp -o $@ + +clean: + rm -rf $(PROGRAMS) + +install: all + test -d $(prefix) || mkdir $(prefix) + test -d $(prefix)/bin || mkdir $(prefix)/bin + for prog in $(PROGRAMS); do \ + install -m 0755 $$prog $(prefix)/bin; \ + done + +.PHONY: install From 322e146b2c0ee05f59b3464aa6305cd6bb5c195d Mon Sep 17 00:00:00 2001 From: darky Date: Mon, 1 Dec 2014 17:51:05 +0100 Subject: [PATCH 02/32] new readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5838c1a..cb15944 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,20 @@ Serial.println(md5str); //Give the Memory back to the System if you run the md5 Hash generation in a loop free(md5str); ``` + +### Raspberry pi install +``` +sudo make install +cd examples_Rpi +make +``` + +### Raspberry pi after changes +``` +sudo make clean +sudo make install +cd examples_Rpi +make clean +make +``` + From 0f592316d63ce0cb63f49079fb4ddab0394761b5 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Mon, 1 Dec 2014 20:55:37 +0100 Subject: [PATCH 03/32] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index cb15944..5e8af1b 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,18 @@ make clean make ``` +### Raspberry pi changes to a sketch +``` +cd examples_Rpi +make + +or +make clean +make +``` + +### Raspberry pi start a sketch +``` +cd examples_Rpi +sudo ./ +``` From 7a86f6235467a8a14858ffaa446ace058b7ba979 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Mon, 1 Dec 2014 20:58:13 +0100 Subject: [PATCH 04/32] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5e8af1b..9adfd07 100644 --- a/README.md +++ b/README.md @@ -23,14 +23,15 @@ Serial.println(md5str); free(md5str); ``` -### Raspberry pi install +### Raspberry pi +install ``` sudo make install cd examples_Rpi make ``` -### Raspberry pi after changes +What to do after changes to the library ``` sudo make clean sudo make install @@ -39,7 +40,7 @@ make clean make ``` -### Raspberry pi changes to a sketch +What to do after changes to a sketch ``` cd examples_Rpi make @@ -49,7 +50,7 @@ make clean make ``` -### Raspberry pi start a sketch +How to start a sketch ``` cd examples_Rpi sudo ./ From 28f961eba0d9f0ea5c74f74f148d878aae5545af Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Mon, 1 Dec 2014 20:59:26 +0100 Subject: [PATCH 05/32] Update Makefile --- examples_Rpi/Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples_Rpi/Makefile b/examples_Rpi/Makefile index fae5404..f0d9ac2 100644 --- a/examples_Rpi/Makefile +++ b/examples_Rpi/Makefile @@ -3,8 +3,8 @@ # Makefile for MD5 examples on Raspberry Pi # # License: GPL (General Public License) -# Author: gnulnulf -# Date: 2013/02/07 (version 1.0) +# Author: spaniakos +# Date: 01/12/2014 (version 1.0) # # Description: # ------------ From 47316ca5c86ec9f4efb62dac3faf2de2663f19bb Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Mon, 1 Dec 2014 21:00:17 +0100 Subject: [PATCH 06/32] Update Makefile --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 6e4a77c..55ef4cf 100644 --- a/Makefile +++ b/Makefile @@ -3,8 +3,8 @@ # Makefile for MD5 on Raspberry Pi # # License: GPL (General Public License) -# Author: Charles-Henri Hallard -# Date: 2013/03/13 +# Author: spaniakos +# Date: 01/12/2014 (version 1.0) # # Description: # ------------ From 9ae913194e848ef7f29fadb660be264f7de8551d Mon Sep 17 00:00:00 2001 From: darky Date: Mon, 15 Dec 2014 14:55:14 +0100 Subject: [PATCH 07/32] char >> const char --- MD5.cpp | 2 +- MD5.h | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/MD5.cpp b/MD5.cpp index bb384a9..81c1ed0 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -275,7 +275,7 @@ void MD5::MD5Final(unsigned char *result, void *ctxBuf) memset(ctx, 0, sizeof(*ctx)); } -unsigned char* MD5::make_hash(char *arg) +unsigned char* MD5::make_hash(const char *arg) { MD5_CTX context; unsigned char * hash = (unsigned char *) malloc(16); diff --git a/MD5.h b/MD5.h index 94a9ccc..d1c13ca 100644 --- a/MD5.h +++ b/MD5.h @@ -49,7 +49,7 @@ class MD5 { public: MD5(); - static unsigned char* make_hash(char *arg); + static unsigned char* make_hash(const char *arg); static char* make_digest(const unsigned char *digest, int len); static const void *body(void *ctxBuf, const void *data, size_t size); static void MD5Init(void *ctxBuf); @@ -57,4 +57,4 @@ class MD5 static void MD5Update(void *ctxBuf, const void *data, size_t size); }; -#endif \ No newline at end of file +#endif From 33b717adb0b52f98242ff04454da8f0e33647932 Mon Sep 17 00:00:00 2001 From: darky Date: Wed, 17 Dec 2014 15:39:21 +0100 Subject: [PATCH 08/32] Config file + example Changes --- MD5.cpp | 2 +- MD5.h | 16 ++-------------- MD5_config.h | 17 +++++++++++++++++ examples/MD5_Hash/MD5_Hash.ino | 31 ++++++++++++++++++++++++++++++- examples_Rpi/MD5_Hash.cpp | 32 +++++++++++++++++++++++++++++++- 5 files changed, 81 insertions(+), 17 deletions(-) create mode 100644 MD5_config.h diff --git a/MD5.cpp b/MD5.cpp index 81c1ed0..bb384a9 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -275,7 +275,7 @@ void MD5::MD5Final(unsigned char *result, void *ctxBuf) memset(ctx, 0, sizeof(*ctx)); } -unsigned char* MD5::make_hash(const char *arg) +unsigned char* MD5::make_hash(char *arg) { MD5_CTX context; unsigned char * hash = (unsigned char *) malloc(16); diff --git a/MD5.h b/MD5.h index d1c13ca..ca465ac 100644 --- a/MD5.h +++ b/MD5.h @@ -1,17 +1,7 @@ #ifndef MD5_h #define MD5_h -#if (defined(__linux) || defined(linux)) && !defined(__ARDUINO_X86__) - - #define RF24_LINUX - - #include - #include - #include - #include -#else - #include -#endif +#include "MD5_config.h" /* * This is an OpenSSL-compatible implementation of the RSA Data Security, * Inc. MD5 Message-Digest Algorithm (RFC 1321). @@ -34,8 +24,6 @@ * */ -#include - typedef unsigned long MD5_u32plus; typedef struct { @@ -49,7 +37,7 @@ class MD5 { public: MD5(); - static unsigned char* make_hash(const char *arg); + static unsigned char* make_hash(char *arg); static char* make_digest(const unsigned char *digest, int len); static const void *body(void *ctxBuf, const void *data, size_t size); static void MD5Init(void *ctxBuf); diff --git a/MD5_config.h b/MD5_config.h new file mode 100644 index 0000000..8f8bc72 --- /dev/null +++ b/MD5_config.h @@ -0,0 +1,17 @@ +#ifndef MD5_config_h +#define MD5_config_h + +#if (defined(__linux) || defined(linux)) && !defined(__ARDUINO_X86__) + + #define RF24_LINUX + + #include + #include + #include + #include +#else + #include +#endif + +#include +#endif diff --git a/examples/MD5_Hash/MD5_Hash.ino b/examples/MD5_Hash/MD5_Hash.ino index b292a5b..f8c4834 100644 --- a/examples/MD5_Hash/MD5_Hash.ino +++ b/examples/MD5_Hash/MD5_Hash.ino @@ -11,12 +11,41 @@ void setup() //give it a second delay(1000); //generate the MD5 hash for our string - unsigned char* hash=MD5::make_hash("hello world"); + unsigned char* hash=MD5::make_hash("abc"); //generate the digest (hex encoding) of our hash char *md5str = MD5::make_digest(hash, 16); free(hash); //print it on our serial monitor + Serial.println("PLAIN :abc"); + Serial.println("EXPECTED:900150983cd24fb0d6963f7d28e17f72"); + Serial.print("RESULT :"); Serial.println(md5str); + Serial.println(); + + //generate the MD5 hash for our string + hash=MD5::make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + //generate the digest (hex encoding) of our hash + md5str = MD5::make_digest(hash, 16); + Serial.println("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + Serial.println("EXPECTED:8215ef0796a20bcaaae116d3876c664a"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + + //generate the MD5 hash for our string + char aa[1000001]; + for (int i=0;i<1000000;i++) + aa[i] = 'a'; + aa[1000000] = '\0'; + hash=MD5::make_hash(aa); + //generate the digest (hex encoding) of our hash + md5str = MD5::make_digest(hash, 16); + Serial.println("PLAIN :1,000,000 x a"); + Serial.println("EXPECTED:7707d6ae4e027c70eea2a935c2296f21"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); //Give the Memory back to the System if you run the md5 Hash generation in a loop free(md5str); } diff --git a/examples_Rpi/MD5_Hash.cpp b/examples_Rpi/MD5_Hash.cpp index c129de5..bf87e40 100644 --- a/examples_Rpi/MD5_Hash.cpp +++ b/examples_Rpi/MD5_Hash.cpp @@ -3,11 +3,41 @@ int main(int argc, char** argv) { //generate the MD5 hash for our string - unsigned char* hash=MD5::make_hash("hello world"); + unsigned char* hash=MD5::make_hash("abc"); //generate the digest (hex encoding) of our hash char *md5str = MD5::make_digest(hash, 16); free(hash); + //print it on our serial monitor + printf("PLAIN :abc\n"); + printf("EXPECTED:900150983cd24fb0d6963f7d28e17f72\n"); + printf("RESULT :"); printf("%s\n",md5str); + printf("\n"); + + //generate the MD5 hash for our string + hash=MD5::make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + //generate the digest (hex encoding) of our hash + md5str = MD5::make_digest(hash, 16); + printf("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq\n"); + printf("EXPECTED:8215ef0796a20bcaaae116d3876c664a\n"); + printf("RESULT :"); + printf("%s\n",md5str); + printf("\n"); + + //generate the MD5 hash for our string + char aa[100001]; + for (int i=0;i<1000000;i++) + aa[i] = 'a'; + aa[1000000] = '\0'; + hash=MD5::make_hash(aa); + //generate the digest (hex encoding) of our hash + md5str = MD5::make_digest(hash, 16); + printf("PLAIN :1,000,000 x a\n"); + printf("EXPECTED:7707d6ae4e027c70eea2a935c2296f21\n"); + printf("RESULT :"); + printf("%s\n",md5str); + printf("\n"); + //Give the Memory back to the System if you run the md5 Hash generation in a loop free(md5str); return 0; } From 77a19ca215714a2124739111b74e8605c502bd78 Mon Sep 17 00:00:00 2001 From: darky Date: Mon, 12 Jan 2015 15:09:28 +0100 Subject: [PATCH 09/32] added time measurement --- MD5.cpp | 8 ++++++++ MD5.h | 7 +++++++ MD5_config.h | 2 +- examples/MD5_Hash/MD5_Hash.ino | 16 ++++++++++++++++ examples_Rpi/MD5_Hash.cpp | 7 +++++++ 5 files changed, 39 insertions(+), 1 deletion(-) diff --git a/MD5.cpp b/MD5.cpp index bb384a9..ea9aaf2 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -285,3 +285,11 @@ unsigned char* MD5::make_hash(char *arg) return hash; } +/******************************************************************************/ +#if defined(MD5_LINUX) +double MD5::millis(){ + gettimeofday(&tv, NULL); + return (tv.tv_sec + 0.000001 * tv.tv_usec); +} +#endif + diff --git a/MD5.h b/MD5.h index ca465ac..9a7a4b1 100644 --- a/MD5.h +++ b/MD5.h @@ -43,6 +43,13 @@ class MD5 static void MD5Init(void *ctxBuf); static void MD5Final(unsigned char *result, void *ctxBuf); static void MD5Update(void *ctxBuf, const void *data, size_t size); + #if defined(MD5_LINUX) + double millis(); + #endif +private: + #if defined(MD5_LINUX) + timeval tv; + #endif }; #endif diff --git a/MD5_config.h b/MD5_config.h index 8f8bc72..b9aed23 100644 --- a/MD5_config.h +++ b/MD5_config.h @@ -3,7 +3,7 @@ #if (defined(__linux) || defined(linux)) && !defined(__ARDUINO_X86__) - #define RF24_LINUX + #define MD5_LINUX #include #include diff --git a/examples/MD5_Hash/MD5_Hash.ino b/examples/MD5_Hash/MD5_Hash.ino index f8c4834..43f2d19 100644 --- a/examples/MD5_Hash/MD5_Hash.ino +++ b/examples/MD5_Hash/MD5_Hash.ino @@ -6,15 +6,21 @@ one to generate the hex encoding of the hash, which is frequently used. */ void setup() { + unsigned long ms; //initialize serial Serial.begin(9600); //give it a second delay(1000); //generate the MD5 hash for our string + ms = micros(); unsigned char* hash=MD5::make_hash("abc"); //generate the digest (hex encoding) of our hash char *md5str = MD5::make_digest(hash, 16); free(hash); + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); //print it on our serial monitor Serial.println("PLAIN :abc"); Serial.println("EXPECTED:900150983cd24fb0d6963f7d28e17f72"); @@ -23,9 +29,14 @@ void setup() Serial.println(); //generate the MD5 hash for our string + ms = micros(); hash=MD5::make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); //generate the digest (hex encoding) of our hash md5str = MD5::make_digest(hash, 16); + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); Serial.println("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); Serial.println("EXPECTED:8215ef0796a20bcaaae116d3876c664a"); Serial.print("RESULT :"); @@ -38,9 +49,14 @@ void setup() for (int i=0;i<1000000;i++) aa[i] = 'a'; aa[1000000] = '\0'; + ms = micros(); hash=MD5::make_hash(aa); //generate the digest (hex encoding) of our hash md5str = MD5::make_digest(hash, 16); + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); Serial.println("PLAIN :1,000,000 x a"); Serial.println("EXPECTED:7707d6ae4e027c70eea2a935c2296f21"); Serial.print("RESULT :"); diff --git a/examples_Rpi/MD5_Hash.cpp b/examples_Rpi/MD5_Hash.cpp index bf87e40..aaa7e3a 100644 --- a/examples_Rpi/MD5_Hash.cpp +++ b/examples_Rpi/MD5_Hash.cpp @@ -2,10 +2,13 @@ int main(int argc, char** argv) { + double ms; //generate the MD5 hash for our string + ms = MD5::millis(); unsigned char* hash=MD5::make_hash("abc"); //generate the digest (hex encoding) of our hash char *md5str = MD5::make_digest(hash, 16); + printf("Done in (%f) ms",(MD5::millis() - ms)); free(hash); //print it on our serial monitor printf("PLAIN :abc\n"); @@ -15,9 +18,11 @@ int main(int argc, char** argv) printf("\n"); //generate the MD5 hash for our string + ms = MD5::millis(); hash=MD5::make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); //generate the digest (hex encoding) of our hash md5str = MD5::make_digest(hash, 16); + printf("Done in (%f) ms",(MD5::millis() - ms)); printf("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq\n"); printf("EXPECTED:8215ef0796a20bcaaae116d3876c664a\n"); printf("RESULT :"); @@ -29,9 +34,11 @@ int main(int argc, char** argv) for (int i=0;i<1000000;i++) aa[i] = 'a'; aa[1000000] = '\0'; + ms = MD5::millis(); hash=MD5::make_hash(aa); //generate the digest (hex encoding) of our hash md5str = MD5::make_digest(hash, 16); + printf("Done in (%f) ms",(MD5::millis() - ms)); printf("PLAIN :1,000,000 x a\n"); printf("EXPECTED:7707d6ae4e027c70eea2a935c2296f21\n"); printf("RESULT :"); From 809513ea5c247c1099dbe5a45949fce23466816b Mon Sep 17 00:00:00 2001 From: spaniakos Date: Mon, 12 Jan 2015 15:54:15 +0100 Subject: [PATCH 10/32] RPi fixes --- MD5_config.h | 2 ++ examples_Rpi/MD5_Hash.cpp | 28 +++++++++++++++------------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/MD5_config.h b/MD5_config.h index b9aed23..f7e4aae 100644 --- a/MD5_config.h +++ b/MD5_config.h @@ -9,6 +9,8 @@ #include #include #include + #include + #include #else #include #endif diff --git a/examples_Rpi/MD5_Hash.cpp b/examples_Rpi/MD5_Hash.cpp index aaa7e3a..05c528e 100644 --- a/examples_Rpi/MD5_Hash.cpp +++ b/examples_Rpi/MD5_Hash.cpp @@ -1,14 +1,16 @@ #include +MD5 md5; + int main(int argc, char** argv) { double ms; //generate the MD5 hash for our string - ms = MD5::millis(); - unsigned char* hash=MD5::make_hash("abc"); + ms = md5.millis(); + unsigned char* hash=md5.make_hash("abc"); //generate the digest (hex encoding) of our hash - char *md5str = MD5::make_digest(hash, 16); - printf("Done in (%f) ms",(MD5::millis() - ms)); + char *md5str = md5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(md5.millis() - ms)); free(hash); //print it on our serial monitor printf("PLAIN :abc\n"); @@ -18,11 +20,11 @@ int main(int argc, char** argv) printf("\n"); //generate the MD5 hash for our string - ms = MD5::millis(); - hash=MD5::make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + ms = md5.millis(); + hash= md5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); //generate the digest (hex encoding) of our hash - md5str = MD5::make_digest(hash, 16); - printf("Done in (%f) ms",(MD5::millis() - ms)); + md5str = md5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(md5.millis() - ms)); printf("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq\n"); printf("EXPECTED:8215ef0796a20bcaaae116d3876c664a\n"); printf("RESULT :"); @@ -30,15 +32,15 @@ int main(int argc, char** argv) printf("\n"); //generate the MD5 hash for our string - char aa[100001]; + char aa[1000001]; for (int i=0;i<1000000;i++) aa[i] = 'a'; aa[1000000] = '\0'; - ms = MD5::millis(); - hash=MD5::make_hash(aa); + ms = md5.millis(); + hash= md5.make_hash(aa); //generate the digest (hex encoding) of our hash - md5str = MD5::make_digest(hash, 16); - printf("Done in (%f) ms",(MD5::millis() - ms)); + md5str = md5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(md5.millis() - ms)); printf("PLAIN :1,000,000 x a\n"); printf("EXPECTED:7707d6ae4e027c70eea2a935c2296f21\n"); printf("RESULT :"); From e140f1368d584283baebe057a513b1c641fb740b Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 21:07:55 +0100 Subject: [PATCH 11/32] Added --- MD5.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/MD5.h b/MD5.h index 9a7a4b1..af5d67e 100644 --- a/MD5.h +++ b/MD5.h @@ -39,6 +39,8 @@ class MD5 MD5(); static unsigned char* make_hash(char *arg); static char* make_digest(const unsigned char *digest, int len); + static char* md5(char *arg); + static char* hmac_md5(char *arh,char *key); static const void *body(void *ctxBuf, const void *data, size_t size); static void MD5Init(void *ctxBuf); static void MD5Final(unsigned char *result, void *ctxBuf); From 8aa8b2213f6e3c2f2f9a823c38671eb4eb77dc22 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 21:10:45 +0100 Subject: [PATCH 12/32] added md5 and hmac this is a test code --- MD5.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MD5.h b/MD5.h index af5d67e..b7bb21f 100644 --- a/MD5.h +++ b/MD5.h @@ -40,7 +40,7 @@ class MD5 static unsigned char* make_hash(char *arg); static char* make_digest(const unsigned char *digest, int len); static char* md5(char *arg); - static char* hmac_md5(char *arh,char *key); + static char* hmac_md5(char *key,char *arg); static const void *body(void *ctxBuf, const void *data, size_t size); static void MD5Init(void *ctxBuf); static void MD5Final(unsigned char *result, void *ctxBuf); From 8e1c6a67b14edc6d5b3854cf3a0f9552bc4a9071 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 21:23:40 +0100 Subject: [PATCH 13/32] Update MD5_config.h --- MD5_config.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/MD5_config.h b/MD5_config.h index f7e4aae..1fc575e 100644 --- a/MD5_config.h +++ b/MD5_config.h @@ -1,6 +1,10 @@ #ifndef MD5_config_h #define MD5_config_h +#define HMAC_IPAD 0x36 +#define HMAC_OPAD 0x5c +#define BLOCK_SIZE 16 + #if (defined(__linux) || defined(linux)) && !defined(__ARDUINO_X86__) #define MD5_LINUX From 8c1dc7c0c8f6d9e976ddf7a8cb9ec3ced68c4db5 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 21:33:15 +0100 Subject: [PATCH 14/32] added md5 and hmac md5 experimantal code --- MD5.cpp | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/MD5.cpp b/MD5.cpp index b7a8a51..1ac9d70 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -281,18 +281,45 @@ void MD5::MD5Final(unsigned char *result, void *ctxBuf) unsigned char* MD5::make_hash(char *arg) { MD5_CTX context; - unsigned char * hash = (unsigned char *) malloc(16); + unsigned char * hash = (unsigned char *) malloc(BLOCK_SIZE); MD5Init(&context); MD5Update(&context, arg, strlen(arg)); MD5Final(hash, &context); return hash; } +static char* md5(char *arg){ + return md5.make_digest(make_hash(arg), BLOCK_SIZE); +} + +static char* hmac_md5(char *key,char *arg){ + char l_key[BLOCK_SIZE]; + if (strlen(key) > BLOCK_SIZE){ + memcpy(&l_key,md5(key),BLOCK_SIZE) // keys longer than blocksize are shortened + } + if (length(key) < BLOCK_SIZE){ + memcpy(l_key,key,strlen(key)); + //use the key as is + //for (int i=(BLOCK_SIZE - strlen(key));i Date: Sun, 18 Jan 2015 21:34:20 +0100 Subject: [PATCH 15/32] Update MD5_Hash.ino --- examples/MD5_Hash/MD5_Hash.ino | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/MD5_Hash/MD5_Hash.ino b/examples/MD5_Hash/MD5_Hash.ino index 43f2d19..e87dc84 100644 --- a/examples/MD5_Hash/MD5_Hash.ino +++ b/examples/MD5_Hash/MD5_Hash.ino @@ -13,9 +13,9 @@ void setup() delay(1000); //generate the MD5 hash for our string ms = micros(); - unsigned char* hash=MD5::make_hash("abc"); + unsigned char* hash=md5.make_hash("abc"); //generate the digest (hex encoding) of our hash - char *md5str = MD5::make_digest(hash, 16); + char *md5str = md5.make_digest(hash, 16); free(hash); Serial.print("done. ("); ms = micros() - ms; @@ -30,9 +30,9 @@ void setup() //generate the MD5 hash for our string ms = micros(); - hash=MD5::make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + hash=md5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); //generate the digest (hex encoding) of our hash - md5str = MD5::make_digest(hash, 16); + md5str = md5.make_digest(hash, 16); Serial.print("done. ("); ms = micros() - ms; Serial.print(ms); @@ -50,9 +50,9 @@ void setup() aa[i] = 'a'; aa[1000000] = '\0'; ms = micros(); - hash=MD5::make_hash(aa); + hash=md5.make_hash(aa); //generate the digest (hex encoding) of our hash - md5str = MD5::make_digest(hash, 16); + md5str = md5.make_digest(hash, 16); Serial.print("done. ("); ms = micros() - ms; Serial.print(ms); From d7282d6a9b129e52699636074a55694a6b239fdb Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 21:34:37 +0100 Subject: [PATCH 16/32] Update MD5_Hash.cpp --- examples_Rpi/MD5_Hash.cpp | 2 -- 1 file changed, 2 deletions(-) diff --git a/examples_Rpi/MD5_Hash.cpp b/examples_Rpi/MD5_Hash.cpp index 05c528e..6f88699 100644 --- a/examples_Rpi/MD5_Hash.cpp +++ b/examples_Rpi/MD5_Hash.cpp @@ -1,7 +1,5 @@ #include -MD5 md5; - int main(int argc, char** argv) { double ms; From c31d425b102507027c1be68cae43d591cc85d8d7 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 21:40:38 +0100 Subject: [PATCH 17/32] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9adfd07..252b987 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -This is an MD5 library for the Arduino, based on scottmac's MD5 library, which you can find here: +This is an MD5 library for the Arduino, based on tzikis's MD5 library, which you can find here: +https://github.com/tzikis/arduino. +Tzikis library was based on scottmac`s library, which you can find here: https://github.com/scottmac/arduino -I created this because I was having a really hard time finding an easy-to-install and use libray for the Arduino, -so I decided to make my own. There is an example on how to use it. +This library provides an easy way of using md5 for both arduino and Raspberyy Pi. + +It includes MD5 and HMAC-MD5. ### Installation Create a folder named _MD5_ in the _libraries_ folder inside your Arduino sketch folder. If the From b2bba9c4dcdcb079737e05b6e29ab2d459c4de37 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 21:48:49 +0100 Subject: [PATCH 18/32] added md5 and hmac testing code --- MD5.cpp | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/MD5.cpp b/MD5.cpp index 1ac9d70..37c0201 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -299,10 +299,9 @@ static char* hmac_md5(char *key,char *arg){ } if (length(key) < BLOCK_SIZE){ memcpy(l_key,key,strlen(key)); - //use the key as is - //for (int i=(BLOCK_SIZE - strlen(key));i Date: Sun, 18 Jan 2015 22:01:48 +0100 Subject: [PATCH 19/32] Update MD5.cpp --- MD5.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MD5.cpp b/MD5.cpp index 37c0201..b761efd 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -310,7 +310,7 @@ static char* hmac_md5(char *key,char *arg){ o_key_pad[i] = HMAC_OPAD ^ l_key[i]; i_key_pad[i] = HMAC_IPAD ^ l_key[i]; } - return md5(strcat(o_key_pad,strcat(i_key_pad,arg))); + return md5(strcat(o_key_pad,md5(strcat(i_key_pad,arg)))); } /******************************************************************************/ From f7ec99fddae97084979bcbd308b97b851eed07e4 Mon Sep 17 00:00:00 2001 From: Georgios Spanos Date: Sun, 18 Jan 2015 22:13:52 +0100 Subject: [PATCH 20/32] Update MD5.cpp --- MD5.cpp | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/MD5.cpp b/MD5.cpp index b761efd..3703358 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -294,23 +294,24 @@ static char* md5(char *arg){ static char* hmac_md5(char *key,char *arg){ char l_key[BLOCK_SIZE]; + nt i = 0; + if (strlen(key) > BLOCK_SIZE){ memcpy(&l_key,md5(key),BLOCK_SIZE) // keys longer than blocksize are shortened - } - if (length(key) < BLOCK_SIZE){ - memcpy(l_key,key,strlen(key)); - for (int i=(BLOCK_SIZE - strlen(key));i0;i++){ sprintf(l_key[i],"%02x",0x00); // keys shorter than blocksize are zero-padded } } - int i = 0; - char o_key_pad[BLOCK_SIZE]; - char i_key_pad[BLOCK_SIZE]; - for (i=0;i<16;i++){ - o_key_pad[i] = HMAC_OPAD ^ l_key[i]; - i_key_pad[i] = HMAC_IPAD ^ l_key[i]; - } - return md5(strcat(o_key_pad,md5(strcat(i_key_pad,arg)))); + char o_key_pad[BLOCK_SIZE]; + char i_key_pad[BLOCK_SIZE]; + for (i=0;i<16;i++){ + o_key_pad[i] = HMAC_OPAD ^ l_key[i]; + i_key_pad[i] = HMAC_IPAD ^ l_key[i]; + + } + return md5(strcat(o_key_pad,md5(strcat(i_key_pad,arg)))); } /******************************************************************************/ From 59eec548609aa85a02385865920f90c9fb014f01 Mon Sep 17 00:00:00 2001 From: darky Date: Tue, 20 Jan 2015 18:06:05 +0100 Subject: [PATCH 21/32] Hmac added and tested NO RPI YET --- MD5.cpp | 57 ++++++++++++++++++++------------ MD5.h | 6 ++-- examples/MD5_Hash/MD5_Hash.ino | 40 ++++++++++++++++------- printf.h | 59 ++++++++++++++++++++++++++++++++++ 4 files changed, 128 insertions(+), 34 deletions(-) create mode 100644 printf.h diff --git a/MD5.cpp b/MD5.cpp index 3703358..9ed156d 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -288,30 +288,48 @@ unsigned char* MD5::make_hash(char *arg) return hash; } -static char* md5(char *arg){ - return md5.make_digest(make_hash(arg), BLOCK_SIZE); +char* MD5::md5(char *arg){ + return make_digest(make_hash(arg), BLOCK_SIZE); } -static char* hmac_md5(char *key,char *arg){ - char l_key[BLOCK_SIZE]; - nt i = 0; +void MD5::hmac_md5(const void *text, int text_len,void *key, int key_len, unsigned char *digest){ + MD5_CTX context; + unsigned char k_ipad[65]; + unsigned char k_opad[65]; + unsigned char tk[BLOCK_SIZE]; + int i; - if (strlen(key) > BLOCK_SIZE){ - memcpy(&l_key,md5(key),BLOCK_SIZE) // keys longer than blocksize are shortened - }else (strlen(key) <= BLOCK_SIZE){ - memcpy(&l_key,key,strlen(key)); - for (i=(BLOCK_SIZE - strlen(key));i>0;i++){ - sprintf(l_key[i],"%02x",0x00); // keys shorter than blocksize are zero-padded - } - } - char o_key_pad[BLOCK_SIZE]; - char i_key_pad[BLOCK_SIZE]; - for (i=0;i<16;i++){ - o_key_pad[i] = HMAC_OPAD ^ l_key[i]; - i_key_pad[i] = HMAC_IPAD ^ l_key[i]; + if (key_len > 64){ + MD5_CTX tctx; + MD5Init(&tctx); + MD5Update(&tctx, key, key_len); + MD5Final(tk,&tctx); + key = tk; + key_len= 16; + } + + memset( k_ipad, 0, sizeof(k_ipad)); + memset( k_opad, 0, sizeof(k_opad)); + memcpy( k_ipad, key, key_len); + memcpy( k_opad, key, key_len); + + for(i = 0; i < 64; i++){ + k_ipad[i] ^= HMAC_IPAD; + k_opad[i] ^= HMAC_OPAD; } - return md5(strcat(o_key_pad,md5(strcat(i_key_pad,arg)))); + + //inner + MD5Init(&context); + MD5Update(&context, k_ipad, 64); + MD5Update(&context, text, text_len); + MD5Final(digest, &context); + + //outer + MD5Init(&context); + MD5Update(&context, k_opad, 64); + MD5Update(&context, digest, 16); + MD5Final(digest,&context); } /******************************************************************************/ @@ -320,6 +338,5 @@ double MD5::millis(){ gettimeofday(&tv, NULL); return (tv.tv_sec + 0.000001 * tv.tv_usec); } -extern MD5 md5; #endif diff --git a/MD5.h b/MD5.h index b7bb21f..681ed0b 100644 --- a/MD5.h +++ b/MD5.h @@ -39,8 +39,8 @@ class MD5 MD5(); static unsigned char* make_hash(char *arg); static char* make_digest(const unsigned char *digest, int len); - static char* md5(char *arg); - static char* hmac_md5(char *key,char *arg); + char* md5(char *arg); + void hmac_md5(const void *text, int text_len,void *key, int key_len, unsigned char *digest); static const void *body(void *ctxBuf, const void *data, size_t size); static void MD5Init(void *ctxBuf); static void MD5Final(unsigned char *result, void *ctxBuf); @@ -53,5 +53,5 @@ class MD5 timeval tv; #endif }; - +extern MD5 hashMD5; #endif diff --git a/examples/MD5_Hash/MD5_Hash.ino b/examples/MD5_Hash/MD5_Hash.ino index e87dc84..4955ffc 100644 --- a/examples/MD5_Hash/MD5_Hash.ino +++ b/examples/MD5_Hash/MD5_Hash.ino @@ -1,4 +1,6 @@ #include +#include "printf" +MD5 hashMD5; /* This is en example of how to use my MD5 library. It provides two easy-to-use methods, one for generating the MD5 hash, and the second @@ -6,6 +8,7 @@ one to generate the hex encoding of the hash, which is frequently used. */ void setup() { + printf_begin(); unsigned long ms; //initialize serial Serial.begin(9600); @@ -13,10 +16,7 @@ void setup() delay(1000); //generate the MD5 hash for our string ms = micros(); - unsigned char* hash=md5.make_hash("abc"); - //generate the digest (hex encoding) of our hash - char *md5str = md5.make_digest(hash, 16); - free(hash); + char *md5str = hashMD5.md5("abc");; Serial.print("done. ("); ms = micros() - ms; Serial.print(ms); @@ -30,9 +30,8 @@ void setup() //generate the MD5 hash for our string ms = micros(); - hash=md5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + md5str = hashMD5.md5("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); //generate the digest (hex encoding) of our hash - md5str = md5.make_digest(hash, 16); Serial.print("done. ("); ms = micros() - ms; Serial.print(ms); @@ -50,9 +49,7 @@ void setup() aa[i] = 'a'; aa[1000000] = '\0'; ms = micros(); - hash=md5.make_hash(aa); - //generate the digest (hex encoding) of our hash - md5str = md5.make_digest(hash, 16); + md5str = hashMD5.md5(aa); Serial.print("done. ("); ms = micros() - ms; Serial.print(ms); @@ -62,8 +59,29 @@ void setup() Serial.print("RESULT :"); Serial.println(md5str); Serial.println(); - //Give the Memory back to the System if you run the md5 Hash generation in a loop - free(md5str); + + unsigned char digest[16]; + unsigned char key[5] = "Jefe"; + int key_len = 4; + unsigned char text[29] = "what do ya want for nothing?"; + int text_len = 28; + ms = micros(); + hashMD5.hmac_md5(text, text_len, key, key_len, digest); + for (int j=0;j<16;j++){ + printf("%02x",digest[i]); + } + md5str = hashMD5.make_digest(digest,16); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :what do ya want for nothing?"); + Serial.println("KEY :Jefe"); + Serial.println("EXPECTED:750c783ee6ab0b503eaa86e310a5db738"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); } void loop() diff --git a/printf.h b/printf.h new file mode 100644 index 0000000..d54e661 --- /dev/null +++ b/printf.h @@ -0,0 +1,59 @@ +/* + Copyright (C) 2011 J. Coliz + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + version 2 as published by the Free Software Foundation. + */ + /* Galileo support from spaniakos */ + +/** + * @file printf.h + * + * Setup necessary to direct stdout to the Arduino Serial library, which + * enables 'printf' + */ + +#ifndef __PRINTF_H__ +#define __PRINTF_H__ + +#if defined (ARDUINO) && !defined (__arm__) && !defined(__ARDUINO_X86__) + +int serial_putc( char c, FILE * ) +{ + Serial.write( c ); + + return c; +} + +void printf_begin(void) +{ + fdevopen( &serial_putc, 0 ); +} + +#elif defined (__arm__) + +void printf_begin(void){} + +#elif defined(__ARDUINO_X86__) +int serial_putc( char c, FILE * ) +{ + Serial.write( c ); + + return c; +} + +void printf_begin(void) +{ + //JESUS - For reddirect stdout to /dev/ttyGS0 (Serial Monitor port) + stdout = freopen("/dev/ttyGS0","w",stdout); + delay(500); + printf("redirecting to Serial..."); + + //JESUS ----------------------------------------------------------- +} +#else +#error This example is only for use on Arduino. +#endif // ARDUINO + +#endif // __PRINTF_H__ From 4f186a9d50aac3f1ca2ddee47e491d8ddc9ecc90 Mon Sep 17 00:00:00 2001 From: darky Date: Wed, 21 Jan 2015 11:32:45 +0100 Subject: [PATCH 22/32] examples hmac --- examples/MD5_Hash/MD5_Hash.ino | 164 ++++++++++++++++++++++++++++++--- 1 file changed, 153 insertions(+), 11 deletions(-) diff --git a/examples/MD5_Hash/MD5_Hash.ino b/examples/MD5_Hash/MD5_Hash.ino index 4955ffc..4736b24 100644 --- a/examples/MD5_Hash/MD5_Hash.ino +++ b/examples/MD5_Hash/MD5_Hash.ino @@ -1,5 +1,5 @@ #include -#include "printf" + MD5 hashMD5; /* This is en example of how to use my MD5 library. It provides two @@ -8,7 +8,6 @@ one to generate the hex encoding of the hash, which is frequently used. */ void setup() { - printf_begin(); unsigned long ms; //initialize serial Serial.begin(9600); @@ -60,16 +59,35 @@ void setup() Serial.println(md5str); Serial.println(); - unsigned char digest[16]; - unsigned char key[5] = "Jefe"; - int key_len = 4; - unsigned char text[29] = "what do ya want for nothing?"; - int text_len = 28; + unsigned char digest[17]; + digest[17] = 0x00; + char key[] = {0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b, 0x00}; + int key_len; + key_len = strlen(key); + char *text = "Hi There"; + int text_len; + text_len = strlen(text); ms = micros(); hashMD5.hmac_md5(text, text_len, key, key_len, digest); - for (int j=0;j<16;j++){ - printf("%02x",digest[i]); - } + md5str = hashMD5.make_digest(digest,16); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Hi There"); + Serial.println("KEY :0x0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b"); + Serial.println("EXPECTED:9294727a3638bb1c13f48ef8158bfc9d"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char *key2 = "Jefe"; + key_len = strlen(key2); + char *text2 = "what do ya want for nothing?"; + text_len = strlen(text2); + ms = micros(); + hashMD5.hmac_md5(text2, text_len, key2, key_len, digest); md5str = hashMD5.make_digest(digest,16); //generate the digest (hex encoding) of our hash Serial.print("done. ("); @@ -78,7 +96,131 @@ void setup() Serial.println(" micros)"); Serial.println("PLAIN :what do ya want for nothing?"); Serial.println("KEY :Jefe"); - Serial.println("EXPECTED:750c783ee6ab0b503eaa86e310a5db738"); + Serial.println("EXPECTED:750c783e6ab0b503eaa86e310a5db738"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key3[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, 0x00}; + key_len = strlen(key3); + char text3[] = {0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, 0x00 + }; + text_len = strlen(text3); + Serial.println(text_len); + ms = micros(); + hashMD5.hmac_md5(text3, text_len, key3, key_len, digest); + md5str = hashMD5.make_digest(digest,16); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"); + Serial.println("KEY :0xdd repeated 50 times"); + Serial.println("EXPECTED:56be34521d144c88dbb8c733f0e8b3f6"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key4[] = {0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0a, + 0x0b,0x0c,0x0d,0x0e,0x0f,0x10,0x11,0x12,0x13,0x14, + 0x15,0x16,0x17,0x18,0x19, 0x00}; + key_len = strlen(key4); + char text4[] = {0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, 0x00 + }; + text_len = strlen(text4); + ms = micros(); + hashMD5.hmac_md5(text4, text_len, key4, key_len, digest); + md5str = hashMD5.make_digest(digest,16); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :0x0102030405060708090a0b0c0d0e0f10111213141516171819"); + Serial.println("KEY :0xcd repeated 50 times"); + Serial.println("EXPECTED:697eaf0aca3a3aea3a75164746ffaa79"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key5[] = {0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x00}; + key_len = strlen(key5); + char *text5 = "Test With Truncation"; + text_len = strlen(text5); + ms = micros(); + hashMD5.hmac_md5(text5, text_len, key5, key_len, digest); + md5str = hashMD5.make_digest(digest,16); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Test With Truncation"); + Serial.println("KEY :0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c"); + Serial.println("EXPECTED:56461ef2342edc00f9bab995690efd4c"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key6[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 + }; + key_len = strlen(key6); + char *text6 = "Test Using Larger Than Block-Size Key - Hash Key First"; + text_len = strlen(text6); + ms = micros(); + hashMD5.hmac_md5(text6, text_len, key6, key_len, digest); + md5str = hashMD5.make_digest(digest,16); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Test Using Larger Than Block-Size Key - Hash Key First"); + Serial.println("KEY :0xaa repeated 80 times"); + Serial.println("EXPECTED:6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key7[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 + }; + key_len = strlen(key7); + char *text7 = "Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data"; + text_len = strlen(text7); + ms = micros(); + hashMD5.hmac_md5(text7, text_len, key7, key_len, digest); + md5str = hashMD5.make_digest(digest,16); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data"); + Serial.println("KEY :0xaa repeated 80 times"); + Serial.println("EXPECTED:6f630fad67cda0ee1fb1f562db3aa53e"); Serial.print("RESULT :"); Serial.println(md5str); Serial.println(); From dcdc915dee4f693a37cc5dc573c4c3e729b270fd Mon Sep 17 00:00:00 2001 From: darky Date: Thu, 22 Jan 2015 14:15:31 +0100 Subject: [PATCH 23/32] HMAC md5 --- MD5.cpp | 50 ++++++++- MD5.h | 7 +- README.md | 10 +- examples/HMAC_MD5/HMAC_MD5.ino | 181 +++++++++++++++++++++++++++++++++ examples/MD5_Hash/MD5_Hash.ino | 170 +------------------------------ examples_Rpi/HMAC_MD5.cpp | 51 ++++++++++ examples_Rpi/MD5_Hash.cpp | 29 +++--- examples_Rpi/Makefile | 2 +- 8 files changed, 306 insertions(+), 194 deletions(-) create mode 100644 examples/HMAC_MD5/HMAC_MD5.ino create mode 100644 examples_Rpi/HMAC_MD5.cpp diff --git a/MD5.cpp b/MD5.cpp index 9ed156d..143aa8e 100644 --- a/MD5.cpp +++ b/MD5.cpp @@ -278,17 +278,17 @@ void MD5::MD5Final(unsigned char *result, void *ctxBuf) memset(ctx, 0, sizeof(*ctx)); } -unsigned char* MD5::make_hash(char *arg) +unsigned char* MD5::make_hash(const void *arg) { MD5_CTX context; unsigned char * hash = (unsigned char *) malloc(BLOCK_SIZE); MD5Init(&context); - MD5Update(&context, arg, strlen(arg)); + MD5Update(&context, arg, strlen((char*)arg)); MD5Final(hash, &context); return hash; } -char* MD5::md5(char *arg){ +char* MD5::md5(const void *arg){ return make_digest(make_hash(arg), BLOCK_SIZE); } @@ -332,6 +332,50 @@ void MD5::hmac_md5(const void *text, int text_len,void *key, int key_len, unsign MD5Final(digest,&context); } +char* MD5::hmac_md5(const void *text, int text_len,void *key, int key_len){ + unsigned char digest[17]; + digest[16] = 0x00; + MD5_CTX context; + unsigned char k_ipad[65]; + unsigned char k_opad[65]; + unsigned char tk[BLOCK_SIZE]; + int i; + + if (key_len > 64){ + MD5_CTX tctx; + MD5Init(&tctx); + MD5Update(&tctx, key, key_len); + MD5Final(tk,&tctx); + + key = tk; + key_len= 16; + } + + memset( k_ipad, 0, sizeof(k_ipad)); + memset( k_opad, 0, sizeof(k_opad)); + memcpy( k_ipad, key, key_len); + memcpy( k_opad, key, key_len); + + for(i = 0; i < 64; i++){ + k_ipad[i] ^= HMAC_IPAD; + k_opad[i] ^= HMAC_OPAD; + } + + //inner + MD5Init(&context); + MD5Update(&context, k_ipad, 64); + MD5Update(&context, text, text_len); + MD5Final(digest, &context); + + //outer + MD5Init(&context); + MD5Update(&context, k_opad, 64); + MD5Update(&context, digest, 16); + MD5Final(digest,&context); + + return make_digest(digest,BLOCK_SIZE); +} + /******************************************************************************/ #if defined(MD5_LINUX) double MD5::millis(){ diff --git a/MD5.h b/MD5.h index 681ed0b..1b46caa 100644 --- a/MD5.h +++ b/MD5.h @@ -37,10 +37,11 @@ class MD5 { public: MD5(); - static unsigned char* make_hash(char *arg); - static char* make_digest(const unsigned char *digest, int len); - char* md5(char *arg); + unsigned char* make_hash(const void *arg); + char* make_digest(const unsigned char *digest, int len); + char* md5(const void *arg); void hmac_md5(const void *text, int text_len,void *key, int key_len, unsigned char *digest); + char* hmac_md5(const void *text, int text_len,void *key, int key_len); static const void *body(void *ctxBuf, const void *data, size_t size); static void MD5Init(void *ctxBuf); static void MD5Final(unsigned char *result, void *ctxBuf); diff --git a/README.md b/README.md index 252b987..c33f692 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,7 @@ You're done. Time for a mojito ### Usage -If you create md5 Hashes in a loop you must give the Memory back to the System -``` -unsigned char* hash=MD5::make_hash("hello world"); -//generate the digest (hex encoding) of our hash -char *md5str = MD5::make_digest(hash, 16); -//print it on our serial monitor -Serial.println(md5str); -//Give the Memory back to the System if you run the md5 Hash generation in a loop -free(md5str); +see examples for md5 and hmac md5 ``` ### Raspberry pi diff --git a/examples/HMAC_MD5/HMAC_MD5.ino b/examples/HMAC_MD5/HMAC_MD5.ino new file mode 100644 index 0000000..0c0593a --- /dev/null +++ b/examples/HMAC_MD5/HMAC_MD5.ino @@ -0,0 +1,181 @@ +#include + +MD5 hashMD5; +/* +This is en example of how to use my MD5 library. It provides two +easy-to-use methods, one for generating the MD5 hash, and the second +one to generate the hex encoding of the hash, which is frequently used. +*/ +void setup() +{ + unsigned long ms; + //initialize serial + Serial.begin(9600); + //give it a second + delay(1000); + Serial.println("*********************"); + Serial.println("**HMAC MD5 examples**"); + Serial.println("*********************"); + Serial.println(); + + char key[] = {0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b, 0x00}; + int key_len; + key_len = strlen(key); + char *text = "Hi There"; + int text_len; + text_len = strlen(text); + ms = micros(); + char *md5str = hashMD5.hmac_md5(text, text_len, key, key_len); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Hi There"); + Serial.println("KEY :0x0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b"); + Serial.println("EXPECTED:9294727a3638bb1c13f48ef8158bfc9d"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char *key2 = "Jefe"; + key_len = strlen(key2); + char *text2 = "what do ya want for nothing?"; + text_len = strlen(text2); + ms = micros(); + md5str = hashMD5.hmac_md5(text2, text_len, key2, key_len); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :what do ya want for nothing?"); + Serial.println("KEY :Jefe"); + Serial.println("EXPECTED:750c783e6ab0b503eaa86e310a5db738"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key3[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, 0x00}; + key_len = strlen(key3); + char text3[] = {0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, 0x00 + }; + text_len = strlen(text3); + Serial.println(text_len); + ms = micros(); + md5str = hashMD5.hmac_md5(text3, text_len, key3, key_len); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"); + Serial.println("KEY :0xdd repeated 50 times"); + Serial.println("EXPECTED:56be34521d144c88dbb8c733f0e8b3f6"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key4[] = {0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0a, + 0x0b,0x0c,0x0d,0x0e,0x0f,0x10,0x11,0x12,0x13,0x14, + 0x15,0x16,0x17,0x18,0x19, 0x00}; + key_len = strlen(key4); + char text4[] = {0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, 0x00 + }; + text_len = strlen(text4); + ms = micros(); + md5str = hashMD5.hmac_md5(text4, text_len, key4, key_len); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :0x0102030405060708090a0b0c0d0e0f10111213141516171819"); + Serial.println("KEY :0xcd repeated 50 times"); + Serial.println("EXPECTED:697eaf0aca3a3aea3a75164746ffaa79"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key5[] = {0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x00}; + key_len = strlen(key5); + char *text5 = "Test With Truncation"; + text_len = strlen(text5); + ms = micros(); + md5str = hashMD5.hmac_md5(text5, text_len, key5, key_len); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Test With Truncation"); + Serial.println("KEY :0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c"); + Serial.println("EXPECTED:56461ef2342edc00f9bab995690efd4c"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key6[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 + }; + key_len = strlen(key6); + char *text6 = "Test Using Larger Than Block-Size Key - Hash Key First"; + text_len = strlen(text6); + ms = micros(); + md5str = hashMD5.hmac_md5(text6, text_len, key6, key_len); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Test Using Larger Than Block-Size Key - Hash Key First"); + Serial.println("KEY :0xaa repeated 80 times"); + Serial.println("EXPECTED:6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); + + char key7[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 + }; + key_len = strlen(key7); + char *text7 = "Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data"; + text_len = strlen(text7); + ms = micros(); + md5str = hashMD5.hmac_md5(text7, text_len, key7, key_len); + //generate the digest (hex encoding) of our hash + Serial.print("done. ("); + ms = micros() - ms; + Serial.print(ms); + Serial.println(" micros)"); + Serial.println("PLAIN :Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data"); + Serial.println("KEY :0xaa repeated 80 times"); + Serial.println("EXPECTED:6f630fad67cda0ee1fb1f562db3aa53e"); + Serial.print("RESULT :"); + Serial.println(md5str); + Serial.println(); +} + +void loop() +{ +} diff --git a/examples/MD5_Hash/MD5_Hash.ino b/examples/MD5_Hash/MD5_Hash.ino index 4736b24..7e228b9 100644 --- a/examples/MD5_Hash/MD5_Hash.ino +++ b/examples/MD5_Hash/MD5_Hash.ino @@ -13,6 +13,10 @@ void setup() Serial.begin(9600); //give it a second delay(1000); + Serial.println("********************"); + Serial.println("****MD5 examples****"); + Serial.println("********************"); + Serial.println(); //generate the MD5 hash for our string ms = micros(); char *md5str = hashMD5.md5("abc");; @@ -58,172 +62,6 @@ void setup() Serial.print("RESULT :"); Serial.println(md5str); Serial.println(); - - unsigned char digest[17]; - digest[17] = 0x00; - char key[] = {0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b, 0x00}; - int key_len; - key_len = strlen(key); - char *text = "Hi There"; - int text_len; - text_len = strlen(text); - ms = micros(); - hashMD5.hmac_md5(text, text_len, key, key_len, digest); - md5str = hashMD5.make_digest(digest,16); - //generate the digest (hex encoding) of our hash - Serial.print("done. ("); - ms = micros() - ms; - Serial.print(ms); - Serial.println(" micros)"); - Serial.println("PLAIN :Hi There"); - Serial.println("KEY :0x0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b"); - Serial.println("EXPECTED:9294727a3638bb1c13f48ef8158bfc9d"); - Serial.print("RESULT :"); - Serial.println(md5str); - Serial.println(); - - char *key2 = "Jefe"; - key_len = strlen(key2); - char *text2 = "what do ya want for nothing?"; - text_len = strlen(text2); - ms = micros(); - hashMD5.hmac_md5(text2, text_len, key2, key_len, digest); - md5str = hashMD5.make_digest(digest,16); - //generate the digest (hex encoding) of our hash - Serial.print("done. ("); - ms = micros() - ms; - Serial.print(ms); - Serial.println(" micros)"); - Serial.println("PLAIN :what do ya want for nothing?"); - Serial.println("KEY :Jefe"); - Serial.println("EXPECTED:750c783e6ab0b503eaa86e310a5db738"); - Serial.print("RESULT :"); - Serial.println(md5str); - Serial.println(); - - char key3[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, 0x00}; - key_len = strlen(key3); - char text3[] = {0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, - 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, - 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, - 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, - 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, 0x00 - }; - text_len = strlen(text3); - Serial.println(text_len); - ms = micros(); - hashMD5.hmac_md5(text3, text_len, key3, key_len, digest); - md5str = hashMD5.make_digest(digest,16); - //generate the digest (hex encoding) of our hash - Serial.print("done. ("); - ms = micros() - ms; - Serial.print(ms); - Serial.println(" micros)"); - Serial.println("PLAIN :0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"); - Serial.println("KEY :0xdd repeated 50 times"); - Serial.println("EXPECTED:56be34521d144c88dbb8c733f0e8b3f6"); - Serial.print("RESULT :"); - Serial.println(md5str); - Serial.println(); - - char key4[] = {0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0a, - 0x0b,0x0c,0x0d,0x0e,0x0f,0x10,0x11,0x12,0x13,0x14, - 0x15,0x16,0x17,0x18,0x19, 0x00}; - key_len = strlen(key4); - char text4[] = {0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, - 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, - 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, - 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, - 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, 0x00 - }; - text_len = strlen(text4); - ms = micros(); - hashMD5.hmac_md5(text4, text_len, key4, key_len, digest); - md5str = hashMD5.make_digest(digest,16); - //generate the digest (hex encoding) of our hash - Serial.print("done. ("); - ms = micros() - ms; - Serial.print(ms); - Serial.println(" micros)"); - Serial.println("PLAIN :0x0102030405060708090a0b0c0d0e0f10111213141516171819"); - Serial.println("KEY :0xcd repeated 50 times"); - Serial.println("EXPECTED:697eaf0aca3a3aea3a75164746ffaa79"); - Serial.print("RESULT :"); - Serial.println(md5str); - Serial.println(); - - char key5[] = {0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x00}; - key_len = strlen(key5); - char *text5 = "Test With Truncation"; - text_len = strlen(text5); - ms = micros(); - hashMD5.hmac_md5(text5, text_len, key5, key_len, digest); - md5str = hashMD5.make_digest(digest,16); - //generate the digest (hex encoding) of our hash - Serial.print("done. ("); - ms = micros() - ms; - Serial.print(ms); - Serial.println(" micros)"); - Serial.println("PLAIN :Test With Truncation"); - Serial.println("KEY :0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c"); - Serial.println("EXPECTED:56461ef2342edc00f9bab995690efd4c"); - Serial.print("RESULT :"); - Serial.println(md5str); - Serial.println(); - - char key6[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 - }; - key_len = strlen(key6); - char *text6 = "Test Using Larger Than Block-Size Key - Hash Key First"; - text_len = strlen(text6); - ms = micros(); - hashMD5.hmac_md5(text6, text_len, key6, key_len, digest); - md5str = hashMD5.make_digest(digest,16); - //generate the digest (hex encoding) of our hash - Serial.print("done. ("); - ms = micros() - ms; - Serial.print(ms); - Serial.println(" micros)"); - Serial.println("PLAIN :Test Using Larger Than Block-Size Key - Hash Key First"); - Serial.println("KEY :0xaa repeated 80 times"); - Serial.println("EXPECTED:6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd"); - Serial.print("RESULT :"); - Serial.println(md5str); - Serial.println(); - - char key7[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, - 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 - }; - key_len = strlen(key7); - char *text7 = "Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data"; - text_len = strlen(text7); - ms = micros(); - hashMD5.hmac_md5(text7, text_len, key7, key_len, digest); - md5str = hashMD5.make_digest(digest,16); - //generate the digest (hex encoding) of our hash - Serial.print("done. ("); - ms = micros() - ms; - Serial.print(ms); - Serial.println(" micros)"); - Serial.println("PLAIN :Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data"); - Serial.println("KEY :0xaa repeated 80 times"); - Serial.println("EXPECTED:6f630fad67cda0ee1fb1f562db3aa53e"); - Serial.print("RESULT :"); - Serial.println(md5str); - Serial.println(); } void loop() diff --git a/examples_Rpi/HMAC_MD5.cpp b/examples_Rpi/HMAC_MD5.cpp new file mode 100644 index 0000000..6f88699 --- /dev/null +++ b/examples_Rpi/HMAC_MD5.cpp @@ -0,0 +1,51 @@ +#include + +int main(int argc, char** argv) +{ + double ms; + //generate the MD5 hash for our string + ms = md5.millis(); + unsigned char* hash=md5.make_hash("abc"); + //generate the digest (hex encoding) of our hash + char *md5str = md5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(md5.millis() - ms)); + free(hash); + //print it on our serial monitor + printf("PLAIN :abc\n"); + printf("EXPECTED:900150983cd24fb0d6963f7d28e17f72\n"); + printf("RESULT :"); + printf("%s\n",md5str); + printf("\n"); + + //generate the MD5 hash for our string + ms = md5.millis(); + hash= md5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + //generate the digest (hex encoding) of our hash + md5str = md5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(md5.millis() - ms)); + printf("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq\n"); + printf("EXPECTED:8215ef0796a20bcaaae116d3876c664a\n"); + printf("RESULT :"); + printf("%s\n",md5str); + printf("\n"); + + //generate the MD5 hash for our string + char aa[1000001]; + for (int i=0;i<1000000;i++) + aa[i] = 'a'; + aa[1000000] = '\0'; + ms = md5.millis(); + hash= md5.make_hash(aa); + //generate the digest (hex encoding) of our hash + md5str = md5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(md5.millis() - ms)); + printf("PLAIN :1,000,000 x a\n"); + printf("EXPECTED:7707d6ae4e027c70eea2a935c2296f21\n"); + printf("RESULT :"); + printf("%s\n",md5str); + printf("\n"); + //Give the Memory back to the System if you run the md5 Hash generation in a loop + free(md5str); + return 0; +} + diff --git a/examples_Rpi/MD5_Hash.cpp b/examples_Rpi/MD5_Hash.cpp index 6f88699..4b0be2b 100644 --- a/examples_Rpi/MD5_Hash.cpp +++ b/examples_Rpi/MD5_Hash.cpp @@ -1,14 +1,19 @@ #include +MD5 hashMD5(); int main(int argc, char** argv) { + printf("********************\n"); + printf("****MD5 examples****\n"); + printf("********************\n"); + printf("\n"); double ms; //generate the MD5 hash for our string - ms = md5.millis(); - unsigned char* hash=md5.make_hash("abc"); + ms = hashMD5.millis(); + unsigned char* hash=hashMD5.make_hash("abc"); //generate the digest (hex encoding) of our hash - char *md5str = md5.make_digest(hash, 16); - printf("Done in (%f) ms\n",(md5.millis() - ms)); + char *md5str = hashMD5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(hashMD5.millis() - ms)); free(hash); //print it on our serial monitor printf("PLAIN :abc\n"); @@ -18,11 +23,11 @@ int main(int argc, char** argv) printf("\n"); //generate the MD5 hash for our string - ms = md5.millis(); - hash= md5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + ms = hashMD5.millis(); + hash= hashMD5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); //generate the digest (hex encoding) of our hash - md5str = md5.make_digest(hash, 16); - printf("Done in (%f) ms\n",(md5.millis() - ms)); + md5str = hashMD5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(hashMD5.millis() - ms)); printf("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq\n"); printf("EXPECTED:8215ef0796a20bcaaae116d3876c664a\n"); printf("RESULT :"); @@ -34,11 +39,11 @@ int main(int argc, char** argv) for (int i=0;i<1000000;i++) aa[i] = 'a'; aa[1000000] = '\0'; - ms = md5.millis(); - hash= md5.make_hash(aa); + ms = hashMD5.millis(); + hash= hashMD5.make_hash(aa); //generate the digest (hex encoding) of our hash - md5str = md5.make_digest(hash, 16); - printf("Done in (%f) ms\n",(md5.millis() - ms)); + md5str = hashMD5.make_digest(hash, 16); + printf("Done in (%f) ms\n",(hashMD5.millis() - ms)); printf("PLAIN :1,000,000 x a\n"); printf("EXPECTED:7707d6ae4e027c70eea2a935c2296f21\n"); printf("RESULT :"); diff --git a/examples_Rpi/Makefile b/examples_Rpi/Makefile index f0d9ac2..f556c99 100644 --- a/examples_Rpi/Makefile +++ b/examples_Rpi/Makefile @@ -18,7 +18,7 @@ CCFLAGS=-Ofast -mfpu=vfp -mfloat-abi=hard -march=armv6zk -mtune=arm1176jzf-s #CCFLAGS= # define all programs -PROGRAMS = MD5_Hash +PROGRAMS = MD5_Hash HMAC_MD5 SOURCES = ${PROGRAMS:=.cpp} all: ${PROGRAMS} From cdd4e30b3d5f8c34c0d932769bc96d118b81037e Mon Sep 17 00:00:00 2001 From: darky Date: Thu, 22 Jan 2015 14:22:43 +0100 Subject: [PATCH 24/32] better clean --- Makefile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Makefile b/Makefile index 55ef4cf..f1da9ca 100644 --- a/Makefile +++ b/Makefile @@ -42,6 +42,8 @@ MD5.o: MD5.cpp # clear build files clean: rm -rf *.o ${LIB}.* + rm -rf ${LIBDIR}/${LIB}.* + rm -rf ${HEADER_DIR} install: all install-libs install-headers From ddbcc1cc2936eb5ecd56243b29c8ef5f1eb8dbf0 Mon Sep 17 00:00:00 2001 From: spaniakos Date: Thu, 22 Jan 2015 15:11:47 +0100 Subject: [PATCH 25/32] Hmac update --- examples/HMAC_MD5/HMAC_MD5.ino | 1 - examples_Rpi/HMAC_MD5.cpp | 162 +++++++++++++++++++++++++-------- examples_Rpi/MD5_Hash.cpp | 21 +---- 3 files changed, 127 insertions(+), 57 deletions(-) diff --git a/examples/HMAC_MD5/HMAC_MD5.ino b/examples/HMAC_MD5/HMAC_MD5.ino index 0c0593a..6830ba4 100644 --- a/examples/HMAC_MD5/HMAC_MD5.ino +++ b/examples/HMAC_MD5/HMAC_MD5.ino @@ -65,7 +65,6 @@ void setup() 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, 0x00 }; text_len = strlen(text3); - Serial.println(text_len); ms = micros(); md5str = hashMD5.hmac_md5(text3, text_len, key3, key_len); //generate the digest (hex encoding) of our hash diff --git a/examples_Rpi/HMAC_MD5.cpp b/examples_Rpi/HMAC_MD5.cpp index 6f88699..47ae403 100644 --- a/examples_Rpi/HMAC_MD5.cpp +++ b/examples_Rpi/HMAC_MD5.cpp @@ -1,51 +1,135 @@ #include +MD5 hashMD5; int main(int argc, char** argv) { double ms; - //generate the MD5 hash for our string - ms = md5.millis(); - unsigned char* hash=md5.make_hash("abc"); + printf("*********************\n"); + printf("**HMAC MD5 examples**\n"); + printf("*********************\n"); + + char key[] = {0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b,0x0b, 0x00}; + int key_len; + key_len = strlen(key); + char *text = "Hi There"; + int text_len; + text_len = strlen(text); + ms = hashMD5.millis(); + char *md5str = hashMD5.hmac_md5(text, text_len, key, key_len); //generate the digest (hex encoding) of our hash - char *md5str = md5.make_digest(hash, 16); - printf("Done in (%f) ms\n",(md5.millis() - ms)); - free(hash); - //print it on our serial monitor - printf("PLAIN :abc\n"); - printf("EXPECTED:900150983cd24fb0d6963f7d28e17f72\n"); - printf("RESULT :"); - printf("%s\n",md5str); - printf("\n"); + ms = hashMD5.millis() - ms; + printf("done. (%f millis)\n",ms); + printf("PLAIN :Hi There\n"); + printf("KEY :0x0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b\n"); + printf("EXPECTED:9294727a3638bb1c13f48ef8158bfc9d\n"); + printf("RESULT :%s\n\n",md5str); - //generate the MD5 hash for our string - ms = md5.millis(); - hash= md5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); + char *key2 = "Jefe"; + key_len = strlen(key2); + char *text2 = "what do ya want for nothing?"; + text_len = strlen(text2); + ms = hashMD5.millis(); + md5str = hashMD5.hmac_md5(text2, text_len, key2, key_len); //generate the digest (hex encoding) of our hash - md5str = md5.make_digest(hash, 16); - printf("Done in (%f) ms\n",(md5.millis() - ms)); - printf("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq\n"); - printf("EXPECTED:8215ef0796a20bcaaae116d3876c664a\n"); - printf("RESULT :"); - printf("%s\n",md5str); - printf("\n"); + ms = hashMD5.millis() - ms; + printf("done. (%f millis)\n",ms); + printf("PLAIN :what do ya want for nothing?\n"); + printf("KEY :Jefe\n"); + printf("EXPECTED:750c783e6ab0b503eaa86e310a5db738\n"); + printf("RESULT :%s\n\n",md5str); - //generate the MD5 hash for our string - char aa[1000001]; - for (int i=0;i<1000000;i++) - aa[i] = 'a'; - aa[1000000] = '\0'; - ms = md5.millis(); - hash= md5.make_hash(aa); - //generate the digest (hex encoding) of our hash - md5str = md5.make_digest(hash, 16); - printf("Done in (%f) ms\n",(md5.millis() - ms)); - printf("PLAIN :1,000,000 x a\n"); - printf("EXPECTED:7707d6ae4e027c70eea2a935c2296f21\n"); - printf("RESULT :"); - printf("%s\n",md5str); - printf("\n"); - //Give the Memory back to the System if you run the md5 Hash generation in a loop - free(md5str); + char key3[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, 0x00}; + key_len = strlen(key3); + char text3[] = {0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, + 0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd, 0x00 + }; + text_len = strlen(text3); + ms = hashMD5.millis(); + md5str = hashMD5.hmac_md5(text3, text_len, key3, key_len); + ms = hashMD5.millis() - ms; + printf("done. (%f millis)\n",ms); + printf("PLAIN :0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"); + printf("KEY :0xdd repeated 50 times\n"); + printf("EXPECTED:56be34521d144c88dbb8c733f0e8b3f6\n"); + printf("RESULT :%s\n\n",md5str); + + char key4[] = {0x01,0x02,0x03,0x04,0x05,0x06,0x07,0x08,0x09,0x0a, + 0x0b,0x0c,0x0d,0x0e,0x0f,0x10,0x11,0x12,0x13,0x14, + 0x15,0x16,0x17,0x18,0x19, 0x00}; + key_len = strlen(key4); + char text4[] = {0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, + 0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd,0xcd, 0x00 + }; + text_len = strlen(text4); + ms = hashMD5.millis(); + md5str = hashMD5.hmac_md5(text4, text_len, key4, key_len); + ms = hashMD5.millis() - ms; + printf("done. (%f millis)\n",ms); + printf("PLAIN :0x0102030405060708090a0b0c0d0e0f10111213141516171819\n"); + printf("KEY :0xcd repeated 50 times\n"); + printf("EXPECTED:697eaf0aca3a3aea3a75164746ffaa79\n"); + printf("RESULT :%s\n\n",md5str); + + char key5[] = {0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x0c,0x00}; + key_len = strlen(key5); + char *text5 = "Test With Truncation"; + text_len = strlen(text5); + ms = hashMD5.millis(); + md5str = hashMD5.hmac_md5(text5, text_len, key5, key_len); + ms = hashMD5.millis() - ms; + printf("done. (%f millis)\n",ms); + printf("PLAIN :Test With Truncation\n"); + printf("KEY :0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c\n"); + printf("EXPECTED:56461ef2342edc00f9bab995690efd4c\n"); + printf("RESULT :%s\n\n",md5str); + + char key6[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 + }; + key_len = strlen(key6); + char *text6 = "Test Using Larger Than Block-Size Key - Hash Key First"; + text_len = strlen(text6); + ms = hashMD5.millis(); + md5str = hashMD5.hmac_md5(text6, text_len, key6, key_len); + ms = hashMD5.millis() - ms; + printf("done. (%f millis)\n",ms); + printf("PLAIN :Test Using Larger Than Block-Size Key - Hash Key First\n"); + printf("KEY :0xaa repeated 80 times\n"); + printf("EXPECTED:6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd\n"); + printf("RESULT :%s\n\n",md5str); + + char key7[] = {0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa, + 0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0xaa,0x00 + }; + key_len = strlen(key7); + char *text7 = "Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data"; + text_len = strlen(text7); + ms = hashMD5.millis(); + md5str = hashMD5.hmac_md5(text7, text_len, key7, key_len); + ms = hashMD5.millis() - ms; + printf("done. (%f millis)\n",ms); + printf("PLAIN :Test Using Larger Than Block-Size Key and Larger Than One Block-Size Data\n"); + printf("KEY :0xaa repeated 80 times\n"); + printf("EXPECTED:6f630fad67cda0ee1fb1f562db3aa53e\n"); + printf("RESULT :%s\n\n",md5str); return 0; } diff --git a/examples_Rpi/MD5_Hash.cpp b/examples_Rpi/MD5_Hash.cpp index 4b0be2b..629a1a9 100644 --- a/examples_Rpi/MD5_Hash.cpp +++ b/examples_Rpi/MD5_Hash.cpp @@ -1,6 +1,6 @@ #include -MD5 hashMD5(); +MD5 hashMD5; int main(int argc, char** argv) { printf("********************\n"); @@ -8,25 +8,17 @@ int main(int argc, char** argv) printf("********************\n"); printf("\n"); double ms; - //generate the MD5 hash for our string ms = hashMD5.millis(); - unsigned char* hash=hashMD5.make_hash("abc"); - //generate the digest (hex encoding) of our hash - char *md5str = hashMD5.make_digest(hash, 16); + char *md5str = hashMD5.md5("abc"); printf("Done in (%f) ms\n",(hashMD5.millis() - ms)); - free(hash); - //print it on our serial monitor printf("PLAIN :abc\n"); printf("EXPECTED:900150983cd24fb0d6963f7d28e17f72\n"); printf("RESULT :"); printf("%s\n",md5str); printf("\n"); - //generate the MD5 hash for our string ms = hashMD5.millis(); - hash= hashMD5.make_hash("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); - //generate the digest (hex encoding) of our hash - md5str = hashMD5.make_digest(hash, 16); + md5str = hashMD5.md5("abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"); printf("Done in (%f) ms\n",(hashMD5.millis() - ms)); printf("PLAIN :abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq\n"); printf("EXPECTED:8215ef0796a20bcaaae116d3876c664a\n"); @@ -34,23 +26,18 @@ int main(int argc, char** argv) printf("%s\n",md5str); printf("\n"); - //generate the MD5 hash for our string char aa[1000001]; for (int i=0;i<1000000;i++) aa[i] = 'a'; aa[1000000] = '\0'; ms = hashMD5.millis(); - hash= hashMD5.make_hash(aa); - //generate the digest (hex encoding) of our hash - md5str = hashMD5.make_digest(hash, 16); + md5str = hashMD5.md5(aa); printf("Done in (%f) ms\n",(hashMD5.millis() - ms)); printf("PLAIN :1,000,000 x a\n"); printf("EXPECTED:7707d6ae4e027c70eea2a935c2296f21\n"); printf("RESULT :"); printf("%s\n",md5str); printf("\n"); - //Give the Memory back to the System if you run the md5 Hash generation in a loop - free(md5str); return 0; } From 34c0e784efa2ebd10543994998307cd5ded7d3bd Mon Sep 17 00:00:00 2001 From: darky Date: Thu, 22 Jan 2015 15:14:45 +0100 Subject: [PATCH 26/32] Readme update --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index c33f692..a4a61fc 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ You're done. Time for a mojito ### Usage see examples for md5 and hmac md5 -``` ### Raspberry pi install From 449a7297c7f57994deffac800715507abff4ec4a Mon Sep 17 00:00:00 2001 From: darky Date: Fri, 23 Jan 2015 14:40:51 +0100 Subject: [PATCH 27/32] changes for Documenation --- Doxyfile | 2371 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ MD5.h | 212 ++++- 2 files changed, 2581 insertions(+), 2 deletions(-) create mode 100644 Doxyfile diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..3c6bcb3 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2371 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "MD5 and HMAC-MD5 class" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Spaniakos - MD5 and HMAC-MD5 class for arduino and Raspberry Pi" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "../Documentations/MD5" + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = ino=c \ + pde=c + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = YES + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = NO + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = NO + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = ./ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = examples \ + examples_RPi + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 10 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = doxygen-custom.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /