adicionado documentação em comentarios

LightBase Consultoria em Software Publico
1 parent 70143f74
Showing 4 changed files with 33 additions and 10 deletions Show diff stats
cacic-teste/cacic-teste.pro.user
install-cacic/install-cacic.pro.user
src/CACIC_comm.h
src/ccacic.cpp
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE QtCreatorProject>
-<!-- Written by QtCreator 3.1.2, 2014-07-17T18:11:35. -->
+<!-- Written by QtCreator 3.1.2, 2014-07-22T12:25:15. -->
 <qtcreator>
  <data>
   <variable>ProjectExplorer.Project.ActiveTarget</variable>
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE QtCreatorProject>
-<!-- Written by QtCreator 3.1.2, 2014-07-17T18:11:35. -->
+<!-- Written by QtCreator 3.1.2, 2014-07-21T17:43:51. -->
 <qtcreator>
  <data>
   <variable>ProjectExplorer.Project.ActiveTarget</variable>
@@ -79,6 +79,12 @@ public:
         return retorno;
     }
+
+    /* commStatus
+     * execulta um teste do tipo GET na urlGerente;
+     * @return retorna o resultado da conexão HTTP:
+     *      exemplo: 200 OK
+     */
     bool commStatus(){
         // cria um event-loop temporario
         QEventLoop eventLoop;
@@ -102,8 +102,17 @@ bool CCacic::deleteFile(QString path)
         return true;
 }
-std::string CCacic::enCrypt(QString str_in, QString key, QString iv)
-{
+
+/*enCrypt
+ * @parameter QString str_in: string que será encriptada (url).
+ *            QString key: chave utilizada na encriptação (32 caracteres) 32*8 = 256 bits
+ *              *exemplo: qwertyuiopasdfghjklzxcvbnmqwerty
+ *            QString iv: IV (Vetor de Inicialização) deve ser aleatório.
+ *              (http://pt.wikipedia.org/wiki/Modo_de_opera%C3%A7%C3%A3o_%28criptografia%29#Vetor_de_inicializa.C3.A7.C3.A3o_.28IV.29)
+ *              exemplo de iv: 0123456789123456
+ * @return std:string: retorna a string encriptada convertida em base64.
+ * */
+QString CCacic::enCrypt(QString str_in, QString key, QString iv) {
     std::string str_out;
     CryptoPP::CFB_Mode<CryptoPP::AES>::Encryption encryption((byte*)key.toStdString().c_str(), key.length(), (byte*)iv.toStdString().c_str());
     CryptoPP::StringSource encryptor(str_in.toStdString(), true,
@@ -114,12 +123,21 @@ std::string CCacic::enCrypt(QString str_in, QString key, QString iv)
                       )
                   )
               );
-    qDebug(QString::fromStdString(str_out).toLocal8Bit());
-    return str_out;
+    //qDebug(QString::fromStdString(str_out).toLocal8Bit());
+    return QString::fromStdString(str_out).toLocal8Bit();
 }
-std::string CCacic::deCrypt(QString str_in, QString key, QString iv)
-{
+/*deCrypt
+ * @parameter QString str_in: string encriptada convertida em base64.
+ *            QString key: chave utilizada na encriptação (32 caracteres) 32*8 = 256 bits
+ *              *exemplo: qwertyuiopasdfghjklzxcvbnmqwerty
+ *            QString iv: IV (Vetor de Inicialização) deve ser aleatório.
+ *              *Um IV jamais deve ser utilizado mais de uma vez com a mesma chave.
+ *              *(http://pt.wikipedia.org/wiki/Modo_de_opera%C3%A7%C3%A3o_%28criptografia%29#Vetor_de_inicializa.C3.A7.C3.A3o_.28IV.29)
+ *              *exemplo de iv: 0123456789123456
+ * @return QString: retorna a string desencriptada convertida em base64.
+ * */
+QString CCacic::deCrypt(QString str_in, QString key, QString iv) {
     std::string str_out;
     CryptoPP::CFB_Mode<CryptoPP::AES>::Decryption decryption((byte*)key.toStdString().c_str(), key.length(), (byte*)iv.toStdString().c_str());
@@ -130,8 +148,7 @@ std::string CCacic::deCrypt(QString str_in, QString key, QString iv)
             )
         )
     );
-    qDebug(QString::fromStdString(str_out).toLocal8Bit());
-    return str_out;
+    return QString::fromStdString(str_out).toLocal8Bit();
 }
 /*Getters/Setters
1	<?xml version="1.0" encoding="UTF-8"?>	1	<?xml version="1.0" encoding="UTF-8"?>
2	<!DOCTYPE QtCreatorProject>	2	<!DOCTYPE QtCreatorProject>
3	-<!-- Written by QtCreator 3.1.2, 2014-07-17T18:11:35. -->	3	+<!-- Written by QtCreator 3.1.2, 2014-07-22T12:25:15. -->
4	<qtcreator>	4	<qtcreator>
5	<data>	5	<data>
6	<variable>ProjectExplorer.Project.ActiveTarget</variable>	6	<variable>ProjectExplorer.Project.ActiveTarget</variable>
	@@ -79,6 +79,12 @@ public:		@@ -79,6 +79,12 @@ public:
79	return retorno;	79	return retorno;
80	}	80	}
81		81
		82	+
		83	+ /* commStatus
		84	+ * execulta um teste do tipo GET na urlGerente;
		85	+ * @return retorna o resultado da conexão HTTP:
		86	+ * exemplo: 200 OK
		87	+ */
82	bool commStatus(){	88	bool commStatus(){
83	// cria um event-loop temporario	89	// cria um event-loop temporario
84	QEventLoop eventLoop;	90	QEventLoop eventLoop;