Crypt::...er::XTEA(3)

🌸 NAME 🌸

okay so welcome to the Crypt::...er::XTEA(3) page β€” user-contributed Perl documentation for Crypt::Cipher::XTEA, aka the symmetric cipher XTEA with a key size of 128 bits πŸ’…βœ¨


πŸ¦‹ SYNOPSIS πŸ¦‹

Here are the starter recipes, bestie β€” copy-paste energy only 🫢

         ### example 1
         use Crypt::Mode::CBC;

         my $key = '...'; # length must be a valid key size for this cipher
         my $iv = '...';  # 16 bytes
         my $cbc = Crypt::Mode::CBC->new('XTEA');
         my $ciphertext = $cbc->encrypt("secret data", $key, $iv);

         ### example 2 (slower)
         use Crypt::CBC;
         use Crypt::Cipher::XTEA;

         my $key = '...'; # length must be a valid key size for this cipher
         my $iv = '...';  # 16 bytes
         my $cbc = Crypt::CBC->new( -cipher=>'Cipher::XTEA', -key=>$key, -iv=>$iv );
         my $ciphertext = $cbc->encrypt("secret data");

πŸŽ€ DESCRIPTION πŸŽ€

This module implements the XTEA cipher. Its interface is compatible with Crypt::CBC.

Note: This module only implements single-block encryption and decryption. For general data, use a block mode such as Crypt::Mode::CBC, Crypt::Mode::CTR, or Crypt::CBC (which is slower). πŸ’€

✨ METHODS ✨

Unless noted otherwise, assume $c is an existing cipher object created via new, for example:

        my $c = Crypt::Cipher::XTEA->new($key);

🐚 new 🐚

Meet your constructor, bestie:

        my $c = Crypt::Cipher::XTEA->new($key);
        #or
        my $c = Crypt::Cipher::XTEA->new($key, $rounds);

        # $key .... [binary string] key of an accepted length (see keysize, min_keysize, max_keysize)
        # $rounds . [integer] optional, number of rounds (if supported by the cipher; croaks on invalid value)

So: $key is a [binary string] key of an accepted length (see keysize, min_keysize, max_keysize). $rounds is an [integer] that’s optional β€” the number of rounds, if supported by the cipher β€” and it croaks on an invalid value. No cap. 😌

πŸ” encrypt πŸ”

Encrypts exactly one block of plaintext. The length of $plaintext must equal blocksize; croaks otherwise. An empty string is accepted and returned unchanged.

        my $ciphertext = $c->encrypt($plaintext);

Returns the encrypted block as a binary string (raw bytes). slay.

πŸ”“ decrypt πŸ”“

Decrypts exactly one block of ciphertext. The length of $ciphertext must equal blocksize; croaks otherwise. An empty string is accepted and returned unchanged.

        my $plaintext = $c->decrypt($ciphertext);

Returns the decrypted block as a binary string (raw bytes). iconic.

πŸ”‘ keysize πŸ”‘

Just an alias for max_keysize.

         $c->keysize;
         #or
         Crypt::Cipher::XTEA->keysize;
         #or
         Crypt::Cipher::XTEA::keysize;

🧱 blocksize 🧱

Returns the cipher block size (in bytes).

         $c->blocksize;
         #or
         Crypt::Cipher::XTEA->blocksize;
         #or
         Crypt::Cipher::XTEA::blocksize;

πŸ“ max_keysize πŸ“

Returns the maximum key size (in bytes).

         $c->max_keysize;
         #or
         Crypt::Cipher::XTEA->max_keysize;
         #or
         Crypt::Cipher::XTEA::max_keysize;

πŸ“ min_keysize πŸ“

Returns the minimum key size (in bytes).

         $c->min_keysize;
         #or
         Crypt::Cipher::XTEA->min_keysize;
         #or
         Crypt::Cipher::XTEA::min_keysize;

πŸ” default_rounds πŸ”

Returns the cipher’s default round count.

         $c->default_rounds;
         #or
         Crypt::Cipher::XTEA->default_rounds;
         #or
         Crypt::Cipher::XTEA::default_rounds;

🌈 SEE ALSO 🌈


Signed off with perl v5.42.0 energy and dated 2026-05-11 β€” Crypt::...er::XTEA(3) out, periodt πŸ’…πŸ«Άβœ¨

πŸ“¦ where this page comes from