SymmetricCipher.h

Go to the documentation of this file.

#pragma once
#include <aws/cal/symmetric_cipher.h>
#include <aws/crt/Exports.h>
#include <aws/crt/Types.h>
 
struct aws_symmetric_cipher;
 
namespace Aws
{
    namespace Crt
    {
        namespace Crypto
        {
            static const size_t AES_256_CIPHER_BLOCK_SIZE = 16u;
            static const size_t AES_256_KEY_SIZE_BYTES = 32u;
 
            enum class SymmetricCipherState
            {
                Ready = AWS_SYMMETRIC_CIPHER_READY,
                Finalized = AWS_SYMMETRIC_CIPHER_FINALIZED,
                Error = AWS_SYMMETRIC_CIPHER_ERROR,
            };
 
            class AWS_CRT_CPP_API SymmetricCipher final
            {
              public:
                SymmetricCipher(const SymmetricCipher &) = delete;
                SymmetricCipher &operator=(const SymmetricCipher &) = delete;
                SymmetricCipher(SymmetricCipher &&) noexcept = default;
                SymmetricCipher &operator=(SymmetricCipher &&) noexcept = default;

                static SymmetricCipher CreateAES_256_CBC_Cipher(
                    const Optional<ByteCursor> &key = Optional<ByteCursor>(),
                    const Optional<ByteCursor> &iv = Optional<ByteCursor>(),
                    Allocator *allocator = ApiAllocator()) noexcept;

                static SymmetricCipher CreateAES_256_CTR_Cipher(
                    const Optional<ByteCursor> &key = Optional<ByteCursor>(),
                    const Optional<ByteCursor> &iv = Optional<ByteCursor>(),
                    Allocator *allocator = ApiAllocator()) noexcept;

                static SymmetricCipher CreateAES_256_GCM_Cipher(
                    const Optional<ByteCursor> &key = Optional<ByteCursor>(),
                    const Optional<ByteCursor> &iv = Optional<ByteCursor>(),
                    const Optional<ByteCursor> &aad = Optional<ByteCursor>(),
                    Allocator *allocator = ApiAllocator()) noexcept;

                static SymmetricCipher CreateAES_256_KeyWrap_Cipher(
                    const Optional<ByteCursor> &key = Optional<ByteCursor>(),
                    Allocator *allocator = ApiAllocator()) noexcept;

                operator bool() const noexcept;

                SymmetricCipherState GetState() const noexcept;

                inline int LastError() const noexcept { return m_lastError; }

                bool Encrypt(const ByteCursor &toEncrypt, ByteBuf &out) noexcept;

                bool FinalizeEncryption(ByteBuf &out) noexcept;

                bool Decrypt(const ByteCursor &toDecrypt, ByteBuf &out) noexcept;

                bool FinalizeDecryption(ByteBuf &out) noexcept;

                bool Reset() noexcept;

                ByteCursor GetKey() const noexcept;

                ByteCursor GetIV() const noexcept;

                ByteCursor GetTag() const noexcept;

                void SetTag(ByteCursor tag) const noexcept;
 
              private:
                SymmetricCipher(aws_symmetric_cipher *cipher) noexcept;
                ScopedResource<struct aws_symmetric_cipher> m_cipher;
                int m_lastError;
            };
        } // namespace Crypto
    } // namespace Crt
} // namespace Aws