RSAKey.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_RSAKEY_H_
#define _MIRA_RSAKEY_H_

#include <sstream>
#include <string>

#include <platform/Types.h>
#include <serialization/SplitReflect.h>
#include <serialization/IsTransparentSerializable.h>

namespace mira {


struct OpenSSLRSAWrapper;


class MIRA_BASE_EXPORT RSAKey
{
public:

    RSAKey();

    RSAKey(const RSAKey& key);

    RSAKey(const std::string& n, const std::string& e, const std::string& d);

    virtual~ RSAKey();


private:

    RSAKey(const OpenSSLRSAWrapper* key);


public:

    MIRA_SPLIT_REFLECT_MEMBER

    template<typename Reflector>
    void reflectRead(Reflector& r)
    {
        std::stringstream ss;
        ss << (*this);
        std::string str = ss.str();
        r.delegate(str);
    }

    template<typename Reflector>
    void reflectWrite(Reflector& r)
    {
        std::string str;
        r.delegate(str);
        std::stringstream ss(str);
        ss >> (*this);
    }


public:

    bool isValid() const;

    bool isPublicKey() const;

    bool isPrivateKey() const;

    bool clear();


public:

    RSAKey& operator=(const RSAKey& key);

    bool operator==(const RSAKey& key);

    bool operator!=(const RSAKey& key);


public:

    const OpenSSLRSAWrapper* getOpenSSLKey() const { return(mKey); }

    std::string getNStr() const;

    std::string getEStr() const;

    std::string getDStr() const;


public:

    static void generateKey(unsigned int iKeyBitLength,
                            RSAKey &oPublicKey,
                            RSAKey &oPrivateKey);

    static void feedRandomNumberGenerator(size_t count);


private:
    friend MIRA_BASE_EXPORT std::ostream& operator<<(std::ostream& stream,
                                                     const RSAKey& key);
    friend MIRA_BASE_EXPORT std::istream& operator>>(std::istream& stream,
                                                     RSAKey& key);

private:
    OpenSSLRSAWrapper* mKey;
};


MIRA_BASE_EXPORT std::ostream& operator<<(std::ostream& stream,
                                          const RSAKey& key);

MIRA_BASE_EXPORT std::istream& operator>>(std::istream& stream, RSAKey& key);



template<typename SerializerTag>
class IsTransparentSerializable<RSAKey,SerializerTag> : public std::true_type {};


} // namespace mira

#endif