使用 Kerberos 集成身份验证连接到 SQL Server

下载 JDBC 驱动程序

从 {1}Microsoft JDBC Driver 4.0 for SQL Server{2} 开始,应用程序可使用 authenticationScheme 连接属性指示它希望连接到使用类型 4 Kerberos 集成身份验证的数据库 。 若要详细了解连接属性,请参阅设置连接属性。 有关 Kerberos 的详细信息,请参阅 Microsoft Kerberos

对 Java Krb5LoginModule 使用集成身份验证时,可使用类 Krb5LoginModule 配置该模块 。

Microsoft JDBC Driver for SQL Server 针对 IBM Java VM 设置了以下属性:

  • useDefaultCcache = true
  • moduleBanner = false

Microsoft JDBC Driver for SQL Server 针对所有其他 Java VM 设置了以下属性:

  • useTicketCache = true
  • doNotPrompt = true

备注

在 Microsoft JDBC Driver 4.0 for SQL Server 之前,应用程序可通过使用 integratedSecurity 连接属性并引用 mssql-jdbc_auth-<version>-<arch>.dll 来指定集成身份验证(使用 Kerberos 或 NTLM,视可用情况而定),如生成连接 URL 中所述。

从 {1}Microsoft JDBC Driver 4.0 for SQL Server{2} 开始,应用程序可使用 authenticationScheme 连接属性指示它希望通过纯 Java Kerberos 实现连接到使用 Kerberos 集成身份验证的数据库 :

  • 如果要选择使用 Krb5LoginModule 的集成身份验证,仍然必须指定 integratedSecurity=true 连接属性。 然后,还可以指定 authenticationScheme=JavaKerberos 连接属性。

  • 若要继续通过 mssql-jdbc_auth-<version>-<arch>.dll 使用集成身份验证,只需指定 integratedSecurity=true 连接属性(或者可以选择使用 authenticationScheme=NativeAuthentication)。

  • 如果指定 authenticationScheme=JavaKerberos 但未同时指定 integratedSecurity=true,则驱动程序将忽略 authenticationScheme 连接属性,并希望在连接字符串中找到用户名和密码凭据。

使用数据源来创建连接时,可使用 setAuthenticationScheme 以编程方式设置身份验证方案,也可选择性地使用 setServerSpn 为 Kerberos 连接设置 SPN 。

新增了一个记录程序以支持 Kerberos 身份验证:com.microsoft.sqlserver.jdbc.internals.KerbAuthentication。 有关详细信息,请参阅跟踪驱动程序操作

以下准则将有助于您配置 Kerberos:

  1. 在 Windows 注册表中,将 AllowTgtSessionKey 设置为 1。 有关详细信息,请参阅 Windows Server 2003 中的 Kerberos 协议注册表项和 KDC 配置项
  2. 请确保 Kerberos 配置(UNIX 环境中的 krb5.conf)指向您的环境中正确的领域和 KDC。
  3. 通过使用 kinit 或登录到域来初始化 TGT 缓存。
  4. 当在 Windows Vista 或 Windows 7 操作系统上运行使用 authenticationScheme=JavaKerberos 的应用程序时,应使用标准用户帐户 。 但是,如果在管理员帐户下运行应用程序,则该程序必须以管理员特权运行。

注意

serverSpn 连接属性仅受 Microsoft JDBC Driver 4.2 及更高版本支持。

服务主体名称

服务主体名称 (SPN) 是客户端用来唯一标识服务实例的名称。

可以使用 serverSpn 连接属性指定 SPN 或让驱动程序生成它(默认)。 此属性采用“MSSQLSvc/fqdn:port@REALM”的形式,其中 fqdn 是完全限定的域名,port 是端口号,REALM 是 SQL Server 的 Kerberos 领域(采用大写形式)。 如果 Kerberos 配置的默认领域与该 Server 的领域相同且不默认包含在内,则此属性的领域部分可选。 如果想要支持跨领域身份验证方案,其中 Kerberos 配置中的默认领域与服务器的领域不同,则必须使用 serverSpn 属性设置 SPN。

例如,SPN 可能如下所示:MSSQLSvc/some-server.zzz.corp.contoso.com:1433@ZZZZ.CORP.CONTOSO.COM

有关服务主体名称 (SPN) 的详细信息,请参阅:

注意

在 JDBC Driver 6.2 之前,为了正确使用跨领域 Kerberos,需要显式设置 serverSpn 。

从 6.2 版开始,即使在使用跨领域 Kerberos 的情况下,该驱动程序也能够默认生成 serverSpn 。 (尽管也可以显式使用 serverSpn )。

创建登录模块配置文件

您也可选择指定 Kerberos 配置文件。 如果未指定配置文件,则以下设置有效:

Sun JVM
com.sun.security.auth.module.Krb5LoginModule required useTicketCache=true;

IBM JVM
com.ibm.security.auth.module.Krb5LoginModule required useDefaultCcache = true;

如果您决定创建登录模块配置文件,则该文件必须遵循以下格式:

<name> {  
    <LoginModule> <flag> <LoginModule options>;  
    <optional_additional_LoginModules, flags_and_options>;  
};  

登录配置文件包含一个或多个条目,每个条目分别指定应用于某个特定应用程序或多个应用程序的基础身份验证技术。 例如,

SQLJDBCDriver {  
   com.sun.security.auth.module.Krb5LoginModule required useTicketCache=true;  
};  

每个登录模块配置文件条目都包含一个名称,后跟一个或多个特定于 LoginModule 的条目。 每个特定于 LoginModule 的条目以分号结束,而整个特定于 LoginModule 的条目组用大括号括起来。 每个配置文件条目均以分号结尾。

除了允许驱动程序使用登录配置模块文件中指定的设置获取 Kerberos 凭据之外,驱动程序还可使用现有凭据。 如果应用程序需要使用多个用户凭据来创建连接,则此方法非常有用。

在尝试使用指定登录模块登录之前,如果现有凭据可用,则驱动程序将尝试使用它们。 因此,在使用 Subject.doAs 方法在特定上下文中执行代码时,可通过传递到 Subject.doAs 调用的凭据创建连接。

有关详细信息,请参阅 JAAS 登录配置文件类 Krb5LoginModule

从 Microsoft JDBC Driver 6.2 开始,可以选择使用连接属性 jaasConfigurationName 来传递登录模块配置的条目名称。 此方法可以让每个连接都有其自己的登录配置或使用 SQLJDBCDriver 以外的名称。

创建 Kerberos 配置文件

有关 Kerberos 配置文件的详细信息,请参阅 Kerberos 需求

这是一个示例域配置文件,其中 YYYYZZZZ 是域名。

[libdefaults]  
default_realm = YYYY.CORP.CONTOSO.COM  
dns_lookup_realm = false  
dns_lookup_kdc = true  
ticket_lifetime = 24h  
forwardable = yes  

[domain_realm]  
.yyyy.corp.contoso.com = YYYY.CORP.CONTOSO.COM  
.zzzz.corp.contoso.com = ZZZZ.CORP.CONTOSO.COM  

[realms]  
        YYYY.CORP.CONTOSO.COM = {  
  kdc = krbtgt/YYYY.CORP. CONTOSO.COM @ YYYY.CORP. CONTOSO.COM  
  default_domain = YYYY.CORP. CONTOSO.COM  
}  

        ZZZZ.CORP. CONTOSO.COM = {  
  kdc = krbtgt/ZZZZ.CORP. CONTOSO.COM @ ZZZZ.CORP. CONTOSO.COM  
  default_domain = ZZZZ.CORP. CONTOSO.COM  
}  

启用域配置文件和登录模块配置文件

您可以使用 -Djava.security.krb5.conf 启用域配置文件。 可以使用 -Djava.security.auth.login.config 启用登录模块配置文件。

例如,可以使用以下命令启动应用程序:

Java.exe -Djava.security.auth.login.config=SQLJDBCDriver.conf -Djava.security.krb5.conf=krb5.ini <APPLICATION_NAME>  

验证能否通过 Kerberos 访问 SQL Server

在 SQL Server Management Studio 中运行以下查询:

select auth_scheme from sys.dm_exec_connections where session_id=\@\@spid

请确保您具有运行此查询的必要权限。

约束委派

从 Microsoft JDBC Driver 6.2 开始,驱动程序支持 Kerberos 约束委派。 委派的凭据可以作为 org.ietf.jgss.GSSCredential 对象传入,驱动程序使用这些凭据来建立连接。

Properties driverProperties = new Properties();
GSSCredential impersonatedUserCredential = [userCredential]
driverProperties.setProperty("integratedSecurity", "true");
driverProperties.setProperty("authenticationScheme", "JavaKerberos");
driverProperties.put("gsscredential", impersonatedUserCredential);
Connection conn = DriverManager.getConnection(CONNECTION_URI, driverProperties);

使用主体名称、密码和领域的 Kerberos 连接

从 Microsoft JDBC Driver 6.2 开始,驱动程序可以使用连接字符串中传递的主体名称和密码建立 Kerberos 连接。

jdbc:sqlserver://servername=server_name;encrypt=true;integratedSecurity=true;authenticationScheme=JavaKerberos;userName=user@REALM;password=****

如果用户属于 krb5.conf 文件中设置的 default_realm,则 username 属性不需要 REALM。 当 userNamepasswordintegratedSecurity=true;authenticationScheme=JavaKerberos; 属性一起设置时,将使用作为 Kerberos 主体的 userName 的值以及提供的密码建立连接。

从 Microsoft JDBC Driver 9.4 开始,用户可以在连接字符串中指定 Kerberos 身份验证的领域。

jdbc:sqlserver://servername=server_name;encrypt=true;integratedSecurity=true;authenticationScheme=JavaKerberos;userName=user;password=****;realm=REALM

在同一域中的 Unix 计算机上使用 Kerberos 身份验证

本指南假定已经存在有效的 Kerberos 设置。 在使用 Kerberos 身份验证的 Windows 计算机上运行以下代码,验证上述内容是否正确。 如果成功,代码会将“身份验证方案:KERBEROS”打印到控制台。 除了提供的运行时标志、依赖项或驱动程序设置之外,不再需要任何其他此类内容。 可以在 Linux 上运行相同的代码块来验证连接是否成功。

SQLServerDataSource ds = new SQLServerDataSource();
ds.setServerName("<server>");
ds.setPortNumber(1433); // change if necessary
ds.setIntegratedSecurity(true);
ds.setAuthenticationScheme("JavaKerberos");
ds.setDatabaseName("<database>");

try (Connection c = ds.getConnection(); Statement s = c.createStatement();
        ResultSet rs = s.executeQuery("select auth_scheme from sys.dm_exec_connections where session_id=@@spid")) {
    while (rs.next()) {
        System.out.println("Authentication Scheme: " + rs.getString(1));
    }
}
  1. 将客户端计算机加入与服务器相同的域中。
  2. (可选)设置默认的 Kerberos 票证位置。 通过设置 KRB5CCNAME 环境变量可以最方便地完成此步骤。
  3. 通过生成一个新的 Kerberos 票证,或将一个现有的 Kerberos 票证放置在默认的 Kerberos 票证位置中来获取 Kerberos 票证。 若要生成票证,请使用终端并通过 kinit USER@DOMAIN.AD(其中“USER”和“DOMAIN.AD”分别表示主体和域)初始化票证。 例如:kinit SQL_SERVER_USER03@EXAMPLE.COM。 票证将在默认票证位置或 KRB5CCNAME 路径(如果已设置)中生成。
  4. 终端会提示输入密码,请输入密码。
  5. 通过 klist 验证票证中的凭据,并确认凭据是要用于身份验证的那个凭据。
  6. 运行上述示例代码并确认 Kerberos 身份验证已成功。

本机平台 GSS 集成

本机平台 GSS 集成允许 Java 应用程序使用本机 GSS-API,而不是 GSS-API JDK 实现的加密机制。 例如,以下示例代码演示了如何在驱动程序中启用本机 GSS-API:

GSSCredential credential = GSSManager.getInstance().createCredential(null, GSSCredential.DEFAULT_LIFETIME, new Oid("1.2.840.113554.1.2.2"), GSSCredential.INITIATE_ONLY);

SQLServerDataSource ds = new SQLServerDataSource();
ds.setURL("jdbc:sqlserver://<server>;databaseName=<database>;integratedSecurity=true;authenticationScheme=JavaKerberos;");
ds.setGSSCredentials(credential);
ds.getConnection();

try (Connection conn = ds.getConnection()) {
    ResultSet rs = conn.executeQuery("select auth_scheme from sys.dm_exec_connections where session_id=@@spid")) {
    while (rs.next()) {
        System.out.println("Authentication Scheme: " + rs.getString(1));
    }
}

此外,还需要以下 JVM 参数:

-Dsun.security.jgss.native=true
-Djavax.security.auth.useSubjectCredsOnly=false

还可以选择提供本机 GSS 库的路径。

-Dsun.security.jgss.lib=path/to/native/gss/library // This is optional

有关 JVM 参数的详细信息,请参阅官方 Java 文档。

另请参阅

通过 JDBC 驱动程序连接到 SQL Server