From c7dd5225b80960d3b47e76f16d4e9a06657e4b86 Mon Sep 17 00:00:00 2001
From: Loic GUEGAN <loic@debian>
Date: Sun, 8 Mar 2015 09:08:21 +0400
Subject: Switch to doxygen comments, and english comments.

---
 CryptClass/HASHCrypt.cpp | 59 ++++++++++++++++++++----------------------------
 1 file changed, 25 insertions(+), 34 deletions(-)

(limited to 'CryptClass/HASHCrypt.cpp')

diff --git a/CryptClass/HASHCrypt.cpp b/CryptClass/HASHCrypt.cpp
index d77ee05..4c42ef3 100644
--- a/CryptClass/HASHCrypt.cpp
+++ b/CryptClass/HASHCrypt.cpp
@@ -1,68 +1,51 @@
+/**
+ * @file HASHCrypt.cpp
+ * @brief HASHCrypt class definitions
+ * @author manzerbredes
+ * @date 8 Mars 2015
+ *
+ * Contain all definitions of HASHCrypt class.
+ *
+ */
+
+
 #include "HASHCrypt.hpp"
 
 
-//Constructeur
+//Constructor
 HASHCrypt::HASHCrypt(){
 }
 
-
-//Destructeur
+//Destructor
 HASHCrypt::~HASHCrypt(){
 }
 
 
-/*
-    chain : objet de type string à hacher à l'aide de l'algorithme MD5
-    digest: tableau de type byte* contenant les données hasher
-    size: int faisant référence à la taille du tableau
 
-    Attention si size!=sizeof(digest) risque d'erreur de type Segmentation fault
-
-*/
 void HASHCrypt::getMD5_128(std::string chain, byte* digest, int size){
 
-    //Contrôle de la taille du digest
+    //Digest size controller
     this->checkDigestSize(CryptoPP::Weak1::MD5::DIGESTSIZE,size);
 
-    //Calcule de la somme de controle MD5 dans un type byte* à partir du paramètre chain
+    //Create the MD5 on digest parameter
     CryptoPP::Weak1::MD5 hash;
     hash.CalculateDigest( digest, (byte*) chain.c_str(), chain.length() );
 
 }
 
 
-/*
-    chain : objet de type string à hacher à l'aide de l'algorithme SHA-256
-    digest: tableau de type byte* contenant les données hasher
-    size : int faisant référence à la taille du tableau
-
-    Attention si size!=sizeof(digest) risque d'erreur de type Segmentation fault
-
-*/
 void HASHCrypt::getSHA_256(std::string chain, byte* digest, int size){
 
-    //Contrôle de la taille du digest
+    //Digest size controller
     this->checkDigestSize(CryptoPP::SHA256::DIGESTSIZE,size);
 
-    //Calcule du SHA-256 dans un type byte* à partir du paramètre chain
+    //Create the SHA-256 on digest parameter
     CryptoPP::SHA256 hash;
     hash.CalculateDigest( digest, (byte*) chain.c_str(), chain.length() );
 }
 
 
-/*
-    size : contient la taille des données passer en paramètre à la méthode de hashage choisi
-*/
-std::string HASHCrypt::getInvalidDigestSizeError(int sizeRequired, int size){
-    std::ostringstream erreurStream;
-    erreurStream << "Taille de digest invalide ! ("<< sizeRequired <<" octets requis et "<< size <<" donner)";
-    return erreurStream.str();
-}
 
-/*
-    sizeRequired : Taille du disgest attendu
-    size : Taille du digest donné
-*/
 void HASHCrypt::checkDigestSize(int sizeRequired, int size){
     try{
         if(size !=sizeRequired){
@@ -75,3 +58,11 @@ void HASHCrypt::checkDigestSize(int sizeRequired, int size){
         std::exit(EXIT_FAILURE);
     }
 }
+
+
+std::string HASHCrypt::getInvalidDigestSizeError(int sizeRequired, int size){
+    std::ostringstream erreurStream;
+    erreurStream << "Invalid digest size ! ("<< sizeRequired <<" bytes required and "<< size <<" given)";
+    return erreurStream.str();
+}
+
-- 
cgit v1.2.3