at_auth library
The AtAuth package contains common logic for onboarding/authenticating an atSign to a secondary server
Classes
- ApprovedRequestDecisionBuilder
- The class encapsulates the data required for approving an enrollment.
- AtAuth
- Interface for onboarding and authentication to a secondary server of an atsign
- AtAuthKeys
- Holder for different encryption keys that will be stored in .atKeys file. Apkam symmetric key, enrollmentId and defaultSelfEncryptionKey will be stored in unencrypted format in .atKeys file. All other values will be encrypted before saving to .atKeys file.
- AtAuthRequest
- Represents an authentication request of an atSign.
- AtAuthResponse
- Represents and authentication response of an atSign.
- AtEnrollmentBase
- An abstract class for submitting and managing the enrollment requests.
- AtEnrollmentResponse
- Represents the response of an enrollment operation received from the secondary server.
- AtOnboardingRequest
- AtOnboardingResponse
- BaseEnrollmentRequest
- The BaseEnrollmentRequest class encapsulates shared fields between the InitialEnrollmentRequest and EnrollmentRequest.
- EnrollmentRequest
- 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.
- 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.
Constants
- apkamEnrollmentId → const String
- apkamPrivateKey → const String
- apkamPublicKey → const String
- apkamSymmetricKey → const String
- defaultEncryptionPrivateKey → const String
- defaultEncryptionPublicKey → const String
- defaultSelfEncryptionKey → const String
Properties
- atAuthBase → AtAuthInterface
-
Global constant to access
AtAuthInterface.final