solid_auth_client library

Solid client management.

Copyright (C) 2025, Software Innovation Institute, ANU.

Licensed under the MIT License (the "License").

License: https://choosealicense.com/licenses/mit/.

Authors: Anushka Vidanage

Properties

authManager ↔ AuthManager
Initialise authentication manager
getter/setter pair
currPlatform PlatformInfo
To get platform information
getter/setter pair

Functions

authenticate(Uri issuerUri, List<String> scopes, BuildContext context) Future<Map>
The authentication function
cancelAuthenticate() Future<void>
Aborts any in-flight desktop authenticate call. The awaited future throws an AuthCancelledException, the local OAuth callback HTTP server is closed when no other flow needs it, and the cached authenticator reference is cleared.
clientDynamicReg(String regEndpoint, List reidirUrlList, String authMethod, List scopes) Future<String>
Dynamically register the user in the POD server
genDpopToken(String endPointUrl, KeyPair rsaKeyPair, dynamic publicKeyJwk, String httpMethod) String
Generate dPoP token for the authentication
genRsaKeyPair() Future<Map>
Generate RSA key pair for the authentication
isAuthenticatePending() bool
Returns true while a desktop authenticate call is awaiting the OAuth browser redirect. Useful for UI code that wants to gate retry buttons while a previous attempt is still pending.
logout(dynamic logoutUrl) Future<bool>

Exceptions / Errors

AuthCancelledException
Thrown by authenticate when the in-flight OAuth flow is aborted via cancelAuthenticate. Lets callers distinguish a deliberate user (or programmatic) cancellation from a genuine network/server failure so they can suppress error UI accordingly.