使用Knex连接Azure SQL数据库的令牌认证实践

在Node.js应用中，Knex.js是一个流行的SQL查询构建器，它支持多种数据库系统。当我们需要连接Azure SQL数据库时，通常会使用用户名和密码进行认证。然而，在云原生环境中，使用托管身份(Managed Identity)进行认证是更安全、更符合云最佳实践的方式。

传统认证方式的局限性

传统的用户名/密码认证方式存在几个问题：

1. 凭证需要硬编码在应用配置中
2. 密码轮换会导致应用中断
3. 不符合最小权限原则

Azure的托管身份服务解决了这些问题，它允许Azure资源(如App Service、VM等)自动获取访问令牌，无需管理任何凭证。

解决方案探索

最初尝试使用Knex连接Azure SQL时，开发者可能会遇到"Login failed for user ''"的错误。这是因为Knex的默认配置不支持Azure AD令牌认证方式。

正确的实现需要以下几个关键点：

1. 使用@azure/identity库获取访问令牌
2. 在Knex配置中正确设置认证类型
3. 将令牌放置在连接配置的适当位置

实现细节

以下是完整的实现代码示例：

const { DefaultAzureCredential } = require("@azure/identity");
const knex = require("knex");

async function connectToAzureSqlWithToken() {
  try {
    // 从Azure Identity获取令牌
    const credential = new DefaultAzureCredential();
    const tokenResponse = await credential.getToken("https://database.windows.net/");

    // Knex配置
    const config = {
      client: "mssql",
      connection: {
        server: process.env.DB_SERVER,
        database: process.env.DB_NAME,
        type: "azure-active-directory-access-token", // 关键配置
        token: tokenResponse.token, // 令牌位置
        options: {
          encrypt: true, // 启用加密
        },
      },
    };

    const db = knex(config);
    const result = await db.raw("SELECT 1 as value");
    console.log("成功连接到Azure SQL数据库");
    await db.destroy();
    return true;
  } catch (err) {
    console.error("连接失败:", err);
    return false;
  }
}

关键配置说明

1. 认证类型(type): 必须设置为"azure-active-directory-access-token"，这告诉Knex使用Azure AD令牌认证
2. 令牌(token): 从DefaultAzureCredential获取的访问令牌
3. 加密选项(encrypt): 在Azure环境中必须启用加密

常见问题解决

如果遇到认证失败，可以检查以下几点：

1. 确保Azure资源(如App Service)已启用系统分配的托管身份
2. 确认SQL数据库已配置允许该托管身份的访问权限
3. 检查令牌是否有效且未过期
4. 验证令牌的作用域是否正确(应为https://database.windows.net/)

最佳实践

1. 在生产环境中，考虑使用环境变量管理数据库服务器和名称
2. 实现令牌刷新机制，处理令牌过期情况
3. 为不同的环境(开发、测试、生产)配置不同的权限
4. 定期审计数据库访问权限

通过这种方式，开发者可以安全、高效地使用Knex连接Azure SQL数据库，同时遵循云安全最佳实践。