/* ****************************************************************************
 * Copyright 2019 Open Systems Development BV                                 *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
 * DEALINGS IN THE SOFTWARE.                                                  *
 * ***************************************************************************/

#ifndef OSDEV_COMPONENTS_CRYPTER_H
#define OSDEV_COMPONENTS_CRYPTER_H

// std
#include <string>

namespace osdev {
namespace components {

/**
 * @brief Provides encryption/hashing functionality.
 */
class Crypter
{
public:
    /**
     * @brief Defines the encryption/hashing algorithms.
     */
    enum class AlgorithmEnum
    {
        MD0,            ///< Empty initializer.
        MD2,
        MD5,
        MDC2,
        SHA1,
        SHA224,
        SHA256,
        SHA384,
        SHA512,
        RIPEMD160
    };

    /**
     * @brief Constructs a default instance of Crypter.
     */
    Crypter();

    /**
     * @brief Encrypts the specified message using the specified algorithm.
     * @param message The message to encrypt.
     * @param algo The encryption algorithm to use. The default value is SHA256.
     * @return The encrypted string.
     */
    static std::string encrypt( const std::string& message, Crypter::AlgorithmEnum algo = Crypter::AlgorithmEnum::SHA256 );
};

}   /* End namespace components */
}   /* End namespace osdev */

#endif /* OSDEV_COMPONENTS_CRYPTER_H */