at_auth library
The AtAuth package contains common logic for onboarding/authenticating an atSign to a secondary server
Classes
- AtAuth
- Interface for onboarding and authentication to a secondary server of an atsign
- AtAuthRequest
- AtAuthResponse
- AtEnrollment
- An abstract class for submitting and managing the enrollment requests.
- AtEnrollmentRequest
- The EnrollmentRequest is used by the apps to submit enrollment request for APKAM keys which provides .atKeys specific to an application with restricted access to the namespaces. The application can access only the namespaces which are specified in the enrollment request. If the namespace has Read-Write access then the application is allowed to create/update the data, otherwise, if the namespace has only Read access then the application is allowed to read the data, but cannot create/update the data.
- AtEnrollmentResponse
- Represents the response of an enrollment operation received from the secondary server.
- AtKeys
- AtKeysIo
- An interface that defines methods for reading AtKeys. It can be implemented by classes that read AtKeys from different sources,
- AtOnboardingRequest
- AtOnboardingResponse
- Represents an onboarding response of an atSign.
- AuthRequest
- AuthResponse
- EnrollmentRequest
- The BaseEnrollmentRequest class encapsulates shared fields between the InitialEnrollmentRequest and EnrollmentRequest.
- EnrollmentRequestDecision
- This class serves as the entity responsible for either approving or denying an enrollment request. The enrollment request is received through a notification from the server. The approving app has the authority to either grant or deny the request, with approval resulting in authentication and authorization to the requested namespaces.
- EnrollmentServerResponse
- The class holds details regarding an enrollment request, where the server notifies the approving app upon receiving a request from the requesting app, seeking approval or denial.
- FileAtKeysIo
- An implementation of AtKeysIo that reads and writes AtKeys to the file system. This implementation uses a mixin KeyIOMixin to provide common functionality for encoding and decoding AtKeys. The FileAtKeysIo class can be configured with an optional filePath and passPhrase.
- FirstEnrollmentRequest
- The FirstEnrollmentRequest represents an enrollment request when onboarding (activating) an atSign.
- GeneratedAtKeysIo
- An interface that defines methods for AtKeys that can be generated. It can be implemented by classes that generate AtKeys using different methods, such as secure element.
- RegistrarService
- RetryOptions
- WrittenAtKeysIo
- An interface that defines methods for AtKeys that can be written. It can be implemented by classes that write AtKeys to different sources, such as file system or keychain.
Mixins
- KeyIOMixin
- A mixin that provides common functionality for encoding and decoding AtKeys.
Constants
- apiBase → const String
- apkamEnrollmentId → const String
- apkamPrivateKey → const String
- apkamPublicKey → const String
- apkamSymmetricKey → const String
- defaultEncryptionPrivateKey → const String
- defaultEncryptionPublicKey → const String
- defaultSelfEncryptionKey → const String
-
keySchemaList
→ const List<
String>
Functions
-
getDefaultAtKeysFilePath(
String homeDirectory, String atSign) → String -
getHomeDirectory(
{bool throwIfNull = false}) → String?