Fix GUID conversion (#207)

Co-authored-by: Andrea Magnetto <[email protected]>
Adds a connection string value to preserve the raw guid byte order returned by SQL Server.

Author: andrea-mgn

README.md

@@ -68,6 +68,7 @@ Other supported formats are listed below.
 * `multisubnetfailover`
   * `true` (Default) Client attempt to connect to all IPs simultaneously. 
   * `false` Client attempts to connect to IPs in serial.
+* `guid conversion` - Enables the conversion of GUIDs, so that byte order is preserved. UniqueIdentifier isn't supported for nullable fields, NullUniqueIdentifier must be used instead.
 
 ### Connection parameters for namedpipe package
 * `pipe`  - If set, no Browser query is made and named pipe used will be `\\<host>\pipe\<pipe>`

alwaysencrypted_test.go

@@ -213,7 +213,7 @@ func TestAlwaysEncryptedE2E(t *testing.T) {
 func testProviderErrorHandling(t *testing.T, name string, provider aecmk.ColumnEncryptionKeyProvider, sel string, insert string, insertArgs []interface{}) {
 	t.Helper()
 	testProvider := &testKeyProvider{fallback: provider}
-	connector, _ := getTestConnector(t)
+	connector, _ := getTestConnector(t, false /*guidConversion*/)
 	connector.RegisterCekProvider(name, testProvider)
 	conn := sql.OpenDB(connector)
 	defer conn.Close()

bulkcopy.go

@@ -264,7 +264,7 @@ func (b *Bulk) createColMetadata() []byte {
 		}
 		binary.Write(buf, binary.LittleEndian, uint16(col.Flags))
 
-		writeTypeInfo(buf, &b.bulkColumns[i].ti, false)
+		writeTypeInfo(buf, &b.bulkColumns[i].ti, false, b.cn.sess.encoding)
 
 		if col.ti.TypeId == typeNText ||
 			col.ti.TypeId == typeText ||

bulkcopy_test.go

@@ -111,9 +111,9 @@ func TestBulkcopyWithInvalidNullableType(t *testing.T) {
 	}
 }
 
-func TestBulkcopy(t *testing.T) {
+func testBulkcopy(t *testing.T, guidConversion bool) {
 	// TDS level Bulk Insert is not supported on Azure SQL Server.
-	if dsn := makeConnStr(t); strings.HasSuffix(strings.Split(dsn.Host, ":")[0], ".database.windows.net") {
+	if dsn := makeConnStrSettingGuidConversion(t, guidConversion); strings.HasSuffix(strings.Split(dsn.Host, ":")[0], ".database.windows.net") {
 		t.Skip("TDS level bulk copy is not supported on Azure SQL Server")
 	}
 	type testValue struct {
@@ -300,6 +300,14 @@ func TestBulkcopy(t *testing.T) {
 	}
 }
 
+func TestBulkcopyWithGuidConversion(t *testing.T) {
+	testBulkcopy(t, true /*guidConversion*/)
+}
+
+func TestBulkcopy(t *testing.T) {
+	testBulkcopy(t, false /*guidConversion*/)
+}
+
 func compareValue(a interface{}, expected interface{}) bool {
 	if got, ok := a.([]uint8); ok {
 		if _, ok := expected.([]uint8); !ok {

msdsn/conn_str.go

@@ -84,8 +84,14 @@ const (
 	Pipe                   = "pipe"
 	MultiSubnetFailover    = "multisubnetfailover"
 	NoTraceID              = "notraceid"
+	GuidConversion         = "guid conversion"
 )
 
+type EncodeParameters struct {
+	// Properly convert GUIDs, using correct byte endianness
+	GuidConversion bool
+}
+
 type Config struct {
 	Port       uint64
 	Host       string
@@ -141,6 +147,8 @@ type Config struct {
 	// When true, no connection id or trace id value is sent in the prelogin packet.
 	// Some cloud servers may block connections that lack such values.
 	NoTraceID bool
+	// Parameters related to type encoding
+	Encoding EncodeParameters
 }
 
 func readDERFile(filename string) ([]byte, error) {
@@ -525,6 +533,20 @@ func Parse(dsn string) (Config, error) {
 			p.NoTraceID = notraceid
 		}
 	}
+
+	guidConversion, ok := params[GuidConversion]
+	if ok {
+		var err error
+		p.Encoding.GuidConversion, err = strconv.ParseBool(guidConversion)
+		if err != nil {
+			f := "invalid guid conversion '%s': %s"
+			return p, fmt.Errorf(f, guidConversion, err.Error())
+		}
+	} else {
+		// set to false for backward compatibility
+		p.Encoding.GuidConversion = false
+	}
+
 	return p, nil
 }
 
@@ -585,6 +607,11 @@ func (p Config) URL() *url.URL {
 	if p.ColumnEncryption {
 		q.Add("columnencryption", "true")
 	}
+
+	if p.Encoding.GuidConversion {
+		q.Add(GuidConversion, strconv.FormatBool(p.Encoding.GuidConversion))
+	}
+
 	if len(q) > 0 {
 		res.RawQuery = q.Encode()
 	}

msdsn/conn_str_test.go

@@ -190,7 +190,10 @@ func TestValidConnectionString(t *testing.T) {
 			return p.Host == "somehost" && p.Port == 0 && p.Instance == "" && p.User == "someuser" && p.Password == "" && p.ConnTimeout == 30*time.Second && p.DisableRetry && !p.ColumnEncryption
 		}},
 		{"sqlserver://somehost?encrypt=true&tlsmin=1.1&columnencryption=1", func(p Config) bool {
-			return p.Host == "somehost" && p.Encryption == EncryptionRequired && p.TLSConfig.MinVersion == tls.VersionTLS11 && p.ColumnEncryption
+			return p.Host == "somehost" && p.Encryption == EncryptionRequired && p.TLSConfig.MinVersion == tls.VersionTLS11 && p.ColumnEncryption && !p.Encoding.GuidConversion
+		}},
+		{"sqlserver://somehost?encrypt=true&tlsmin=1.1&columnencryption=1&guid+conversion=true", func(p Config) bool {
+			return p.Host == "somehost" && p.Encryption == EncryptionRequired && p.TLSConfig.MinVersion == tls.VersionTLS11 && p.ColumnEncryption && p.Encoding.GuidConversion
 		}},
 	}
 	for _, ts := range connStrings {

mssql.go

@@ -554,7 +554,7 @@ func (s *Stmt) sendQuery(ctx context.Context, args []namedValue) (err error) {
 			params[0] = makeStrParam(s.query)
 			params[1] = makeStrParam(strings.Join(decls, ","))
 		}
-		if err = sendRpc(conn.sess.buf, headers, proc, 0, params, reset); err != nil {
+		if err = sendRpc(conn.sess.buf, headers, proc, 0, params, reset, conn.sess.encoding); err != nil {
 			conn.sess.LogF(ctx, msdsn.LogErrors, "Failed to send Rpc with %v", err)
 			conn.connectionGood = false
 			return fmt.Errorf("failed to send RPC: %v", err)

mssql_go19.go

@@ -206,7 +206,7 @@ func (s *Stmt) makeParamExtra(val driver.Value) (res param, err error) {
 			err = errCalTypes
 			return
 		}
-		res.buffer, err = val.encode(schema, name, columnStr, tvpFieldIndexes)
+		res.buffer, err = val.encode(schema, name, columnStr, tvpFieldIndexes, s.c.sess.encoding)
 		if err != nil {
 			return
 		}

queries_test.go

@@ -27,8 +27,8 @@ func driverWithProcess(t *testing.T, tl Logger) *Driver {
 	}
 }
 
-func TestSelect(t *testing.T) {
-	conn, logger := open(t)
+func testSelect(t *testing.T, guidConversion bool) {
+	conn, logger := openSettingGuidConversion(t, guidConversion)
 	defer conn.Close()
 	defer logger.StopLogging()
 
@@ -39,6 +39,10 @@ func TestSelect(t *testing.T) {
 		}
 
 		longstr := strings.Repeat("x", 10000)
+		expectedGuid := []byte{0x6F, 0x96, 0x19, 0xFF, 0x8B, 0x86, 0xD0, 0x11, 0xB4, 0x2D, 0x00, 0xC0, 0x4F, 0xC9, 0x64, 0xFF}
+		if guidConversion {
+			expectedGuid = []byte{0xFF, 0x19, 0x96, 0x6F, 0x86, 0x8B, 0x11, 0xD0, 0xB4, 0x2D, 0x00, 0xC0, 0x4F, 0xC9, 0x64, 0xFF}
+		}
 
 		values := []testStruct{
 			{"1", int64(1)},
@@ -83,8 +87,7 @@ func TestSelect(t *testing.T) {
 			{"cast('2079-06-06T23:59:00' as smalldatetime)",
 				time.Date(2079, 6, 6, 23, 59, 0, 0, time.UTC)},
 			{"cast(NULL as smalldatetime)", nil},
-			{"cast(0x6F9619FF8B86D011B42D00C04FC964FF as uniqueidentifier)",
-				[]byte{0x6F, 0x96, 0x19, 0xFF, 0x8B, 0x86, 0xD0, 0x11, 0xB4, 0x2D, 0x00, 0xC0, 0x4F, 0xC9, 0x64, 0xFF}},
+			{"cast(0x6F9619FF8B86D011B42D00C04FC964FF as uniqueidentifier)", expectedGuid},
 			{"cast(NULL as uniqueidentifier)", nil},
 			{"cast(0x1234 as varbinary(2))", []byte{0x12, 0x34}},
 			{"cast(N'abc' as nvarchar(max))", "abc"},
@@ -114,8 +117,7 @@ func TestSelect(t *testing.T) {
 			{"cast(cast(N'chào' as nvarchar(max)) collate Vietnamese_CI_AI as varchar(max))", "chào"},              // cp1258
 			{fmt.Sprintf("cast(N'%s' as nvarchar(max))", longstr), longstr},
 			{"cast(NULL as sql_variant)", nil},
-			{"cast(cast(0x6F9619FF8B86D011B42D00C04FC964FF as uniqueidentifier) as sql_variant)",
-				[]byte{0x6F, 0x96, 0x19, 0xFF, 0x8B, 0x86, 0xD0, 0x11, 0xB4, 0x2D, 0x00, 0xC0, 0x4F, 0xC9, 0x64, 0xFF}},
+			{"cast(cast(0x6F9619FF8B86D011B42D00C04FC964FF as uniqueidentifier) as sql_variant)", expectedGuid},
 			{"cast(cast(1 as bit) as sql_variant)", true},
 			{"cast(cast(10 as tinyint) as sql_variant)", int64(10)},
 			{"cast(cast(-10 as smallint) as sql_variant)", int64(-10)},
@@ -214,6 +216,14 @@ func TestSelect(t *testing.T) {
 	})
 }
 
+func TestSelectWithGuidConversion(t *testing.T) {
+	testSelect(t, true /*guidConversion*/)
+}
+
+func TestSelect(t *testing.T) {
+	testSelect(t, false /*guidConversion*/)
+}
+
 func TestSelectDateTimeOffset(t *testing.T) {
 	type testStruct struct {
 		sql string

rpc.go

@@ -2,6 +2,8 @@ package mssql
 
 import (
 	"encoding/binary"
+
+	"github.com/microsoft/go-mssqldb/msdsn"
 )
 
 type procId struct {
@@ -43,7 +45,7 @@ var (
 )
 
 // http://msdn.microsoft.com/en-us/library/dd357576.aspx
-func sendRpc(buf *tdsBuffer, headers []headerStruct, proc procId, flags uint16, params []param, resetSession bool) (err error) {
+func sendRpc(buf *tdsBuffer, headers []headerStruct, proc procId, flags uint16, params []param, resetSession bool, encoding msdsn.EncodeParameters) (err error) {
 	buf.BeginPacket(packRPCRequest, resetSession)
 	writeAllHeaders(buf, headers)
 	if len(proc.name) == 0 {
@@ -73,7 +75,7 @@ func sendRpc(buf *tdsBuffer, headers []headerStruct, proc procId, flags uint16,
 		if err = binary.Write(buf, binary.LittleEndian, param.Flags); err != nil {
 			return
 		}
-		err = writeTypeInfo(buf, &param.ti, (param.Flags&fByRevValue) != 0)
+		err = writeTypeInfo(buf, &param.ti, (param.Flags&fByRevValue) != 0, encoding)
 		if err != nil {
 			return
 		}
@@ -82,7 +84,7 @@ func sendRpc(buf *tdsBuffer, headers []headerStruct, proc procId, flags uint16,
 			return
 		}
 		if (param.Flags & fEncrypted) == fEncrypted {
-			err = writeTypeInfo(buf, &param.tiOriginal, false)
+			err = writeTypeInfo(buf, &param.tiOriginal, false, encoding)
 			if err != nil {
 				return
 			}