History

Pieter Noordhuis ad8183d7a9 Bump Go SDK to v0.12.0 (#540 ) ## Changes * Regenerate CLI commands * Ignore `account-access-control-proxy` (see #505) ## Tests Unit and integration tests pass.		2023-07-03 11:46:45 +02:00
..
README.md	Rename bricks -> databricks (#389 )	2023-05-16 18:35:39 +02:00
auth.go	Rename bricks -> databricks (#389 )	2023-05-16 18:35:39 +02:00
env.go	Rename bricks -> databricks (#389 )	2023-05-16 18:35:39 +02:00
login.go	Bump Go SDK to v0.12.0 (#540 )	2023-07-03 11:46:45 +02:00
profiles.go	Do not use FgWhite and FgBlack for terminal output (#435 )	2023-06-05 17:30:40 +02:00
token.go	Rename bricks -> databricks (#389 )	2023-05-16 18:35:39 +02: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