Struct Authenticator 

pub struct Authenticator(/* private fields */);

Signs in to ChatGPT and keeps the stored credential fresh. Clones share the store and the refresh lock.

Implementations

impl Authenticator

pub async fn sign_in<H, F>( &self, http: &H, method: SignInMethod, prompt: F, ) -> Result<AuthContext, AuthError>

where H: HttpClientExt, F: FnMut(SignInPrompt) + WasmCompatSend,

Available on non-target_family=wasm only.

Sign in again by method, whatever is cached, telling prompt what the user must do. A browser sign-in whose callback ports are taken says so and falls back to the device code. The credential is kept in the token store. Native only.

pub async fn sign_in_with_device_code<H>( &self, http: &H, ) -> Result<AuthContext, AuthError>

where H: HttpClientExt,

Available on non-target_family=wasm only.

Sign in again with the device-code flow, whatever is cached: the handler shows the code to enter, and the credential is kept in the token store. Native only.

pub async fn sign_in_with_browser<H, F>( &self, http: &H, prompt: F, ) -> Result<AuthContext, AuthError>

where H: HttpClientExt, F: FnOnce(BrowserSignInPrompt) + WasmCompatSend,

Available on non-target_family=wasm only.

Sign in again in the browser, whatever is cached: an authorization code with PKCE, returned to a one-shot listener on 127.0.0.1 port 1455, or 1457 when that is taken. The default browser is opened on the sign-in page and prompt receives its URL, for the user to open when the browser did not. The credential is kept in the token store. Native only.

When both ports are taken, fails with AuthError::Io of kind std::io::ErrorKind::AddrInUse, before prompting, so the caller can fall back to Self::sign_in_with_device_code. Gives up after 15 minutes. Dropping the future stops the listener within a fraction of a second and frees its port.

pub async fn sign_out<H>(&self, http: &H) -> Result<SignedOut, AuthError>

where H: HttpClientExt,

Available on non-target_family=wasm only.

Sign out: the provider revokes the stored refresh token and access token, then the record is deleted from the store and forgotten here, whether or not the provider confirmed. Native only.

Errors

When the store cannot be read, or the record cannot be deleted. A revocation that failed is not an error: SignedOut::Forgotten says why.

impl Authenticator

pub fn new( source: AuthSource, store: impl TokenStore + 'static, device_code_handler: DeviceCodeHandler, allow_device_flow: bool, ) -> Self

An authenticator over source, keeping an OAuth sign-in in store under PROVIDER_NAME, chatgpt; device_code_handler shows a device code when the device flow is allowed.

pub fn forget(&self)

Forget the credential held in memory, so the next request reads the store: after the store’s record is deleted, as a sign-out does.

pub fn with_device_code_handler(self, handler: DeviceCodeHandler) -> Self

This authenticator showing device codes with handler, still sharing its store and refresh lock with the original.

pub async fn auth_context<H>(&self, http: &H) -> Result<AuthContext, AuthError>

where H: HttpClientExt,

Resolve the access token and account id, refreshing through http as needed. Return cache, transport, or authorization errors. OAuth is unsupported on WASM; explicit access tokens remain available.

Trait Implementations

impl Clone for Authenticator

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CredentialSource for Authenticator

fn auth_context( &self, http: &DynHttpClient, ) -> impl Future<Output = Result<AuthContext, AuthError>> + WasmCompatSend

The credential to send with now, refreshed through http when it has expired.

impl Debug for Authenticator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.