hl_md5wrapper.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. /*
  2. * hashlib++ - a simple hash library for C++
  3. *
  4. * Copyright (c) 2007-2010 Benjamin Grüdelbach
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1) Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. *
  12. * 2) Redistributions in binary form must reproduce the above copyright
  13. * notice, this list of conditions and the following disclaimer in
  14. * the documentation and/or other materials provided with the
  15. * distribution.
  16. *
  17. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  18. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  21. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  24. * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27. */
  28. //----------------------------------------------------------------------
  29. /**
  30. * @file hl_md5wrapper.h
  31. * @brief This file contains the definition of the md5wrapper
  32. * class.
  33. * @date Mo 17 Sep 2007
  34. */
  35. //----------------------------------------------------------------------
  36. //include protection
  37. #ifndef MD5WRAPPER_H
  38. #define MD5WRAPPER_H
  39. //----------------------------------------------------------------------
  40. //hashlib++ includes
  41. #include "hl_hashwrapper.h"
  42. #include "hl_md5.h"
  43. //----------------------------------------------------------------------
  44. //STL includes
  45. #include <string>
  46. //----------------------------------------------------------------------
  47. /**
  48. * @brief This class represents the MD5 wrapper-class
  49. *
  50. * You can use this class to easily create a md5 hash.
  51. * Just create an instance of md5wrapper and call the
  52. * inherited memberfunctions getHashFromString()
  53. * and getHashFromFile() to create a hash based on a
  54. * string or a file.
  55. *
  56. * Have a look at the following example:
  57. *
  58. * @include md5example.cpp
  59. *
  60. * md5wrapper implements resetContext(), updateContext()
  61. * and hashIt() to create a hash.
  62. */
  63. class md5wrapper : public hashwrapper
  64. {
  65. protected:
  66. /**
  67. * MD5 access
  68. */
  69. MD5 *md5;
  70. /**
  71. * MD5 context
  72. */
  73. HL_MD5_CTX ctx;
  74. /**
  75. * @brief This method ends the hash process
  76. * and returns the hash as string.
  77. *
  78. * @return the hash as std::string
  79. */
  80. virtual std::string hashIt(void);
  81. /**
  82. * @brief This internal member-function
  83. * convertes the hash-data to a
  84. * std::string (HEX).
  85. *
  86. * @param data The hash-data to covert into HEX
  87. * @return the converted data as std::string
  88. */
  89. virtual std::string convToString(unsigned char *data);
  90. /**
  91. * @brief This method adds the given data to the
  92. * current hash context.
  93. *
  94. * @param data The data to add to the current context
  95. * @param len The length of the data to add
  96. */
  97. virtual void updateContext(unsigned char *data, unsigned int len);
  98. /**
  99. * @brief This method resets the current hash context.
  100. * In other words: It starts a new hash process.
  101. */
  102. virtual void resetContext(void);
  103. /**
  104. * @brief This method should return the hash of the
  105. * test-string "The quick brown fox jumps over the lazy
  106. * dog"
  107. */
  108. virtual std::string getTestHash(void);
  109. public:
  110. /**
  111. * @brief default constructor
  112. */
  113. md5wrapper();
  114. /**
  115. * @brief default destructor
  116. */
  117. virtual ~md5wrapper();
  118. };
  119. //----------------------------------------------------------------------
  120. //include protection
  121. #endif
  122. //----------------------------------------------------------------------
  123. //EOF