.. index:: pair: class; EE::System::RC4
.. _doxid-class_e_e_1_1_system_1_1_r_c4:

class EE::System::RC4
=====================

.. toctree::
	:hidden:

	struct_EE_System_RC4_RC4Key.rst

Overview
~~~~~~~~

:ref:`RC4 <doxid-class_e_e_1_1_system_1_1_r_c4>` Encryption Class. For more information check Wikipedia: `http://en.wikipedia.org/wiki/RC4 <http://en.wikipedia.org/wiki/RC4>`__. :ref:`More...<details-class_e_e_1_1_system_1_1_r_c4>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <rc4.hpp>
	
	class RC4 {
	public:
		// structs
	
		struct :ref:`RC4Key<doxid-struct_e_e_1_1_system_1_1_r_c4_1_1_r_c4_key>`;

		// construction
	
		:target:`~RC4<doxid-class_e_e_1_1_system_1_1_r_c4_1a7385265b494be9b57601d1adf231a359>`();

		// methods
	
		void :ref:`setKey<doxid-class_e_e_1_1_system_1_1_r_c4_1a38276566a9cf1c583a5c701deaf119b7>`(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* key, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` size);
		void :ref:`setKey<doxid-class_e_e_1_1_system_1_1_r_c4_1ac1a245f6ac74029659d818319b4af0eb>`(const std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& Key);
		void :ref:`setKey<doxid-class_e_e_1_1_system_1_1_r_c4_1ac63b8398575b4ce564684f5aa617203c>`(const std::string& Key);
		void :ref:`encryptByte<doxid-class_e_e_1_1_system_1_1_r_c4_1acf8747612e54b8e34073ac0b3952adc8>`(:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* data, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` size);
		void :ref:`encryptByte<doxid-class_e_e_1_1_system_1_1_r_c4_1ab49023f9b6b59f881755610a72d99e2c>`(std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& buffer);
		void :ref:`decryptByte<doxid-class_e_e_1_1_system_1_1_r_c4_1ae1ed686e046718b7c24a8db667eb95b5>`(std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& buffer);
		void :ref:`encryptString<doxid-class_e_e_1_1_system_1_1_r_c4_1ab73f224036a58e2216aa345885a28068>`(std::string& buffer);
		void :ref:`decryptString<doxid-class_e_e_1_1_system_1_1_r_c4_1a7f21165cd2e4392868071c19f7264b4c>`(std::string& buffer);
		bool :ref:`encryptFile<doxid-class_e_e_1_1_system_1_1_r_c4_1a652b3257335bda9b8f487823adb3037a>`(const std::string& SourceFile, const std::string& DestFile);
		bool :ref:`decryptFile<doxid-class_e_e_1_1_system_1_1_r_c4_1aa2755747f2d2f812069b0e666e2ba43f>`(const std::string& SourceFile, const std::string& DestFile);
	};
.. _details-class_e_e_1_1_system_1_1_r_c4:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

:ref:`RC4 <doxid-class_e_e_1_1_system_1_1_r_c4>` Encryption Class. For more information check Wikipedia: `http://en.wikipedia.org/wiki/RC4 <http://en.wikipedia.org/wiki/RC4>`__.

Methods
-------

.. index:: pair: function; setKey
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1a38276566a9cf1c583a5c701deaf119b7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setKey(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* key, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` size)

Set the encryption Key.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- key

		- the key data

	*
		- size

		- the key size

.. index:: pair: function; setKey
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1ac1a245f6ac74029659d818319b4af0eb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setKey(const std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& Key)

Set the encryption Key.

.. index:: pair: function; setKey
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1ac63b8398575b4ce564684f5aa617203c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setKey(const std::string& Key)

Set the encryption Key.

.. index:: pair: function; encryptByte
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1acf8747612e54b8e34073ac0b3952adc8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void encryptByte(:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* data, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` size)

Encrypt the buffer ( you must set the key first ).



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- data

		- The buffer to encrypt

	*
		- size

		- The buffer size

.. index:: pair: function; encryptByte
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1ab49023f9b6b59f881755610a72d99e2c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void encryptByte(std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& buffer)

Encrypt a vector of bytes ( you must set the key first ).

.. index:: pair: function; decryptByte
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1ae1ed686e046718b7c24a8db667eb95b5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void decryptByte(std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& buffer)

Decrypt a vector of bytes ( you must set the key first ).

.. index:: pair: function; encryptString
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1ab73f224036a58e2216aa345885a28068:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void encryptString(std::string& buffer)

Encrypt a string ( you must set the key first ).

.. index:: pair: function; decryptString
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1a7f21165cd2e4392868071c19f7264b4c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void decryptString(std::string& buffer)

Decrypt a string ( you must set the key first ).

.. index:: pair: function; encryptFile
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1a652b3257335bda9b8f487823adb3037a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool encryptFile(const std::string& SourceFile, const std::string& DestFile)

Encrypt a file ( you must set the key first ).

.. index:: pair: function; decryptFile
.. _doxid-class_e_e_1_1_system_1_1_r_c4_1aa2755747f2d2f812069b0e666e2ba43f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool decryptFile(const std::string& SourceFile, const std::string& DestFile)

Decrypt a file ( you must set the key first ).