MIRA
RSAKey.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_RSAKEY_H_
48 #define _MIRA_RSAKEY_H_
49 
50 #include <sstream>
51 #include <string>
52 
53 #include <platform/Types.h>
56 
57 namespace mira {
58 
60 
62 struct OpenSSLRSAWrapper;
63 
65 
72 {
73 public:
76 
78  RSAKey();
79 
81  RSAKey(const RSAKey& key);
82 
84  RSAKey(const std::string& n, const std::string& e, const std::string& d);
85 
87  virtual~ RSAKey();
88 
90 
91 private:
94 
96  RSAKey(const OpenSSLRSAWrapper* key);
97 
99 
100 public:
103 
105 
107  template<typename Reflector>
108  void reflectRead(Reflector& r)
109  {
110  std::stringstream ss;
111  ss << (*this);
112  std::string str = ss.str();
113  r.delegate(str);
114  }
115 
116  template<typename Reflector>
117  void reflectWrite(Reflector& r)
118  {
119  std::string str;
120  r.delegate(str);
121  std::stringstream ss(str);
122  ss >> (*this);
123  }
124 
126 
127 public:
130 
132  bool isValid() const;
133 
135  bool isPublicKey() const;
136 
138  bool isPrivateKey() const;
139 
141  bool clear();
142 
144 
145 public:
148 
150  RSAKey& operator=(const RSAKey& key);
151 
153  bool operator==(const RSAKey& key);
154 
156  bool operator!=(const RSAKey& key);
157 
159 
160 public:
163 
165  const OpenSSLRSAWrapper* getOpenSSLKey() const { return(mKey); }
166 
168  std::string getNStr() const;
169 
171  std::string getEStr() const;
172 
174  std::string getDStr() const;
175 
177 
178 public:
181 
188  static void generateKey(unsigned int iKeyBitLength,
189  RSAKey &oPublicKey,
190  RSAKey &oPrivateKey);
191 
196  static void feedRandomNumberGenerator(size_t count);
197 
199 
200 private:
201  friend MIRA_BASE_EXPORT std::ostream& operator<<(std::ostream& stream,
202  const RSAKey& key);
203  friend MIRA_BASE_EXPORT std::istream& operator>>(std::istream& stream,
204  RSAKey& key);
205 
206 private:
207  OpenSSLRSAWrapper* mKey;
208 };
209 
211 
221 MIRA_BASE_EXPORT std::ostream& operator<<(std::ostream& stream,
222  const RSAKey& key);
223 
229 MIRA_BASE_EXPORT std::istream& operator>>(std::istream& stream, RSAKey& key);
230 
232 
233 
234 template<typename SerializerTag>
235 class IsTransparentSerializable<RSAKey,SerializerTag> : public std::true_type {};
236 
238 
239 } // namespace mira
240 
241 #endif
Typedefs for OS independent basic data types.
Type trait that indicates whether a type should be serialized "transparently", i.e.
Definition: IsTransparentSerializable.h:81
IStream & operator>>(IStream &is, JSONValue &value)
Definition: JSON.h:389
Definition of a RSA key (public or private)
Definition: RSAKey.h:71
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
#define MIRA_SPLIT_REFLECT_MEMBER
Macro that insert a class member reflect() method just splitting reflection into a reflectRead() and ...
Definition: SplitReflect.h:238
Provides type trait that indicates whether a type should be serialized "transparently".
Provides MIRA_SPLIT_REFLECT macros.
std::ostream & operator<<(std::ostream &s, const LibraryVersion &version)
bool operator==(const ImgIteratorBase &a, const ImgIteratorBase &b)
Definition: ImgIterator.h:225
MIRA_SPLIT_REFLECT_MEMBER void reflectRead(Reflector &r)
Reflect.
Definition: RSAKey.h:108
bool operator!=(const ImgIteratorBase &a, const ImgIteratorBase &b)
Definition: ImgIterator.h:228
void reflectWrite(Reflector &r)
Definition: RSAKey.h:117
#define MIRA_BASE_EXPORT
This is required because on windows there is a macro defined called ERROR.
Definition: Platform.h:153
const OpenSSLRSAWrapper * getOpenSSLKey() const
Return a pointer to the OpenSSL RSA key wrapper.
Definition: RSAKey.h:165