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.
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
[SPARK-31336][SQL] Support Oracle Kerberos login in JDBC connector #28863
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright ownership. | ||
* The ASF licenses this file to You under the Apache License, Version 2.0 | ||
* (the "License"); you may not use this file except in compliance with | ||
* the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.spark.sql.execution.datasources.jdbc.connection | ||
|
||
import java.security.PrivilegedExceptionAction | ||
import java.sql.{Connection, Driver} | ||
import java.util.Properties | ||
|
||
import org.apache.hadoop.security.UserGroupInformation | ||
|
||
import org.apache.spark.sql.execution.datasources.jdbc.JDBCOptions | ||
|
||
private[sql] class OracleConnectionProvider(driver: Driver, options: JDBCOptions) | ||
extends SecureConnectionProvider(driver, options) { | ||
override val appEntry: String = "kprb5module" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just a question; where does this value come? From the Oracle JDBC impl? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, I've used JD-GUI to take a look at the details. |
||
|
||
override def getConnection(): Connection = { | ||
setAuthenticationConfigIfNeeded() | ||
UserGroupInformation.loginUserFromKeytabAndReturnUGI(options.principal, options.keytab).doAs( | ||
new PrivilegedExceptionAction[Connection]() { | ||
override def run(): Connection = { | ||
OracleConnectionProvider.super.getConnection() | ||
} | ||
} | ||
) | ||
} | ||
|
||
override def getAdditionalProperties(): Properties = { | ||
val result = new Properties() | ||
// This prop is needed to turn on kerberos authentication in the JDBC driver. | ||
// The possible values can be found in AnoServices public interface | ||
// The value is coming from AUTHENTICATION_KERBEROS5 final String in driver version 19.6.0.0 | ||
result.put("oracle.net.authentication_services", "(KERBEROS5)"); | ||
gaborgsomogyi marked this conversation as resolved.
Show resolved
Hide resolved
gaborgsomogyi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
result | ||
} | ||
|
||
override def setAuthenticationConfigIfNeeded(): Unit = SecurityConfigurationLock.synchronized { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here synchronization is important to avoid race just like in other providers. |
||
val (parent, configEntry) = getConfigWithAppEntry() | ||
if (configEntry == null || configEntry.isEmpty) { | ||
setAuthenticationConfig(parent) | ||
} | ||
} | ||
} | ||
|
||
private[sql] object OracleConnectionProvider { | ||
val driverClass = "oracle.jdbc.OracleDriver" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright ownership. | ||
* The ASF licenses this file to You under the Apache License, Version 2.0 | ||
* (the "License"); you may not use this file except in compliance with | ||
* the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.spark.sql.execution.datasources.jdbc.connection | ||
|
||
class OracleConnectionProviderSuite extends ConnectionProviderSuiteBase { | ||
test("setAuthenticationConfigIfNeeded must set authentication if not set") { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. All the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How do you suggest to do that? Driver registration and provider instantiation lines are different in each case. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, I see. But, I felt a a bit less testing for creating a separate test file. |
||
val driver = registerDriver(OracleConnectionProvider.driverClass) | ||
val provider = new OracleConnectionProvider(driver, | ||
options("jdbc:oracle:thin:@//localhost/xe")) | ||
|
||
testSecureConnectionProvider(provider) | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The implementation is based on this.