DecodeString: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(RSA decryption)
(Add base64 & base32 as #3312)
Line 7: Line 7:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string decodeString ( string algorithm, string input, table options [, function callback ] )   
string decodeString ( string algorithm, string input, [table options, function callback] )   
</syntaxhighlight>  
</syntaxhighlight>  


Line 27: Line 27:
** '''key''': a private key to decode the input.
** '''key''': a private key to decode the input.
|21055}}
|21055}}
{{Added feature/item|1.6.0|1.6.1|22402|
* ''base64'' ([https://en.wikipedia.org/wiki/Base64 Base64 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "URL" is available)
|22402}}
{{Added feature/item|1.6.0|1.6.1|22402|
* ''base32'' ([https://en.wikipedia.org/wiki/Base32 Base32 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
|22402}}


===Optional Arguments===
===Optional Arguments===

Revision as of 20:11, 19 February 2024

This function decodes an encoded string using the specified algorithm. The counterpart of this function is encodeString.

Syntax

string decodeString ( string algorithm, string input, [table options, function callback] )  

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

  • aes128 (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.
BETA: NEW FEATURE (BUILD: 1.6.1 r22402)
BETA: NEW FEATURE (BUILD: 1.6.1 r22402)

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.

Click to collapse [-]
Server
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
)

See Also