feat: APKAM Enrollment changes

[sitaram-kalluri]

- What I did

• The PR contains changes related to APKAM feature.

  • at_client :
    • The AtClient package contains changes to expose the enrollment services to the apps such as to fetch the pending enrollments, approve or deny enrollments.
    • Modify SelfKeyEncryption and SelfKeyDecryption to use at_chops instance to fetch the self encryption key key instead of fetching the key from the local secondary.
  • at_client_mobile:
    • Introduce "enroll", "getSentEnrollmentRequest" and "getFinalEnrollmentStatus" methods in "AtAuthService" class to support APKAM feature.
    • Remove exporting of the implementation classes in at_client_mobile.
    • Updated the port number's docker compose to publish the newly added atSign ports from the container to the host.

• AtClientMobile :

  • To submit a new enrollment, use "enroll" method in the AtAuthService.
  • After submitting an enrollment, to view the enrollment and to check the status, introduced "getSentEnrollmentRequest" and "getFinalEnrollmentStatus" method in AtAuthService respectively.
  • Currently, the implementation classes are exported in at_client_mobile.dart file. For example export 'src/auth/at_auth_service_impl.dart' is being exported. To prevent this, introduce a new class AtClientMobile in at_client_mobile_base.dart file . This class contains methods to obtain the instances of implementation classes.

• AtClient:

  • Introduce a new class "EnrollmentService" which exposes methods to fetch the pending enrollment list, approve and deny the enrollments. The "EnrollmentServiceImpl" class implements the "EnrollmentService".
  • The "fetchEnrollmentRequest" forwards the request to server to get the pending enrollment requests. The "PendingEnrollmentRequest" class encapsulates the enrollment details received from the server.
  • The approve and deny requests are forwarded to to at_auth package which fulfills the request.
  • Update the AtClientManager, AtClientSpec, AtClientImpl classes to set the EnrollmentService instance.
  • In the "SelfKeyEncryption" class, use at_chops to fetch the self encryption key instead of fetching from the local secondary stoage.

• Update the existing unit and functional tests to consume the refactoring changes.

- How to verify it

• Tested the changes with the mobile app.

• In AtClientMobile, when an enrollment is approved, to generate atkeys file we use at_file_saver package, with which we are facing issue with latest version. This is worked by @sachins-geekyants in the following PR: https://github.com/atsign-foundation/at_client_sdk/pull/1276

[gkc]

@sitaram-kalluri will review today thank you!

[gkc]

@sitaram-kalluri This PR is not ready for review. Please ping me once you have addressed @murali-shris's requests and the functional tests are passing

[sitaram-kalluri]

@sitaram-kalluri This PR is not ready for review. Please ping me once you have addressed @murali-shris's requests and the functional tests are passing

@gkc: The review comments are addressed and updated with the latest trunk branch code.

Pending work: Once enrollment is approved, securely store the keys in the keychain manager being worked by @sachins-geekyants. Therefore, the PR is still marked as draft..

[gkc]

@sitaram-kalluri Have you tested with other things that use the at_client package e.g. at_talk, the various demos in at_demos, noports, etc?

[gkc]

@sitaram-kalluri This PR is not ready for review. Please ping me once you have addressed @murali-shris's requests and the functional tests are passing

@gkc: The review comments are addressed and updated with the latest trunk branch code.

Pending work: Once enrollment is approved, securely store the keys in the keychain manager being worked by @sachins-geekyants. Therefore, the PR is still marked as draft..

@sitaram-kalluri Since the PR is no longer marked as 'draft', can I presume that the Pending work you mention has been completed?

[sitaram-kalluri]

@gkc : Completed testing with at_talk and no-ports and works fine. Attaching the log

NoPorts Log : no-ports.log at_talk Log :

[gkc]

@sitaram-kalluri Functional tests failing on this test

❌ loading test/enrollment_test.dart (failed)
  Failed to load "test/enrollment_test.dart":
  test/enrollment_test.dart:309:29: Error: Method not found: 'FirstEnrollmentRequest'.
      var enrollmentRequest = FirstEnrollmentRequest(
                              ^^^^^^^^^^^^^^^^^^^^^^

[sitaram-kalluri]

@sitaram-kalluri Functional tests failing on this test

❌ loading test/enrollment_test.dart (failed)
  Failed to load "test/enrollment_test.dart":
  test/enrollment_test.dart:309:29: Error: Method not found: 'FirstEnrollmentRequest'.
      var enrollmentRequest = FirstEnrollmentRequest(
                              ^^^^^^^^^^^^^^^^^^^^^^

@gkc : The root cause of the failure is very clear. The "FirstEnrollmentRequest" class is not exported in the at_auth package. We did not export the class because apps will not use the FirstEnrollmentRequest. Apps will invoke the onboard method, which will internally submit the FirstEnrollmentRequest.

Something that is strange is how did tests pass till now and why the issue occur now? Will debug on this and keep it updated.

[sitaram-kalluri]

@sitaram-kalluri Functional tests failing on this test

❌ loading test/enrollment_test.dart (failed)
  Failed to load "test/enrollment_test.dart":
  test/enrollment_test.dart:309:29: Error: Method not found: 'FirstEnrollmentRequest'.
      var enrollmentRequest = FirstEnrollmentRequest(
                              ^^^^^^^^^^^^^^^^^^^^^^

@gkc : The root cause of the failure is very clear. The "FirstEnrollmentRequest" class is not exported in the at_auth package. We did not export the class because apps will not use the FirstEnrollmentRequest. Apps will invoke the onboard method, which will internally submit the FirstEnrollmentRequest.

Something that is strange is how did tests pass till now and why the issue occur now? Will debug on this and keep it updated.

@gkc : The issue is fixed. The issue occurs because a particular test is modified to use "FirstEnrollmentRequest". Reverted the change and modified the test as it was before.

[gkc]

@sitaram-kalluri Functional tests failing on this test

❌ loading test/enrollment_test.dart (failed)

  Failed to load "test/enrollment_test.dart":

  test/enrollment_test.dart:309:29: Error: Method not found: 'FirstEnrollmentRequest'.

      var enrollmentRequest = FirstEnrollmentRequest(

                              ^^^^^^^^^^^^^^^^^^^^^^

@gkc : The root cause of the failure is very clear. The "FirstEnrollmentRequest" class is not exported in the at_auth package. We did not export the class because apps will not use the FirstEnrollmentRequest. Apps will invoke the onboard method, which will internally submit the FirstEnrollmentRequest.

Something that is strange is how did tests pass till now and why the issue occur now? Will debug on this and keep it updated.

@gkc : The issue is fixed. The issue occurs because a particular test is modified to use "FirstEnrollmentRequest". Reverted the change and modified the test as it was before.

👍 thanks @sitaram-kalluri