First commit
[anna.git] / include / anna / core / util / EncodedData.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_EncodedData_hpp
38 #define anna_core_util_EncodedData_hpp
39
40 #include <openssl/des.h>
41
42 #include <anna/core//DataBlock.hpp>
43
44 namespace anna {
45
46 namespace xml {
47 class Node;
48 }
49
50 class Encoder;
51
52 /**
53    Interface generico para guardar el resultado de una codificacion. Ver anna::util::Encoder.
54 */
55 class EncodedData {
56 public:
57   /**
58      Constructor.
59   */
60   EncodedData() : a_value(true), a_realSize(0) {;}
61
62   /**
63      Inicializa el contenido de esta clase a partir de la informacion contenida en el
64      documento XML recibido.
65
66      \param document Documento XML que contiene la informacion con la inicializar esta clase.
67      Deberia haber sido obtenido mediate #asXML.
68   */
69   void initialize(const xml::Node* document) throw(RuntimeException);
70
71   /**
72      Devuelve un documento XML con la informacion necesaria para reproducir el contenido de esta
73      instancia.
74      \param parent Nodo XML del que dependende la informacion.
75      \return Nodo XML que en el que podemos aplicar informacion.
76   */
77   xml::Node* asXML(xml::Node* parent) const throw(RuntimeException);
78
79 private:
80   DES_key_schedule a_skey [3];
81   DES_cblock a_iv;
82   DataBlock a_value;
83   int a_realSize;
84
85   EncodedData(const EncodedData&);
86
87   static const std::string& asBCD(const DataBlock&, std::string&) throw();
88   static int fromBCD(const std::string&, DataBlock&) throw();
89
90   friend class Encoder;
91 };
92
93
94 }
95
96 #endif