CipherAlgorithm.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_Cryptography_OpenSSL_CipherAlgorithm_h_
#define _Stroika_Foundation_Cryptography_OpenSSL_CipherAlgorithm_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#if qStroika_HasComponent_OpenSSL
#include <openssl/evp.h>
#endif
 
#include "Stroika/Foundation/Characters/ToString.h"
#include "Stroika/Foundation/Common/Common.h"
#include "Stroika/Foundation/Common/Property.h"
#include "Stroika/Foundation/Execution/Exceptions.h"
#include "Stroika/Foundation/Execution/LazyInitialized.h"
#include "Stroika/Foundation/Memory/Common.h"
 
/**
 *  \file
 *
 */
 
#if qStroika_HasComponent_OpenSSL
namespace Stroika::Foundation::Cryptography::Providers::OpenSSL {
 
    using Characters::String;
 
    /**
     *  \brief object oriented wrapper on OpenSSL cipher algorithms (const EVP_CIPHER*)
     */
    class CipherAlgorithm {
    public:
        /**
         */
        CipherAlgorithm (const ::EVP_CIPHER* cipher);
        CipherAlgorithm (const CipherAlgorithm& src);
 
    public:
        nonvirtual CipherAlgorithm& operator= (const CipherAlgorithm& src);
 
    public:
        /**
         *  Wrapper on CipherAlgorithm
         * 
         *  @see https://linux.die.net/man/3/evp_get_cipherbyname
         */
        static CipherAlgorithm           GetByName (const String& cipherName);
        static optional<CipherAlgorithm> GetByNameQuietly (const String& cipherName);
 
    public:
        nonvirtual operator const ::EVP_CIPHER* () const;
 
    public:
        /**
         */
        Common::ReadOnlyProperty<String> name;
 
    public:
        nonvirtual auto operator<=> (const CipherAlgorithm& rhs) const;
        nonvirtual bool operator== (const CipherAlgorithm& rhs) const;
 
    public:
        /**
         */
        nonvirtual size_t KeyLength () const;
 
    public:
        /**
         */
        nonvirtual size_t IVLength () const;
 
    public:
        /**
         */
        nonvirtual String ToString () const;
 
    private:
        const ::EVP_CIPHER* fCipher_;
    };
 
    /**
     *      @see https://wiki.openssl.org/index.php/OpenSSL_3.0 section 9.3.2
     */
    namespace CipherAlgorithms {
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_128_CBC;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_128_ECB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_128_OFB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_128_CFB1;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_128_CFB8;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_128_CFB128;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_192_CBC;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_192_ECB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_192_OFB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_192_CFB1;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_192_CFB8;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_192_CFB128;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_256_CBC;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_256_ECB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_256_OFB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_256_CFB1;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_256_CFB8;
        extern const Execution::LazyInitialized<CipherAlgorithm> kAES_256_CFB128;
 
        /*
         * NB: In OpenSSL v3, the algorithms:
         *  o   eBlowfish
         *  o   eRC2,
         *  o   eRC4,
         *  o   (and others listed in https://wiki.openssl.org/index.php/OpenSSL_3.0 but we never supported them before)
         * are only available in the LEGACY provider, and it is not recommended to use, so dont make that easy
         * from Stroika. By default just assume default provider is in use.
         *  @see http://stroika-bugs.sophists.com/browse/STK-735
         * 
         * @todo mark these below as deprecated...
         */
        extern const Execution::LazyInitialized<CipherAlgorithm> kBlowfish_CBC;
        extern const Execution::LazyInitialized<CipherAlgorithm> kBlowfish_ECB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kBlowfish_CFB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kBlowfish_OFB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kBlowfish;
        extern const Execution::LazyInitialized<CipherAlgorithm> kRC2_CBC;
        extern const Execution::LazyInitialized<CipherAlgorithm> kRC2_ECB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kRC2_CFB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kRC2_OFB;
        extern const Execution::LazyInitialized<CipherAlgorithm> kRC4;
    }
 
}
#endif
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "CipherAlgorithm.inl"
 
#endif /*_Stroika_Foundation_Cryptography_OpenSSL_CipherAlgorithm_h_*/