12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660 |
- <?php
- /**
- * Base Class for all Crypt_* cipher classes
- *
- * PHP versions 4 and 5
- *
- * Internally for phpseclib developers:
- * If you plan to add a new cipher class, please note following rules:
- *
- * - The new Crypt_* cipher class should extend Crypt_Base
- *
- * - Following methods are then required to be overridden/overloaded:
- *
- * - _encryptBlock()
- *
- * - _decryptBlock()
- *
- * - _setupKey()
- *
- * - All other methods are optional to be overridden/overloaded
- *
- * - Look at the source code of the current ciphers how they extend Crypt_Base
- * and take one of them as a start up for the new cipher class.
- *
- * - Please read all the other comments/notes/hints here also for each class var/method
- *
- * LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @category Crypt
- * @package Crypt_Base
- * @author Jim Wigginton <terrafrost@php.net>
- * @author Hans-Juergen Petrich <petrich@tronic-media.com>
- * @copyright 2007 Jim Wigginton
- * @license http://www.opensource.org/licenses/mit-license.html MIT License
- * @link http://phpseclib.sourceforge.net
- */
- /**#@+
- * @access public
- * @see self::encrypt()
- * @see self::decrypt()
- */
- /**
- * Encrypt / decrypt using the Counter mode.
- *
- * Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.
- *
- * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29
- */
- define('CRYPT_MODE_CTR', -1);
- /**
- * Encrypt / decrypt using the Electronic Code Book mode.
- *
- * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29
- */
- define('CRYPT_MODE_ECB', 1);
- /**
- * Encrypt / decrypt using the Code Book Chaining mode.
- *
- * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29
- */
- define('CRYPT_MODE_CBC', 2);
- /**
- * Encrypt / decrypt using the Cipher Feedback mode.
- *
- * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29
- */
- define('CRYPT_MODE_CFB', 3);
- /**
- * Encrypt / decrypt using the Output Feedback mode.
- *
- * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29
- */
- define('CRYPT_MODE_OFB', 4);
- /**
- * Encrypt / decrypt using streaming mode.
- */
- define('CRYPT_MODE_STREAM', 5);
- /**#@-*/
- /**#@+
- * @access private
- * @see self::Crypt_Base()
- * @internal These constants are for internal use only
- */
- /**
- * Base value for the internal implementation $engine switch
- */
- define('CRYPT_ENGINE_INTERNAL', 1);
- /**
- * Base value for the mcrypt implementation $engine switch
- */
- define('CRYPT_ENGINE_MCRYPT', 2);
- /**
- * Base value for the OpenSSL implementation $engine switch
- */
- define('CRYPT_ENGINE_OPENSSL', 3);
- /**#@-*/
- /**
- * Base Class for all Crypt_* cipher classes
- *
- * @package Crypt_Base
- * @author Jim Wigginton <terrafrost@php.net>
- * @author Hans-Juergen Petrich <petrich@tronic-media.com>
- * @access public
- */
- class Crypt_Base
- {
- /**
- * The Encryption Mode
- *
- * @see self::Crypt_Base()
- * @var int
- * @access private
- */
- var $mode;
- /**
- * The Block Length of the block cipher
- *
- * @var int
- * @access private
- */
- var $block_size = 16;
- /**
- * The Key
- *
- * @see self::setKey()
- * @var string
- * @access private
- */
- var $key = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
- /**
- * The Initialization Vector
- *
- * @see self::setIV()
- * @var string
- * @access private
- */
- var $iv;
- /**
- * A "sliding" Initialization Vector
- *
- * @see self::enableContinuousBuffer()
- * @see self::_clearBuffers()
- * @var string
- * @access private
- */
- var $encryptIV;
- /**
- * A "sliding" Initialization Vector
- *
- * @see self::enableContinuousBuffer()
- * @see self::_clearBuffers()
- * @var string
- * @access private
- */
- var $decryptIV;
- /**
- * Continuous Buffer status
- *
- * @see self::enableContinuousBuffer()
- * @var bool
- * @access private
- */
- var $continuousBuffer = false;
- /**
- * Encryption buffer for CTR, OFB and CFB modes
- *
- * @see self::encrypt()
- * @see self::_clearBuffers()
- * @var array
- * @access private
- */
- var $enbuffer;
- /**
- * Decryption buffer for CTR, OFB and CFB modes
- *
- * @see self::decrypt()
- * @see self::_clearBuffers()
- * @var array
- * @access private
- */
- var $debuffer;
- /**
- * mcrypt resource for encryption
- *
- * The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
- * Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
- *
- * @see self::encrypt()
- * @var resource
- * @access private
- */
- var $enmcrypt;
- /**
- * mcrypt resource for decryption
- *
- * The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
- * Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
- *
- * @see self::decrypt()
- * @var resource
- * @access private
- */
- var $demcrypt;
- /**
- * Does the enmcrypt resource need to be (re)initialized?
- *
- * @see Crypt_Twofish::setKey()
- * @see Crypt_Twofish::setIV()
- * @var bool
- * @access private
- */
- var $enchanged = true;
- /**
- * Does the demcrypt resource need to be (re)initialized?
- *
- * @see Crypt_Twofish::setKey()
- * @see Crypt_Twofish::setIV()
- * @var bool
- * @access private
- */
- var $dechanged = true;
- /**
- * mcrypt resource for CFB mode
- *
- * mcrypt's CFB mode, in (and only in) buffered context,
- * is broken, so phpseclib implements the CFB mode by it self,
- * even when the mcrypt php extension is available.
- *
- * In order to do the CFB-mode work (fast) phpseclib
- * use a separate ECB-mode mcrypt resource.
- *
- * @link http://phpseclib.sourceforge.net/cfb-demo.phps
- * @see self::encrypt()
- * @see self::decrypt()
- * @see self::_setupMcrypt()
- * @var resource
- * @access private
- */
- var $ecb;
- /**
- * Optimizing value while CFB-encrypting
- *
- * Only relevant if $continuousBuffer enabled
- * and $engine == CRYPT_ENGINE_MCRYPT
- *
- * It's faster to re-init $enmcrypt if
- * $buffer bytes > $cfb_init_len than
- * using the $ecb resource furthermore.
- *
- * This value depends of the chosen cipher
- * and the time it would be needed for it's
- * initialization [by mcrypt_generic_init()]
- * which, typically, depends on the complexity
- * on its internaly Key-expanding algorithm.
- *
- * @see self::encrypt()
- * @var int
- * @access private
- */
- var $cfb_init_len = 600;
- /**
- * Does internal cipher state need to be (re)initialized?
- *
- * @see self::setKey()
- * @see self::setIV()
- * @see self::disableContinuousBuffer()
- * @var bool
- * @access private
- */
- var $changed = true;
- /**
- * Padding status
- *
- * @see self::enablePadding()
- * @var bool
- * @access private
- */
- var $padding = true;
- /**
- * Is the mode one that is paddable?
- *
- * @see self::Crypt_Base()
- * @var bool
- * @access private
- */
- var $paddable = false;
- /**
- * Holds which crypt engine internaly should be use,
- * which will be determined automatically on __construct()
- *
- * Currently available $engines are:
- * - CRYPT_ENGINE_OPENSSL (very fast, php-extension: openssl, extension_loaded('openssl') required)
- * - CRYPT_ENGINE_MCRYPT (fast, php-extension: mcrypt, extension_loaded('mcrypt') required)
- * - CRYPT_ENGINE_INTERNAL (slower, pure php-engine, no php-extension required)
- *
- * @see self::_setEngine()
- * @see self::encrypt()
- * @see self::decrypt()
- * @var int
- * @access private
- */
- var $engine;
- /**
- * Holds the preferred crypt engine
- *
- * @see self::_setEngine()
- * @see self::setPreferredEngine()
- * @var int
- * @access private
- */
- var $preferredEngine;
- /**
- * The mcrypt specific name of the cipher
- *
- * Only used if $engine == CRYPT_ENGINE_MCRYPT
- *
- * @link http://www.php.net/mcrypt_module_open
- * @link http://www.php.net/mcrypt_list_algorithms
- * @see self::_setupMcrypt()
- * @var string
- * @access private
- */
- var $cipher_name_mcrypt;
- /**
- * The openssl specific name of the cipher
- *
- * Only used if $engine == CRYPT_ENGINE_OPENSSL
- *
- * @link http://www.php.net/openssl-get-cipher-methods
- * @var string
- * @access private
- */
- var $cipher_name_openssl;
- /**
- * The openssl specific name of the cipher in ECB mode
- *
- * If OpenSSL does not support the mode we're trying to use (CTR)
- * it can still be emulated with ECB mode.
- *
- * @link http://www.php.net/openssl-get-cipher-methods
- * @var string
- * @access private
- */
- var $cipher_name_openssl_ecb;
- /**
- * The default salt used by setPassword()
- *
- * @see self::setPassword()
- * @var string
- * @access private
- */
- var $password_default_salt = 'phpseclib/salt';
- /**
- * The namespace used by the cipher for its constants.
- *
- * ie: AES.php is using CRYPT_AES_MODE_* for its constants
- * so $const_namespace is AES
- *
- * DES.php is using CRYPT_DES_MODE_* for its constants
- * so $const_namespace is DES... and so on
- *
- * All CRYPT_<$const_namespace>_MODE_* are aliases of
- * the generic CRYPT_MODE_* constants, so both could be used
- * for each cipher.
- *
- * Example:
- * $aes = new Crypt_AES(CRYPT_AES_MODE_CFB); // $aes will operate in cfb mode
- * $aes = new Crypt_AES(CRYPT_MODE_CFB); // identical
- *
- * @see self::Crypt_Base()
- * @var string
- * @access private
- */
- var $const_namespace;
- /**
- * The name of the performance-optimized callback function
- *
- * Used by encrypt() / decrypt()
- * only if $engine == CRYPT_ENGINE_INTERNAL
- *
- * @see self::encrypt()
- * @see self::decrypt()
- * @see self::_setupInlineCrypt()
- * @see self::$use_inline_crypt
- * @var Callback
- * @access private
- */
- var $inline_crypt;
- /**
- * Holds whether performance-optimized $inline_crypt() can/should be used.
- *
- * @see self::encrypt()
- * @see self::decrypt()
- * @see self::inline_crypt
- * @var mixed
- * @access private
- */
- var $use_inline_crypt;
- /**
- * If OpenSSL can be used in ECB but not in CTR we can emulate CTR
- *
- * @see self::_openssl_ctr_process()
- * @var bool
- * @access private
- */
- var $openssl_emulate_ctr = false;
- /**
- * Determines what options are passed to openssl_encrypt/decrypt
- *
- * @see self::isValidEngine()
- * @var mixed
- * @access private
- */
- var $openssl_options;
- /**
- * Has the key length explicitly been set or should it be derived from the key, itself?
- *
- * @see self::setKeyLength()
- * @var bool
- * @access private
- */
- var $explicit_key_length = false;
- /**
- * Don't truncate / null pad key
- *
- * @see self::_clearBuffers()
- * @var bool
- * @access private
- */
- var $skip_key_adjustment = false;
- /**
- * Default Constructor.
- *
- * Determines whether or not the mcrypt extension should be used.
- *
- * $mode could be:
- *
- * - CRYPT_MODE_ECB
- *
- * - CRYPT_MODE_CBC
- *
- * - CRYPT_MODE_CTR
- *
- * - CRYPT_MODE_CFB
- *
- * - CRYPT_MODE_OFB
- *
- * (or the alias constants of the chosen cipher, for example for AES: CRYPT_AES_MODE_ECB or CRYPT_AES_MODE_CBC ...)
- *
- * If not explicitly set, CRYPT_MODE_CBC will be used.
- *
- * @param int $mode
- * @access public
- */
- function __construct($mode = CRYPT_MODE_CBC)
- {
- // $mode dependent settings
- switch ($mode) {
- case CRYPT_MODE_ECB:
- $this->paddable = true;
- $this->mode = CRYPT_MODE_ECB;
- break;
- case CRYPT_MODE_CTR:
- case CRYPT_MODE_CFB:
- case CRYPT_MODE_OFB:
- case CRYPT_MODE_STREAM:
- $this->mode = $mode;
- break;
- case CRYPT_MODE_CBC:
- default:
- $this->paddable = true;
- $this->mode = CRYPT_MODE_CBC;
- }
- $this->_setEngine();
- // Determining whether inline crypting can be used by the cipher
- if ($this->use_inline_crypt !== false) {
- $this->use_inline_crypt = version_compare(PHP_VERSION, '5.3.0') >= 0 || function_exists('create_function');
- }
- }
- /**
- * PHP4 compatible Default Constructor.
- *
- * @see self::__construct()
- * @param int $mode
- * @access public
- */
- function Crypt_Base($mode = CRYPT_MODE_CBC)
- {
- $this->__construct($mode);
- }
- /**
- * Sets the initialization vector. (optional)
- *
- * SetIV is not required when CRYPT_MODE_ECB (or ie for AES: CRYPT_AES_MODE_ECB) is being used. If not explicitly set, it'll be assumed
- * to be all zero's.
- *
- * @access public
- * @param string $iv
- * @internal Can be overwritten by a sub class, but does not have to be
- */
- function setIV($iv)
- {
- if ($this->mode == CRYPT_MODE_ECB) {
- return;
- }
- $this->iv = $iv;
- $this->changed = true;
- }
- /**
- * Sets the key length.
- *
- * Keys with explicitly set lengths need to be treated accordingly
- *
- * @access public
- * @param int $length
- */
- function setKeyLength($length)
- {
- $this->explicit_key_length = true;
- $this->changed = true;
- $this->_setEngine();
- }
- /**
- * Returns the current key length in bits
- *
- * @access public
- * @return int
- */
- function getKeyLength()
- {
- return $this->key_length << 3;
- }
- /**
- * Returns the current block length in bits
- *
- * @access public
- * @return int
- */
- function getBlockLength()
- {
- return $this->block_size << 3;
- }
- /**
- * Sets the key.
- *
- * The min/max length(s) of the key depends on the cipher which is used.
- * If the key not fits the length(s) of the cipher it will paded with null bytes
- * up to the closest valid key length. If the key is more than max length,
- * we trim the excess bits.
- *
- * If the key is not explicitly set, it'll be assumed to be all null bytes.
- *
- * @access public
- * @param string $key
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function setKey($key)
- {
- if (!$this->explicit_key_length) {
- $this->setKeyLength(strlen($key) << 3);
- $this->explicit_key_length = false;
- }
- $this->key = $key;
- $this->changed = true;
- $this->_setEngine();
- }
- /**
- * Sets the password.
- *
- * Depending on what $method is set to, setPassword()'s (optional) parameters are as follows:
- * {@link http://en.wikipedia.org/wiki/PBKDF2 pbkdf2} or pbkdf1:
- * $hash, $salt, $count, $dkLen
- *
- * Where $hash (default = sha1) currently supports the following hashes: see: Crypt/Hash.php
- *
- * @see Crypt/Hash.php
- * @param string $password
- * @param string $method
- * @return bool
- * @access public
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function setPassword($password, $method = 'pbkdf2')
- {
- $key = '';
- switch ($method) {
- default: // 'pbkdf2' or 'pbkdf1'
- $func_args = func_get_args();
- // Hash function
- $hash = isset($func_args[2]) ? $func_args[2] : 'sha1';
- // WPA and WPA2 use the SSID as the salt
- $salt = isset($func_args[3]) ? $func_args[3] : $this->password_default_salt;
- // RFC2898#section-4.2 uses 1,000 iterations by default
- // WPA and WPA2 use 4,096.
- $count = isset($func_args[4]) ? $func_args[4] : 1000;
- // Keylength
- if (isset($func_args[5]) && $func_args[5] > 0) {
- $dkLen = $func_args[5];
- } else {
- $dkLen = $method == 'pbkdf1' ? 2 * $this->key_length : $this->key_length;
- }
- switch (true) {
- case $method == 'pbkdf1':
- if (!class_exists('Crypt_Hash')) {
- include_once 'Crypt/Hash.php';
- }
- $hashObj = new Crypt_Hash();
- $hashObj->setHash($hash);
- if ($dkLen > $hashObj->getLength()) {
- user_error('Derived key too long');
- return false;
- }
- $t = $password . $salt;
- for ($i = 0; $i < $count; ++$i) {
- $t = $hashObj->hash($t);
- }
- $key = substr($t, 0, $dkLen);
- $this->setKey(substr($key, 0, $dkLen >> 1));
- $this->setIV(substr($key, $dkLen >> 1));
- return true;
- // Determining if php[>=5.5.0]'s hash_pbkdf2() function avail- and useable
- case !function_exists('hash_pbkdf2'):
- case !function_exists('hash_algos'):
- case !in_array($hash, hash_algos()):
- if (!class_exists('Crypt_Hash')) {
- include_once 'Crypt/Hash.php';
- }
- $i = 1;
- $hmac = new Crypt_Hash();
- $hmac->setHash($hash);
- $hmac->setKey($password);
- while (strlen($key) < $dkLen) {
- $f = $u = $hmac->hash($salt . pack('N', $i++));
- for ($j = 2; $j <= $count; ++$j) {
- $u = $hmac->hash($u);
- $f^= $u;
- }
- $key.= $f;
- }
- $key = substr($key, 0, $dkLen);
- break;
- default:
- $key = hash_pbkdf2($hash, $password, $salt, $count, $dkLen, true);
- }
- }
- $this->setKey($key);
- return true;
- }
- /**
- * Encrypts a message.
- *
- * $plaintext will be padded with additional bytes such that it's length is a multiple of the block size. Other cipher
- * implementations may or may not pad in the same manner. Other common approaches to padding and the reasons why it's
- * necessary are discussed in the following
- * URL:
- *
- * {@link http://www.di-mgt.com.au/cryptopad.html http://www.di-mgt.com.au/cryptopad.html}
- *
- * An alternative to padding is to, separately, send the length of the file. This is what SSH, in fact, does.
- * strlen($plaintext) will still need to be a multiple of the block size, however, arbitrary values can be added to make it that
- * length.
- *
- * @see self::decrypt()
- * @access public
- * @param string $plaintext
- * @return string $ciphertext
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function encrypt($plaintext)
- {
- if ($this->paddable) {
- $plaintext = $this->_pad($plaintext);
- }
- if ($this->engine === CRYPT_ENGINE_OPENSSL) {
- if ($this->changed) {
- $this->_clearBuffers();
- $this->changed = false;
- }
- switch ($this->mode) {
- case CRYPT_MODE_STREAM:
- return openssl_encrypt($plaintext, $this->cipher_name_openssl, $this->key, $this->openssl_options);
- case CRYPT_MODE_ECB:
- $result = @openssl_encrypt($plaintext, $this->cipher_name_openssl, $this->key, $this->openssl_options);
- return !defined('OPENSSL_RAW_DATA') ? substr($result, 0, -$this->block_size) : $result;
- case CRYPT_MODE_CBC:
- $result = openssl_encrypt($plaintext, $this->cipher_name_openssl, $this->key, $this->openssl_options, $this->encryptIV);
- if (!defined('OPENSSL_RAW_DATA')) {
- $result = substr($result, 0, -$this->block_size);
- }
- if ($this->continuousBuffer) {
- $this->encryptIV = substr($result, -$this->block_size);
- }
- return $result;
- case CRYPT_MODE_CTR:
- return $this->_openssl_ctr_process($plaintext, $this->encryptIV, $this->enbuffer);
- case CRYPT_MODE_CFB:
- // cfb loosely routines inspired by openssl's:
- // {@link http://cvs.openssl.org/fileview?f=openssl/crypto/modes/cfb128.c&v=1.3.2.2.2.1}
- $ciphertext = '';
- if ($this->continuousBuffer) {
- $iv = &$this->encryptIV;
- $pos = &$this->enbuffer['pos'];
- } else {
- $iv = $this->encryptIV;
- $pos = 0;
- }
- $len = strlen($plaintext);
- $i = 0;
- if ($pos) {
- $orig_pos = $pos;
- $max = $this->block_size - $pos;
- if ($len >= $max) {
- $i = $max;
- $len-= $max;
- $pos = 0;
- } else {
- $i = $len;
- $pos+= $len;
- $len = 0;
- }
- // ie. $i = min($max, $len), $len-= $i, $pos+= $i, $pos%= $blocksize
- $ciphertext = substr($iv, $orig_pos) ^ $plaintext;
- $iv = substr_replace($iv, $ciphertext, $orig_pos, $i);
- $plaintext = substr($plaintext, $i);
- }
- $overflow = $len % $this->block_size;
- if ($overflow) {
- $ciphertext.= openssl_encrypt(substr($plaintext, 0, -$overflow) . str_repeat("\0", $this->block_size), $this->cipher_name_openssl, $this->key, $this->openssl_options, $iv);
- $iv = $this->_string_pop($ciphertext, $this->block_size);
- $size = $len - $overflow;
- $block = $iv ^ substr($plaintext, -$overflow);
- $iv = substr_replace($iv, $block, 0, $overflow);
- $ciphertext.= $block;
- $pos = $overflow;
- } elseif ($len) {
- $ciphertext = openssl_encrypt($plaintext, $this->cipher_name_openssl, $this->key, $this->openssl_options, $iv);
- $iv = substr($ciphertext, -$this->block_size);
- }
- return $ciphertext;
- case CRYPT_MODE_OFB:
- return $this->_openssl_ofb_process($plaintext, $this->encryptIV, $this->enbuffer);
- }
- }
- if ($this->engine === CRYPT_ENGINE_MCRYPT) {
- if ($this->changed) {
- $this->_setupMcrypt();
- $this->changed = false;
- }
- if ($this->enchanged) {
- @mcrypt_generic_init($this->enmcrypt, $this->key, $this->encryptIV);
- $this->enchanged = false;
- }
- // re: {@link http://phpseclib.sourceforge.net/cfb-demo.phps}
- // using mcrypt's default handing of CFB the above would output two different things. using phpseclib's
- // rewritten CFB implementation the above outputs the same thing twice.
- if ($this->mode == CRYPT_MODE_CFB && $this->continuousBuffer) {
- $block_size = $this->block_size;
- $iv = &$this->encryptIV;
- $pos = &$this->enbuffer['pos'];
- $len = strlen($plaintext);
- $ciphertext = '';
- $i = 0;
- if ($pos) {
- $orig_pos = $pos;
- $max = $block_size - $pos;
- if ($len >= $max) {
- $i = $max;
- $len-= $max;
- $pos = 0;
- } else {
- $i = $len;
- $pos+= $len;
- $len = 0;
- }
- $ciphertext = substr($iv, $orig_pos) ^ $plaintext;
- $iv = substr_replace($iv, $ciphertext, $orig_pos, $i);
- $this->enbuffer['enmcrypt_init'] = true;
- }
- if ($len >= $block_size) {
- if ($this->enbuffer['enmcrypt_init'] === false || $len > $this->cfb_init_len) {
- if ($this->enbuffer['enmcrypt_init'] === true) {
- @mcrypt_generic_init($this->enmcrypt, $this->key, $iv);
- $this->enbuffer['enmcrypt_init'] = false;
- }
- $ciphertext.= @mcrypt_generic($this->enmcrypt, substr($plaintext, $i, $len - $len % $block_size));
- $iv = substr($ciphertext, -$block_size);
- $len%= $block_size;
- } else {
- while ($len >= $block_size) {
- $iv = @mcrypt_generic($this->ecb, $iv) ^ substr($plaintext, $i, $block_size);
- $ciphertext.= $iv;
- $len-= $block_size;
- $i+= $block_size;
- }
- }
- }
- if ($len) {
- $iv = @mcrypt_generic($this->ecb, $iv);
- $block = $iv ^ substr($plaintext, -$len);
- $iv = substr_replace($iv, $block, 0, $len);
- $ciphertext.= $block;
- $pos = $len;
- }
- return $ciphertext;
- }
- $ciphertext = @mcrypt_generic($this->enmcrypt, $plaintext);
- if (!$this->continuousBuffer) {
- @mcrypt_generic_init($this->enmcrypt, $this->key, $this->encryptIV);
- }
- return $ciphertext;
- }
- if ($this->changed) {
- $this->_setup();
- $this->changed = false;
- }
- if ($this->use_inline_crypt) {
- $inline = $this->inline_crypt;
- return $inline('encrypt', $this, $plaintext);
- }
- $buffer = &$this->enbuffer;
- $block_size = $this->block_size;
- $ciphertext = '';
- switch ($this->mode) {
- case CRYPT_MODE_ECB:
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $ciphertext.= $this->_encryptBlock(substr($plaintext, $i, $block_size));
- }
- break;
- case CRYPT_MODE_CBC:
- $xor = $this->encryptIV;
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $block = substr($plaintext, $i, $block_size);
- $block = $this->_encryptBlock($block ^ $xor);
- $xor = $block;
- $ciphertext.= $block;
- }
- if ($this->continuousBuffer) {
- $this->encryptIV = $xor;
- }
- break;
- case CRYPT_MODE_CTR:
- $xor = $this->encryptIV;
- if (strlen($buffer['ciphertext'])) {
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $block = substr($plaintext, $i, $block_size);
- if (strlen($block) > strlen($buffer['ciphertext'])) {
- $buffer['ciphertext'].= $this->_encryptBlock($xor);
- }
- $this->_increment_str($xor);
- $key = $this->_string_shift($buffer['ciphertext'], $block_size);
- $ciphertext.= $block ^ $key;
- }
- } else {
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $block = substr($plaintext, $i, $block_size);
- $key = $this->_encryptBlock($xor);
- $this->_increment_str($xor);
- $ciphertext.= $block ^ $key;
- }
- }
- if ($this->continuousBuffer) {
- $this->encryptIV = $xor;
- if ($start = strlen($plaintext) % $block_size) {
- $buffer['ciphertext'] = substr($key, $start) . $buffer['ciphertext'];
- }
- }
- break;
- case CRYPT_MODE_CFB:
- // cfb loosely routines inspired by openssl's:
- // {@link http://cvs.openssl.org/fileview?f=openssl/crypto/modes/cfb128.c&v=1.3.2.2.2.1}
- if ($this->continuousBuffer) {
- $iv = &$this->encryptIV;
- $pos = &$buffer['pos'];
- } else {
- $iv = $this->encryptIV;
- $pos = 0;
- }
- $len = strlen($plaintext);
- $i = 0;
- if ($pos) {
- $orig_pos = $pos;
- $max = $block_size - $pos;
- if ($len >= $max) {
- $i = $max;
- $len-= $max;
- $pos = 0;
- } else {
- $i = $len;
- $pos+= $len;
- $len = 0;
- }
- // ie. $i = min($max, $len), $len-= $i, $pos+= $i, $pos%= $blocksize
- $ciphertext = substr($iv, $orig_pos) ^ $plaintext;
- $iv = substr_replace($iv, $ciphertext, $orig_pos, $i);
- }
- while ($len >= $block_size) {
- $iv = $this->_encryptBlock($iv) ^ substr($plaintext, $i, $block_size);
- $ciphertext.= $iv;
- $len-= $block_size;
- $i+= $block_size;
- }
- if ($len) {
- $iv = $this->_encryptBlock($iv);
- $block = $iv ^ substr($plaintext, $i);
- $iv = substr_replace($iv, $block, 0, $len);
- $ciphertext.= $block;
- $pos = $len;
- }
- break;
- case CRYPT_MODE_OFB:
- $xor = $this->encryptIV;
- if (strlen($buffer['xor'])) {
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $block = substr($plaintext, $i, $block_size);
- if (strlen($block) > strlen($buffer['xor'])) {
- $xor = $this->_encryptBlock($xor);
- $buffer['xor'].= $xor;
- }
- $key = $this->_string_shift($buffer['xor'], $block_size);
- $ciphertext.= $block ^ $key;
- }
- } else {
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $xor = $this->_encryptBlock($xor);
- $ciphertext.= substr($plaintext, $i, $block_size) ^ $xor;
- }
- $key = $xor;
- }
- if ($this->continuousBuffer) {
- $this->encryptIV = $xor;
- if ($start = strlen($plaintext) % $block_size) {
- $buffer['xor'] = substr($key, $start) . $buffer['xor'];
- }
- }
- break;
- case CRYPT_MODE_STREAM:
- $ciphertext = $this->_encryptBlock($plaintext);
- break;
- }
- return $ciphertext;
- }
- /**
- * Decrypts a message.
- *
- * If strlen($ciphertext) is not a multiple of the block size, null bytes will be added to the end of the string until
- * it is.
- *
- * @see self::encrypt()
- * @access public
- * @param string $ciphertext
- * @return string $plaintext
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function decrypt($ciphertext)
- {
- if ($this->paddable) {
- // we pad with chr(0) since that's what mcrypt_generic does. to quote from {@link http://www.php.net/function.mcrypt-generic}:
- // "The data is padded with "\0" to make sure the length of the data is n * blocksize."
- $ciphertext = str_pad($ciphertext, strlen($ciphertext) + ($this->block_size - strlen($ciphertext) % $this->block_size) % $this->block_size, chr(0));
- }
- if ($this->engine === CRYPT_ENGINE_OPENSSL) {
- if ($this->changed) {
- $this->_clearBuffers();
- $this->changed = false;
- }
- switch ($this->mode) {
- case CRYPT_MODE_STREAM:
- $plaintext = openssl_decrypt($ciphertext, $this->cipher_name_openssl, $this->key, $this->openssl_options);
- break;
- case CRYPT_MODE_ECB:
- if (!defined('OPENSSL_RAW_DATA')) {
- $ciphertext.= @openssl_encrypt('', $this->cipher_name_openssl_ecb, $this->key, true);
- }
- $plaintext = openssl_decrypt($ciphertext, $this->cipher_name_openssl, $this->key, $this->openssl_options);
- break;
- case CRYPT_MODE_CBC:
- if (!defined('OPENSSL_RAW_DATA')) {
- $padding = str_repeat(chr($this->block_size), $this->block_size) ^ substr($ciphertext, -$this->block_size);
- $ciphertext.= substr(@openssl_encrypt($padding, $this->cipher_name_openssl_ecb, $this->key, true), 0, $this->block_size);
- $offset = 2 * $this->block_size;
- } else {
- $offset = $this->block_size;
- }
- $plaintext = openssl_decrypt($ciphertext, $this->cipher_name_openssl, $this->key, $this->openssl_options, $this->decryptIV);
- if ($this->continuousBuffer) {
- $this->decryptIV = substr($ciphertext, -$offset, $this->block_size);
- }
- break;
- case CRYPT_MODE_CTR:
- $plaintext = $this->_openssl_ctr_process($ciphertext, $this->decryptIV, $this->debuffer);
- break;
- case CRYPT_MODE_CFB:
- // cfb loosely routines inspired by openssl's:
- // {@link http://cvs.openssl.org/fileview?f=openssl/crypto/modes/cfb128.c&v=1.3.2.2.2.1}
- $plaintext = '';
- if ($this->continuousBuffer) {
- $iv = &$this->decryptIV;
- $pos = &$this->buffer['pos'];
- } else {
- $iv = $this->decryptIV;
- $pos = 0;
- }
- $len = strlen($ciphertext);
- $i = 0;
- if ($pos) {
- $orig_pos = $pos;
- $max = $this->block_size - $pos;
- if ($len >= $max) {
- $i = $max;
- $len-= $max;
- $pos = 0;
- } else {
- $i = $len;
- $pos+= $len;
- $len = 0;
- }
- // ie. $i = min($max, $len), $len-= $i, $pos+= $i, $pos%= $this->blocksize
- $plaintext = substr($iv, $orig_pos) ^ $ciphertext;
- $iv = substr_replace($iv, substr($ciphertext, 0, $i), $orig_pos, $i);
- $ciphertext = substr($ciphertext, $i);
- }
- $overflow = $len % $this->block_size;
- if ($overflow) {
- $plaintext.= openssl_decrypt(substr($ciphertext, 0, -$overflow), $this->cipher_name_openssl, $this->key, $this->openssl_options, $iv);
- if ($len - $overflow) {
- $iv = substr($ciphertext, -$overflow - $this->block_size, -$overflow);
- }
- $iv = openssl_encrypt(str_repeat("\0", $this->block_size), $this->cipher_name_openssl, $this->key, $this->openssl_options, $iv);
- $plaintext.= $iv ^ substr($ciphertext, -$overflow);
- $iv = substr_replace($iv, substr($ciphertext, -$overflow), 0, $overflow);
- $pos = $overflow;
- } elseif ($len) {
- $plaintext.= openssl_decrypt($ciphertext, $this->cipher_name_openssl, $this->key, $this->openssl_options, $iv);
- $iv = substr($ciphertext, -$this->block_size);
- }
- break;
- case CRYPT_MODE_OFB:
- $plaintext = $this->_openssl_ofb_process($ciphertext, $this->decryptIV, $this->debuffer);
- }
- return $this->paddable ? $this->_unpad($plaintext) : $plaintext;
- }
- if ($this->engine === CRYPT_ENGINE_MCRYPT) {
- $block_size = $this->block_size;
- if ($this->changed) {
- $this->_setupMcrypt();
- $this->changed = false;
- }
- if ($this->dechanged) {
- @mcrypt_generic_init($this->demcrypt, $this->key, $this->decryptIV);
- $this->dechanged = false;
- }
- if ($this->mode == CRYPT_MODE_CFB && $this->continuousBuffer) {
- $iv = &$this->decryptIV;
- $pos = &$this->debuffer['pos'];
- $len = strlen($ciphertext);
- $plaintext = '';
- $i = 0;
- if ($pos) {
- $orig_pos = $pos;
- $max = $block_size - $pos;
- if ($len >= $max) {
- $i = $max;
- $len-= $max;
- $pos = 0;
- } else {
- $i = $len;
- $pos+= $len;
- $len = 0;
- }
- // ie. $i = min($max, $len), $len-= $i, $pos+= $i, $pos%= $blocksize
- $plaintext = substr($iv, $orig_pos) ^ $ciphertext;
- $iv = substr_replace($iv, substr($ciphertext, 0, $i), $orig_pos, $i);
- }
- if ($len >= $block_size) {
- $cb = substr($ciphertext, $i, $len - $len % $block_size);
- $plaintext.= @mcrypt_generic($this->ecb, $iv . $cb) ^ $cb;
- $iv = substr($cb, -$block_size);
- $len%= $block_size;
- }
- if ($len) {
- $iv = @mcrypt_generic($this->ecb, $iv);
- $plaintext.= $iv ^ substr($ciphertext, -$len);
- $iv = substr_replace($iv, substr($ciphertext, -$len), 0, $len);
- $pos = $len;
- }
- return $plaintext;
- }
- $plaintext = @mdecrypt_generic($this->demcrypt, $ciphertext);
- if (!$this->continuousBuffer) {
- @mcrypt_generic_init($this->demcrypt, $this->key, $this->decryptIV);
- }
- return $this->paddable ? $this->_unpad($plaintext) : $plaintext;
- }
- if ($this->changed) {
- $this->_setup();
- $this->changed = false;
- }
- if ($this->use_inline_crypt) {
- $inline = $this->inline_crypt;
- return $inline('decrypt', $this, $ciphertext);
- }
- $block_size = $this->block_size;
- $buffer = &$this->debuffer;
- $plaintext = '';
- switch ($this->mode) {
- case CRYPT_MODE_ECB:
- for ($i = 0; $i < strlen($ciphertext); $i+=$block_size) {
- $plaintext.= $this->_decryptBlock(substr($ciphertext, $i, $block_size));
- }
- break;
- case CRYPT_MODE_CBC:
- $xor = $this->decryptIV;
- for ($i = 0; $i < strlen($ciphertext); $i+=$block_size) {
- $block = substr($ciphertext, $i, $block_size);
- $plaintext.= $this->_decryptBlock($block) ^ $xor;
- $xor = $block;
- }
- if ($this->continuousBuffer) {
- $this->decryptIV = $xor;
- }
- break;
- case CRYPT_MODE_CTR:
- $xor = $this->decryptIV;
- if (strlen($buffer['ciphertext'])) {
- for ($i = 0; $i < strlen($ciphertext); $i+=$block_size) {
- $block = substr($ciphertext, $i, $block_size);
- if (strlen($block) > strlen($buffer['ciphertext'])) {
- $buffer['ciphertext'].= $this->_encryptBlock($xor);
- $this->_increment_str($xor);
- }
- $key = $this->_string_shift($buffer['ciphertext'], $block_size);
- $plaintext.= $block ^ $key;
- }
- } else {
- for ($i = 0; $i < strlen($ciphertext); $i+=$block_size) {
- $block = substr($ciphertext, $i, $block_size);
- $key = $this->_encryptBlock($xor);
- $this->_increment_str($xor);
- $plaintext.= $block ^ $key;
- }
- }
- if ($this->continuousBuffer) {
- $this->decryptIV = $xor;
- if ($start = strlen($ciphertext) % $block_size) {
- $buffer['ciphertext'] = substr($key, $start) . $buffer['ciphertext'];
- }
- }
- break;
- case CRYPT_MODE_CFB:
- if ($this->continuousBuffer) {
- $iv = &$this->decryptIV;
- $pos = &$buffer['pos'];
- } else {
- $iv = $this->decryptIV;
- $pos = 0;
- }
- $len = strlen($ciphertext);
- $i = 0;
- if ($pos) {
- $orig_pos = $pos;
- $max = $block_size - $pos;
- if ($len >= $max) {
- $i = $max;
- $len-= $max;
- $pos = 0;
- } else {
- $i = $len;
- $pos+= $len;
- $len = 0;
- }
- // ie. $i = min($max, $len), $len-= $i, $pos+= $i, $pos%= $blocksize
- $plaintext = substr($iv, $orig_pos) ^ $ciphertext;
- $iv = substr_replace($iv, substr($ciphertext, 0, $i), $orig_pos, $i);
- }
- while ($len >= $block_size) {
- $iv = $this->_encryptBlock($iv);
- $cb = substr($ciphertext, $i, $block_size);
- $plaintext.= $iv ^ $cb;
- $iv = $cb;
- $len-= $block_size;
- $i+= $block_size;
- }
- if ($len) {
- $iv = $this->_encryptBlock($iv);
- $plaintext.= $iv ^ substr($ciphertext, $i);
- $iv = substr_replace($iv, substr($ciphertext, $i), 0, $len);
- $pos = $len;
- }
- break;
- case CRYPT_MODE_OFB:
- $xor = $this->decryptIV;
- if (strlen($buffer['xor'])) {
- for ($i = 0; $i < strlen($ciphertext); $i+=$block_size) {
- $block = substr($ciphertext, $i, $block_size);
- if (strlen($block) > strlen($buffer['xor'])) {
- $xor = $this->_encryptBlock($xor);
- $buffer['xor'].= $xor;
- }
- $key = $this->_string_shift($buffer['xor'], $block_size);
- $plaintext.= $block ^ $key;
- }
- } else {
- for ($i = 0; $i < strlen($ciphertext); $i+=$block_size) {
- $xor = $this->_encryptBlock($xor);
- $plaintext.= substr($ciphertext, $i, $block_size) ^ $xor;
- }
- $key = $xor;
- }
- if ($this->continuousBuffer) {
- $this->decryptIV = $xor;
- if ($start = strlen($ciphertext) % $block_size) {
- $buffer['xor'] = substr($key, $start) . $buffer['xor'];
- }
- }
- break;
- case CRYPT_MODE_STREAM:
- $plaintext = $this->_decryptBlock($ciphertext);
- break;
- }
- return $this->paddable ? $this->_unpad($plaintext) : $plaintext;
- }
- /**
- * OpenSSL CTR Processor
- *
- * PHP's OpenSSL bindings do not operate in continuous mode so we'll wrap around it. Since the keystream
- * for CTR is the same for both encrypting and decrypting this function is re-used by both Crypt_Base::encrypt()
- * and Crypt_Base::decrypt(). Also, OpenSSL doesn't implement CTR for all of it's symmetric ciphers so this
- * function will emulate CTR with ECB when necessary.
- *
- * @see self::encrypt()
- * @see self::decrypt()
- * @param string $plaintext
- * @param string $encryptIV
- * @param array $buffer
- * @return string
- * @access private
- */
- function _openssl_ctr_process($plaintext, &$encryptIV, &$buffer)
- {
- $ciphertext = '';
- $block_size = $this->block_size;
- $key = $this->key;
- if ($this->openssl_emulate_ctr) {
- $xor = $encryptIV;
- if (strlen($buffer['ciphertext'])) {
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $block = substr($plaintext, $i, $block_size);
- if (strlen($block) > strlen($buffer['ciphertext'])) {
- $result = @openssl_encrypt($xor, $this->cipher_name_openssl_ecb, $key, $this->openssl_options);
- $result = !defined('OPENSSL_RAW_DATA') ? substr($result, 0, -$this->block_size) : $result;
- $buffer['ciphertext'].= $result;
- }
- $this->_increment_str($xor);
- $otp = $this->_string_shift($buffer['ciphertext'], $block_size);
- $ciphertext.= $block ^ $otp;
- }
- } else {
- for ($i = 0; $i < strlen($plaintext); $i+=$block_size) {
- $block = substr($plaintext, $i, $block_size);
- $otp = @openssl_encrypt($xor, $this->cipher_name_openssl_ecb, $key, $this->openssl_options);
- $otp = !defined('OPENSSL_RAW_DATA') ? substr($otp, 0, -$this->block_size) : $otp;
- $this->_increment_str($xor);
- $ciphertext.= $block ^ $otp;
- }
- }
- if ($this->continuousBuffer) {
- $encryptIV = $xor;
- if ($start = strlen($plaintext) % $block_size) {
- $buffer['ciphertext'] = substr($key, $start) . $buffer['ciphertext'];
- }
- }
- return $ciphertext;
- }
- if (strlen($buffer['ciphertext'])) {
- $ciphertext = $plaintext ^ $this->_string_shift($buffer['ciphertext'], strlen($plaintext));
- $plaintext = substr($plaintext, strlen($ciphertext));
- if (!strlen($plaintext)) {
- return $ciphertext;
- }
- }
- $overflow = strlen($plaintext) % $block_size;
- if ($overflow) {
- $plaintext2 = $this->_string_pop($plaintext, $overflow); // ie. trim $plaintext to a multiple of $block_size and put rest of $plaintext in $plaintext2
- $encrypted = openssl_encrypt($plaintext . str_repeat("\0", $block_size), $this->cipher_name_openssl, $key, $this->openssl_options, $encryptIV);
- $temp = $this->_string_pop($encrypted, $block_size);
- $ciphertext.= $encrypted . ($plaintext2 ^ $temp);
- if ($this->continuousBuffer) {
- $buffer['ciphertext'] = substr($temp, $overflow);
- $encryptIV = $temp;
- }
- } elseif (!strlen($buffer['ciphertext'])) {
- $ciphertext.= openssl_encrypt($plaintext . str_repeat("\0", $block_size), $this->cipher_name_openssl, $key, $this->openssl_options, $encryptIV);
- $temp = $this->_string_pop($ciphertext, $block_size);
- if ($this->continuousBuffer) {
- $encryptIV = $temp;
- }
- }
- if ($this->continuousBuffer) {
- if (!defined('OPENSSL_RAW_DATA')) {
- $encryptIV.= @openssl_encrypt('', $this->cipher_name_openssl_ecb, $key, $this->openssl_options);
- }
- $encryptIV = openssl_decrypt($encryptIV, $this->cipher_name_openssl_ecb, $key, $this->openssl_options);
- if ($overflow) {
- $this->_increment_str($encryptIV);
- }
- }
- return $ciphertext;
- }
- /**
- * OpenSSL OFB Processor
- *
- * PHP's OpenSSL bindings do not operate in continuous mode so we'll wrap around it. Since the keystream
- * for OFB is the same for both encrypting and decrypting this function is re-used by both Crypt_Base::encrypt()
- * and Crypt_Base::decrypt().
- *
- * @see self::encrypt()
- * @see self::decrypt()
- * @param string $plaintext
- * @param string $encryptIV
- * @param array $buffer
- * @return string
- * @access private
- */
- function _openssl_ofb_process($plaintext, &$encryptIV, &$buffer)
- {
- if (strlen($buffer['xor'])) {
- $ciphertext = $plaintext ^ $buffer['xor'];
- $buffer['xor'] = substr($buffer['xor'], strlen($ciphertext));
- $plaintext = substr($plaintext, strlen($ciphertext));
- } else {
- $ciphertext = '';
- }
- $block_size = $this->block_size;
- $len = strlen($plaintext);
- $key = $this->key;
- $overflow = $len % $block_size;
- if (strlen($plaintext)) {
- if ($overflow) {
- $ciphertext.= openssl_encrypt(substr($plaintext, 0, -$overflow) . str_repeat("\0", $block_size), $this->cipher_name_openssl, $key, $this->openssl_options, $encryptIV);
- $xor = $this->_string_pop($ciphertext, $block_size);
- if ($this->continuousBuffer) {
- $encryptIV = $xor;
- }
- $ciphertext.= $this->_string_shift($xor, $overflow) ^ substr($plaintext, -$overflow);
- if ($this->continuousBuffer) {
- $buffer['xor'] = $xor;
- }
- } else {
- $ciphertext = openssl_encrypt($plaintext, $this->cipher_name_openssl, $key, $this->openssl_options, $encryptIV);
- if ($this->continuousBuffer) {
- $encryptIV = substr($ciphertext, -$block_size) ^ substr($plaintext, -$block_size);
- }
- }
- }
- return $ciphertext;
- }
- /**
- * phpseclib <-> OpenSSL Mode Mapper
- *
- * May need to be overwritten by classes extending this one in some cases
- *
- * @return int
- * @access private
- */
- function _openssl_translate_mode()
- {
- switch ($this->mode) {
- case CRYPT_MODE_ECB:
- return 'ecb';
- case CRYPT_MODE_CBC:
- return 'cbc';
- case CRYPT_MODE_CTR:
- return 'ctr';
- case CRYPT_MODE_CFB:
- return 'cfb';
- case CRYPT_MODE_OFB:
- return 'ofb';
- }
- }
- /**
- * Pad "packets".
- *
- * Block ciphers working by encrypting between their specified [$this->]block_size at a time
- * If you ever need to encrypt or decrypt something that isn't of the proper length, it becomes necessary to
- * pad the input so that it is of the proper length.
- *
- * Padding is enabled by default. Sometimes, however, it is undesirable to pad strings. Such is the case in SSH,
- * where "packets" are padded with random bytes before being encrypted. Unpad these packets and you risk stripping
- * away characters that shouldn't be stripped away. (SSH knows how many bytes are added because the length is
- * transmitted separately)
- *
- * @see self::disablePadding()
- * @access public
- */
- function enablePadding()
- {
- $this->padding = true;
- }
- /**
- * Do not pad packets.
- *
- * @see self::enablePadding()
- * @access public
- */
- function disablePadding()
- {
- $this->padding = false;
- }
- /**
- * Treat consecutive "packets" as if they are a continuous buffer.
- *
- * Say you have a 32-byte plaintext $plaintext. Using the default behavior, the two following code snippets
- * will yield different outputs:
- *
- * <code>
- * echo $rijndael->encrypt(substr($plaintext, 0, 16));
- * echo $rijndael->encrypt(substr($plaintext, 16, 16));
- * </code>
- * <code>
- * echo $rijndael->encrypt($plaintext);
- * </code>
- *
- * The solution is to enable the continuous buffer. Although this will resolve the above discrepancy, it creates
- * another, as demonstrated with the following:
- *
- * <code>
- * $rijndael->encrypt(substr($plaintext, 0, 16));
- * echo $rijndael->decrypt($rijndael->encrypt(substr($plaintext, 16, 16)));
- * </code>
- * <code>
- * echo $rijndael->decrypt($rijndael->encrypt(substr($plaintext, 16, 16)));
- * </code>
- *
- * 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 Crypt_*() 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 self::disableContinuousBuffer()
- * @access public
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function enableContinuousBuffer()
- {
- if ($this->mode == CRYPT_MODE_ECB) {
- return;
- }
- $this->continuousBuffer = true;
- $this->_setEngine();
- }
- /**
- * Treat consecutive packets as if they are a discontinuous buffer.
- *
- * The default behavior.
- *
- * @see self::enableContinuousBuffer()
- * @access public
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function disableContinuousBuffer()
- {
- if ($this->mode == CRYPT_MODE_ECB) {
- return;
- }
- if (!$this->continuousBuffer) {
- return;
- }
- $this->continuousBuffer = false;
- $this->changed = true;
- $this->_setEngine();
- }
- /**
- * Test for engine validity
- *
- * @see self::Crypt_Base()
- * @param int $engine
- * @access public
- * @return bool
- */
- function isValidEngine($engine)
- {
- switch ($engine) {
- case CRYPT_ENGINE_OPENSSL:
- if ($this->mode == CRYPT_MODE_STREAM && $this->continuousBuffer) {
- return false;
- }
- $this->openssl_emulate_ctr = false;
- $result = $this->cipher_name_openssl &&
- extension_loaded('openssl') &&
- // PHP 5.3.0 - 5.3.2 did not let you set IV's
- version_compare(PHP_VERSION, '5.3.3', '>=');
- if (!$result) {
- return false;
- }
- // prior to PHP 5.4.0 OPENSSL_RAW_DATA and OPENSSL_ZERO_PADDING were not defined. instead of expecting an integer
- // $options openssl_encrypt expected a boolean $raw_data.
- if (!defined('OPENSSL_RAW_DATA')) {
- $this->openssl_options = true;
- } else {
- $this->openssl_options = OPENSSL_RAW_DATA | OPENSSL_ZERO_PADDING;
- }
- $methods = openssl_get_cipher_methods();
- if (in_array($this->cipher_name_openssl, $methods)) {
- return true;
- }
- // not all of openssl's symmetric cipher's support ctr. for those
- // that don't we'll emulate it
- switch ($this->mode) {
- case CRYPT_MODE_CTR:
- if (in_array($this->cipher_name_openssl_ecb, $methods)) {
- $this->openssl_emulate_ctr = true;
- return true;
- }
- }
- return false;
- case CRYPT_ENGINE_MCRYPT:
- return $this->cipher_name_mcrypt &&
- extension_loaded('mcrypt') &&
- in_array($this->cipher_name_mcrypt, @mcrypt_list_algorithms());
- case CRYPT_ENGINE_INTERNAL:
- return true;
- }
- return false;
- }
- /**
- * Sets the preferred crypt engine
- *
- * Currently, $engine could be:
- *
- * - CRYPT_ENGINE_OPENSSL [very fast]
- *
- * - CRYPT_ENGINE_MCRYPT [fast]
- *
- * - CRYPT_ENGINE_INTERNAL [slow]
- *
- * If the preferred crypt engine is not available the fastest available one will be used
- *
- * @see self::Crypt_Base()
- * @param int $engine
- * @access public
- */
- function setPreferredEngine($engine)
- {
- switch ($engine) {
- //case CRYPT_ENGINE_OPENSSL:
- case CRYPT_ENGINE_MCRYPT:
- case CRYPT_ENGINE_INTERNAL:
- $this->preferredEngine = $engine;
- break;
- default:
- $this->preferredEngine = CRYPT_ENGINE_OPENSSL;
- }
- $this->_setEngine();
- }
- /**
- * Returns the engine currently being utilized
- *
- * @see self::_setEngine()
- * @access public
- */
- function getEngine()
- {
- return $this->engine;
- }
- /**
- * Sets the engine as appropriate
- *
- * @see self::Crypt_Base()
- * @access private
- */
- function _setEngine()
- {
- $this->engine = null;
- $candidateEngines = array(
- $this->preferredEngine,
- CRYPT_ENGINE_OPENSSL,
- CRYPT_ENGINE_MCRYPT
- );
- foreach ($candidateEngines as $engine) {
- if ($this->isValidEngine($engine)) {
- $this->engine = $engine;
- break;
- }
- }
- if (!$this->engine) {
- $this->engine = CRYPT_ENGINE_INTERNAL;
- }
- if ($this->engine != CRYPT_ENGINE_MCRYPT && $this->enmcrypt) {
- // Closing the current mcrypt resource(s). _mcryptSetup() will, if needed,
- // (re)open them with the module named in $this->cipher_name_mcrypt
- @mcrypt_module_close($this->enmcrypt);
- @mcrypt_module_close($this->demcrypt);
- $this->enmcrypt = null;
- $this->demcrypt = null;
- if ($this->ecb) {
- @mcrypt_module_close($this->ecb);
- $this->ecb = null;
- }
- }
- $this->changed = true;
- }
- /**
- * Encrypts a block
- *
- * @access private
- * @param string $in
- * @return string
- * @internal Must be extended by the child Crypt_* class
- */
- function _encryptBlock($in)
- {
- user_error((version_compare(PHP_VERSION, '5.0.0', '>=') ? __METHOD__ : __FUNCTION__) . '() must extend by class ' . get_class($this), E_USER_ERROR);
- }
- /**
- * Decrypts a block
- *
- * @access private
- * @param string $in
- * @return string
- * @internal Must be extended by the child Crypt_* class
- */
- function _decryptBlock($in)
- {
- user_error((version_compare(PHP_VERSION, '5.0.0', '>=') ? __METHOD__ : __FUNCTION__) . '() must extend by class ' . get_class($this), E_USER_ERROR);
- }
- /**
- * Setup the key (expansion)
- *
- * Only used if $engine == CRYPT_ENGINE_INTERNAL
- *
- * @see self::_setup()
- * @access private
- * @internal Must be extended by the child Crypt_* class
- */
- function _setupKey()
- {
- user_error((version_compare(PHP_VERSION, '5.0.0', '>=') ? __METHOD__ : __FUNCTION__) . '() must extend by class ' . get_class($this), E_USER_ERROR);
- }
- /**
- * Setup the CRYPT_ENGINE_INTERNAL $engine
- *
- * (re)init, if necessary, the internal cipher $engine and flush all $buffers
- * Used (only) if $engine == CRYPT_ENGINE_INTERNAL
- *
- * _setup() will be called each time if $changed === true
- * typically this happens when using one or more of following public methods:
- *
- * - setKey()
- *
- * - setIV()
- *
- * - disableContinuousBuffer()
- *
- * - First run of encrypt() / decrypt() with no init-settings
- *
- * @see self::setKey()
- * @see self::setIV()
- * @see self::disableContinuousBuffer()
- * @access private
- * @internal _setup() is always called before en/decryption.
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function _setup()
- {
- $this->_clearBuffers();
- $this->_setupKey();
- if ($this->use_inline_crypt) {
- $this->_setupInlineCrypt();
- }
- }
- /**
- * Setup the CRYPT_ENGINE_MCRYPT $engine
- *
- * (re)init, if necessary, the (ext)mcrypt resources and flush all $buffers
- * Used (only) if $engine = CRYPT_ENGINE_MCRYPT
- *
- * _setupMcrypt() will be called each time if $changed === true
- * typically this happens when using one or more of following public methods:
- *
- * - setKey()
- *
- * - setIV()
- *
- * - disableContinuousBuffer()
- *
- * - First run of encrypt() / decrypt()
- *
- * @see self::setKey()
- * @see self::setIV()
- * @see self::disableContinuousBuffer()
- * @access private
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function _setupMcrypt()
- {
- $this->_clearBuffers();
- $this->enchanged = $this->dechanged = true;
- if (!isset($this->enmcrypt)) {
- static $mcrypt_modes = array(
- CRYPT_MODE_CTR => 'ctr',
- CRYPT_MODE_ECB => MCRYPT_MODE_ECB,
- CRYPT_MODE_CBC => MCRYPT_MODE_CBC,
- CRYPT_MODE_CFB => 'ncfb',
- CRYPT_MODE_OFB => MCRYPT_MODE_NOFB,
- CRYPT_MODE_STREAM => MCRYPT_MODE_STREAM,
- );
- $this->demcrypt = @mcrypt_module_open($this->cipher_name_mcrypt, '', $mcrypt_modes[$this->mode], '');
- $this->enmcrypt = @mcrypt_module_open($this->cipher_name_mcrypt, '', $mcrypt_modes[$this->mode], '');
- // we need the $ecb mcrypt resource (only) in MODE_CFB with enableContinuousBuffer()
- // to workaround mcrypt's broken ncfb implementation in buffered mode
- // see: {@link http://phpseclib.sourceforge.net/cfb-demo.phps}
- if ($this->mode == CRYPT_MODE_CFB) {
- $this->ecb = @mcrypt_module_open($this->cipher_name_mcrypt, '', MCRYPT_MODE_ECB, '');
- }
- } // else should mcrypt_generic_deinit be called?
- if ($this->mode == CRYPT_MODE_CFB) {
- @mcrypt_generic_init($this->ecb, $this->key, str_repeat("\0", $this->block_size));
- }
- }
- /**
- * Pads a string
- *
- * Pads a string using the RSA PKCS padding standards so that its length is a multiple of the blocksize.
- * $this->block_size - (strlen($text) % $this->block_size) bytes are added, each of which is equal to
- * chr($this->block_size - (strlen($text) % $this->block_size)
- *
- * If padding is disabled and $text is not a multiple of the blocksize, the string will be padded regardless
- * and padding will, hence forth, be enabled.
- *
- * @see self::_unpad()
- * @param string $text
- * @access private
- * @return string
- */
- function _pad($text)
- {
- $length = strlen($text);
- if (!$this->padding) {
- if ($length % $this->block_size == 0) {
- return $text;
- } else {
- user_error("The plaintext's length ($length) is not a multiple of the block size ({$this->block_size})");
- $this->padding = true;
- }
- }
- $pad = $this->block_size - ($length % $this->block_size);
- return str_pad($text, $length + $pad, chr($pad));
- }
- /**
- * Unpads a string.
- *
- * If padding is enabled and the reported padding length is invalid the encryption key will be assumed to be wrong
- * and false will be returned.
- *
- * @see self::_pad()
- * @param string $text
- * @access private
- * @return string
- */
- function _unpad($text)
- {
- if (!$this->padding) {
- return $text;
- }
- $length = ord($text[strlen($text) - 1]);
- if (!$length || $length > $this->block_size) {
- return false;
- }
- return substr($text, 0, -$length);
- }
- /**
- * Clears internal buffers
- *
- * Clearing/resetting the internal buffers is done everytime
- * after disableContinuousBuffer() or on cipher $engine (re)init
- * ie after setKey() or setIV()
- *
- * @access public
- * @internal Could, but not must, extend by the child Crypt_* class
- */
- function _clearBuffers()
- {
- $this->enbuffer = $this->debuffer = array('ciphertext' => '', 'xor' => '', 'pos' => 0, 'enmcrypt_init' => true);
- // mcrypt's handling of invalid's $iv:
- // $this->encryptIV = $this->decryptIV = strlen($this->iv) == $this->block_size ? $this->iv : str_repeat("\0", $this->block_size);
- $this->encryptIV = $this->decryptIV = str_pad(substr($this->iv, 0, $this->block_size), $this->block_size, "\0");
- if (!$this->skip_key_adjustment) {
- $this->key = str_pad(substr($this->key, 0, $this->key_length), $this->key_length, "\0");
- }
- }
- /**
- * String Shift
- *
- * Inspired by array_shift
- *
- * @param string $string
- * @param int $index
- * @access private
- * @return string
- */
- function _string_shift(&$string, $index = 1)
- {
- $substr = substr($string, 0, $index);
- $string = substr($string, $index);
- return $substr;
- }
- /**
- * String Pop
- *
- * Inspired by array_pop
- *
- * @param string $string
- * @param int $index
- * @access private
- * @return string
- */
- function _string_pop(&$string, $index = 1)
- {
- $substr = substr($string, -$index);
- $string = substr($string, 0, -$index);
- return $substr;
- }
- /**
- * Increment the current string
- *
- * @see self::decrypt()
- * @see self::encrypt()
- * @param string $var
- * @access private
- */
- function _increment_str(&$var)
- {
- for ($i = 4; $i <= strlen($var); $i+= 4) {
- $temp = substr($var, -$i, 4);
- switch ($temp) {
- case "\xFF\xFF\xFF\xFF":
- $var = substr_replace($var, "\x00\x00\x00\x00", -$i, 4);
- break;
- case "\x7F\xFF\xFF\xFF":
- $var = substr_replace($var, "\x80\x00\x00\x00", -$i, 4);
- return;
- default:
- $temp = unpack('Nnum', $temp);
- $var = substr_replace($var, pack('N', $temp['num'] + 1), -$i, 4);
- return;
- }
- }
- $remainder = strlen($var) % 4;
- if ($remainder == 0) {
- return;
- }
- $temp = unpack('Nnum', str_pad(substr($var, 0, $remainder), 4, "\0", STR_PAD_LEFT));
- $temp = substr(pack('N', $temp['num'] + 1), -$remainder);
- $var = substr_replace($var, $temp, 0, $remainder);
- }
- /**
- * Setup the performance-optimized function for de/encrypt()
- *
- * Stores the created (or existing) callback function-name
- * in $this->inline_crypt
- *
- * Internally for phpseclib developers:
- *
- * _setupInlineCrypt() would be called only if:
- *
- * - $engine == CRYPT_ENGINE_INTERNAL and
- *
- * - $use_inline_crypt === true
- *
- * - each time on _setup(), after(!) _setupKey()
- *
- *
- * This ensures that _setupInlineCrypt() has always a
- * full ready2go initializated internal cipher $engine state
- * where, for example, the keys allready expanded,
- * keys/block_size calculated and such.
- *
- * It is, each time if called, the responsibility of _setupInlineCrypt():
- *
- * - to set $this->inline_crypt to a valid and fully working callback function
- * as a (faster) replacement for encrypt() / decrypt()
- *
- * - NOT to create unlimited callback functions (for memory reasons!)
- * no matter how often _setupInlineCrypt() would be called. At some
- * point of amount they must be generic re-useable.
- *
- * - the code of _setupInlineCrypt() it self,
- * and the generated callback code,
- * must be, in following order:
- * - 100% safe
- * - 100% compatible to encrypt()/decrypt()
- * - using only php5+ features/lang-constructs/php-extensions if
- * compatibility (down to php4) or fallback is provided
- * - readable/maintainable/understandable/commented and... not-cryptic-styled-code :-)
- * - >= 10% faster than encrypt()/decrypt() [which is, by the way,
- * the reason for the existence of _setupInlineCrypt() :-)]
- * - memory-nice
- * - short (as good as possible)
- *
- * Note: - _setupInlineCrypt() is using _createInlineCryptFunction() to create the full callback function code.
- * - In case of using inline crypting, _setupInlineCrypt() must extend by the child Crypt_* class.
- * - The following variable names are reserved:
- * - $_* (all variable names prefixed with an underscore)
- * - $self (object reference to it self. Do not use $this, but $self instead)
- * - $in (the content of $in has to en/decrypt by the generated code)
- * - The callback function should not use the 'return' statement, but en/decrypt'ing the content of $in only
- *
- *
- * @see self::_setup()
- * @see self::_createInlineCryptFunction()
- * @see self::encrypt()
- * @see self::decrypt()
- * @access private
- * @internal If a Crypt_* class providing inline crypting it must extend _setupInlineCrypt()
- */
- function _setupInlineCrypt()
- {
- // If, for any reason, an extending Crypt_Base() Crypt_* class
- // not using inline crypting then it must be ensured that: $this->use_inline_crypt = false
- // ie in the class var declaration of $use_inline_crypt in general for the Crypt_* class,
- // in the constructor at object instance-time
- // or, if it's runtime-specific, at runtime
- $this->use_inline_crypt = false;
- }
- /**
- * Creates the performance-optimized function for en/decrypt()
- *
- * Internally for phpseclib developers:
- *
- * _createInlineCryptFunction():
- *
- * - merge the $cipher_code [setup'ed by _setupInlineCrypt()]
- * with the current [$this->]mode of operation code
- *
- * - create the $inline function, which called by encrypt() / decrypt()
- * as its replacement to speed up the en/decryption operations.
- *
- * - return the name of the created $inline callback function
- *
- * - used to speed up en/decryption
- *
- *
- *
- * The main reason why can speed up things [up to 50%] this way are:
- *
- * - using variables more effective then regular.
- * (ie no use of expensive arrays but integers $k_0, $k_1 ...
- * or even, for example, the pure $key[] values hardcoded)
- *
- * - avoiding 1000's of function calls of ie _encryptBlock()
- * but inlining the crypt operations.
- * in the mode of operation for() loop.
- *
- * - full loop unroll the (sometimes key-dependent) rounds
- * avoiding this way ++$i counters and runtime-if's etc...
- *
- * The basic code architectur of the generated $inline en/decrypt()
- * lambda function, in pseudo php, is:
- *
- * <code>
- * +----------------------------------------------------------------------------------------------+
- * | callback $inline = create_function: |
- * | lambda_function_0001_crypt_ECB($action, $text) |
- * | { |
- * | INSERT PHP CODE OF: |
- * | $cipher_code['init_crypt']; // general init code. |
- * | // ie: $sbox'es declarations used for |
- * | // encrypt and decrypt'ing. |
- * | |
- * | switch ($action) { |
- * | case 'encrypt': |
- * | INSERT PHP CODE OF: |
- * | $cipher_code['init_encrypt']; // encrypt sepcific init code. |
- * | ie: specified $key or $box |
- * | declarations for encrypt'ing. |
- * | |
- * | foreach ($ciphertext) { |
- * | $in = $block_size of $ciphertext; |
- * | |
- * | INSERT PHP CODE OF: |
- * | $cipher_code['encrypt_block']; // encrypt's (string) $in, which is always: |
- * | // strlen($in) == $this->block_size |
- * | // here comes the cipher algorithm in action |
- * | // for encryption. |
- * | // $cipher_code['encrypt_block'] has to |
- * | // encrypt the content of the $in variable |
- * | |
- * | $plaintext .= $in; |
- * | } |
- * | return $plaintext; |
- * | |
- * | case 'decrypt': |
- * | INSERT PHP CODE OF: |
- * | $cipher_code['init_decrypt']; // decrypt sepcific init code |
- * | ie: specified $key or $box |
- * | declarations for decrypt'ing. |
- * | foreach ($plaintext) { |
- * | $in = $block_size of $plaintext; |
- * | |
- * | INSERT PHP CODE OF: |
- * | $cipher_code['decrypt_block']; // decrypt's (string) $in, which is always |
- * | // strlen($in) == $this->block_size |
- * | // here comes the cipher algorithm in action |
- * | // for decryption. |
- * | // $cipher_code['decrypt_block'] has to |
- * | // decrypt the content of the $in variable |
- * | $ciphertext .= $in; |
- * | } |
- * | return $ciphertext; |
- * | } |
- * | } |
- * +----------------------------------------------------------------------------------------------+
- * </code>
- *
- * See also the Crypt_*::_setupInlineCrypt()'s for
- * productive inline $cipher_code's how they works.
- *
- * Structure of:
- * <code>
- * $cipher_code = array(
- * 'init_crypt' => (string) '', // optional
- * 'init_encrypt' => (string) '', // optional
- * 'init_decrypt' => (string) '', // optional
- * 'encrypt_block' => (string) '', // required
- * 'decrypt_block' => (string) '' // required
- * );
- * </code>
- *
- * @see self::_setupInlineCrypt()
- * @see self::encrypt()
- * @see self::decrypt()
- * @param array $cipher_code
- * @access private
- * @return string (the name of the created callback function)
- */
- function _createInlineCryptFunction($cipher_code)
- {
- $block_size = $this->block_size;
- // optional
- $init_crypt = isset($cipher_code['init_crypt']) ? $cipher_code['init_crypt'] : '';
- $init_encrypt = isset($cipher_code['init_encrypt']) ? $cipher_code['init_encrypt'] : '';
- $init_decrypt = isset($cipher_code['init_decrypt']) ? $cipher_code['init_decrypt'] : '';
- // required
- $encrypt_block = $cipher_code['encrypt_block'];
- $decrypt_block = $cipher_code['decrypt_block'];
- // Generating mode of operation inline code,
- // merged with the $cipher_code algorithm
- // for encrypt- and decryption.
- switch ($this->mode) {
- case CRYPT_MODE_ECB:
- $encrypt = $init_encrypt . '
- $_ciphertext = "";
- $_plaintext_len = strlen($_text);
- for ($_i = 0; $_i < $_plaintext_len; $_i+= '.$block_size.') {
- $in = substr($_text, $_i, '.$block_size.');
- '.$encrypt_block.'
- $_ciphertext.= $in;
- }
- return $_ciphertext;
- ';
- $decrypt = $init_decrypt . '
- $_plaintext = "";
- $_text = str_pad($_text, strlen($_text) + ('.$block_size.' - strlen($_text) % '.$block_size.') % '.$block_size.', chr(0));
- $_ciphertext_len = strlen($_text);
- for ($_i = 0; $_i < $_ciphertext_len; $_i+= '.$block_size.') {
- $in = substr($_text, $_i, '.$block_size.');
- '.$decrypt_block.'
- $_plaintext.= $in;
- }
- return $self->_unpad($_plaintext);
- ';
- break;
- case CRYPT_MODE_CTR:
- $encrypt = $init_encrypt . '
- $_ciphertext = "";
- $_plaintext_len = strlen($_text);
- $_xor = $self->encryptIV;
- $_buffer = &$self->enbuffer;
- if (strlen($_buffer["ciphertext"])) {
- for ($_i = 0; $_i < $_plaintext_len; $_i+= '.$block_size.') {
- $_block = substr($_text, $_i, '.$block_size.');
- if (strlen($_block) > strlen($_buffer["ciphertext"])) {
- $in = $_xor;
- '.$encrypt_block.'
- $self->_increment_str($_xor);
- $_buffer["ciphertext"].= $in;
- }
- $_key = $self->_string_shift($_buffer["ciphertext"], '.$block_size.');
- $_ciphertext.= $_block ^ $_key;
- }
- } else {
- for ($_i = 0; $_i < $_plaintext_len; $_i+= '.$block_size.') {
- $_block = substr($_text, $_i, '.$block_size.');
- $in = $_xor;
- '.$encrypt_block.'
- $self->_increment_str($_xor);
- $_key = $in;
- $_ciphertext.= $_block ^ $_key;
- }
- }
- if ($self->continuousBuffer) {
- $self->encryptIV = $_xor;
- if ($_start = $_plaintext_len % '.$block_size.') {
- $_buffer["ciphertext"] = substr($_key, $_start) . $_buffer["ciphertext"];
- }
- }
- return $_ciphertext;
- ';
- $decrypt = $init_encrypt . '
- $_plaintext = "";
- $_ciphertext_len = strlen($_text);
- $_xor = $self->decryptIV;
- $_buffer = &$self->debuffer;
- if (strlen($_buffer["ciphertext"])) {
- for ($_i = 0; $_i < $_ciphertext_len; $_i+= '.$block_size.') {
- $_block = substr($_text, $_i, '.$block_size.');
- if (strlen($_block) > strlen($_buffer["ciphertext"])) {
- $in = $_xor;
- '.$encrypt_block.'
- $self->_increment_str($_xor);
- $_buffer["ciphertext"].= $in;
- }
- $_key = $self->_string_shift($_buffer["ciphertext"], '.$block_size.');
- $_plaintext.= $_block ^ $_key;
- }
- } else {
- for ($_i = 0; $_i < $_ciphertext_len; $_i+= '.$block_size.') {
- $_block = substr($_text, $_i, '.$block_size.');
- $in = $_xor;
- '.$encrypt_block.'
- $self->_increment_str($_xor);
- $_key = $in;
- $_plaintext.= $_block ^ $_key;
- }
- }
- if ($self->continuousBuffer) {
- $self->decryptIV = $_xor;
- if ($_start = $_ciphertext_len % '.$block_size.') {
- $_buffer["ciphertext"] = substr($_key, $_start) . $_buffer["ciphertext"];
- }
- }
- return $_plaintext;
- ';
- break;
- case CRYPT_MODE_CFB:
- $encrypt = $init_encrypt . '
- $_ciphertext = "";
- $_buffer = &$self->enbuffer;
- if ($self->continuousBuffer) {
- $_iv = &$self->encryptIV;
- $_pos = &$_buffer["pos"];
- } else {
- $_iv = $self->encryptIV;
- $_pos = 0;
- }
- $_len = strlen($_text);
- $_i = 0;
- if ($_pos) {
- $_orig_pos = $_pos;
- $_max = '.$block_size.' - $_pos;
- if ($_len >= $_max) {
- $_i = $_max;
- $_len-= $_max;
- $_pos = 0;
- } else {
- $_i = $_len;
- $_pos+= $_len;
- $_len = 0;
- }
- $_ciphertext = substr($_iv, $_orig_pos) ^ $_text;
- $_iv = substr_replace($_iv, $_ciphertext, $_orig_pos, $_i);
- }
- while ($_len >= '.$block_size.') {
- $in = $_iv;
- '.$encrypt_block.';
- $_iv = $in ^ substr($_text, $_i, '.$block_size.');
- $_ciphertext.= $_iv;
- $_len-= '.$block_size.';
- $_i+= '.$block_size.';
- }
- if ($_len) {
- $in = $_iv;
- '.$encrypt_block.'
- $_iv = $in;
- $_block = $_iv ^ substr($_text, $_i);
- $_iv = substr_replace($_iv, $_block, 0, $_len);
- $_ciphertext.= $_block;
- $_pos = $_len;
- }
- return $_ciphertext;
- ';
- $decrypt = $init_encrypt . '
- $_plaintext = "";
- $_buffer = &$self->debuffer;
- if ($self->continuousBuffer) {
- $_iv = &$self->decryptIV;
- $_pos = &$_buffer["pos"];
- } else {
- $_iv = $self->decryptIV;
- $_pos = 0;
- }
- $_len = strlen($_text);
- $_i = 0;
- if ($_pos) {
- $_orig_pos = $_pos;
- $_max = '.$block_size.' - $_pos;
- if ($_len >= $_max) {
- $_i = $_max;
- $_len-= $_max;
- $_pos = 0;
- } else {
- $_i = $_len;
- $_pos+= $_len;
- $_len = 0;
- }
- $_plaintext = substr($_iv, $_orig_pos) ^ $_text;
- $_iv = substr_replace($_iv, substr($_text, 0, $_i), $_orig_pos, $_i);
- }
- while ($_len >= '.$block_size.') {
- $in = $_iv;
- '.$encrypt_block.'
- $_iv = $in;
- $cb = substr($_text, $_i, '.$block_size.');
- $_plaintext.= $_iv ^ $cb;
- $_iv = $cb;
- $_len-= '.$block_size.';
- $_i+= '.$block_size.';
- }
- if ($_len) {
- $in = $_iv;
- '.$encrypt_block.'
- $_iv = $in;
- $_plaintext.= $_iv ^ substr($_text, $_i);
- $_iv = substr_replace($_iv, substr($_text, $_i), 0, $_len);
- $_pos = $_len;
- }
- return $_plaintext;
- ';
- break;
- case CRYPT_MODE_OFB:
- $encrypt = $init_encrypt . '
- $_ciphertext = "";
- $_plaintext_len = strlen($_text);
- $_xor = $self->encryptIV;
- $_buffer = &$self->enbuffer;
- if (strlen($_buffer["xor"])) {
- for ($_i = 0; $_i < $_plaintext_len; $_i+= '.$block_size.') {
- $_block = substr($_text, $_i, '.$block_size.');
- if (strlen($_block) > strlen($_buffer["xor"])) {
- $in = $_xor;
- '.$encrypt_block.'
- $_xor = $in;
- $_buffer["xor"].= $_xor;
- }
- $_key = $self->_string_shift($_buffer["xor"], '.$block_size.');
- $_ciphertext.= $_block ^ $_key;
- }
- } else {
- for ($_i = 0; $_i < $_plaintext_len; $_i+= '.$block_size.') {
- $in = $_xor;
- '.$encrypt_block.'
- $_xor = $in;
- $_ciphertext.= substr($_text, $_i, '.$block_size.') ^ $_xor;
- }
- $_key = $_xor;
- }
- if ($self->continuousBuffer) {
- $self->encryptIV = $_xor;
- if ($_start = $_plaintext_len % '.$block_size.') {
- $_buffer["xor"] = substr($_key, $_start) . $_buffer["xor"];
- }
- }
- return $_ciphertext;
- ';
- $decrypt = $init_encrypt . '
- $_plaintext = "";
- $_ciphertext_len = strlen($_text);
- $_xor = $self->decryptIV;
- $_buffer = &$self->debuffer;
- if (strlen($_buffer["xor"])) {
- for ($_i = 0; $_i < $_ciphertext_len; $_i+= '.$block_size.') {
- $_block = substr($_text, $_i, '.$block_size.');
- if (strlen($_block) > strlen($_buffer["xor"])) {
- $in = $_xor;
- '.$encrypt_block.'
- $_xor = $in;
- $_buffer["xor"].= $_xor;
- }
- $_key = $self->_string_shift($_buffer["xor"], '.$block_size.');
- $_plaintext.= $_block ^ $_key;
- }
- } else {
- for ($_i = 0; $_i < $_ciphertext_len; $_i+= '.$block_size.') {
- $in = $_xor;
- '.$encrypt_block.'
- $_xor = $in;
- $_plaintext.= substr($_text, $_i, '.$block_size.') ^ $_xor;
- }
- $_key = $_xor;
- }
- if ($self->continuousBuffer) {
- $self->decryptIV = $_xor;
- if ($_start = $_ciphertext_len % '.$block_size.') {
- $_buffer["xor"] = substr($_key, $_start) . $_buffer["xor"];
- }
- }
- return $_plaintext;
- ';
- break;
- case CRYPT_MODE_STREAM:
- $encrypt = $init_encrypt . '
- $_ciphertext = "";
- '.$encrypt_block.'
- return $_ciphertext;
- ';
- $decrypt = $init_decrypt . '
- $_plaintext = "";
- '.$decrypt_block.'
- return $_plaintext;
- ';
- break;
- // case CRYPT_MODE_CBC:
- default:
- $encrypt = $init_encrypt . '
- $_ciphertext = "";
- $_plaintext_len = strlen($_text);
- $in = $self->encryptIV;
- for ($_i = 0; $_i < $_plaintext_len; $_i+= '.$block_size.') {
- $in = substr($_text, $_i, '.$block_size.') ^ $in;
- '.$encrypt_block.'
- $_ciphertext.= $in;
- }
- if ($self->continuousBuffer) {
- $self->encryptIV = $in;
- }
- return $_ciphertext;
- ';
- $decrypt = $init_decrypt . '
- $_plaintext = "";
- $_text = str_pad($_text, strlen($_text) + ('.$block_size.' - strlen($_text) % '.$block_size.') % '.$block_size.', chr(0));
- $_ciphertext_len = strlen($_text);
- $_iv = $self->decryptIV;
- for ($_i = 0; $_i < $_ciphertext_len; $_i+= '.$block_size.') {
- $in = $_block = substr($_text, $_i, '.$block_size.');
- '.$decrypt_block.'
- $_plaintext.= $in ^ $_iv;
- $_iv = $_block;
- }
- if ($self->continuousBuffer) {
- $self->decryptIV = $_iv;
- }
- return $self->_unpad($_plaintext);
- ';
- break;
- }
- // Create the $inline function and return its name as string. Ready to run!
- if (version_compare(PHP_VERSION, '5.3.0') >= 0) {
- eval('$func = function ($_action, &$self, $_text) { ' . $init_crypt . 'if ($_action == "encrypt") { ' . $encrypt . ' } else { ' . $decrypt . ' } };');
- return $func;
- }
- return create_function('$_action, &$self, $_text', $init_crypt . 'if ($_action == "encrypt") { ' . $encrypt . ' } else { ' . $decrypt . ' }');
- }
- /**
- * Holds the lambda_functions table (classwide)
- *
- * Each name of the lambda function, created from
- * _setupInlineCrypt() && _createInlineCryptFunction()
- * is stored, classwide (!), here for reusing.
- *
- * The string-based index of $function is a classwide
- * unique value representing, at least, the $mode of
- * operation (or more... depends of the optimizing level)
- * for which $mode the lambda function was created.
- *
- * @access private
- * @return array &$functions
- */
- function &_getLambdaFunctions()
- {
- static $functions = array();
- return $functions;
- }
- /**
- * Generates a digest from $bytes
- *
- * @see self::_setupInlineCrypt()
- * @access private
- * @param $bytes
- * @return string
- */
- function _hashInlineCryptFunction($bytes)
- {
- if (!defined('CRYPT_BASE_WHIRLPOOL_AVAILABLE')) {
- define('CRYPT_BASE_WHIRLPOOL_AVAILABLE', (bool)(extension_loaded('hash') && in_array('whirlpool', hash_algos())));
- }
- $result = '';
- $hash = $bytes;
- switch (true) {
- case CRYPT_BASE_WHIRLPOOL_AVAILABLE:
- foreach (str_split($bytes, 64) as $t) {
- $hash = hash('whirlpool', $hash, true);
- $result .= $t ^ $hash;
- }
- return $result . hash('whirlpool', $hash, true);
- default:
- $len = strlen($bytes);
- for ($i = 0; $i < $len; $i+=20) {
- $t = substr($bytes, $i, 20);
- $hash = pack('H*', sha1($hash));
- $result .= $t ^ $hash;
- }
- return $result . pack('H*', sha1($hash));
- }
- }
- /**
- * Convert float to int
- *
- * On 32-bit Linux installs running PHP < 5.3 converting floats to ints doesn't always work
- *
- * @access private
- * @param string $x
- * @return int
- */
- function safe_intval($x)
- {
- switch (true) {
- case is_int($x):
- // PHP 5.3, per http://php.net/releases/5_3_0.php, introduced "more consistent float rounding"
- case version_compare(PHP_VERSION, '5.3.0') >= 0 && (php_uname('m') & "\xDF\xDF\xDF") != 'ARM':
- // PHP_OS & "\xDF\xDF\xDF" == strtoupper(substr(PHP_OS, 0, 3)), but a lot faster
- case (PHP_OS & "\xDF\xDF\xDF") === 'WIN':
- return $x;
- }
- return (fmod($x, 0x80000000) & 0x7FFFFFFF) |
- ((fmod(floor($x / 0x80000000), 2) & 1) << 31);
- }
- /**
- * eval()'able string for in-line float to int
- *
- * @access private
- * @return string
- */
- function safe_intval_inline()
- {
- // on 32-bit linux systems with PHP < 5.3 float to integer conversion is bad
- switch (true) {
- case defined('PHP_INT_SIZE') && PHP_INT_SIZE == 8:
- case version_compare(PHP_VERSION, '5.3.0') >= 0 && (php_uname('m') & "\xDF\xDF\xDF") != 'ARM':
- case (PHP_OS & "\xDF\xDF\xDF") === 'WIN':
- return '%s';
- break;
- default:
- $safeint = '(is_int($temp = %s) ? $temp : (fmod($temp, 0x80000000) & 0x7FFFFFFF) | ';
- return $safeint . '((fmod(floor($temp / 0x80000000), 2) & 1) << 31))';
- }
- }
- }
|