Class CallbackHandler

Receives one OAuth authorization code on a loopback HTTP server.

The server binds to 127.0.0.1 on an available port. It accepts the code only when the returned state matches the generated state. This class is a low-level part of interactive federation login.

Index

Constructors

Accessors

addr code state

Methods

listenAndServe shutdown waitForCode

Constructors

constructor

new CallbackHandler(logger?: Logger): CallbackHandler
Creates a new callback handler.
Parameters
- Optionallogger: Logger
Returns CallbackHandler
- Defined in src/runtime/token/federation_bearer/server.ts:27

Accessors

addr

get addr(): string
Returns the redirect URI after the server starts; throws before then.

Returns string
- Defined in src/runtime/token/federation_bearer/server.ts:44

code

get code(): string | null
Returns the received authorization code.

Returns string | null
- Defined in src/runtime/token/federation_bearer/server.ts:40

state

get state(): string
Returns the OAuth state value.

Returns string
- Defined in src/runtime/token/federation_bearer/server.ts:36

Methods

listenAndServe

listenAndServe(): Promise<void>
Starts the local callback server. Call waitForCode to await the request.

Returns Promise<void>
- Defined in src/runtime/token/federation_bearer/server.ts:50

shutdown

shutdown(): Promise<void>
Stops the local callback server.

Returns Promise<void>
- Defined in src/runtime/token/federation_bearer/server.ts:124

waitForCode

waitForCode(timeoutMs: number | undefined): Promise<string | null>
Waits for a valid code and rejects when the optional timeout expires.
Parameters
- timeoutMs: number | undefined
Returns Promise<string | null>
- Defined in src/runtime/token/federation_bearer/server.ts:134