Multi Theft Auto: Wiki - User contributions [en]

EncodeString

2022-09-25T14:28:17Z

Indereek: RSA encryption

__NOTOC__
{{Shared function}}
{{New feature/item|3.0156|1.5.5|11849|
This function encodes a [[string]] using the specified algorithm. The counterpart of this function is [[decodeString]].
}}

{{Tip|If it doesn't matter which algorithm you use for the encoding, keep in mind that ''aes128'' uses hardware acceleration so it may outperform the ''tea'' algorithm on most processors.}}

==Syntax==
<syntaxhighlight lang="lua">
string encodeString ( string algorithm, string input, table options [, function callback ] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm:''' The algorithm to use.
*'''input:''' The input to encode.
*'''options:''' A [[table]] with options and other necessary data for the algorithm, as detailed below.

===Options for each algorithm===
* ''tea'' ([https://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm Tiny Encryption Algorithm])
** '''key''': a key to encode the input with.
{{Added feature/item|1.5.9|1.5.8|20898|
* ''aes128'' ([https://en.wikipedia.org/wiki/Advanced_Encryption_Standard Advanced Encryption Standard] in CTR mode)
** '''key''': a key to encode the input with (must be 16 characters long).
|20898}}
{{Added feature/item|1.5.9|1.5.8|21055|
* ''rsa'' ([https://en.wikipedia.org/wiki/RSA_(cryptosystem) Rivest-Shamir-Adleman] in OAEP with SHA-1 mode)
** '''key''': a public key to encode the input.
|21055}}

===Optional Arguments===
*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.
===Returns for each algorithm===
* ''tea''
** '''encodedString''': the encoded string if successful, ''false'' otherwise. If a callback was provided, ''true'' is returned immediately, and the encoded string is passed as an argument to the callback.
{{New items|3.0159|1.5.8|
* ''aes128''
** '''encodedString''': the encoded string if successful, ''false'' otherwise. If a callback was provided, ''true'' is returned immediately, and the encoded string is passed as an argument to the callback.
** '''iv''' ([https://en.wikipedia.org/wiki/Initialization_vector Initialization vector]): this is a string generated by the encryption algorithm that is needed to decrypt the message by [[decodeString]]. If a callback was provided, ''true'' is returned immediately, and the ''iv'' is passed as an argument to the callback.
|20898}}
{{New items|3.0159|1.5.8|
* ''rsa''
** '''encodedString''': the encoded string if successful, ''false'' otherwise. If a callback was provided, ''true'' is returned immediately, and the encoded string is passed as an argument to the callback.
|21055}}

==Example==
Adds an ''/encode'' command in which you can provide an algorithm, key and data to encode. Below is the example provided as both server-side and client-side variations.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("encode",
function(player, _, algorithm, key, ...)
if algorithm and key then
local text = table.concat({...}, " ")
if type(text) == "string" and text ~= "" then
local encoded = encodeString(algorithm, text, { key = key })
if encoded then
outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
else
outputChatBox("Failed to encode. Make sure that all arguments are valid.", player, 255, 0, 0)
end
else
outputChatBox("Please specify text in the command.", player, 255, 0, 0)
end
else
outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

DecodeString

2022-09-25T14:28:13Z

Indereek: RSA decryption

__NOTOC__
{{Shared function}}
{{New feature/item|3.0156|1.5.5|11849|
This function decodes an encoded [[string]] using the specified algorithm. The counterpart of this function is [[encodeString]].
}}

==Syntax==
<syntaxhighlight lang="lua">
string decodeString ( string algorithm, string input, table options [, function callback ] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm:''' The algorithm to use.
*'''input:''' The input to decode.
*'''options:''' A [[table]] with options and other necessary data for the algorithm, as detailed below.

===Options for each algorithm===
* ''tea'' ([https://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm Tiny Encryption Algorithm])
** '''key''': a key to decode the input with.
{{Added feature/item|1.5.9|1.5.8|20898|
* ''aes128'' ([https://en.wikipedia.org/wiki/Advanced_Encryption_Standard Advanced Encryption Standard] in CTR mode)
** '''key''': a key to decode the input with.
** '''iv''': the initialization vector that was generated by [[encodeString]] for this combination of data and encryption algorithm.
}}
{{Added feature/item|1.5.9|1.5.8|21055|
* ''rsa'' ([https://en.wikipedia.org/wiki/RSA_(cryptosystem) Rivest-Shamir-Adleman] in OAEP with SHA-1 mode)
** '''key''': a private key to decode the input.
|21055}}

===Optional Arguments===
*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.
===Returns===
Returns the decoded string if successful, ''false'' otherwise. If a callback was provided, the decoded string is argument to the callback.

==Example==
Adds an ''/decode'' command in which you can provide an algorithm, key and data to decode.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("decode",
function(player, _, algorithm, key, ...)
if algorithm and key then
local text = table.concat({...}, " ")
if type(text) == "string" and text ~= "" then
local decoded = decodeString(algorithm, text, { key = key })
if decoded then
outputChatBox("The result of " .. algorithm .. " decoding is: " .. decoded, player)
else
outputChatBox("Failed to decode. Make sure that all arguments are valid.", player, 255, 0, 0)
end
else
outputChatBox("Please specify text in the command.", player, 255, 0, 0)
end
else
outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

GenerateKeyPair

2022-09-25T14:18:19Z

Indereek: Key pair generation example

__NOTOC__
{{Shared function}}
{{Added feature/item|1.6.0|1.5.9|21055|This function creates a new public key and private key for encrypting data}}

==Syntax==
<syntaxhighlight lang="lua">
string, string generateKeyPair ( string algorithm, table options [, function callback ] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm:''' The algorithm to use:
** ''RSA'': use the RSA public-key algorithm
*'''options:''' table with options for the hashing algorithm, as detailed below.

===Optional Arguments===
*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.

===Options for each hashing algorithm===
* ''RSA'':
** ''size'' (int), default: 0 . Size of a key.

==Returns==
Returns 2 strings if successful: '''private key''' and '''public key'''. Otherwise returns '''false'''

==Example==
Adds an ''/generatekeypair'' command in which you can provide a key size to generate a key pair for encryption.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("generatekeypair",
function(player, _, algorithm, keysize)
if algorithm then
if keysize and tonumber(keysize) then
local privateKey, publicKey = generateKeyPair( algorithm, { size = keysize } )
if not privateKey then
outputChatBox("Failed to generate key pair. Make sure that all arguments are valid.", player, 255, 0, 0)
else
outputConsole("Private Key: " .. base64Encode(privateKey),player)
outputConsole("Public Key: " .. base64Encode(publicKey),player)
outputChatBox("The key pair was successfully generated. You can find the result in the console.", player, 0, 255, 0)
end
else
outputChatBox("Please specify key size in the command.", player, 255, 0, 0)
end
else
outputChatBox("Please specify algorithm in the command.", player, 255, 0, 0)
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

Hash

2022-09-25T09:15:29Z

Indereek: HMAC documentaction

__NOTOC__
{{Server client function}}
{{New feature/item|3.0141|1.4.1|6791|
This function returns a hash of the specified string in the specified algorithm.
}}

==Syntax==
<syntaxhighlight lang="lua">
string hash ( string algorithm, string dataToHash, [ table options ] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm''': A string which must be one of these: "md5", "sha1", "sha224", "sha256", "sha384", "sha512", "hmac"
*'''dataToHash''': A string of the data to hash.
*'''options''': A table with options and other necessary data for the algorithm, as detailed below.

===Options for each algorithm===
{{Added feature/item|1.5.9|1.5.8|21329|
* ''hmac'' ([https://en.wikipedia.org/wiki/HMAC HMAC])
** '''key''': a key to encode the input with.
** '''algorithm''': a string which must be one of these: "md5", "sha1", "sha224", "sha256", "sha384", "sha512".
|21329}}

===Returns===
Returns the hash of the data, false if an invalid argument was used.
==Example==
<syntaxhighlight lang="lua">
local myString = "myDatatoHash"
print(hash("md5", myString)) -- This will hash myString with the md5 Algorithm (it's equal to md5()) -> output: 0EF1E2203BD78182911B77EB6B9CC3DE

-- A another Example
local myNewString = "myNewDatatoHash"
print(hash("sha512", myNewString)) -- This will hash myNewString with the sha512 Algorithm -> output: 64A5678DC83EDCD8991E8CF0D69764663C0F933870BB89465F77B6C23D2A2B2400305A36D77404EE647D0D7B9D56CF7937B235BBD3885D08DCC62C81FB6D8429
</syntaxhighlight>

==See Also==
{{Utility functions}}
[[ru:hash]]

Hash

2022-09-25T09:14:46Z

Indereek: HMAC documentaction

__NOTOC__
{{Server client function}}
{{New feature/item|3.0141|1.4.1|6791|
This function returns a hash of the specified string in the specified algorithm.
}}

==Syntax==
<syntaxhighlight lang="lua">
string hash ( string algorithm, string dataToHash, [ table options ] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm''': A string which must be one of these: "md5", "sha1", "sha224", "sha256", "sha384", "sha512", "hmac"
*'''dataToHash''': A string of the data to hash.
*'''options''': A table with options and other necessary data for the algorithm, as detailed below.

===Options for each algorithm===
{{Added feature/item|1.5.9|1.5.8|21329|
* ''hmac'' ([https://en.wikipedia.org/wiki/HMAC HMAC])
** '''key''': a key to encode the input with.
** '''algorithm''': a string which must be one of these: "md5", "sha1", "sha224", "sha256", "sha384", "sha512",
|21329}}

===Returns===
Returns the hash of the data, false if an invalid argument was used.
==Example==
<syntaxhighlight lang="lua">
local myString = "myDatatoHash"
print(hash("md5", myString)) -- This will hash myString with the md5 Algorithm (it's equal to md5()) -> output: 0EF1E2203BD78182911B77EB6B9CC3DE

-- A another Example
local myNewString = "myNewDatatoHash"
print(hash("sha512", myNewString)) -- This will hash myNewString with the sha512 Algorithm -> output: 64A5678DC83EDCD8991E8CF0D69764663C0F933870BB89465F77B6C23D2A2B2400305A36D77404EE647D0D7B9D56CF7937B235BBD3885D08DCC62C81FB6D8429
</syntaxhighlight>

==See Also==
{{Utility functions}}
[[ru:hash]]