EncodeString: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add RSA example)
m (Improved formatting)
 
(3 intermediate revisions by 2 users not shown)
Line 9: Line 9:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string encodeString ( string algorithm, string input, table options [, function callback ] )   
string encodeString ( string algorithm, string input, [table options, function callback] )   
</syntaxhighlight>  
</syntaxhighlight>  


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


===Optional Arguments===
===Optional Arguments===
*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.
*'''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===
===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|
{{New items|3.0159|1.5.8|
* ''aes128''  
* ''aes128''  
Line 39: Line 45:
** '''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.
** '''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}}
|20898}}
{{New items|3.0159|1.5.8|
{{New items|3.0159|1.6.1|
* ''tea''
* ''rsa''  
* ''rsa''  
* ''base64''
* ''base32''
** '''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.
** '''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}}
|22408}}


==Examples==  
==Examples==  
Line 49: Line 58:
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.
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.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler("encode",  
addCommandHandler("encode", function(player, _, algorithm, key, ...)
    function(player, _, algorithm, key, ...)
    if not algorithm or not key then
         if algorithm and key then
         outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
            local text = table.concat({...}, " ")
        return
            if type(text) == "string" and text ~= "" then
    end
                local encoded = encodeString(algorithm, text, { key = key })
    local text = table.concat({...}, " ")
                if encoded then
    if type(text) ~= "string" or text == "" then
                    outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
        outputChatBox("Please specify text in the command.", player, 255, 0, 0)
                else
        return
                    outputChatBox("Failed to encode. Make sure that all arguments are valid.", player, 255, 0, 0)
    end
                end
    local encoded = encodeString(algorithm, text, { key = key })
            else
    if not encoded then
                outputChatBox("Please specify text in the command.", player, 255, 0, 0)
        outputChatBox("Failed to encode. Make sure that all arguments are valid.", player, 255, 0, 0)
            end
         return
         else
            outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
        end
     end
     end
)
 
    outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
end)
</syntaxhighlight>
</syntaxhighlight>


Latest revision as of 20:13, 15 March 2024

This function encodes a string using the specified algorithm. The counterpart of this function is decodeString.


[[{{{image}}}|link=|]] 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

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

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

BETA: NEW FEATURE (BUILD: 1.6.1 r22408)
BETA: NEW FEATURE (BUILD: 1.6.1 r22408)

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

  • 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 (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.
  • tea
  • rsa
  • base64
  • base32
    • 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.

Examples

Click to collapse [-]
Server

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. 

addCommandHandler("encode", function(player, _, algorithm, key, ...)
    if not algorithm or not key then
        outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
        return
    end
    local text = table.concat({...}, " ")
    if type(text) ~= "string" or text == "" then
        outputChatBox("Please specify text in the command.", player, 255, 0, 0)
        return
    end
    local encoded = encodeString(algorithm, text, { key = key })
    if not encoded then
        outputChatBox("Failed to encode. Make sure that all arguments are valid.", player, 255, 0, 0)
        return
    end

    outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
end)

This example shows you how to use the RSA encryption with a simple string message. 

local private, public = generateKeyPair("rsa", { size = 2048 })

local input = "Hello, world!"
local encrypted = encodeString("rsa", input, { key = public })
local decrypted = decodeString("rsa", encrypted, { key = private })

outputServerLog("RSA test: ".. tostring(input == decrypted))

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EncodeString?oldid=78892"