bug(bq_driver): SQLDriverConnectW corrupts/fails to NUL-terminate outConnectionString (breaks Microsoft Excel / iODBC on macOS)

未关闭
#1,719 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
cpp
领域
backend

调研方向

Start in google/cloud/odbc/bq_driver/odbc_api.cc at SQLDriverConnectW and compare its output handling with SQLBrowseConnectW. Check the wire buffer helpers in odbc_type_utils.h and the ODBC truncation behavior described in the issue. Done means using separate UTF-8 storage, respecting the wide output buffer limit, and ensuring the result is NUL-terminated; the issue also requests updating the macOS release tarball after a new release tag.

由索引模型根据 Issue 内容生成。

描述

Summary

When using the Google BigQuery ODBC Driver on macOS with iODBC (sizeof(SQLWCHAR) == 4) and Microsoft Excel / Microsoft Query, calling SQLDriverConnectW corrupts outConnectionString (szConnStrOut), causing Excel's Return Data action (inserting query results as a Table or PivotTable) to fail with:

[iODBC][Driver Manager]Data source name not found and no default driver specified. Driver could not be loaded

Root Cause Analysis
1. Latest Published Release (v1.3.1 / ODBCDriverforBigQuery_macos_latest.tar.gz)

In v1.3.1 (currently the latest binary published on GCS bq-driver-releases and GitHub Releases), SQLDriverConnectW in google/cloud/odbc/bq_driver/odbc_api.cc passed reinterpret_cast<SQLCHAR*>(outConnectionString) to SQLDriverConnectInternal() (which wrote 8-bit UTF-8 bytes into the caller's SQLWCHAR* buffer) and then executed:

outConnectionString = ToSqlWChar(utf16_out_conn_str->data());

Because outConnectionString is a pointer passed by value, reassigning the local parameter was a dead store (optimized out under -O3) and never copied the converted wide characters back into the caller's buffer. Consequently:

  • outConnectionString still contained raw 8-bit UTF-8 bytes (e.g., "DSN=my-bq-dsn;").
  • On macOS, iODBC reads outConnectionString as 32-bit wchar_t (UTF-32LE) code units (0x3d4e5344, ...) and converts them into "??????".
  • When clicking Return Data in Microsoft Query on macOS, Microsoft Query.app passes OutConnectionString to Microsoft Excel.app to open the worksheet connection, which immediately fails in iODBC.
2. Remaining Issues on main (google/cloud/odbc/bq_driver/odbc_api.cc:274-300)

Commit d080bdb282 (#1506) replaced the dead pointer assignment with:

WriteWideToWireBuffer(*utf16_out_conn_str, outConnectionString,
                      out_conn_str_len);

However, three issues remain in SQLDriverConnectW on main:

  1. Missing wire NUL terminator: WriteWideToWireBuffer defaults to bool null_terminate = false (odbc_type_utils.h:188), and unlike SQLBrowseConnectW (odbc_api.cc:402), SQLDriverConnectW neither zeros outConnectionString beforehand nor passes /*null_terminate=*/true.
  2. Buffer overflow when outConnectionStringBufferLen truncates the output: Per the ODBC specification, PopulateOutputConnectionString sets *out_conn_str_len to the full untruncated string length even when out_conn_str_buflen is smaller (SQL_SUCCESS_WITH_INFO / 01004). Passing out_conn_str_len directly to WriteWideToWireBuffer without clamping to outConnectionStringBufferLen - 1 writes past the end of outConnectionString, and Utf8ToUtf16((char*)out_conn_str) on line 287 ignores else only because out_conn_str_len > 0.
  3. Aliasing outConnectionString as a temporary UTF-8 buffer: Casting outConnectionString (SQLWCHAR*) directly to SQLCHAR* aliases the caller's output buffer before wide conversion.

Proposed Fix (google/cloud/odbc/bq_driver/odbc_api.cc)

Use a separate temporary std::vector<SQLCHAR> buffer for SQLDriverConnectInternal, clamp the number of wide characters written to outConnectionStringBufferLen - 1, and pass /*null_terminate=*/true to WriteWideToWireBuffer:

  std::vector<SQLCHAR> utf8_out_buf(
      outConnectionString && outConnectionStringBufferLen > 0
          ? static_cast<size_t>(outConnectionStringBufferLen)
          : 0,
      0);
  SQLCHAR* out_conn_str =
      (!utf8_out_buf.empty()) ? utf8_out_buf.data() : nullptr;
  SQLSMALLINT out_conn_str_len = 0;

  rc = google::cloud::odbc_bq_driver::SQLDriverConnectInternal(
      connectionHandle, windowHandle, sqlchar_in_connection_str,
      inConnectionStringLen, out_conn_str, outConnectionStringBufferLen,
      &out_conn_str_len, driverCompletion);

  // Handle Unicode conversion of output parameters.
  if (SQL_SUCCEEDED(rc) && outConnectionString) {
    if (outConnectionStringBufferLen > 0) {
      std::string val(ToCharStr(out_conn_str));
      StatusRecordOr<std::wstring> utf16_out_conn_str = Utf8ToUtf16(val);
      if (!utf16_out_conn_str) {
        return utf16_out_conn_str.GetCalculatedReturnCode();
      }
      size_t const max_chars =
          static_cast<size_t>(outConnectionStringBufferLen - 1);
      size_t const to_copy =
          std::min<size_t>(utf16_out_conn_str->size(), max_chars);
      WriteWideToWireBuffer(*utf16_out_conn_str, outConnectionString, to_copy,
                            /*null_terminate=*/true);
    } else if (outConnectionStringBufferLen == 0) {
      // Buffer length is 0; do not write to outConnectionString.
    }
  }
  if (outConnectionStringLen) *outConnectionStringLen = out_conn_str_len;

(Note: Once a new release tag is cut, please also update the macOS tarball at https://storage.googleapis.com/bq-driver-releases/odbc/ODBCDriverforBigQuery_macos_latest.tar.gz, which currently still serves v1.3.1.)

主要语言
C++
星标
5
派生
8
平均合并
2 天 14 小时
30 天内合并 PR
10

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

googleapis/cpp-bigquery-odbc 的其他 Issue

查看 googleapis/cpp-bigquery-odbc 的全部 Issue

相似的 Issue

更多 C++ Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。