Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Always encrypted unicode data corruption guard #2289

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

Always encrypted unicode data corruption guard #2289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c309aae
Initial changes
tkyc Jan 4, 2024
3af81f3
AE unicode data corruption guard
tkyc Jan 6, 2024
4b0f854
Updated test testAddbatch2AEOnConnection
tkyc Jan 8, 2024
84f8012
Initial changes
tkyc Jan 4, 2024
dbb883f
AE unicode data corruption guard
tkyc Jan 6, 2024
105b7a0
Updated test testAddbatch2AEOnConnection
tkyc Jan 8, 2024
663846d
Additional test updates for SSPAU=false
tkyc Jan 10, 2024
90578df
AE null dtv jdbctypesetbyuser fix
tkyc Jan 10, 2024
58cb7b4
Merge branch 'ae-data-corruption' of https://github.com/microsoft/mss…
tkyc Jan 10, 2024
f7fdc56
Review changes
tkyc Jan 10, 2024
89f14c2
Merge branch 'ae-data-corruption' of https://github.com/microsoft/mss…
tkyc Jan 10, 2024
7a1f604
Create login creds for new tests
tkyc Jan 15, 2024
98ec0d3
Additional sspau test update
tkyc Jan 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions src/main/java/com/microsoft/sqlserver/jdbc/Parameter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,14 +168,13 @@ void registerForOutput(JDBCType jdbcType, SQLServerConnection con) throws SQLSer
// to the server as Unicode rather than MBCS. This is accomplished here by re-tagging
// the value with the appropriate corresponding Unicode type.
if (con.sendStringParametersAsUnicode()) {

if (shouldHonorAEForParameter) {
setJdbcTypeSetByUser(jdbcType);
}

jdbcType = getSSPAUJDBCType(jdbcType);
}

if (shouldHonorAEForParameter) {
setJdbcTypeSetByUser(jdbcType);
}

registeredOutDTV = new DTV();
registeredOutDTV.setJdbcType(jdbcType);

Expand Down Expand Up @@ -415,18 +414,24 @@ void setValue(JDBCType jdbcType, Object value, JavaType javaType, StreamSetterAr
// the value with the appropriate corresponding Unicode type.
// JavaType.OBJECT == javaType when calling setNull()
if (con.sendStringParametersAsUnicode() && (JavaType.STRING == javaType || JavaType.READER == javaType
|| JavaType.CLOB == javaType || JavaType.OBJECT == javaType)) {
|| JavaType.CLOB == javaType || JavaType.OBJECT == javaType) && !((jdbcType == JDBCType.VARCHAR || jdbcType == JDBCType.CHAR) && con.isColumnEncryptionSettingEnabled())) {
jdbcType = getSSPAUJDBCType(jdbcType);
}

DTV newDTV = new DTV();
newDTV.setValue(con.getDatabaseCollation(), jdbcType, value, javaType, streamSetterArgs, calendar, scale, con,
forceEncrypt);

if (!con.sendStringParametersAsUnicode()) {
if (!con.sendStringParametersAsUnicode() || (con.sendStringParametersAsUnicode()
&& con.isColumnEncryptionSettingEnabled() && (jdbcType == JDBCType.VARCHAR || jdbcType == JDBCType.CHAR))) {
newDTV.sendStringParametersAsUnicode = false;
}

if (con.sendStringParametersAsUnicode() && (jdbcType == JDBCType.VARCHAR || jdbcType == JDBCType.CHAR) && con.isColumnEncryptionSettingEnabled()
&& (!con.getDatabaseCollation().isUtf8Encoding() || con.getServerMajorVersion() < 15)) {
throw new SQLServerException(SQLServerException.getErrString("R_possibleColumnDataCorruption"), null);
}

inputDTV = setterDTV = newDTV;
}

Expand Down Expand Up @@ -808,7 +813,7 @@ private void setTypeDefinition(DTV dtv) {
} else {
param.typeDefinition = SSType.VARCHAR.toString() + "(" + valueLength + ")";

if (DataTypes.SHORT_VARTYPE_MAX_BYTES <= valueLength) {
if (DataTypes.SHORT_VARTYPE_MAX_BYTES < valueLength) {
param.typeDefinition = VARCHAR_MAX;
}
}
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/com/microsoft/sqlserver/jdbc/SQLCollation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ final boolean hasAsciiCompatibleSBCS() {
return encoding.hasAsciiCompatibleSBCS();
}

boolean isUtf8Encoding() {
return encoding.equals(Encoding.UTF8);
}

static final int tdsLength() {
return TDS_LENGTH;
} // Length of collation in TDS (in bytes)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/microsoft/sqlserver/jdbc/SQLServerResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ protected Object[][] getContents() {
{"R_invalidDatetimeType", "The datetimeType connection property {0} is not valid."},
{"R_dataAlreadyAccessed", "The data has been accessed and is not available for this column or parameter."},
{"R_outParamsNotPermittedinBatch", "The OUT and INOUT parameters are not permitted in a batch."},
{"R_possibleColumnDataCorruption", "Attempted to insert encrypted unicode data into non-unicode column. Data corruption may occur."},
{"R_colNotMatchTable", "Number of provided columns {0} does not match the table definition {1}."},
{"R_invalidSQL", "Invalid SQL query {0}."},
{"R_multipleQueriesNotAllowed", "Multiple queries are not allowed."},
Expand Down
179 changes: 174 additions & 5 deletions src/test/java/com/microsoft/sqlserver/jdbc/AlwaysEncrypted/AESetup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import java.io.FileReader;
import java.io.IOException;
import java.math.BigDecimal;
import java.sql.Connection;
import java.sql.Date;
import java.sql.JDBCType;
import java.sql.SQLException;
Expand Down Expand Up @@ -62,7 +63,6 @@ public class AESetup extends AbstractTest {
static String cekWin = Constants.CEK_NAME + "_WIN";
static String cekAkv = Constants.CEK_NAME + "_AKV";
static SQLServerStatementColumnEncryptionSetting stmtColEncSetting = null;

static String AETestConnectionString;
static String enclaveProperties = "";

Expand All @@ -73,6 +73,8 @@ public class AESetup extends AbstractTest {
.escapeSingleQuotes(AbstractSQLGenerator.escapeIdentifier(RandomUtil.getIdentifier("AETest_")));
public static final String CHAR_TABLE_AE = TestUtils
.escapeSingleQuotes(AbstractSQLGenerator.escapeIdentifier(RandomUtil.getIdentifier("JDBCEncryptedChar")));
public static final String CHAR_TABLE_AE_NON_UNICODE = TestUtils
.escapeSingleQuotes(AbstractSQLGenerator.escapeIdentifier(RandomUtil.getIdentifier("JDBCEncryptedCharNonUnicode")));
public static final String BINARY_TABLE_AE = TestUtils
.escapeSingleQuotes(AbstractSQLGenerator.escapeIdentifier(RandomUtil.getIdentifier("JDBCEncryptedBinary")));
public static final String DATE_TABLE_AE = TestUtils
Expand Down Expand Up @@ -107,6 +109,16 @@ enum ColumnType {
{"Varchar8000", "varchar(8000) COLLATE Latin1_General_BIN2", "CHAR"},
{"Nvarchar4000", "nvarchar(4000) COLLATE Latin1_General_BIN2", "NCHAR"},};

static String charTableNonUnicode[][] = {{"Char", "char(20) COLLATE Latin1_General_BIN2", "CHAR"},
{"Varchar", "varchar(50) COLLATE Latin1_General_BIN2", "CHAR"},
{"VarcharMax", "varchar(max) COLLATE Latin1_General_BIN2", "LONGVARCHAR"},
{"Varchar8000", "varchar(8000) COLLATE Latin1_General_BIN2", "CHAR"},};

static String charTableUTF8Collate[][] = {{"Char", "char(20) COLLATE Latin1_General_100_BIN2_UTF8", "CHAR"},
{"Varchar", "varchar(50) COLLATE Latin1_General_100_BIN2_UTF8", "CHAR"},
{"VarcharMax", "varchar(max) COLLATE Latin1_General_100_BIN2_UTF8", "LONGVARCHAR"},
{"Varchar8000", "varchar(8000) COLLATE Latin1_General_100_BIN2_UTF8", "CHAR"},};

static String dateTable[][] = {{"Date", "date", "DATE"}, {"Datetime2Default", "datetime2", "TIMESTAMP"},
{"DatetimeoffsetDefault", "datetimeoffset", "DATETIMEOFFSET"}, {"TimeDefault", "time", "TIME"},
{"Datetime", "datetime", "DATETIME"}, {"Smalldatetime", "smalldatetime", "SMALLDATETIME"}};
Expand Down Expand Up @@ -338,6 +350,25 @@ protected static void createTable(String tableName, String cekName, String table
}
}

protected static void createTable(String tableName, String cekName, String table[][], SQLServerStatement stmt) {
try {
String sql = "";
for (int i = 0; i < table.length; i++) {
sql += ColumnType.PLAIN.name() + table[i][0] + " " + table[i][1] + " NULL,";
sql += ColumnType.DETERMINISTIC.name() + table[i][0] + " " + table[i][1]
+ String.format(encryptSql, ColumnType.DETERMINISTIC.name(), cekName) + ") NULL,";
sql += ColumnType.RANDOMIZED.name() + table[i][0] + " " + table[i][1]
+ String.format(encryptSql, ColumnType.RANDOMIZED.name(), cekName) + ") NULL,";
}
TestUtils.dropTableIfExists(tableName, stmt);
sql = String.format(createSql, tableName, sql);
stmt.execute(sql);
stmt.execute("DBCC FREEPROCCACHE");
} catch (SQLException e) {
fail(e.getMessage());
}
}

protected static void createPrecisionTable(String tableName, String table[][], String cekName, int floatPrecision,
int precision, int scale) throws SQLException {
try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(AETestConnectionString, AEInfo);
Expand Down Expand Up @@ -400,6 +431,48 @@ protected static void createScaleTable(String tableName, String table[][], Strin
}
}

protected static void createDatabaseWithUtf8Collation(Connection conn, String dbName) throws SQLException {
try (SQLServerStatement stmt = (SQLServerStatement) conn.createStatement()) {
String dropDB = "IF EXISTS (SELECT name FROM sys.databases WHERE name = N'"+ dbName + "') DROP DATABASE " + dbName + ";";
String createDB = "CREATE DATABASE " + dbName + " COLLATE Latin1_General_100_CS_AS_WS_SC_UTF8";
stmt.execute(dropDB);
stmt.execute(createDB);
}
}

protected static void dropDatabaseWithUtf8Collation(Connection conn, String dbName) throws SQLException {
try (SQLServerStatement stmt = (SQLServerStatement) conn.createStatement()) {
String dropDB = "IF EXISTS (SELECT name FROM sys.databases WHERE name = N'"+ dbName + "') DROP DATABASE " + dbName + ";";
stmt.execute(dropDB);
}
}

protected static void createUtf8CollationDbCredentials(Connection conn, String dbName, String login, String user, String password) throws SQLException {
String dropLogin = "IF EXISTS (select * from sys.sql_logins where name = '" + login + "') DROP LOGIN " + login;
String dropUser = "IF EXISTS (select * from sys.sysusers where name = '" + user + "') DROP USER " + user;
String createLogin = "CREATE LOGIN " + login + " WITH PASSWORD=N'" + password + "'";
String createUser = "USE " + dbName + ";CREATE USER " + user + " FOR LOGIN " + login;
String grantRole = "USE " + dbName + ";ALTER ROLE db_owner ADD MEMBER " + user;
String grantAlterServerState = "USE MASTER;GRANT ALTER SERVER STATE TO " + login;
try (SQLServerStatement stmt = (SQLServerStatement) conn.createStatement()) {
stmt.execute(dropLogin);
stmt.execute(dropUser);
stmt.execute(createLogin);
stmt.execute(createUser);
stmt.execute(grantRole);
stmt.execute(grantAlterServerState);
}
}

protected static void dropUtf8CollationDbCredentials(Connection conn, String login, String user) throws SQLException {
String dropLogin = "IF EXISTS (select * from sys.sql_logins where name = '" + login + "') DROP LOGIN " + login;
String dropUser = "IF EXISTS (select * from sys.sysusers where name = '" + user + "') DROP USER " + user;
try (SQLServerStatement stmt = (SQLServerStatement) conn.createStatement()) {
stmt.execute(dropLogin);
stmt.execute(dropUser);
}
}

/**
* Create a list of binary values
*
Expand Down Expand Up @@ -449,6 +522,24 @@ protected static String[] createCharValues(boolean nullable) {
return values;
}

/**
* Create a list of char values for non-unicode data types
*
* @param nullable
*/
protected static String[] createCharValuesNonUnicode(boolean nullable) {

boolean encrypted = true;
String char20 = RandomData.generateCharTypes("20", nullable, encrypted);
String varchar50 = RandomData.generateCharTypes("50", nullable, encrypted);
String varcharmax = RandomData.generateCharTypes("max", nullable, encrypted);
String varchar8000 = RandomData.generateCharTypes("8000", nullable, encrypted);

String[] values = {char20.trim(), varchar50, varcharmax, varchar8000};

return values;
}

/**
* Create a list of numeric values
*
Expand Down Expand Up @@ -809,7 +900,8 @@ protected static void populateCharNormalCase(String[] charValues) throws SQLExce
String sql = "insert into " + CHAR_TABLE_AE + " values( " + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?,"
+ "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?" + ")";

try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(AETestConnectionString, AEInfo);
String connectionString = TestUtils.addOrOverrideProperty(AETestConnectionString, "sendStringParametersAsUnicode", Boolean.toString(false));
try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(connectionString, AEInfo);
SQLServerPreparedStatement pstmt = (SQLServerPreparedStatement) TestUtils.getPreparedStmt(con, sql,
stmtColEncSetting)) {

Expand Down Expand Up @@ -866,6 +958,82 @@ protected static void populateCharNormalCase(String[] charValues) throws SQLExce
}
}

/**
* Populate char data non-unicode.
*
* @param charValues
* @throws SQLException
*/
protected static void populateCharNormalCaseNonUnicode(String connectionString, String[] charValues, boolean sendStringParametersAsUnicode) throws SQLException {
String sql = "insert into " + CHAR_TABLE_AE_NON_UNICODE + " values( " + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?)";

String cs = TestUtils.addOrOverrideProperty(connectionString, "sendStringParametersAsUnicode", Boolean.toString(sendStringParametersAsUnicode));
try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(cs, AEInfo);
SQLServerPreparedStatement pstmt = (SQLServerPreparedStatement) TestUtils.getPreparedStmt(con, sql,
stmtColEncSetting)) {

// char
for (int i = 1; i <= 3; i++) {
pstmt.setString(i, charValues[0]);
}

// varchar
for (int i = 4; i <= 6; i++) {
pstmt.setString(i, charValues[1]);
}

// varchar(max)
for (int i = 7; i <= 9; i++) {
pstmt.setString(i, charValues[2]);
}

// varchar8000
for (int i = 10; i <= 12; i++) {
pstmt.setString(i, charValues[3]);
}

pstmt.execute();
}
}

/**
* Populate char data using set object.
*
* @param charValues
* @throws SQLException
*/
protected static void populateCharSetObjectNonUnicode(String connectionString, String[] charValues, boolean sendStringParametersAsUnicode) throws SQLException {
String sql = "insert into " + CHAR_TABLE_AE_NON_UNICODE + " values( " + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?)";

String cs = TestUtils.addOrOverrideProperty(connectionString, "sendStringParametersAsUnicode", Boolean.toString(sendStringParametersAsUnicode));
try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(cs, AEInfo);
SQLServerPreparedStatement pstmt = (SQLServerPreparedStatement) TestUtils.getPreparedStmt(con, sql,
stmtColEncSetting)) {

// char
for (int i = 1; i <= 3; i++) {
pstmt.setObject(i, charValues[0]);
}

// varchar
for (int i = 4; i <= 6; i++) {
pstmt.setObject(i, charValues[1]);
}

// varchar(max)
for (int i = 7; i <= 9; i++) {
pstmt.setObject(i, charValues[2], java.sql.Types.LONGVARCHAR);
}

// varchar8000
for (int i = 10; i <= 12; i++) {
pstmt.setObject(i, charValues[3]);
}

pstmt.execute();
}
}

/**
* Populate char data using set object.
*
Expand All @@ -876,7 +1044,8 @@ protected static void populateCharSetObject(String[] charValues) throws SQLExcep
String sql = "insert into " + CHAR_TABLE_AE + " values( " + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?,"
+ "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?" + ")";

try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(AETestConnectionString, AEInfo);
String connectionString = TestUtils.addOrOverrideProperty(AETestConnectionString, "sendStringParametersAsUnicode", "false");
try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(connectionString, AEInfo);
SQLServerPreparedStatement pstmt = (SQLServerPreparedStatement) TestUtils.getPreparedStmt(con, sql,
stmtColEncSetting)) {

Expand Down Expand Up @@ -939,7 +1108,7 @@ protected static void populateCharSetObjectWithJDBCTypes(String[] charValues) th
String sql = "insert into " + CHAR_TABLE_AE + " values( " + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?,"
+ "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?" + ")";

try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(AETestConnectionString, AEInfo);
try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(AETestConnectionString + ";sendStringParametersAsUnicode=false;", AEInfo);
SQLServerPreparedStatement pstmt = (SQLServerPreparedStatement) TestUtils.getPreparedStmt(con, sql,
stmtColEncSetting)) {

Expand Down Expand Up @@ -1001,7 +1170,7 @@ protected static void populateCharNullCase() throws SQLException {
String sql = "insert into " + CHAR_TABLE_AE + " values( " + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?,"
+ "?,?,?," + "?,?,?," + "?,?,?," + "?,?,?" + ")";

try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(AETestConnectionString, AEInfo);
try (SQLServerConnection con = (SQLServerConnection) PrepUtil.getConnection(AETestConnectionString + ";sendStringParametersAsUnicode=false;", AEInfo);
SQLServerPreparedStatement pstmt = (SQLServerPreparedStatement) TestUtils.getPreparedStmt(con, sql,
stmtColEncSetting)) {

Expand Down
Loading
Loading