0xerwin1/dbflux/dbflux-rpc-auth-provider

When to Use

• The auth provider should live outside the DBFlux binary.
• The user mentions auth-provider RPC, external credential service, SSO plugin, or Settings → RPC Services.
• The provider should be registered with RpcServiceKind::AuthProvider.

Source of Truth

• docs/DRIVER_RPC_PROTOCOL.md
• crates/dbflux_ipc/src/auth_provider_protocol.rs
• crates/dbflux_ipc/src/auth_provider_client.rs
• crates/dbflux_app/src/rpc_services.rs
• examples/custom_auth_provider/

Critical Patterns

• Start from examples/custom_auth_provider/ unless the user already has service code.
• Auth-provider services never register as database drivers.
• Managed auth-provider services require an explicit command; DBFlux does not assume dbflux-driver-host.
• DBFlux probes compatible services on startup, so restart DBFlux after changing RPC service settings.
• If DBFlux launches the provider, it injects the auth-provider handshake token through the environment.

Protocol Checklist

1. Bind the local socket using DBFlux IPC conventions.
2. Handle Hello and negotiate the highest compatible protocol version.
3. Return provider_id, display_name, form_definition, and version-specific capabilities from Hello.
4. Implement ValidateSession.
5. Implement Login; emit zero or one LoginUrlProgress before terminal LoginResult.
6. Implement ResolveCredentials.
7. Return secret credential values as secret fields in the response type.
8. Return UnsupportedMethod for unsupported requests.
9. Use structured protocol errors such as InvalidRequest, VersionMismatch, Provider, or Internal.

Launch Facts

• Use RpcServiceKind::AuthProvider in the persisted service descriptor.
• Empty command and empty args: DBFlux expects an already-running provider service.
• Explicit command: DBFlux starts and owns the provider process.
• Empty command with non-empty args is invalid for auth providers.

Commands

cargo build
RUST_LOG=info cargo run -- --socket <socket-id>
python3 scripts/lint.py fmt --check