include/anna/core/util/Encoder.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_util_Encoder_hpp
  38 #define anna_core_util_Encoder_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41 #include <anna/core//DataBlock.hpp>
  42 #include <anna/core/util/defines.hpp>
  43 #include <anna/core/util/EncodedData.hpp>
  44
  45 #include <anna/core/util/Tokenizer.hpp>
  46
  47 namespace anna {
  48
  49 /**
  50    Interface generico para codificacion y decodificacion de bloques de memoria. Por ahora
  51    solo se aplica el Triple-DES pero es posible que un futuro se pueda selecionar algun otro
  52    algoritmo.
  53 */
  54 class Encoder {
  55 public:
  56   /**
  57      Constructor.
  58   */
  59   Encoder() {;}
  60
  61   /**
  62      Codifica el texto recibido como parametro aplicando el algoritmo seleccionado.
  63      \param text Texto a codificar.
  64      \return Una representacion del texto codificado.
  65      \warning El texto codificado incluye el caracter cero, indicador de fin de cadena.
  66   */
  67   const EncodedData& encode(const char* text) throw(RuntimeException) {
  68     DataBlock aux(text, anna_strlen(text) + 1, false);
  69     return encode(aux);
  70   }
  71
  72   /**
  73      Codifica el texto recibido como parametro aplicando el algoritmo seleccionado.
  74      \param text Texto a codificar.
  75      \return Una representacion del texto codificado.
  76      \warning El texto codificado incluye el caracter cero, indicador de fin de cadena.
  77   */
  78   const EncodedData& encode(const std::string& text) throw(RuntimeException) {
  79     return encode(text.c_str());
  80   }
  81
  82   /**
  83      Codifica el bloque de memoria recibido como parametro aplicando el algoritmo seleccionado.
  84      \param data Bloque de memoria a codificar.
  85      \return Una representacion del bloque de memoria codificado.
  86   */
  87   const EncodedData& encode(const DataBlock& data) throw(RuntimeException);
  88
  89   /**
  90      Deodifica la representacion de codificacion recibida como parametro.
  91      \param data Bloque de memoria a codificar.
  92      \return Una representacion del bloque de memoria codificado.
  93
  94      \warning Si la representacion corresponde a la codificacion de una cadena con
  95      anna::DataBlock::getData obtendremos el contenido original de la cadena.
  96   */
  97   const DataBlock& decode(const EncodedData& data) throw(RuntimeException);
  98
  99   /**
 100      Metodo que debe ser invocado al menos una vez.
 101   */
 102   static void initialize() throw();
 103
 104 private:
 105   EncodedData a_data;
 106
 107   DataBlock& setDataBlock(const DataBlock& other) throw(RuntimeException);
 108
 109 };
 110
 111 }
 112
 113 #endif