.. index:: pair: class; EE::System::SHA1
.. _doxid-class_e_e_1_1_system_1_1_s_h_a1:

class EE::System::SHA1
======================

.. toctree::
	:hidden:

	struct_EE_System_SHA1_Context.rst
	struct_EE_System_SHA1_Result.rst

Overview
~~~~~~~~

SHA-1 (FIPS 180-4) message digest. :ref:`More...<details-class_e_e_1_1_system_1_1_s_h_a1>`


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

	#include <sha1.hpp>
	
	class SHA1 {
	public:
		// typedefs
	
		typedef std::array<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`, 20> :target:`Digest<doxid-class_e_e_1_1_system_1_1_s_h_a1_1a9ed2db6db8a39d2f281e3e65053930e1>`;

		// structs
	
		struct :ref:`Context<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_context>`;
		struct :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>`;

		// methods
	
		static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` :ref:`fromStream<doxid-class_e_e_1_1_system_1_1_s_h_a1_1abc4a40ec35684d564cc4c1f5bb46c7ae>`(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream);
		static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` :ref:`fromFile<doxid-class_e_e_1_1_system_1_1_s_h_a1_1a1b3fb32227b87fe5ba1263e72948bc89>`(std::string path);
		static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` :ref:`fromMemory<doxid-class_e_e_1_1_system_1_1_s_h_a1_1a09b07dc7c588b1918b47a856d730a683>`(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* data, :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` size);
		static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` :ref:`fromString<doxid-class_e_e_1_1_system_1_1_s_h_a1_1ac43b25f4b854da83952335291ca5225e>`(const std::string& str);
		static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` :ref:`fromString<doxid-class_e_e_1_1_system_1_1_s_h_a1_1ae66a2f912ec517f74042cb0d007d38d2>`(const :ref:`String<doxid-class_e_e_1_1_string>`& str);
		static void :target:`init<doxid-class_e_e_1_1_system_1_1_s_h_a1_1af9425a8ba095e3723c5a6b30568f7db4>`(:ref:`Context<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_context>`& ctx);
		static void :target:`update<doxid-class_e_e_1_1_system_1_1_s_h_a1_1a74ded7103d4133edb3d60b4737bc9ef2>`(:ref:`Context<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_context>`& ctx, const void* data, unsigned long size);
		static void :target:`final<doxid-class_e_e_1_1_system_1_1_s_h_a1_1aaada0f4f3f7f6f9c79fd186e0184d2cc>`(:ref:`Digest<doxid-class_e_e_1_1_system_1_1_s_h_a1_1a9ed2db6db8a39d2f281e3e65053930e1>`& result, :ref:`Context<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_context>`& ctx);
		static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` :target:`result<doxid-class_e_e_1_1_system_1_1_s_h_a1_1ad0e04ce04821f5ab0481cc4f649df601>`(:ref:`Context<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_context>`& ctx);
		static std::string :target:`hexDigest<doxid-class_e_e_1_1_system_1_1_s_h_a1_1a4a85c66a86d378f9592ab7ca09e899a3>`(const :ref:`Digest<doxid-class_e_e_1_1_system_1_1_s_h_a1_1a9ed2db6db8a39d2f281e3e65053930e1>`& digest);
	};
.. _details-class_e_e_1_1_system_1_1_s_h_a1:

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

SHA-1 (FIPS 180-4) message digest.

SHA-1 is not collision resistant: use it for identifiers and interoperability (for example OpenSSH's C token or hashed known_hosts names), never for new security-sensitive designs.

Methods
-------

.. index:: pair: function; fromStream
.. _doxid-class_e_e_1_1_system_1_1_s_h_a1_1abc4a40ec35684d564cc4c1f5bb46c7ae:

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

	static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` fromStream(:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`& stream)



.. rubric:: Returns:

Calculates the sha1 hash from a stream

.. index:: pair: function; fromFile
.. _doxid-class_e_e_1_1_system_1_1_s_h_a1_1a1b3fb32227b87fe5ba1263e72948bc89:

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

	static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` fromFile(std::string path)

Calculates the sha1 hash from a file

.. index:: pair: function; fromMemory
.. _doxid-class_e_e_1_1_system_1_1_s_h_a1_1a09b07dc7c588b1918b47a856d730a683:

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

	static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` fromMemory(const :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`* data, :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` size)

Calculates the sha1 hash from memory

.. index:: pair: function; fromString
.. _doxid-class_e_e_1_1_system_1_1_s_h_a1_1ac43b25f4b854da83952335291ca5225e:

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

	static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` fromString(const std::string& str)

Calculates the sha1 hash from a string

.. index:: pair: function; fromString
.. _doxid-class_e_e_1_1_system_1_1_s_h_a1_1ae66a2f912ec517f74042cb0d007d38d2:

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

	static :ref:`Result<doxid-struct_e_e_1_1_system_1_1_s_h_a1_1_1_result>` fromString(const :ref:`String<doxid-class_e_e_1_1_string>`& str)

Calculates the sha1 hash from a string