EncodeString - Revision history

Fernando187: /* Examples */

2025-05-19T10:09:29Z

Examples

← Older revision		Revision as of 10:09, 19 May 2025
Line 80:		Line 80:
	</section>		</section>

	<section name="~~Shared~~" class="~~shared~~" show="true">		<section name="Server" class="server" show="true">
	This example shows you how to use the RSA encryption with a simple string message.		This example shows you how to use the RSA encryption with a simple string message.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Fernando187: /* Examples */

2025-05-19T10:08:13Z

Examples

← Older revision		Revision as of 10:08, 19 May 2025
Line 80:		Line 80:
	</section>		</section>

	<section name="~~Server~~" class="~~server~~" show="true">		<section name="Shared" class="shared" show="true">
	This example shows you how to use the RSA encryption with a simple string message.		This example shows you how to use the RSA encryption with a simple string message.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 89:		Line 89:
	local decrypted = decodeString("rsa", encrypted, { key = private })		local decrypted = decodeString("rsa", encrypted, { key = private })

	~~outputServerLog~~("RSA test: ".. tostring(input == decrypted))		outputDebugString("RSA test: ".. tostring(input == decrypted))
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Fernando187: /* Examples */

2025-05-19T10:06:46Z

Examples

← Older revision		Revision as of 10:06, 19 May 2025
Line 78:		Line 78:
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

			<section name="Server" class="server" show="true">
	This example shows you how to use the RSA encryption with a simple string message.		This example shows you how to use the RSA encryption with a simple string message.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Fernando187: /* Returns for each algorithm */

2025-05-19T10:05:27Z

Returns for each algorithm

← Older revision		Revision as of 10:05, 19 May 2025
Line 53:		Line 53:
	* ''tea'', ''rsa'', ''base64'', ''base32'', ''zlib''		* ''tea'', ''rsa'', ''base64'', ''base32'', ''zlib''
	** '''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.
	~~\|22408}}~~

	==Examples==		==Examples==

Fernando187: display is less confusing this way, i think

2025-05-19T10:03:22Z

display is less confusing this way, i think

← Older revision		Revision as of 10:03, 19 May 2025
Line 45:		Line 45:
	===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===
	~~{{New items\|3.0159\|1.5.8\|~~
	* ''aes128''		* ''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.		** '''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.		** '''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.6.1\|~~		* ''tea'', ''rsa'', ''base64'', ''base32'', ''zlib''
	* ''tea''
	* ''rsa''
	* ''base64''
	* ''base32''
	* ''zlib''
	** '''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.
	\|22408}}		\|22408}}

Samr46: Add new zlib encoding feature

2025-05-17T22:32:30Z

Add new zlib encoding feature

← Older revision		Revision as of 22:32, 17 May 2025
Line 56:		Line 56:
	* ''base64''		* ''base64''
	* ''base32''		* ''base32''
			* ''zlib''
	** '''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.
	\|22408}}		\|22408}}

Samr46: Add new zlib encoding feature

2025-05-17T22:31:18Z

Add new zlib encoding feature

← Older revision		Revision as of 22:31, 17 May 2025
Line 36:		Line 36:
	** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)		** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
	\|22408}}		\|22408}}
			{{Added feature/item\|1.6.0\|1.6.1\|23219\|
			* ''zlib'' ([https://en.wikipedia.org/wiki/Zlib Zlib Compression Algorithm])
			** '''compression''': a number that defines compression level. (0-9) (9 - the best) (default: 9)
			** '''format''': a string or number that defines compression format. (gzip, zlib, raw or [https://www.zlib.net/manual.html#Advanced window size number]) (default: gzip)
			** '''strategy''': a string that defines compression strategy. (default, filtered, huffman, rle, fixed)
			\|23219}}

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

Tracer: Improved formatting

2024-03-15T20:13:49Z

Improved formatting

← Older revision		Revision as of 20:13, 15 March 2024
Line 40:		Line 40:
	*'''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 47:		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''
	** '''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}}~~
	~~{{New items\|3.0159\|1.6.1\|~~
	* ''base64''		* ''base64''
	** '''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.
	~~\|22408}}~~
	~~{{New items\|3.0159\|1.6.1\|~~
	* ''base32''		* ''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.

Nico834: Modify build numbers

2024-02-20T16:29:27Z

Modify build numbers

← Older revision		Revision as of 16:29, 20 February 2024
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\|~~22402~~\|		{{Added feature/item\|1.6.0\|1.6.1\|22408\|
	* ''base64'' ([https://en.wikipedia.org/wiki/Base64 Base64 Encoding Algorithm])		* ''base64'' ([https://en.wikipedia.org/wiki/Base64 Base64 Encoding Algorithm])
	** '''variant''': a string that defines the encoding variant. (Currently only "URL" is available)		** '''variant''': a string that defines the encoding variant. (Currently only "URL" is available)
	\|~~22402~~}}		\|22408}}
	{{Added feature/item\|1.6.0\|1.6.1\|~~22402~~\|		{{Added feature/item\|1.6.0\|1.6.1\|22408\|
	* ''base32'' ([https://en.wikipedia.org/wiki/Base32 Base32 Encoding Algorithm])		* ''base32'' ([https://en.wikipedia.org/wiki/Base32 Base32 Encoding Algorithm])
	** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)		** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
	\|~~22402~~}}		\|22408}}

	===Optional Arguments===		===Optional Arguments===
Line 54:		Line 54:
	* ''base64''		* ''base64''
	** '''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.
	\|~~22402~~}}		\|22408}}
	{{New items\|3.0159\|1.6.1\|		{{New items\|3.0159\|1.6.1\|
	* ''base32''		* ''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.
	\|~~22402~~}}		\|22408}}

	==Examples==		==Examples==

Nico834: Add base64 & base32 as #3312

2024-02-19T20:06:54Z

Add base64 & base32 as #3312

← Older revision		Revision as of 20:06, 19 February 2024
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\|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===
Line 43:		Line 51:
	** '''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}}		\|21055}}
			{{New items\|3.0159\|1.6.1\|
			* ''base64''
			** '''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.
			\|22402}}
			{{New items\|3.0159\|1.6.1\|
			* ''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.
			\|22402}}

	==Examples==		==Examples==