d4dd30335676bcb25986b33ae6a61588454d76b4
[pkg-php/php.git] / UPGRADING
1 $Id$
2
3 PHP 5.6 UPGRADE NOTES
4
5 1. Backward Incompatible Changes
6 2. New Features
7 3. Changes in SAPI modules
8 4. Deprecated Functionality
9 5. Changed Functions
10 6. New Functions
11 7. New Classes and Interfaces
12 8. Removed Extensions
13 9. Other Changes to Extensions
14 10. New Global Constants
15 11. Changes to INI File Handling
16 12. Other Changes
17
18
19 ========================================
20 1. Backward Incompatible Changes
21 ========================================
22
23 - Core:
24   By fixing bug #66015 it is no longer possible to overwrite keys in static scalar
25   arrays. Quick example to illustrate:
26   class Test {
27        const FIRST = 1;
28        public $array = array(
29            self::FIRST => 'first',
30            'second',
31            'third'
32        );
33   }
34   Test::$array will have as expected three array keys (1, 2, 3) and no longer
35   two (0, 1). self::FIRST will no longer overwrite 'third' having key 1 then,
36   but will mark the beginning of indexing. 
37
38 - JSON:
39   json_decode() no longer accepts non-lowercase variants of lone JSON true,
40   false or null values. For example, True or FALSE will now cause json_decode to
41   return NULL and set an error value you can fetch with json_last_error().
42   This affects JSON texts consisting solely of true, false or null. Text
43   containing non-lowercase values inside JSON arrays or objects has never been
44   accepted.
45
46 - OpenSSL:
47   To prevent man-in-the-middle attacks against encrypted transfers client
48   streams now verify peer certificates by default. Previous versions
49   required users to manually enable peer verification. As a result of this
50   change, existing code using ssl:// or tls:// stream wrappers (e.g.
51   file_get_contents(), fsockopen(), stream_socket_client()) may no longer
52   connect successfully without manually disabling peer verification via the
53   stream context's "verify_peer" setting. Encrypted transfers delegate to
54   operating system certificate stores by default if not overridden via the
55   new openssl.cafile and openssl.cafile ini directives or via call-time SSL
56   context options, so most users should be unaffected by this transparent
57   security enhancement. (https://wiki.php.net/rfc/tls-peer-verification)
58
59 - Mcrypt:
60   The mcrypt_encrypt(), mcrypt_decrypt() and mcrypt_{MODE}() functions no
61   longer accept keys or IVs with incorrect sizes. Furthermore an IV is now
62   required if the used block cipher mode requires it.
63
64 ========================================
65 2. New Features
66 ========================================
67
68 - Added constant scalar expressions syntax.
69   (https://wiki.php.net/rfc/const_scalar_exprs)
70
71 - Added dedicated syntax for variadic functions.
72   (https://wiki.php.net/rfc/variadics)
73
74 - Added support for argument unpacking to complement the variadic syntax.
75   (https://wiki.php.net/rfc/argument_unpacking)
76
77 - Added an exponentiation operator (**).
78   (https://wiki.php.net/rfc/pow-operator)
79
80 - Added unified default encoding. default_charset=UTF-8 and functions/extensions
81   use encoding settings honor default_charset.
82
83 - The php://input stream is now re-usable and can be used concurrently with
84   enable_post_data_reading=0.
85
86 - Added use function and use const.
87   (https://wiki.php.net/rfc/use_function)
88
89 - Added a function for timing attack safe string comparison
90   (https://wiki.php.net/rfc/timing_attack)
91
92 - Added the __debugInfo() magic method to allow userland classes to implement
93   the get_debug_info API previously available only to extensions.
94   (https://wiki.php.net/rfc/debug-info)
95
96 - Added gost-crypto (CryptoPro S-box) hash algorithm.
97
98 - Stream wrappers verify peer certificates and host names by default in
99   encrypted client streams.
100
101 - Added openssl certificate fingerprint support (inclusive stream context
102   option).
103
104 - Added support for SAN x509 extension matching when verifing host names in
105   encrypted streams.
106
107 - Added a range of new SSL context options for improved encrypted stream
108   server security (https://wiki.php.net/rfc/improved-tls-defaults):
109
110     . "honor_cipher_order" allows servers to prioritize cipher suites of their
111       choosing when negotiating SSL/TLS handshakes.
112     . "single_ecdh_use" and "single_dh_use" allow for improved forward
113       secrecy in encrypted stream servers.
114     . "dh_param" allows specification of pre-generated key generation
115        parameters when negotiating ephemeral DHE ciphers in stream servers.
116     . "ecdh_curve" allows stream servers to specify which curve to use when
117        negotiating ephemeral ECDHE ciphers (defaults to NIST P-256).
118     . "rsa_key_size" SSL context option gives stream servers control
119       over the key size (in bits) used when negotiating RSA ciphers.
120     . "capture_session_meta" if specified stores an array of data describing
121       the TLS session's protocol/cipher in the "session_meta" SSL context key.
122
123 - Added automatic mitigation against client-initated TLS renegotiation DoS
124   attacks in encrypted server streams. Renegotiation limiting may be
125   customized via three new SSL context options:
126
127     . "reneg_limit" (number of allowed renegotiations per time window)
128     . "reneg_window" (renegotiation time window in seconds)
129     . "reneg_limit_callback" (optional notification callback on limiting)
130
131 - Encrypted TLS servers now support the server name indication (SNI) TLS
132   extension via the new "SNI_server_certs" SSL context option.
133
134 - Added "crypto_method" SSL context option for use in encrypted streams.
135
136 - Added "peer_name" SSL context option to better reflect peer certificate
137   name matching using SAN extension (replaces deprecated "CN_match").
138
139 - Added stream wrapper support when specifying "cafile" SSL context paths.
140
141 - Independent peer cert and peer name validation is now available via a new
142   boolean "verify_peer_name" SSL context option. This option is enabled by
143   default in encrypted client streams.
144
145 - Added protocol-specific tlsv1.0://, tlsv1.1:// and tlsv1.2:// encryption
146   stream wrappers. tls:// wrapper now supports TLSv1.1 and TLSv1.2 (previously
147   only supported TLSv1).
148
149 - Stream crypto method specification now accepts flags instead of values
150   allowing support for multiple discrete protocols in a given stream.
151
152 - PostgreSQL database connections may now be established asynchronously using
153   new constants and polling functions in ext/pgsql.
154
155 - Non-blocking read/write query behavior now optionally available in database
156   operations using the ext/pgsql extension.
157
158 ========================================
159 3. Changes in SAPI modules
160 ========================================
161
162 - Added phpdbg SAPI.
163   (https://wiki.php.net/rfc/phpdbg)
164
165 - Support for FPM workers changing the apparmor profile through the pool configuration.
166   (https://wiki.php.net/rfc/fpm_change_hat)
167
168 - Support for several XML MIME types in the built-in CLI server. For static
169   files with extensions .xml, .xsl, .xsd the Content-Type header
170   application/xml is now sent automatically.
171
172 ========================================
173 4. Deprecated Functionality
174 ========================================
175
176 - Incompatible context calls:
177   Instance calls from an incompatible context are now deprecated and issue
178   E_DEPRECATED instead of E_STRICT. See https://wiki.php.net/rfc/incompat_ctx
179
180 - The "CN_match" and "SNI_server_name" SSL context options are deprecated in
181   favor of the new "peer_name" option. Name verification now checks certificate
182   SAN names as well as the CN field and the specific name fields are deprecated
183   to avoid confusion. Their use triggers E_DEPRECATED but continues to work as
184   before. If specified, the specific values take precedence over the general
185   "peer_name" value.
186
187 - Deprecated PDO::PGSQL_ATTR_DISABLE_NATIVE_PREPARED_STATEMENT, an
188   undocument constant effectively equivalent to PDO::ATTR_EMULATE_PREPARES.
189
190 - Deprecated INIs: Following INIs are deprecated in favour of new
191   internal_encoding/input_encoding/output_encoding. Refer to "Changes to
192   encodings in PHP 5.6" in "11. Other Changes" section for more details.
193
194     iconv.input_encoding
195     iconv.output_encoding
196     iconv.internal_encoding
197     mbstring.http_input
198     mbstring.http_output
199     mbstring.internal_encoding
200
201 ========================================
202 5. Changed Functions
203 ========================================
204
205 - cURL:
206   CURLOPT_SAFE_UPLOAD is now turned on by default and uploads with @file 
207   do not work unless it is explicitly set to false.
208
209   curl_setopt() now supports the following nullable settings (>= 5.5.11): 
210     . CURLOPT_CUSTOMREQUEST
211     . CURLOPT_FTPPORT
212     . CURLOPT_RANGE
213     . CURLOPT_FTP_ACCOUNT
214     . CURLOPT_RTSP_SESSION_ID
215     . CURLOPT_KRBLEVEL
216     . CURLOPT_KRB4LEVEL
217
218 - Strings:
219   substr_compare() now allows $length to be zero.
220
221 - Crypt:
222   crypt() will now raise an E_NOTICE error if the salt parameter is omitted.
223   See: https://wiki.php.net/rfc/crypt_function_salt
224
225 - Mcrypt:
226   The $source parameter of mcrypt_create_iv() now defaults to
227   MCRYPT_DEV_URANDOM instead of MCRYPT_DEV_RANDOM.
228
229 - OpenSSL:
230   The $crypto_type parameter is now optional in stream_socket_enable_crypto()
231   if the stream's SSL context specifies the new "crypto_type" option. The
232   crypto method from the context is used as a fallback if no crypto method is
233   specified at call-time.
234
235 - Reflection:
236   ReflectionClass::newInstanceWithoutConstructor previously didn't allow the
237   instantiation of any internal class which used custom object storage
238   (overriding the default create_object handler), this was changed to only
239   reject the instantiation of such classes if the class is also marked as
240   final.
241
242 - XMLReader:
243   XMLReader::getAttributeNs and XMLReader::getAttributeNo now return NULL if
244   the attribute could not be found, just like XMLReader::getAttribute.
245
246 - Pgsql:
247   pg_insert()/pg_select()/pg_update()/pg_delete() are no longer EXPERIMENTAL.
248   The following functions no longer block until query write completion if the
249   socket stream underlying a database connection is set to non-blocking mode:
250     . pg_send_execute()
251     . pg_send_prepare()
252     . pg_send_query()
253     . pg_send_query_params()
254
255 - unserialize:
256   Manipulated serialization strings for objects implementing Serializable by
257   replacing "C:" with "O:" at the start will now produce an error.
258
259 - parse_ini_file():
260 - parse_ini_string():
261   Added scanner mode INI_SCANNER_TYPED to yield typed .ini values. 
262   For PHP >= 5.6.1
263
264 ========================================
265 6. New Functions
266 ========================================
267
268 - GMP:
269   Added gmp_root($a, $nth) and gmp_rootrem($a, $nth) for calculating nth roots.
270   Added gmp_import($data, $word_size = 1, $options = GMP_MSW_FIRST | GMP_NATIVE_ENDIAN) in PHP 5.6.1.
271   Added gmp_export($gmpnumber, $word_size = 1, $options = GMP_MSW_FIRST | GMP_NATIVE_ENDIAN) in PHP 5.6.1.
272
273 - Hash
274   Added hash_equals($known_string, $user_string)
275
276 - OpenSSL:
277   Added string openssl_x509_fingerprint($x509, $type, $binary).
278   Added string openssl_spki_new($private_key, $challenge, $algorithm)
279   Added bool openssl_spki_verify($spkac)
280   Added string openssl_spki_export($spkac)
281   Added string openssl_spki_export_challenge($spkac)
282   Added array openssl_get_cert_locations()
283
284 - LDAP:
285   Added ldap_escape($value, $ignore = "", $flags = 0).
286   Added ldap_modify_batch($link_identifier, $dn, $modifications) described in 
287   https://wiki.php.net/rfc/ldap_modify_batch.
288
289 - Pgsql:
290   Added pg_socket($connection) to allow async connections and non-blocking IO
291   Added pg_connect_poll($connection) for establishing async connections
292   Added pg_consume_input($connection) for non-blocking query result consumption
293   Added pg_flush($connection) for non-blocking query write completion
294
295 - PDO_pgsql
296   Added PDO::pgsqlGetNotify($result_type = PDO::FETCH_USE_DEFAULT, $ms_timeout = 0)
297   Added PDO::pgsqlGetPid()
298
299 - Zip:
300   Added ZipArchive::setPassword($password)
301
302 - SPL
303   Added SplFileObject::fread($length) to complement fwrite() method (>= 5.5.11)
304
305 ========================================
306 7. New Classes and Interfaces
307 ========================================
308
309
310 ========================================
311 8. Removed Extensions
312 ========================================
313
314
315 ========================================
316 9. Other Changes to Extensions
317 ========================================
318
319 - cURL:
320   - The following constants have been removed as they are now marked "obsolete"
321     in the underlying library and never had any effect to begin with:
322       . CURLOPT_CLOSEPOLICY
323       . CURLCLOSEPOLICY_CALLBACK
324       . CURLCLOSEPOLICY_LEAST_RECENTLY_USED
325       . CURLCLOSEPOLICY_LEAST_TRAFFIC
326       . CURLCLOSEPOLICY_OLDEST
327       . CURLCLOSEPOLICY_SLOWEST
328
329 - GMP:
330   The GMP extension now uses objects as the underlying data structure, rather
331   than resources. GMP instances now support dumping, serialization, cloning,
332   casts to primitive types and have overloaded operators.
333   (RFC: https://wiki.php.net/rfc/operator_overloading_gmp)
334
335 - OCI8:
336   - Added Implicit Result Set support for Oracle Database 12c with a
337     new oci_get_implicit_resultset() function.
338   - Using 'oci_execute($s, OCI_NO_AUTO_COMMIT)' for a SELECT no longer
339     unnecessarily initiates an internal ROLLBACK during connection
340     close.
341   - Multi-row OCI_RETURN_LOB queries require fewer "round trips" to the database.
342   - Added DTrace probes enabled with PHP's generic --enable-dtrace
343   - The oci_internal_debug() function is now a no-op.
344   - The phpinfo() output format for OCI8 has changed.
345
346 - OpenSSL:
347   - The "SNI_enabled" SSL stream context option is now set to TRUE by default
348     if supported by the underlying openssl library.
349
350 - PCRE:
351   - The information collected by the (*MARK) backtracking control verb is now
352     collected into the "MARK" index of the $matches array for preg_match(),
353     preg_match_all() and preg_replace_callback().
354
355 - Pgsql:
356   - pg_insert()/pg_select()/pg_update()/pg_delete()/pg_meta_data()/pg_convert()
357     are no longer EXPERIMENTAL
358   - Added PGSQL_DML_ESCAPE option for pg_insert()/pg_select()/pg_update()/pg_delete()
359     that simply escapes all supplied parameters. These functions can be as fast as
360     native query. Unvalidated data(Unknown data types) is passed as string.
361     JSON/Array/etc are supported both PGSQL_DML_ESCAPE and pg_convert() as string.
362   - pg_select() returns PostgreSQL query resource when query is executed.
363   - Added extended flag parameter for pg_meta_data(). pg_meta_data() always
364     returns "is enum" attribute.
365   - The new pg_socket() function returns a socket stream with no behavior other
366     than to allow IO-readiness polling on a DB connection socket. Calling
367     stream_set_blocking() on its result enables non-blocking behavior.
368   - Passing the new PGSQL_CONNECT_ASYNC flag to pg_connect() allows applications
369     to poll for IO readiness via pg_connect_poll() and establish connections
370     asynchronously.
371
372 - PDO_pgsql:
373   - Added PDO::PGSQL_ATTR_DISABLE_PREPARES constant to execute the queries
374     without preparing them, while still passing parameters separately from
375     the command text using PQexecParams.
376   - Added LISTEN/NOTIFY support via PDO::pgsqlGetNotify / PDO::pgsqlGetPid()
377     as described in https://bugs.php.net/bug.php?id=42614.
378
379 - DOM:
380   - DOMNode::textContent is now a writeable property. (>= 5.6.1)
381
382 ========================================
383 10. New Global Constants
384 ========================================
385
386 - LDAP:
387   LDAP_ESCAPE_FILTER int(1)
388   LDAP_ESCAPE_DN     int(2)
389
390 - Pgsql:
391   PGSQL_DML_ESCAPE   int(4096)
392   PGSQL_CONNECT_ASYNC
393   PGSQL_CONNECTION_STARTED
394   PGSQL_CONNECTION_MADE
395   PGSQL_CONNECTION_AWAITING_RESPONSE
396   PGSQL_CONNECTION_AUTH_OK
397   PGSQL_CONNECTION_SSL_STARTUP
398   PGSQL_CONNECTION_SETENV
399   PGSQL_POLLING_FAILED
400   PGSQL_POLLING_READING
401   PGSQL_POLLING_WRITING
402   PGSQL_POLLING_OK
403   PGSQL_POLLING_ACTIVE
404
405 - OpenSSL:
406   STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT   int(9)
407   STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT   int(17)
408   STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT   int(33)
409   STREAM_CRYPTO_METHOD_ANY_CLIENT       int(63)
410   STREAM_CRYPTO_METHOD_TLSv1_0_SERVER   int(8)
411   STREAM_CRYPTO_METHOD_TLSv1_1_SERVER   int(16)
412   STREAM_CRYPTO_METHOD_TLSv1_2_SERVER   int(32)
413   STREAM_CRYPTO_METHOD_ANY_SERVER       int(62)
414   OPENSSL_DEFAULT_STREAM_CIPHERS        string
415
416 ========================================
417 11. Changes to INI File Handling
418 ========================================
419
420 - Core:
421   Changed always_populate_raw_post_data to throw a deprecation warning when
422   enabled and to recognize the value -1 for never populating the global 
423   $HTTP_RAW_POST_DATA variable, which will be default in future PHP versions.
424
425   default_charset is set to UTF-8. It was empty previously. default_charset
426   is used where it is applicable. Iconv/Mbstring/htmlentities/htmlspecialchars/
427   html_entity_decode use default_charset as default encoding.
428
429   internal_encoding/input_encoding/output_encoding is added for encoding
430   handling modules. Refer to "Changes to encodings in PHP 5.6" in "11. Other Changes"
431   section for more details.
432
433 - cURL:
434   If the new openssl.cafile ini directive is specified ext/curl will give the
435   openssl path precedence over its own curl.cainfo directive.
436
437 - OpenSSL:
438   openssl.cafile and openssl.capath ini directives have been added to allow
439   global CA default specification as necessary.
440
441 ========================================
442 12. Other Changes
443 ========================================
444
445 - File upload:
446   Uploads equal or greater than 2GB in size are now accepted.
447
448 - HTTP stream wrapper:
449   HTTP 1.1 requests now include a Connection: close header unless explicitly
450   overridden by setting a Connection header via the header context option.
451
452 - PDO_pgsql
453   A libpq version providing PQexecParams, PQprepare, PQescapeStringConn,
454   PQescapeByteaConn is now required. According to the release notes that means
455   8.0.8+ or 8.1.4+. 
456
457 - Zip:
458   New --with-libzip option allow to use system libzip. Version > 0.11 required,
459   Version >= 0.11.2 recommended for all features.
460
461 - Changes to encodings in PHP 5.6
462   The default value of default_charset is now UTF-8 when it is not
463   explicitly set in php.ini
464
465   The following php.ini parameters were added:
466     internal_encoding
467     input_encoding
468     output_encoding
469
470   The values of the following php.ini parameters have become empty in
471   PHP 5.6 (previously they were all ISO-8859-1)
472
473     iconv.input_encoding
474     iconv.output_encoding
475     iconv.internal_encoding
476
477   Changes were made to character set handling in:
478    - the iconv and mbstring extensions,
479    - and htmlentities(), htmlspecialchars(), html_entity_decode() functions
480
481   The precedence for these is now:
482
483    default_charset < internal/input/output_encoding < (mbstring.* || iconv.*) < function parameter
484
485   For example, the easiest way to use the UTF-8 encoding is to set
486   default_charset=UTF-8 and leave the following php.ini parameters
487
488   empty:
489
490     iconv.input_encoding
491     iconv.output_encoding
492     iconv.internal_encoding
493     mbstring.http_input
494     mbstring.http_output
495     mbstring.internal_encoding
496     internal_encoding
497     input_encoding
498     output_encoding
499
500   The mb_regex_encoding() default setting is changed from EUC-JP to UTF-8.
501