Hashers (AMX Mod X Scripting) - Revision history

Arkshine at 18:18, 18 June 2017

2017-06-18T18:18:11Z

Arkshine at 18:16, 18 June 2017

2017-06-18T18:16:06Z

Arkshine: Added Hashers documentation

2017-06-18T17:52:03Z

Added Hashers documentation

New page

__FORCETOC__
{{Languages|{{PAGENAME}}}}

== About ==

Hashers provide a way to generate a hash value from a string or file content, available in [https://github.com/alliedmodders/amxmodx/tree/master/plugins/include#L2472-L2495 amxmodx.inc].

{{alert|info|Note:|The following API deprecates {{tt|md5}} and {{tt|md5_file}} natives.|opt=full-border}}

== Usage ==

=== Hashes ===

The available [https://github.com/alliedmodders/amxmodx/blob/master/plugins/include/amxconst.inc#L432-L452 {{tt|HashType|opt=nobg}} constants] are:

:{|
|-
| {{tt|Hash_Crc32}} || {{ns}} Provides {{h:title|Cyclic Redundancy Check 32|CRC32}} hashing
|-
| {{tt|Hash_Md5}} || {{ns}} Provides {{h:title|Message Digest 5|MD5}} hashing
|-
| {{tt|Hash_Sha1}} || {{ns}} Provides {{h:title|Secure Hash Algorithm 1|SHA1}} hashing
|-
| {{tt|Hash_Sha256}} || {{ns}} Provides {{h:title|Secure Hash Algorithm 256|SHA256}} hashing
|-
| {{tt|Hash_Sha3_224}} || {{ns}} Provides {{h:title|Secure Hash Algorithm 3|SHA3}} 224 bit hashing
|-
| {{tt|Hash_Sha3_256}} || {{ns}} Provides {{h:title|Secure Hash Algorithm 3|SHA3}} 256 bit hashing
|-
| {{tt|Hash_Sha3_384}} || {{ns}} Provides {{h:title|Secure Hash Algorithm 3|SHA3}} 384 bit hashing
|-
| {{tt|Hash_Sha3_512}} || {{ns}} Provides {{h:title|Secure Hash Algorithm 3|SHA3}} 512 bit hashing
|-
| {{tt|Hash_Keccak_224}} || {{ns}} Provides Keccak 224 bit hashing
|-
| {{tt|Hash_Keccak_256}} || {{ns}} Provides Keccak 256 bit hashing
|-
| {{tt|Hash_Keccak_384}} || {{ns}} Provides Keccak 384 bit hashing
|-
| {{tt|Hash_Keccak_512}} || {{ns}} Provides Keccak 512 bit hashing
|-
|}

=== Natives ===

{{margin|20px 0 15px 0|{{tt|hash_string(const string[], const {{color|green|HashType}}:type, output[], const outputSize)|opt=large}}}}
: Generates a hash value (message digest).

:{|
|-
| {{tt|string}} || {{ns}} String to be hashed.
|-
| {{tt|type}} || {{ns}} Type of selected hashing algorithm. See {{tt|Hash_*|opt=nobg}} constants above.
|-
| {{tt|output}} || {{ns}} Output string to store hash in.
|-
| {{tt|outputSize}} || {{ns}} The maximum size of the output string to store hash in.
|-
|}

:{{alert|info|Return:|Number of written bytes.|opt=full-border}}
:{{alert|success|Example:|{{tt|new hash[32];<br />new const message[] <nowiki>=</nowiki> "Hello World!";<br />new const length <nowiki>=</nowiki> hash_string(message, Hash_Md5, hash, charsmax(hash));|opt=nobg}}|opt=full-border}}

{{margin|35px 0 15px 0|{{tt|hash_file(const fileName[], const {{color|green|HashType}}:type, output[], const outputSize)|opt=large}}}}
: Generates a hash value using the contents of a given file.

:{|
|-
| {{tt|fileName}} || {{ns}} Path of file to be hashed.
|-
| {{tt|type}} || {{ns}} Type of selected hashing algorithm. See {{tt|Hash_*|opt=nobg}} constants above.
|-
| {{tt|output}} || {{ns}} Output string to store hash in.
|-
| {{tt|outputSize}} || {{ns}} The maximum size of the output string to store hash in.
|-
|}

:{{alert|info|Return:|Number of written bytes.|opt=full-border}}
:{{alert|info|Note:|Path of file is relative to {{tt|$mod/|opt=nobg}} directory.|opt=full-border}}
:{{alert|success|Example:|{{tt|new hash[32];<br />new const fileName[] <nowiki>=</nowiki> "server.cfg";<br />new const length <nowiki>=</nowiki> hash_file(message, Hash_Md5, hash, charsmax(hash));|opt=nobg}}|opt=full-border}}

[[Category:Scripting_(AMX_Mod_X)]]

← Older revision		Revision as of 18:16, 18 June 2017
Line 1:		Line 1:
	__FORCETOC__		__FORCETOC__
−	{{Languages\|~~{{PAGENAME}}~~}}	+	{{Languages\|Hashers (AMX Mod X Scripting)}}

@@ Line 45: / Line 45: @@
 === Natives ===
-{{margin|20px 0 15px 0|{{tt|hash_string(const string[], const {{color|green|HashType}}:type, output[], const outputSize)|opt=large}}}}
+{{margin|20px 0 15px 0|{{tt|hash_string(const {{h:title||string}}[], const {{color|green|HashType}}:{{h:title||type}}, {{h:title||output}}[], const {{h:title||outputSize}})|opt=large}}}}
 : Generates a hash value (message digest).
@@ Line 63: / Line 63: @@
 :{{alert|success|Example:|{{tt|new hash[32];<br />new const message[] <nowiki>=</nowiki> "Hello World!";<br />new const length <nowiki>=</nowiki> hash_string(message, Hash_Md5, hash, charsmax(hash));|opt=nobg}}|opt=full-border}}
-{{margin|35px 0 15px 0|{{tt|hash_file(const fileName[], const {{color|green|HashType}}:type, output[], const outputSize)|opt=large}}}}
+{{margin|35px 0 15px 0|{{tt|hash_file(const {{h:title||fileName}}[], const {{color|green|HashType}}:{{h:title||type}}, {{h:title||output}}[], const {{h:title||outputSize}})|opt=large}}}}
 : Generates a hash value using the contents of a given file.