mirror of
https://github.com/lancedb/lancedb.git
synced 2026-06-28 08:30:39 +00:00
Compare commits
2 Commits
jack/pytho
...
jack/node-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d96c90c5b9 | ||
|
|
c1a8702c65 |
29
docs/src/js/enumerations/OAuthFlowType.md
Normal file
29
docs/src/js/enumerations/OAuthFlowType.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
[**@lancedb/lancedb**](../README.md) • **Docs**
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
[@lancedb/lancedb](../globals.md) / OAuthFlowType
|
||||||
|
|
||||||
|
# Enumeration: OAuthFlowType
|
||||||
|
|
||||||
|
OAuth authentication flow types.
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### AzureManagedIdentity
|
||||||
|
|
||||||
|
```ts
|
||||||
|
AzureManagedIdentity: "azure_managed_identity";
|
||||||
|
```
|
||||||
|
|
||||||
|
Azure Managed Identity via IMDS.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### ClientCredentials
|
||||||
|
|
||||||
|
```ts
|
||||||
|
ClientCredentials: "client_credentials";
|
||||||
|
```
|
||||||
|
|
||||||
|
Client Credentials grant (service-to-service / M2M).
|
||||||
@@ -12,6 +12,7 @@
|
|||||||
## Enumerations
|
## Enumerations
|
||||||
|
|
||||||
- [FullTextQueryType](enumerations/FullTextQueryType.md)
|
- [FullTextQueryType](enumerations/FullTextQueryType.md)
|
||||||
|
- [OAuthFlowType](enumerations/OAuthFlowType.md)
|
||||||
- [Occur](enumerations/Occur.md)
|
- [Occur](enumerations/Occur.md)
|
||||||
- [Operator](enumerations/Operator.md)
|
- [Operator](enumerations/Operator.md)
|
||||||
|
|
||||||
@@ -85,6 +86,8 @@
|
|||||||
- [ListNamespacesResponse](interfaces/ListNamespacesResponse.md)
|
- [ListNamespacesResponse](interfaces/ListNamespacesResponse.md)
|
||||||
- [LsmWriteSpec](interfaces/LsmWriteSpec.md)
|
- [LsmWriteSpec](interfaces/LsmWriteSpec.md)
|
||||||
- [MergeResult](interfaces/MergeResult.md)
|
- [MergeResult](interfaces/MergeResult.md)
|
||||||
|
- [NativeOAuthConfig](interfaces/NativeOAuthConfig.md)
|
||||||
|
- [OAuthConfig](interfaces/OAuthConfig.md)
|
||||||
- [OpenTableOptions](interfaces/OpenTableOptions.md)
|
- [OpenTableOptions](interfaces/OpenTableOptions.md)
|
||||||
- [OptimizeOptions](interfaces/OptimizeOptions.md)
|
- [OptimizeOptions](interfaces/OptimizeOptions.md)
|
||||||
- [OptimizeStats](interfaces/OptimizeStats.md)
|
- [OptimizeStats](interfaces/OptimizeStats.md)
|
||||||
|
|||||||
@@ -64,6 +64,19 @@ client used by manifest-enabled native connections.
|
|||||||
|
|
||||||
***
|
***
|
||||||
|
|
||||||
|
### oauthConfig?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional oauthConfig: NativeOAuthConfig;
|
||||||
|
```
|
||||||
|
|
||||||
|
(For LanceDB cloud only): OAuth configuration for IdP-based
|
||||||
|
authentication (e.g., Azure Entra ID). When set, token acquisition
|
||||||
|
and refresh are handled entirely in Rust. TypeScript users should pass
|
||||||
|
the public `OAuthConfig` type exported from `@lancedb/lancedb`.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
### readConsistencyInterval?
|
### readConsistencyInterval?
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
|||||||
88
docs/src/js/interfaces/NativeOAuthConfig.md
Normal file
88
docs/src/js/interfaces/NativeOAuthConfig.md
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
[**@lancedb/lancedb**](../README.md) • **Docs**
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
[@lancedb/lancedb](../globals.md) / NativeOAuthConfig
|
||||||
|
|
||||||
|
# Interface: NativeOAuthConfig
|
||||||
|
|
||||||
|
OAuth configuration for LanceDB authentication.
|
||||||
|
|
||||||
|
This is the generated napi-rs binding shape. TypeScript users should prefer
|
||||||
|
the public `OAuthConfig` type exported from `@lancedb/lancedb`.
|
||||||
|
|
||||||
|
All token acquisition and refresh is handled in the Rust layer.
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### clientId
|
||||||
|
|
||||||
|
```ts
|
||||||
|
clientId: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
Application / Client ID.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### clientSecret?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional clientSecret: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
Client secret (required for client_credentials).
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### flow?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional flow: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
Authentication flow: "client_credentials" or "azure_managed_identity"
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### issuerUrl
|
||||||
|
|
||||||
|
```ts
|
||||||
|
issuerUrl: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
OIDC issuer URL or OAuth authority URL.
|
||||||
|
For Azure: `https://login.microsoftonline.com/{tenant_id}/v2.0`
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### managedIdentityClientId?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional managedIdentityClientId: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
Client ID for user-assigned managed identity (azure_managed_identity).
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### refreshBufferSecs?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional refreshBufferSecs: number;
|
||||||
|
```
|
||||||
|
|
||||||
|
Seconds before expiry to trigger proactive refresh (default: 300).
|
||||||
|
Keep this well below the token TTL; if it is greater than or equal to
|
||||||
|
the TTL, each request refreshes the token.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### scopes
|
||||||
|
|
||||||
|
```ts
|
||||||
|
scopes: string[];
|
||||||
|
```
|
||||||
|
|
||||||
|
OAuth scopes to request. For Azure managed identity, exactly one scope
|
||||||
|
or resource is required. For example: `["api://{app_id}/.default"]`
|
||||||
111
docs/src/js/interfaces/OAuthConfig.md
Normal file
111
docs/src/js/interfaces/OAuthConfig.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
[**@lancedb/lancedb**](../README.md) • **Docs**
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
[@lancedb/lancedb](../globals.md) / OAuthConfig
|
||||||
|
|
||||||
|
# Interface: OAuthConfig
|
||||||
|
|
||||||
|
OAuth configuration for LanceDB authentication.
|
||||||
|
|
||||||
|
This is the public TypeScript OAuth configuration type. The generated
|
||||||
|
`NativeOAuthConfig` type has the same runtime shape but is an implementation
|
||||||
|
detail of the napi-rs binding.
|
||||||
|
|
||||||
|
All token acquisition and refresh is handled in the Rust layer.
|
||||||
|
This config is passed through to Rust via napi-rs.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const config: OAuthConfig = {
|
||||||
|
issuerUrl: "https://login.microsoftonline.com/{tenant}/v2.0",
|
||||||
|
clientId: "app-id",
|
||||||
|
clientSecret: "secret",
|
||||||
|
scopes: ["api://lancedb-api/.default"],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const config: OAuthConfig = {
|
||||||
|
issuerUrl: "https://login.microsoftonline.com/{tenant}/v2.0",
|
||||||
|
clientId: "app-id",
|
||||||
|
scopes: ["api://lancedb-api/.default"],
|
||||||
|
flow: OAuthFlowType.AzureManagedIdentity,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### clientId
|
||||||
|
|
||||||
|
```ts
|
||||||
|
clientId: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
Application / Client ID.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### clientSecret?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional clientSecret: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
Client secret (required for ClientCredentials).
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### flow?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional flow: OAuthFlowType;
|
||||||
|
```
|
||||||
|
|
||||||
|
Authentication flow (default: ClientCredentials).
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### issuerUrl
|
||||||
|
|
||||||
|
```ts
|
||||||
|
issuerUrl: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
OIDC issuer URL or OAuth authority URL.
|
||||||
|
For Azure: `https://login.microsoftonline.com/{tenant_id}/v2.0`
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### managedIdentityClientId?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional managedIdentityClientId: string;
|
||||||
|
```
|
||||||
|
|
||||||
|
Client ID for user-assigned managed identity (AzureManagedIdentity).
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### refreshBufferSecs?
|
||||||
|
|
||||||
|
```ts
|
||||||
|
optional refreshBufferSecs: number;
|
||||||
|
```
|
||||||
|
|
||||||
|
Seconds before expiry to trigger proactive refresh (default: 300).
|
||||||
|
Keep this well below the token TTL; if it is greater than or equal to
|
||||||
|
the TTL, each request refreshes the token.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
### scopes
|
||||||
|
|
||||||
|
```ts
|
||||||
|
scopes: string[];
|
||||||
|
```
|
||||||
|
|
||||||
|
OAuth scopes to request.
|
||||||
|
For Azure managed identity, exactly one scope or resource is required.
|
||||||
|
For example: `["api://{app_id}/.default"]`
|
||||||
@@ -52,6 +52,7 @@ export {
|
|||||||
SplitHashOptions,
|
SplitHashOptions,
|
||||||
SplitSequentialOptions,
|
SplitSequentialOptions,
|
||||||
ShuffleOptions,
|
ShuffleOptions,
|
||||||
|
OAuthConfig as NativeOAuthConfig,
|
||||||
} from "./native.js";
|
} from "./native.js";
|
||||||
|
|
||||||
export {
|
export {
|
||||||
@@ -130,6 +131,8 @@ export {
|
|||||||
TokenResponse,
|
TokenResponse,
|
||||||
} from "./header";
|
} from "./header";
|
||||||
|
|
||||||
|
export { OAuthConfig, OAuthFlowType } from "./oauth";
|
||||||
|
|
||||||
export { MergeInsertBuilder, WriteExecutionOptions } from "./merge";
|
export { MergeInsertBuilder, WriteExecutionOptions } from "./merge";
|
||||||
|
|
||||||
export * as embedding from "./embedding";
|
export * as embedding from "./embedding";
|
||||||
|
|||||||
76
nodejs/lancedb/oauth.ts
Normal file
76
nodejs/lancedb/oauth.ts
Normal file
@@ -0,0 +1,76 @@
|
|||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
||||||
|
|
||||||
|
/**
|
||||||
|
* OAuth authentication flow types.
|
||||||
|
*/
|
||||||
|
export enum OAuthFlowType {
|
||||||
|
/** Client Credentials grant (service-to-service / M2M). */
|
||||||
|
ClientCredentials = "client_credentials",
|
||||||
|
/** Azure Managed Identity via IMDS. */
|
||||||
|
AzureManagedIdentity = "azure_managed_identity",
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* OAuth configuration for LanceDB authentication.
|
||||||
|
*
|
||||||
|
* This is the public TypeScript OAuth configuration type. The generated
|
||||||
|
* `NativeOAuthConfig` type has the same runtime shape but is an implementation
|
||||||
|
* detail of the napi-rs binding.
|
||||||
|
*
|
||||||
|
* All token acquisition and refresh is handled in the Rust layer.
|
||||||
|
* This config is passed through to Rust via napi-rs.
|
||||||
|
*
|
||||||
|
* @example Client Credentials (service-to-service):
|
||||||
|
* ```typescript
|
||||||
|
* const config: OAuthConfig = {
|
||||||
|
* issuerUrl: "https://login.microsoftonline.com/{tenant}/v2.0",
|
||||||
|
* clientId: "app-id",
|
||||||
|
* clientSecret: "secret",
|
||||||
|
* scopes: ["api://lancedb-api/.default"],
|
||||||
|
* };
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @example Azure Managed Identity:
|
||||||
|
* ```typescript
|
||||||
|
* const config: OAuthConfig = {
|
||||||
|
* issuerUrl: "https://login.microsoftonline.com/{tenant}/v2.0",
|
||||||
|
* clientId: "app-id",
|
||||||
|
* scopes: ["api://lancedb-api/.default"],
|
||||||
|
* flow: OAuthFlowType.AzureManagedIdentity,
|
||||||
|
* };
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export interface OAuthConfig {
|
||||||
|
/**
|
||||||
|
* OIDC issuer URL or OAuth authority URL.
|
||||||
|
* For Azure: `https://login.microsoftonline.com/{tenant_id}/v2.0`
|
||||||
|
*/
|
||||||
|
issuerUrl: string;
|
||||||
|
|
||||||
|
/** Application / Client ID. */
|
||||||
|
clientId: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* OAuth scopes to request.
|
||||||
|
* For Azure managed identity, exactly one scope or resource is required.
|
||||||
|
* For example: `["api://{app_id}/.default"]`
|
||||||
|
*/
|
||||||
|
scopes: string[];
|
||||||
|
|
||||||
|
/** Authentication flow (default: ClientCredentials). */
|
||||||
|
flow?: OAuthFlowType;
|
||||||
|
|
||||||
|
/** Client secret (required for ClientCredentials). */
|
||||||
|
clientSecret?: string;
|
||||||
|
|
||||||
|
/** Client ID for user-assigned managed identity (AzureManagedIdentity). */
|
||||||
|
managedIdentityClientId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Seconds before expiry to trigger proactive refresh (default: 300).
|
||||||
|
* Keep this well below the token TTL; if it is greater than or equal to
|
||||||
|
* the TTL, each request refreshes the token.
|
||||||
|
*/
|
||||||
|
refreshBufferSecs?: number;
|
||||||
|
}
|
||||||
@@ -112,6 +112,12 @@ impl Connection {
|
|||||||
|
|
||||||
builder = builder.client_config(rust_config);
|
builder = builder.client_config(rust_config);
|
||||||
|
|
||||||
|
if let Some(oauth_config) = options.oauth_config {
|
||||||
|
let config: lancedb::remote::oauth::OAuthConfig =
|
||||||
|
oauth_config.try_into().default_error()?;
|
||||||
|
builder = builder.oauth_config(config);
|
||||||
|
}
|
||||||
|
|
||||||
if let Some(api_key) = options.api_key {
|
if let Some(api_key) = options.api_key {
|
||||||
builder = builder.api_key(&api_key);
|
builder = builder.api_key(&api_key);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -65,6 +65,11 @@ pub struct ConnectionOptions {
|
|||||||
/// (For LanceDB cloud only): the host to use for LanceDB cloud. Used
|
/// (For LanceDB cloud only): the host to use for LanceDB cloud. Used
|
||||||
/// for testing purposes.
|
/// for testing purposes.
|
||||||
pub host_override: Option<String>,
|
pub host_override: Option<String>,
|
||||||
|
/// (For LanceDB cloud only): OAuth configuration for IdP-based
|
||||||
|
/// authentication (e.g., Azure Entra ID). When set, token acquisition
|
||||||
|
/// and refresh are handled entirely in Rust. TypeScript users should pass
|
||||||
|
/// the public `OAuthConfig` type exported from `@lancedb/lancedb`.
|
||||||
|
pub oauth_config: Option<remote::OAuthConfig>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[napi(object)]
|
#[napi(object)]
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
|
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
|
||||||
|
use lancedb::error::Error;
|
||||||
use napi_derive::*;
|
use napi_derive::*;
|
||||||
|
|
||||||
/// Timeout configuration for remote HTTP client.
|
/// Timeout configuration for remote HTTP client.
|
||||||
@@ -140,6 +141,84 @@ impl From<TlsConfig> for lancedb::remote::TlsConfig {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// OAuth configuration for LanceDB authentication.
|
||||||
|
///
|
||||||
|
/// This is the generated napi-rs binding shape. TypeScript users should prefer
|
||||||
|
/// the public `OAuthConfig` type exported from `@lancedb/lancedb`.
|
||||||
|
///
|
||||||
|
/// All token acquisition and refresh is handled in the Rust layer.
|
||||||
|
#[napi(object)]
|
||||||
|
#[derive(Clone)]
|
||||||
|
pub struct OAuthConfig {
|
||||||
|
/// OIDC issuer URL or OAuth authority URL.
|
||||||
|
/// For Azure: `https://login.microsoftonline.com/{tenant_id}/v2.0`
|
||||||
|
pub issuer_url: String,
|
||||||
|
/// Application / Client ID.
|
||||||
|
pub client_id: String,
|
||||||
|
/// OAuth scopes to request. For Azure managed identity, exactly one scope
|
||||||
|
/// or resource is required. For example: `["api://{app_id}/.default"]`
|
||||||
|
pub scopes: Vec<String>,
|
||||||
|
/// Authentication flow: "client_credentials" or "azure_managed_identity"
|
||||||
|
pub flow: Option<String>,
|
||||||
|
/// Client secret (required for client_credentials).
|
||||||
|
pub client_secret: Option<String>,
|
||||||
|
/// Client ID for user-assigned managed identity (azure_managed_identity).
|
||||||
|
pub managed_identity_client_id: Option<String>,
|
||||||
|
/// Seconds before expiry to trigger proactive refresh (default: 300).
|
||||||
|
/// Keep this well below the token TTL; if it is greater than or equal to
|
||||||
|
/// the TTL, each request refreshes the token.
|
||||||
|
pub refresh_buffer_secs: Option<u32>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl std::fmt::Debug for OAuthConfig {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
f.debug_struct("OAuthConfig")
|
||||||
|
.field("issuer_url", &self.issuer_url)
|
||||||
|
.field("client_id", &self.client_id)
|
||||||
|
.field("scopes", &self.scopes)
|
||||||
|
.field("flow", &self.flow)
|
||||||
|
.field(
|
||||||
|
"client_secret",
|
||||||
|
&self.client_secret.as_deref().map(|_| "<redacted>"),
|
||||||
|
)
|
||||||
|
.field(
|
||||||
|
"managed_identity_client_id",
|
||||||
|
&self.managed_identity_client_id,
|
||||||
|
)
|
||||||
|
.field("refresh_buffer_secs", &self.refresh_buffer_secs)
|
||||||
|
.finish()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<OAuthConfig> for lancedb::remote::oauth::OAuthConfig {
|
||||||
|
type Error = Error;
|
||||||
|
|
||||||
|
fn try_from(config: OAuthConfig) -> Result<Self, Self::Error> {
|
||||||
|
use lancedb::remote::oauth::OAuthFlow;
|
||||||
|
|
||||||
|
let flow = match config.flow.as_deref().unwrap_or("client_credentials") {
|
||||||
|
"client_credentials" => OAuthFlow::ClientCredentials,
|
||||||
|
"azure_managed_identity" => OAuthFlow::AzureManagedIdentity {
|
||||||
|
client_id: config.managed_identity_client_id,
|
||||||
|
},
|
||||||
|
other => {
|
||||||
|
return Err(Error::InvalidInput {
|
||||||
|
message: format!("Unknown OAuth flow type: {other}"),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
issuer_url: config.issuer_url,
|
||||||
|
client_id: config.client_id,
|
||||||
|
client_secret: config.client_secret,
|
||||||
|
scopes: config.scopes,
|
||||||
|
flow,
|
||||||
|
refresh_buffer_secs: config.refresh_buffer_secs.map(|v| v as u64),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
impl From<ClientConfig> for lancedb::remote::ClientConfig {
|
impl From<ClientConfig> for lancedb::remote::ClientConfig {
|
||||||
fn from(config: ClientConfig) -> Self {
|
fn from(config: ClientConfig) -> Self {
|
||||||
Self {
|
Self {
|
||||||
@@ -156,3 +235,45 @@ impl From<ClientConfig> for lancedb::remote::ClientConfig {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_unknown_oauth_flow_returns_invalid_input() {
|
||||||
|
let config = OAuthConfig {
|
||||||
|
issuer_url: "https://issuer.example.com".to_string(),
|
||||||
|
client_id: "client-id".to_string(),
|
||||||
|
scopes: vec!["scope".to_string()],
|
||||||
|
flow: Some("typo".to_string()),
|
||||||
|
client_secret: None,
|
||||||
|
managed_identity_client_id: None,
|
||||||
|
refresh_buffer_secs: None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let err = lancedb::remote::oauth::OAuthConfig::try_from(config).unwrap_err();
|
||||||
|
assert!(matches!(
|
||||||
|
err,
|
||||||
|
Error::InvalidInput { message }
|
||||||
|
if message == "Unknown OAuth flow type: typo"
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_oauth_config_debug_redacts_client_secret() {
|
||||||
|
let config = OAuthConfig {
|
||||||
|
issuer_url: "https://issuer.example.com".to_string(),
|
||||||
|
client_id: "client-id".to_string(),
|
||||||
|
scopes: vec!["scope".to_string()],
|
||||||
|
flow: Some("client_credentials".to_string()),
|
||||||
|
client_secret: Some("super-secret".to_string()),
|
||||||
|
managed_identity_client_id: None,
|
||||||
|
refresh_buffer_secs: None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let debug = format!("{config:?}");
|
||||||
|
assert!(!debug.contains("super-secret"));
|
||||||
|
assert!(debug.contains("client_secret: Some(\"<redacted>\")"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -89,8 +89,6 @@ def connect(
|
|||||||
If presented, connect to LanceDB cloud.
|
If presented, connect to LanceDB cloud.
|
||||||
Otherwise, connect to a database on file system or cloud storage.
|
Otherwise, connect to a database on file system or cloud storage.
|
||||||
Can be set via environment variable `LANCEDB_API_KEY`.
|
Can be set via environment variable `LANCEDB_API_KEY`.
|
||||||
OAuth configuration is currently supported only by ``connect_async``;
|
|
||||||
synchronous LanceDB Cloud connections require an API key.
|
|
||||||
region: str, default "us-east-1"
|
region: str, default "us-east-1"
|
||||||
The region to use for LanceDB Cloud.
|
The region to use for LanceDB Cloud.
|
||||||
host_override: str, optional
|
host_override: str, optional
|
||||||
@@ -342,7 +340,6 @@ async def connect_async(
|
|||||||
session: Optional[Session] = None,
|
session: Optional[Session] = None,
|
||||||
manifest_enabled: bool = False,
|
manifest_enabled: bool = False,
|
||||||
namespace_client_properties: Optional[Dict[str, str]] = None,
|
namespace_client_properties: Optional[Dict[str, str]] = None,
|
||||||
oauth_config=None,
|
|
||||||
) -> AsyncConnection:
|
) -> AsyncConnection:
|
||||||
"""Connect to a LanceDB database.
|
"""Connect to a LanceDB database.
|
||||||
|
|
||||||
@@ -392,10 +389,6 @@ async def connect_async(
|
|||||||
namespace_client_properties : dict, optional
|
namespace_client_properties : dict, optional
|
||||||
Additional directory namespace client properties to use with
|
Additional directory namespace client properties to use with
|
||||||
``manifest_enabled=True``.
|
``manifest_enabled=True``.
|
||||||
oauth_config : OAuthConfig, optional
|
|
||||||
OAuth configuration for LanceDB Cloud/Enterprise. This is supported by
|
|
||||||
``connect_async`` only; synchronous ``connect`` uses API key
|
|
||||||
authentication for ``db://`` URIs.
|
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
@@ -442,7 +435,6 @@ async def connect_async(
|
|||||||
session,
|
session,
|
||||||
manifest_enabled,
|
manifest_enabled,
|
||||||
namespace_client_properties,
|
namespace_client_properties,
|
||||||
oauth_config,
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -280,7 +280,6 @@ async def connect(
|
|||||||
session: Optional[Session],
|
session: Optional[Session],
|
||||||
manifest_enabled: bool = False,
|
manifest_enabled: bool = False,
|
||||||
namespace_client_properties: Optional[Dict[str, str]] = None,
|
namespace_client_properties: Optional[Dict[str, str]] = None,
|
||||||
oauth_config: Optional[Any] = None,
|
|
||||||
) -> Connection: ...
|
) -> Connection: ...
|
||||||
|
|
||||||
class RecordBatchStream:
|
class RecordBatchStream:
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ from typing import List, Optional
|
|||||||
from lancedb import __version__
|
from lancedb import __version__
|
||||||
|
|
||||||
from .header import HeaderProvider
|
from .header import HeaderProvider
|
||||||
from .oauth import OAuthConfig, OAuthFlowType
|
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"TimeoutConfig",
|
"TimeoutConfig",
|
||||||
@@ -17,8 +16,6 @@ __all__ = [
|
|||||||
"TlsConfig",
|
"TlsConfig",
|
||||||
"ClientConfig",
|
"ClientConfig",
|
||||||
"HeaderProvider",
|
"HeaderProvider",
|
||||||
"OAuthConfig",
|
|
||||||
"OAuthFlowType",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,75 +0,0 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
|
||||||
# SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
|
||||||
|
|
||||||
from dataclasses import dataclass, field
|
|
||||||
from enum import Enum
|
|
||||||
from typing import List, Optional
|
|
||||||
|
|
||||||
|
|
||||||
class OAuthFlowType(str, Enum):
|
|
||||||
"""OAuth authentication flow types."""
|
|
||||||
|
|
||||||
CLIENT_CREDENTIALS = "client_credentials"
|
|
||||||
"""Client Credentials grant (service-to-service / M2M)."""
|
|
||||||
|
|
||||||
AZURE_MANAGED_IDENTITY = "azure_managed_identity"
|
|
||||||
"""Azure Managed Identity via IMDS."""
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class OAuthConfig:
|
|
||||||
"""OAuth configuration for LanceDB authentication.
|
|
||||||
|
|
||||||
All token acquisition and refresh is handled in the Rust layer.
|
|
||||||
This config is passed through to Rust via PyO3.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
issuer_url : str
|
|
||||||
OIDC issuer URL or OAuth authority URL.
|
|
||||||
For Azure: ``https://login.microsoftonline.com/{tenant_id}/v2.0``
|
|
||||||
client_id : str
|
|
||||||
Application / Client ID.
|
|
||||||
scopes : List[str]
|
|
||||||
OAuth scopes to request.
|
|
||||||
For Azure managed identity, exactly one scope or resource is required.
|
|
||||||
For example: ``["api://{app_id}/.default"]``
|
|
||||||
flow : OAuthFlowType
|
|
||||||
Authentication flow to use. Default: CLIENT_CREDENTIALS.
|
|
||||||
client_secret : Optional[str]
|
|
||||||
Client secret (required for CLIENT_CREDENTIALS).
|
|
||||||
managed_identity_client_id : Optional[str]
|
|
||||||
Client ID for user-assigned managed identity (AZURE_MANAGED_IDENTITY).
|
|
||||||
refresh_buffer_secs : Optional[int]
|
|
||||||
Seconds before expiry to trigger proactive refresh (default: 300).
|
|
||||||
Keep this well below the token TTL; if it is greater than or equal to
|
|
||||||
the TTL, each request refreshes the token.
|
|
||||||
|
|
||||||
Examples
|
|
||||||
--------
|
|
||||||
Client Credentials (service-to-service):
|
|
||||||
|
|
||||||
>>> config = OAuthConfig(
|
|
||||||
... issuer_url="https://login.microsoftonline.com/{tenant}/v2.0",
|
|
||||||
... client_id="app-id",
|
|
||||||
... client_secret="secret",
|
|
||||||
... scopes=["api://lancedb-api/.default"],
|
|
||||||
... )
|
|
||||||
|
|
||||||
Azure Managed Identity:
|
|
||||||
|
|
||||||
>>> config = OAuthConfig(
|
|
||||||
... issuer_url="https://login.microsoftonline.com/{tenant}/v2.0",
|
|
||||||
... client_id="app-id",
|
|
||||||
... scopes=["api://lancedb-api/.default"],
|
|
||||||
... flow=OAuthFlowType.AZURE_MANAGED_IDENTITY,
|
|
||||||
... )
|
|
||||||
"""
|
|
||||||
|
|
||||||
issuer_url: str
|
|
||||||
client_id: str
|
|
||||||
scopes: List[str]
|
|
||||||
flow: OAuthFlowType = OAuthFlowType.CLIENT_CREDENTIALS
|
|
||||||
client_secret: Optional[str] = field(default=None, repr=False)
|
|
||||||
managed_identity_client_id: Optional[str] = None
|
|
||||||
refresh_buffer_secs: Optional[int] = None
|
|
||||||
@@ -539,7 +539,7 @@ impl Connection {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[pyfunction]
|
#[pyfunction]
|
||||||
#[pyo3(signature = (uri, api_key=None, region=None, host_override=None, read_consistency_interval=None, client_config=None, storage_options=None, session=None, manifest_enabled=false, namespace_client_properties=None, oauth_config=None))]
|
#[pyo3(signature = (uri, api_key=None, region=None, host_override=None, read_consistency_interval=None, client_config=None, storage_options=None, session=None, manifest_enabled=false, namespace_client_properties=None))]
|
||||||
#[allow(clippy::too_many_arguments)]
|
#[allow(clippy::too_many_arguments)]
|
||||||
pub fn connect(
|
pub fn connect(
|
||||||
py: Python<'_>,
|
py: Python<'_>,
|
||||||
@@ -553,7 +553,6 @@ pub fn connect(
|
|||||||
session: Option<crate::session::Session>,
|
session: Option<crate::session::Session>,
|
||||||
manifest_enabled: bool,
|
manifest_enabled: bool,
|
||||||
namespace_client_properties: Option<HashMap<String, String>>,
|
namespace_client_properties: Option<HashMap<String, String>>,
|
||||||
oauth_config: Option<crate::oauth::PyOAuthConfig>,
|
|
||||||
) -> PyResult<Bound<'_, PyAny>> {
|
) -> PyResult<Bound<'_, PyAny>> {
|
||||||
future_into_py(py, async move {
|
future_into_py(py, async move {
|
||||||
let mut builder = lancedb::connect(&uri);
|
let mut builder = lancedb::connect(&uri);
|
||||||
@@ -583,11 +582,6 @@ pub fn connect(
|
|||||||
if let Some(client_config) = client_config {
|
if let Some(client_config) = client_config {
|
||||||
builder = builder.client_config(client_config.into());
|
builder = builder.client_config(client_config.into());
|
||||||
}
|
}
|
||||||
if let Some(oauth_config) = oauth_config {
|
|
||||||
let config: lancedb::remote::oauth::OAuthConfig =
|
|
||||||
oauth_config.try_into().infer_error()?;
|
|
||||||
builder = builder.oauth_config(config);
|
|
||||||
}
|
|
||||||
if let Some(session) = session {
|
if let Some(session) = session {
|
||||||
builder = builder.session(session.inner.clone());
|
builder = builder.session(session.inner.clone());
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,7 +26,6 @@ pub mod expr;
|
|||||||
pub mod header;
|
pub mod header;
|
||||||
pub mod index;
|
pub mod index;
|
||||||
pub mod namespace;
|
pub mod namespace;
|
||||||
pub mod oauth;
|
|
||||||
pub mod permutation;
|
pub mod permutation;
|
||||||
pub mod query;
|
pub mod query;
|
||||||
pub mod runtime;
|
pub mod runtime;
|
||||||
|
|||||||
@@ -1,72 +0,0 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
// SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
|
||||||
|
|
||||||
use pyo3::FromPyObject;
|
|
||||||
|
|
||||||
use lancedb::error::Error;
|
|
||||||
use lancedb::remote::oauth::{OAuthConfig, OAuthFlow};
|
|
||||||
|
|
||||||
/// Python-side OAuth configuration, extracted via FromPyObject.
|
|
||||||
/// Maps to `lancedb.remote.oauth.OAuthConfig` Python dataclass.
|
|
||||||
#[derive(FromPyObject)]
|
|
||||||
pub struct PyOAuthConfig {
|
|
||||||
pub issuer_url: String,
|
|
||||||
pub client_id: String,
|
|
||||||
pub scopes: Vec<String>,
|
|
||||||
pub flow: String,
|
|
||||||
pub client_secret: Option<String>,
|
|
||||||
pub managed_identity_client_id: Option<String>,
|
|
||||||
pub refresh_buffer_secs: Option<u64>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TryFrom<PyOAuthConfig> for OAuthConfig {
|
|
||||||
type Error = Error;
|
|
||||||
|
|
||||||
fn try_from(py: PyOAuthConfig) -> Result<Self, Self::Error> {
|
|
||||||
let flow = match py.flow.as_str() {
|
|
||||||
"client_credentials" => OAuthFlow::ClientCredentials,
|
|
||||||
"azure_managed_identity" => OAuthFlow::AzureManagedIdentity {
|
|
||||||
client_id: py.managed_identity_client_id,
|
|
||||||
},
|
|
||||||
other => {
|
|
||||||
return Err(Error::InvalidInput {
|
|
||||||
message: format!("Unknown OAuth flow type: {other}"),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
Ok(Self {
|
|
||||||
issuer_url: py.issuer_url,
|
|
||||||
client_id: py.client_id,
|
|
||||||
client_secret: py.client_secret,
|
|
||||||
scopes: py.scopes,
|
|
||||||
flow,
|
|
||||||
refresh_buffer_secs: py.refresh_buffer_secs,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_unknown_oauth_flow_returns_invalid_input() {
|
|
||||||
let config = PyOAuthConfig {
|
|
||||||
issuer_url: "https://issuer.example.com".to_string(),
|
|
||||||
client_id: "client-id".to_string(),
|
|
||||||
scopes: vec!["scope".to_string()],
|
|
||||||
flow: "typo".to_string(),
|
|
||||||
client_secret: None,
|
|
||||||
managed_identity_client_id: None,
|
|
||||||
refresh_buffer_secs: None,
|
|
||||||
};
|
|
||||||
|
|
||||||
let err = OAuthConfig::try_from(config).unwrap_err();
|
|
||||||
assert!(matches!(
|
|
||||||
err,
|
|
||||||
Error::InvalidInput { message }
|
|
||||||
if message == "Unknown OAuth flow type: typo"
|
|
||||||
));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
# SPDX-License-Identifier: Apache-2.0
|
|
||||||
# SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
|
||||||
|
|
||||||
import importlib.util
|
|
||||||
import sys
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
|
|
||||||
def _load_oauth_module():
|
|
||||||
oauth_path = (
|
|
||||||
Path(__file__).parents[1] / "python" / "lancedb" / "remote" / "oauth.py"
|
|
||||||
)
|
|
||||||
spec = importlib.util.spec_from_file_location("lancedb_remote_oauth", oauth_path)
|
|
||||||
module = importlib.util.module_from_spec(spec)
|
|
||||||
assert spec.loader is not None
|
|
||||||
sys.modules[spec.name] = module
|
|
||||||
spec.loader.exec_module(module)
|
|
||||||
return module
|
|
||||||
|
|
||||||
|
|
||||||
def test_oauth_config_repr_redacts_client_secret():
|
|
||||||
oauth = _load_oauth_module()
|
|
||||||
|
|
||||||
config = oauth.OAuthConfig(
|
|
||||||
issuer_url="https://issuer.example.com",
|
|
||||||
client_id="client-id",
|
|
||||||
scopes=["scope"],
|
|
||||||
client_secret="super-secret",
|
|
||||||
)
|
|
||||||
|
|
||||||
rendered = repr(config)
|
|
||||||
assert "super-secret" not in rendered
|
|
||||||
assert "client_secret" not in rendered
|
|
||||||
Reference in New Issue
Block a user