Inheritance diagram for phpseclib\Crypt\TripleDES:

Collaboration diagram for phpseclib\Crypt\TripleDES:

Public Member Functions
	__construct ($mode=Base::MODE_CBC)
	Default Constructor. More...

	isValidEngine ($engine)
	Test for engine validity. More...

	setIV ($iv)
	Sets the initialization vector. More...

	setKeyLength ($length)
	Sets the key length. More...

	setKey ($key)
	Sets the key. More...

	encrypt ($plaintext)
	Encrypts a message. More...

	decrypt ($ciphertext)
	Decrypts a message. More...

	enableContinuousBuffer ()
	Treat consecutive "packets" as if they are a continuous buffer. More...

	disableContinuousBuffer ()
	Treat consecutive packets as if they are a discontinuous buffer. More...

	_setupKey ()
	Creates the key schedule. More...

	setPreferredEngine ($engine)
	Sets the internal crypt engine. More...

Public Member Functions inherited from phpseclib\Crypt\DES
	isValidEngine ($engine)
	Test for engine validity. More...

	setKey ($key)
	Sets the key. More...

	_encryptBlock ($in)
	Encrypts a block. More...

	_decryptBlock ($in)
	Decrypts a block. More...

	_processBlock ($block, $mode)
	Encrypts or decrypts a 64-bit block. More...

	_setupKey ()
	Creates the key schedule. More...

	_setupInlineCrypt ()
	Setup the performance-optimized function for de/encrypt() More...

Public Member Functions inherited from phpseclib\Crypt\Base
	__construct ($mode=self::MODE_CBC)
	Default Constructor. More...

	setIV ($iv)
	Sets the initialization vector. More...

	setKeyLength ($length)
	Sets the key length. More...

	getKeyLength ()
	Returns the current key length in bits. More...

	getBlockLength ()
	Returns the current block length in bits. More...

	setKey ($key)
	Sets the key. More...

	setPassword ($password, $method='pbkdf2')
	Sets the password. More...

	encrypt ($plaintext)
	Encrypts a message. More...

	decrypt ($ciphertext)
	Decrypts a message. More...

	_openssl_ctr_process ($plaintext, &$encryptIV, &$buffer)
	OpenSSL CTR Processor. More...

	_openssl_ofb_process ($plaintext, &$encryptIV, &$buffer)
	OpenSSL OFB Processor. More...

	_openssl_translate_mode ()
	phpseclib <-> OpenSSL Mode Mapper More...

	enablePadding ()
	Pad "packets". More...

	disablePadding ()
	Do not pad packets. More...

	enableContinuousBuffer ()
	Treat consecutive "packets" as if they are a continuous buffer. More...

	disableContinuousBuffer ()
	Treat consecutive packets as if they are a discontinuous buffer. More...

	isValidEngine ($engine)
	Test for engine validity. More...

	setPreferredEngine ($engine)
	Sets the preferred crypt engine. More...

	getEngine ()
	Returns the engine currently being utilized. More...

	_setEngine ()
	Sets the engine as appropriate. More...

	_encryptBlock ($in)
	Encrypts a block. More...

	_decryptBlock ($in)
	Decrypts a block. More...

	_setupKey ()
	Setup the key (expansion) More...

	_setup ()
	Setup the self::ENGINE_INTERNAL $engine. More...

	_setupMcrypt ()
	Setup the self::ENGINE_MCRYPT $engine. More...

	_pad ($text)
	Pads a string. More...

	_unpad ($text)
	Unpads a string. More...

	_clearBuffers ()
	Clears internal buffers. More...

	_string_shift (&$string, $index=1)
	String Shift. More...

	_string_pop (&$string, $index=1)
	String Pop. More...

	_increment_str (&$var)
	Increment the current string. More...

	_setupInlineCrypt ()
	Setup the performance-optimized function for de/encrypt() More...

	_createInlineCryptFunction ($cipher_code)
	Creates the performance-optimized function for en/decrypt() More...

&	_getLambdaFunctions ()
	Holds the lambda_functions table (classwide) More...

	_hashInlineCryptFunction ($bytes)
	Generates a digest from $bytes. More...

Data Fields
const	MODE_3CBC = -2
	Encrypt / decrypt using inner chaining. More...

const	MODE_CBC3 = Base::MODE_CBC
	Encrypt / decrypt using outer chaining. More...

	$key_length = 24

	$password_default_salt = 'phpseclib'

	$cipher_name_mcrypt = 'tripledes'

	$cfb_init_len = 750

	$key_length_max = 24

	$mode_3cbc

	$des

Data Fields inherited from phpseclib\Crypt\DES
const	ENCRYPT = 0
	#+ private More...

const	DECRYPT = 1
	Contains $keys[self::DECRYPT]. More...

	$block_size = 8

	$key_length = 8

	$cipher_name_mcrypt = 'des'

	$openssl_mode_names

	$cfb_init_len = 500

	$des_rounds = 1

	$key_length_max = 8

	$keys

	$shuffle

	$ipmap

	$invipmap

	$sbox1

	$sbox2

	$sbox3

	$sbox4

	$sbox5

	$sbox6

	$sbox7

	$sbox8

Data Fields inherited from phpseclib\Crypt\Base
const	MODE_CTR = -1
	#+ public More...

const	MODE_ECB = 1
	Encrypt / decrypt using the Electronic Code Book mode. More...

const	MODE_CBC = 2
	Encrypt / decrypt using the Code Book Chaining mode. More...

const	MODE_CFB = 3
	Encrypt / decrypt using the Cipher Feedback mode. More...

const	MODE_OFB = 4
	Encrypt / decrypt using the Output Feedback mode. More...

const	MODE_STREAM = 5
	Encrypt / decrypt using streaming mode. More...

const	ENGINE_INTERNAL = 1
	#+ private More...

const	ENGINE_MCRYPT = 2
	Base value for the mcrypt implementation $engine switch. More...

const	ENGINE_OPENSSL = 3
	Base value for the mcrypt implementation $engine switch. More...

	$mode

	$block_size = 16

	$key = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"

	$iv

	$encryptIV

	$decryptIV

	$continuousBuffer = false

	$enbuffer

	$debuffer

	$enmcrypt

	$demcrypt

	$enchanged = true

	$dechanged = true

	$ecb

	$cfb_init_len = 600

	$changed = true

	$padding = true

	$paddable = false

	$engine

	$preferredEngine

	$cipher_name_mcrypt

	$cipher_name_openssl

	$cipher_name_openssl_ecb

	$password_default_salt = 'phpseclib/salt'

	$inline_crypt

	$use_inline_crypt

	$openssl_emulate_ctr = false

	$openssl_options

	$explicit_key_length = false

	$skip_key_adjustment = false

Additional Inherited Members
Static Public Attributes inherited from phpseclib\Crypt\Base
static	$WHIRLPOOL_AVAILABLE

Detailed Description

Definition at line 49 of file TripleDES.php.

Constructor & Destructor Documentation

◆ __construct()

phpseclib\Crypt\TripleDES::__construct ( $mode = Base::MODE_CBC )

Default Constructor.

Determines whether or not the mcrypt extension should be used.

$mode could be:

::MODE_ECB
::MODE_CBC
::MODE_CTR
::MODE_CFB
::MODE_OFB
::MODE_3CBC

If not explicitly set, ::MODE_CBC will be used.

See also: ::__construct(); ::__construct()

Parameters

int $mode public

Definition at line 157 of file TripleDES.php.

References phpseclib\Crypt\Base\$mode, and phpseclib\Crypt\Base\MODE_CBC.

     {
         switch ($mode) {
             // In case of self::MODE_3CBC, we init as CRYPT_DES_MODE_CBC
             // and additional flag us internally as 3CBC
             case self::MODE_3CBC:
                 parent::__construct(Base::MODE_CBC);
                 $this->mode_3cbc = true;
 
                 // This three $des'es will do the 3CBC work (if $key > 64bits)
                 $this->des = array(
                     new DES(Base::MODE_CBC),
                     new DES(Base::MODE_CBC),
                     new DES(Base::MODE_CBC),
                 );
 
                 // we're going to be doing the padding, ourselves, so disable it in the \phpseclib\Crypt\DES objects
                 $this->des[0]->disablePadding();
                 $this->des[1]->disablePadding();
                 $this->des[2]->disablePadding();
                 break;
             // If not 3CBC, we init as usual
             default:
                 parent::__construct($mode);
         }
     }

Member Function Documentation

◆ _setupKey()

phpseclib\Crypt\TripleDES::_setupKey ( )

Creates the key schedule.

See also: ::_setupKey(); ::_setupKey() private

Definition at line 416 of file TripleDES.php.

     {
         switch (true) {
             // if $key <= 64bits we configure our internal pure-php cipher engine
             // to act as regular [1]DES, not as 3DES. mcrypt.so::tripledes does the same.
             case strlen($this->key) <= 8:
                 $this->des_rounds = 1;
                 break;
 
             // otherwise, if $key > 64bits, we configure our engine to work as 3DES.
             default:
                 $this->des_rounds = 3;
 
                 // (only) if 3CBC is used we have, of course, to setup the $des[0-2] keys also separately.
                 if ($this->mode_3cbc) {
                     $this->des[0]->_setupKey();
                     $this->des[1]->_setupKey();
                     $this->des[2]->_setupKey();
 
                     // because $des[0-2] will, now, do all the work we can return here
                     // not need unnecessary stress parent::_setupKey() with our, now unused, $key.
                     return;
                 }
         }
         // setup our key
         parent::_setupKey();
     }

◆ decrypt()

phpseclib\Crypt\TripleDES::decrypt ( $ciphertext )

Decrypts a message.

See also: ::decrypt() User interface

Parameters

string $ciphertext

Returns: string $plaintext

Definition at line 325 of file TripleDES.php.

References phpseclib\Crypt\Base\_unpad(), and phpseclib\Crypt\TripleDES\encrypt().

Referenced by phpseclib\Crypt\TripleDES\encrypt().

     {
         if ($this->mode_3cbc && strlen($this->key) > 8) {
             return $this->_unpad(
                 $this->des[0]->decrypt(
                     $this->des[1]->encrypt(
                         $this->des[2]->decrypt(
                             str_pad($ciphertext, (strlen($ciphertext) + 7) & 0xFFFFFFF8, "\0")
                         )
                     )
                 )
             );
         }
 
         return parent::decrypt($ciphertext);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disableContinuousBuffer()

phpseclib\Crypt\TripleDES::disableContinuousBuffer ( )

Treat consecutive packets as if they are a discontinuous buffer.

The default behavior.

See also: ::disableContinuousBuffer(); self::enableContinuousBuffer() User interface

Definition at line 399 of file TripleDES.php.

     {
         parent::disableContinuousBuffer();
         if ($this->mode_3cbc) {
             $this->des[0]->disableContinuousBuffer();
             $this->des[1]->disableContinuousBuffer();
             $this->des[2]->disableContinuousBuffer();
         }
     }

◆ enableContinuousBuffer()

phpseclib\Crypt\TripleDES::enableContinuousBuffer ( )

Treat consecutive "packets" as if they are a continuous buffer.

Say you have a 16-byte plaintext $plaintext. Using the default behavior, the two following code snippets will yield different outputs:

echo $des->encrypt(substr($plaintext, 0, 8)); echo $des->encrypt(substr($plaintext, 8, 8)); echo $des->encrypt($plaintext);

The solution is to enable the continuous buffer. Although this will resolve the above discrepancy, it creates another, as demonstrated with the following:

$des->encrypt(substr($plaintext, 0, 8)); echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8))); echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8)));

With the continuous buffer disabled, these would yield the same output. With it enabled, they yield different outputs. The reason is due to the fact that the initialization vector's change after every encryption / decryption round when the continuous buffer is enabled. When it's disabled, they remain constant.

Put another way, when the continuous buffer is enabled, the state of the () object changes after each encryption / decryption round, whereas otherwise, it'd remain constant. For this reason, it's recommended that continuous buffers not be used. They do offer better security and are, in fact, sometimes required (SSH uses them), however, they are also less intuitive and more likely to cause you problems.

See also: ::enableContinuousBuffer(); self::disableContinuousBuffer() User interface

Definition at line 380 of file TripleDES.php.

     {
         parent::enableContinuousBuffer();
         if ($this->mode_3cbc) {
             $this->des[0]->enableContinuousBuffer();
             $this->des[1]->enableContinuousBuffer();
             $this->des[2]->enableContinuousBuffer();
         }
     }

◆ encrypt()

phpseclib\Crypt\TripleDES::encrypt ( $plaintext )

Encrypts a message.

See also: ::encrypt() User interface

Parameters

string $plaintext

Returns: string $cipertext

Definition at line 298 of file TripleDES.php.

References phpseclib\Crypt\Base\_pad(), and phpseclib\Crypt\TripleDES\decrypt().

Referenced by phpseclib\Crypt\TripleDES\decrypt().

     {
         // parent::en/decrypt() is able to do all the work for all modes and keylengths,
         // except for: self::MODE_3CBC (inner chaining CBC) with a key > 64bits
 
         // if the key is smaller then 8, do what we'd normally do
         if ($this->mode_3cbc && strlen($this->key) > 8) {
             return $this->des[2]->encrypt(
                 $this->des[1]->decrypt(
                     $this->des[0]->encrypt(
                         $this->_pad($plaintext)
                     )
                 )
             );
         }
 
         return parent::encrypt($plaintext);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidEngine()

phpseclib\Crypt\TripleDES::isValidEngine ( $engine )

Test for engine validity.

This is mainly just a wrapper to set things up for ::isValidEngine()

See also: ::__construct()

Parameters

int $engine public

Returns: bool

Definition at line 194 of file TripleDES.php.

References phpseclib\Crypt\Base\$engine, phpseclib\Crypt\Base\$mode, and phpseclib\Crypt\Base\_openssl_translate_mode().

     {
         if ($engine == self::ENGINE_OPENSSL) {
             $this->cipher_name_openssl_ecb = 'des-ede3';
             $mode = $this->_openssl_translate_mode();
             $this->cipher_name_openssl = $mode == 'ecb' ? 'des-ede3' : 'des-ede3-' . $mode;
         }
 
         return parent::isValidEngine($engine);
     }

Here is the call graph for this function:

◆ setIV()

phpseclib\Crypt\TripleDES::setIV ( $iv )

Sets the initialization vector.

(optional)

SetIV is not required when ::MODE_ECB is being used. If not explicitly set, it'll be assumed to be all zero's.

See also: ::setIV() User interface

Parameters

string $iv

Definition at line 215 of file TripleDES.php.

References phpseclib\Crypt\Base\$iv.

     {
         parent::setIV($iv);
         if ($this->mode_3cbc) {
             $this->des[0]->setIV($iv);
             $this->des[1]->setIV($iv);
             $this->des[2]->setIV($iv);
         }
     }

◆ setKey()

phpseclib\Crypt\TripleDES::setKey ( $key )

Sets the key.

Keys can be of any length. Triple DES, itself, can use 128-bit (eg. strlen($key) == 16) or 192-bit (eg. strlen($key) == 24) keys. This function pads and truncates $key as appropriate.

DES also requires that every eighth bit be a parity bit, however, we'll ignore that.

If the key is not explicitly set, it'll be assumed to be all null bytes.

public

See also: ::setKey(); ::setKey()

Parameters

string $key

Definition at line 266 of file TripleDES.php.

References phpseclib\Crypt\Base\$key.

     {
         $length = $this->explicit_key_length ? $this->key_length : strlen($key);
         if ($length > 8) {
             $key = str_pad(substr($key, 0, 24), 24, chr(0));
             // if $key is between 64 and 128-bits, use the first 64-bits as the last, per this:
             // http://php.net/function.mcrypt-encrypt#47973
             $key = $length <= 16 ? substr_replace($key, substr($key, 0, 8), 16) : substr($key, 0, 24);
         } else {
             $key = str_pad($key, 8, chr(0));
         }
         parent::setKey($key);
 
         // And in case of self::MODE_3CBC:
         // if key <= 64bits we not need the 3 $des to work,
         // because we will then act as regular DES-CBC with just a <= 64bit key.
         // So only if the key > 64bits (> 8 bytes) we will call setKey() for the 3 $des.
         if ($this->mode_3cbc && $length > 8) {
             $this->des[0]->setKey(substr($key,  0, 8));
             $this->des[1]->setKey(substr($key,  8, 8));
             $this->des[2]->setKey(substr($key, 16, 8));
         }
     }

◆ setKeyLength()

phpseclib\Crypt\TripleDES::setKeyLength ( $length )

Sets the key length.

Valid key lengths are 64, 128 and 192

See also: :setKeyLength() User interface

Parameters

int $length

Definition at line 234 of file TripleDES.php.

     {
         $length >>= 3;
         switch (true) {
             case $length <= 8:
                 $this->key_length = 8;
                 break;
             case $length <= 16:
                 $this->key_length = 16;
                 break;
             default:
                 $this->key_length = 24;
         }
 
         parent::setKeyLength($length);
     }

◆ setPreferredEngine()

phpseclib\Crypt\TripleDES::setPreferredEngine ( $engine )

Sets the internal crypt engine.

See also: ::__construct(); ::setPreferredEngine()

Parameters

int $engine public

Returns: int

Definition at line 453 of file TripleDES.php.

References phpseclib\Crypt\Base\$engine.

     {
         if ($this->mode_3cbc) {
             $this->des[0]->setPreferredEngine($engine);
             $this->des[1]->setPreferredEngine($engine);
             $this->des[2]->setPreferredEngine($engine);
         }
 
         return parent::setPreferredEngine($engine);
     }

Field Documentation

◆ $cfb_init_len

phpseclib\Crypt\TripleDES::$cfb_init_len = 750

Definition at line 101 of file TripleDES.php.

◆ $cipher_name_mcrypt

phpseclib\Crypt\TripleDES::$cipher_name_mcrypt = 'tripledes'

Definition at line 92 of file TripleDES.php.

◆ $des

phpseclib\Crypt\TripleDES::$des

Definition at line 129 of file TripleDES.php.

◆ $key_length

phpseclib\Crypt\TripleDES::$key_length = 24

Definition at line 72 of file TripleDES.php.

◆ $key_length_max

phpseclib\Crypt\TripleDES::$key_length_max = 24

Definition at line 111 of file TripleDES.php.

◆ $mode_3cbc

phpseclib\Crypt\TripleDES::$mode_3cbc

Definition at line 119 of file TripleDES.php.

◆ $password_default_salt

phpseclib\Crypt\TripleDES::$password_default_salt = 'phpseclib'

Definition at line 82 of file TripleDES.php.

◆ MODE_3CBC

const phpseclib\Crypt\TripleDES::MODE_3CBC = -2

Encrypt / decrypt using inner chaining.

Inner chaining is used by SSH-1 and is generally considered to be less secure then outer chaining (self::MODE_CBC3).

Definition at line 56 of file TripleDES.php.

Referenced by phpseclib\Net\SSH1\_connect().

◆ MODE_CBC3

const phpseclib\Crypt\TripleDES::MODE_CBC3 = Base::MODE_CBC

Encrypt / decrypt using outer chaining.

Outer chaining is used by SSH-2 and when the mode is set to ::MODE_CBC.

Definition at line 63 of file TripleDES.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpseclib/phpseclib/phpseclib/Crypt/TripleDES.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _setupKey()

◆ decrypt()

◆ disableContinuousBuffer()

◆ enableContinuousBuffer()

◆ encrypt()

◆ isValidEngine()

◆ setIV()

◆ setKey()

◆ setKeyLength()

◆ setPreferredEngine()

Field Documentation

◆ $cfb_init_len

◆ $cipher_name_mcrypt

◆ $des

◆ $key_length

◆ $key_length_max

◆ $mode_3cbc

◆ $password_default_salt

◆ MODE_3CBC

◆ MODE_CBC3