History

Kartik Gupta 1c02224902 Pass `DATABRICKS_CONFIG_FILE` env var to sdk config during `auth profiles` (#1394 ) ## Changes * Currently, we use `auth profiles` command with `DATABRICKS_CONFIG_FILE` env var set, the file pointed to by the env var is ONLY used for loading the profile names (ini file sections). It is not passed to go sdk config object. We also don't use env variable loader in the go sdk config object, so this env var is ignored by the config and only default file is read. * This PR explicitly sets the config file path in the go sdk config object. ## Tests * integration tests in vscode		2024-04-24 09:18:13 +00:00
..
README.md	Rename bricks -> databricks (#389 )	2023-05-16 18:35:39 +02:00
auth.go	Add better documentation for the `auth login` command (#1366 )	2024-04-18 11:55:42 +00:00
describe.go	Fixed typo in error template for auth describe (#1341 )	2024-04-08 11:19:13 +00:00
describe_test.go	Added `auth describe` command (#1244 )	2024-04-03 08:14:04 +00:00
env.go	Added `env.UserHomeDir(ctx)` for parallel-friendly tests (#955 )	2023-11-08 14:50:20 +00:00
login.go	Add better documentation for the `auth login` command (#1366 )	2024-04-18 11:55:42 +00:00
login_test.go	Tolerate missing .databrickscfg file during `databricks auth login` (#1003 )	2023-11-23 09:04:54 +00:00
profiles.go	Pass `DATABRICKS_CONFIG_FILE` env var to sdk config during `auth profiles` (#1394 )	2024-04-24 09:18:13 +00:00
profiles_test.go	Pass `DATABRICKS_CONFIG_FILE` env var to sdk config during `auth profiles` (#1394 )	2024-04-24 09:18:13 +00:00
token.go	Use profile information when getting a token using the CLI (#855 )	2023-10-11 11:12:18 +00:00

README.md

Auth challenge (happy path)

Simplified description of PKCE implementation:

sequenceDiagram
    autonumber
    actor User

    User ->> CLI: type `databricks auth login HOST`
    CLI ->>+ HOST: request OIDC endpoints
    HOST ->>- CLI: auth & token endpoints
    CLI ->> CLI: start embedded server to consume redirects (lock)
    CLI -->>+ Auth Endpoint: open browser with RND1 + SHA256(RND2)

    User ->>+ Auth Endpoint: Go through SSO
    Auth Endpoint ->>- CLI: AUTH CODE + 'RND1 (redirect)

    CLI ->>+ Token Endpoint: Exchange: AUTH CODE + RND2
    Token Endpoint ->>- CLI: Access Token (JWT) + refresh + expiry
    CLI ->> Token cache: Save Access Token (JWT) + refresh + expiry
    CLI ->> User: success

Token refresh (happy path)

sequenceDiagram
    autonumber
    actor User

    User ->> CLI: type `databricks token HOST`

    CLI ->> CLI: acquire lock (same local addr as redirect server)
    CLI ->>+ Token cache: read token

    critical token not expired
    Token cache ->>- User: JWT (without refresh)

    option token is expired
    CLI ->>+ HOST: request OIDC endpoints
    HOST ->>- CLI: auth & token endpoints
    CLI ->>+ Token Endpoint: refresh token
    Token Endpoint ->>- CLI: JWT (refreshed)
    CLI ->> Token cache: save JWT (refreshed)
    CLI ->> User: JWT (refreshed)

    option no auth for host
    CLI -X User: no auth configured
    end