Merge remote-tracking branch 'upstream/dev' into dev

.travis.yml

@@ -15,7 +15,9 @@ env:
   - PHPSQLDIR=/REPO/msphpsql-dev
   - TEST_PHP_SQL_SERVER=sql
   - SQLSRV_DBNAME=msphpsql_sqlsrv
-  - PDOSQLSRV_DBNAME=msphpsql_pdosqlsrv
+  - PDOSQLSRV_DBNAME=msphpsql_pdosqlsrv  
+  - TEST_PHP_SQL_UID=sa
+  - TEST_PHP_SQL_PWD=Password123
 
 before_install:
   - docker pull microsoft/mssql-server-linux
@@ -33,6 +35,12 @@ script:
   - docker logs client
   - travis_retry docker exec client python ./test/functional/setup/setup_dbs.py -dbname $SQLSRV_DBNAME
   - travis_retry docker exec client python ./test/functional/setup/setup_dbs.py -dbname $PDOSQLSRV_DBNAME
+  - docker exec client cp ./source/shared/msodbcsql.h ./test/functional/setup/
+  - travis_retry docker exec client python ./test/functional/setup/build_ksp.py 
+  - docker exec client cp ./test/functional/setup/myKSP.so ./test/functional/sqlsrv/
+  - docker exec client cp ./test/functional/setup/myKSP.so ./test/functional/pdo_sqlsrv/
+  - travis_retry docker exec client python ./test/functional/setup/run_ksp.py -server $TEST_PHP_SQL_SERVER -dbname $SQLSRV_DBNAME -uid $TEST_PHP_SQL_UID -pwd $TEST_PHP_SQL_PWD 
+  - travis_retry docker exec client python ./test/functional/setup/run_ksp.py -server $TEST_PHP_SQL_SERVER -dbname $PDOSQLSRV_DBNAME -uid $TEST_PHP_SQL_UID -pwd $TEST_PHP_SQL_PWD 
   - travis_retry docker exec client php ./source/pdo_sqlsrv/run-tests.php ./test/functional/pdo_sqlsrv/*.phpt
   - travis_retry docker exec client php ./source/sqlsrv/run-tests.php ./test/functional/sqlsrv/*.phpt
   - docker exec client bash -c 'for f in ./test/functional/sqlsrv/*.diff; do ls $f 2>/dev/null; cat $f 2>/dev/null; done || true'

CHANGELOG.md

@@ -3,6 +3,35 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 
+## Windows/Linux 5.1.0-preview - 2017-09-15
+Updated PECL release packages. Here is the list of updates:
+
+### Added
+- Added support for Always Encrypted with basic CRUD functionalities (see [here](https://github.com/Microsoft/msphpsql/wiki/Features#aebindparam))
+  - Support for Windows Certificate Store (use connection keyword ColumnEncryption)
+  - Support for custom key store provider (use connection keywords ColumnEncryption, CEKeystoreProvider, CEKeystoreName, CEKeystoreEncryptKey)
+  - Support for inserting into an encrypted column
+  - Support for fetching from an encrypted column
+- Added support for MSODBC 17 preview
+- Added Driver option to set the ODBC driver, Added"Driver" option, valid values are ODBC Driver 13 for SQL Server,ODBC Driver 11 for SQL Server, and ODBC Driver 17 for SQL Server
+  - If the user intends to use the new Always Encrypted features, we recommend you to specify explicitly the 'Driver' option to 'ODBC Driver 17 for SQL Server' in the connection string
+
+### Limitations
+- Always Encrypted functionalities are only supported using [MSODBC 17 preview](https://github.com/Microsoft/msphpsql/tree/dev/ODBC%2017%20binaries%20preview)
+  - ODBC binaries for macOS available upon request
+- MSODBC 17 preview msodbcsql.msi only works for Windows10
+- [Always Encrypted limitations](https://github.com/Microsoft/msphpsql/wiki/Features#aelimitation)
+- when using sqlsrv_query with Always Encrypted feature, SQL type has to be specified for each input (see [here](https://github.com/Microsoft/msphpsql/wiki/Features#aebindparam))
+- No support for inout / output params when using sql_variant type
+
+### Known Issues
+- Connection pooling on Linux doesn't work properly if the user uses the MSODBC17 preview
+- PDO::quote returns truncated string with garbage characters appended if the string contains a ASCII NUL ('/0') character
+- Binding decimal type when using Always Encrypted in the SQLSRV x64 driver returns an error during insertion when the input does not have any decimal places
+- When pooling is enabled in Linux or MAC
+  - unixODBC <= 2.3.4 (Linux and MAC) might not return proper diagnostics information, such as error messages, warnings and informative messages
+  - due to this unixODBC bug, fetch large data (such as xml, binary) as streams as a workaround. See the examples [here](https://github.com/Microsoft/msphpsql/wiki/Connection-Pooling-on-Linux-and-Mac)
+
 ## Windows/Linux/MAC 5.0.0-preview - 2017-07-31
 Updated PECL release packages. Here is the list of updates:
 

ODBC 17 binaries preview/README.md

@@ -0,0 +1 @@
+The ODBC driver 17 preview binaries in this directory are required in order to use Always Encrypted (AE) functionality. Please note that these drivers should be considered to be preview versions -- they should not be used in production and are not supported by Microsoft. They will be replaced upon the official release of ODBC driver 17.

appveyor.yml

@@ -166,6 +166,12 @@ test_script:
     - python %APPVEYOR_BUILD_FOLDER%\test\functional\setup\setup_dbs.py -dbname %SQLSRV_DBNAME%
     - Echo setup test database for PDO_SQLSRV tests - %PDOSQLSRV_DBNAME%
     - python %APPVEYOR_BUILD_FOLDER%\test\functional\setup\setup_dbs.py -dbname %PDOSQLSRV_DBNAME%
+    - copy %APPVEYOR_BUILD_FOLDER%\source\shared\msodbcsql.h %APPVEYOR_BUILD_FOLDER%\test\functional\setup\
+    - python %APPVEYOR_BUILD_FOLDER%\test\functional\setup\build_ksp.py
+    - copy %APPVEYOR_BUILD_FOLDER%\test\functional\setup\*.dll %APPVEYOR_BUILD_FOLDER%\test\functional\sqlsrv\
+    - copy %APPVEYOR_BUILD_FOLDER%\test\functional\setup\*.dll %APPVEYOR_BUILD_FOLDER%\test\functional\pdo_sqlsrv\
+    - python %APPVEYOR_BUILD_FOLDER%\test\functional\setup\run_ksp.py -server %TEST_PHP_SQL_SERVER% -dbname %SQLSRV_DBNAME% -uid %TEST_PHP_SQL_UID% -pwd %TEST_PHP_SQL_PWD%
+    - python %APPVEYOR_BUILD_FOLDER%\test\functional\setup\run_ksp.py -server %TEST_PHP_SQL_SERVER% -dbname %PDOSQLSRV_DBNAME% -uid %TEST_PHP_SQL_UID% -pwd %TEST_PHP_SQL_PWD%    
     - php run-tests.php -p php.exe %APPVEYOR_BUILD_FOLDER%\test\functional\sqlsrv\*.phpt > %APPVEYOR_BUILD_FOLDER%\test\functional\sqlsrv.log 2>&1    
     - type %APPVEYOR_BUILD_FOLDER%\test\functional\sqlsrv.log
     - php run-tests.php -p php.exe %APPVEYOR_BUILD_FOLDER%\test\functional\pdo_sqlsrv\*.phpt > %APPVEYOR_BUILD_FOLDER%\test\functional\pdo_sqlsrv.log 2>&1    

source/pdo_sqlsrv/config.w32

@@ -3,7 +3,7 @@
 //
 // Contents: JScript build configuration used by buildconf.bat
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/pdo_dbh.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Implements the PDO object for PDO_SQLSRV
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License
@@ -43,6 +43,11 @@ const char AttachDBFileName[] = "AttachDbFileName";
 const char ConnectionPooling[] = "ConnectionPooling";
 const char Authentication[] = "Authentication";
 const char ColumnEncryption[] = "ColumnEncryption";
+const char Driver[] = "Driver";
+const char CEKeystoreProvider[] = "CEKeystoreProvider";
+const char CEKeystoreName[] = "CEKeystoreName";
+const char CEKeystoreEncryptKey[] = "CEKeystoreEncryptKey";
+
 #ifdef _WIN32
 const char ConnectRetryCount[] = "ConnectRetryCount";
 const char ConnectRetryInterval[] = "ConnectRetryInterval";
@@ -230,6 +235,42 @@ const connection_option PDO_CONN_OPTS[] = {
         CONN_ATTR_STRING,
         column_encryption_set_func::func
     },
+    {
+        PDOConnOptionNames::Driver,
+        sizeof(PDOConnOptionNames::Driver),
+        SQLSRV_CONN_OPTION_DRIVER,
+        ODBCConnOptions::Driver,
+        sizeof(ODBCConnOptions::Driver),
+        CONN_ATTR_STRING,
+        driver_set_func::func
+    },
+    {
+        PDOConnOptionNames::CEKeystoreProvider,
+        sizeof(PDOConnOptionNames::CEKeystoreProvider),
+        SQLSRV_CONN_OPTION_CEKEYSTORE_PROVIDER,
+        ODBCConnOptions::CEKeystoreProvider,
+        sizeof(ODBCConnOptions::CEKeystoreProvider),
+        CONN_ATTR_STRING,
+        ce_ksp_provider_set_func::func
+    },
+    {
+        PDOConnOptionNames::CEKeystoreName,
+        sizeof(PDOConnOptionNames::CEKeystoreName),
+        SQLSRV_CONN_OPTION_CEKEYSTORE_NAME,
+        ODBCConnOptions::CEKeystoreName,
+        sizeof(ODBCConnOptions::CEKeystoreName),
+        CONN_ATTR_STRING,
+        ce_ksp_provider_set_func::func
+    },
+    {
+        PDOConnOptionNames::CEKeystoreEncryptKey,
+        sizeof(PDOConnOptionNames::CEKeystoreEncryptKey),
+        SQLSRV_CONN_OPTION_CEKEYSTORE_ENCRYPT_KEY,
+        ODBCConnOptions::CEKeystoreEncryptKey,
+        sizeof(ODBCConnOptions::CEKeystoreEncryptKey),
+        CONN_ATTR_STRING,
+        ce_ksp_provider_set_func::func
+    },
 #ifdef _WIN32
     {
         PDOConnOptionNames::ConnectRetryCount,

source/pdo_sqlsrv/pdo_init.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: initialization routines for PDO_SQLSRV
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/pdo_parser.cpp

@@ -5,7 +5,7 @@
 // 
 // Copyright Microsoft Corporation
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/pdo_stmt.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Implements the PDOStatement object for the PDO_SQLSRV
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/pdo_util.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Utility functions used by both connection or statement functions
 // 
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License
@@ -56,8 +56,8 @@ pdo_error PDO_ERRORS[] = {
 
     {
         SQLSRV_ERROR_DRIVER_NOT_INSTALLED,
-        { IMSSP, (SQLCHAR*) "This extension requires the Microsoft ODBC Driver 13 for SQL Server to "
-        "communicate with SQL Server. Access the following URL to download the ODBC Driver 13 for SQL Server "
+        { IMSSP, (SQLCHAR*) "This extension requires the Microsoft ODBC Driver for SQL Server to "
+        "communicate with SQL Server. Access the following URL to download the ODBC Driver for SQL Server "
         "for %1!s!: "
         "http://go.microsoft.com/fwlink/?LinkId=163712", -1, true }
     },  
@@ -380,7 +380,31 @@ pdo_error PDO_ERRORS[] = {
     {
         PDO_SQLSRV_ERROR_INVALID_AUTHENTICATION_OPTION,
         { IMSSP, (SQLCHAR*) "Invalid option for the Authentication keyword. Only SqlPassword or ActiveDirectoryPassword is supported.", -73, false }
-    },          
+    },
+    {
+        SQLSRV_ERROR_KEYSTORE_NAME_MISSING,
+        { IMSSP, (SQLCHAR*) "The name of the custom keystore provider is missing.", -74, false}
+    },
+    {
+        SQLSRV_ERROR_KEYSTORE_PATH_MISSING,
+        { IMSSP, (SQLCHAR*) "The path to the custom keystore provider is missing.", -75, false}
+    },
+    {
+        SQLSRV_ERROR_KEYSTORE_KEY_MISSING,
+        { IMSSP, (SQLCHAR*) "The encryption key for the custom keystore provider is missing.", -76, false}
+    },
+    {
+        SQLSRV_ERROR_KEYSTORE_INVALID_VALUE,
+        { IMSSP, (SQLCHAR*) "Invalid value for loading a custom keystore provider.", -77, false}
+    },
+    {
+        SQLSRV_ERROR_AE_DRIVER_NOT_INSTALLED,
+        { IMSSP, (SQLCHAR*) "The Always Encrypted feature requires Microsoft ODBC Driver 17 for SQL Server.", -78, false }
+    },
+    {
+        SQLSRV_ERROR_CONNECT_INVALID_DRIVER,
+        { IMSSP, (SQLCHAR*) "Invalid value %1!s! was specified for Driver option.", -79, true }
+    },
     { UINT_MAX, {} }
 };
 

source/pdo_sqlsrv/php_pdo_sqlsrv.h

@@ -6,7 +6,7 @@
 //
 // Contents: Declarations for the extension
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/pdo_sqlsrv/template.rc

@@ -3,7 +3,7 @@
 //
 // Contents: Version resource
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/FormattedPrint.cpp

@@ -6,7 +6,7 @@
 // Contents:    Contains functions for handling Windows format strings
 //              and UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/FormattedPrint.h

@@ -4,7 +4,7 @@
 // Contents: Contains functions for handling Windows format strings
 //			 and UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/StringFunctions.cpp

@@ -3,7 +3,7 @@
 //
 // Contents: Contains functions for handling UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License

source/shared/StringFunctions.h

@@ -3,7 +3,7 @@
 //
 // Contents: Contains functions for handling UTF-16 on non-Windows platforms
 //
-// Microsoft Drivers 5.0 for PHP for SQL Server
+// Microsoft Drivers 5.1 for PHP for SQL Server
 // Copyright(c) Microsoft Corporation
 // All rights reserved.
 // MIT License