feat: apkam-aware activate_cli #576

gkc · 2024-05-07T12:50:09Z

- What I did

feat: 'activate' CLI is now APKAM-aware, and supports
- onboarding (as before)
- submitting enrollment requests
- listing / approving / denying / revoking enrollment requests
- generating one-time passcodes
- setting semi-permanent passcode

- How I did it

New code in src/cli : auth_cli.dart, auth_cli_args.dart
Modified existing bin/activate_cli.dart so it uses auth_cli.main instead of activate_cli.main

- How to verify it

See NoPorts e2e tests (initial PR) which use this CLI extensively
Some examples if you wish to test manually:
- dart bin/activate_cli.dart -h to see overall usage info and list of available commands
- dart bin/activate_cli.dart <some command> -h to see help and usage info for a specific command
- dart bin/activate_cli.dart otp -a @alice to generate an OTP for example
- dart bin/activate_cli.dart interactive -a @alice to run interactively

-Additional context

TODO but will be in follow-up PR as it's not on critical path right now: Add code which allows user to 'resume' an enrollment similar to what has been done in at_client_mobile - basically if the CLI is killed while waiting for its enrollment request to be approved or denied, then allow the exact same command to be re-run, but instead of submitting a new enrollment request it finds the details of the previous one and then goes straight to attempting PKAM auth

…tPreference fields

# Conflicts: # packages/at_onboarding_cli/bin/activate_cli.dart # packages/at_onboarding_cli/pubspec.yaml

…; deprecate the int? pkamRetryIntervalMins parameter

…nagement. Interim commit: mostly structural changes for testability, readability etc

…lint rules to analysis_options.yaml including the unawaited futures rule so we don't have this happen anywhere else.

… go to prod swarms before can be used for prod

…y / revoke in auth_cli

…om pub.dev rather than local path. This is slightly inconvenient but we have a circular dependency now between at_onboarding_cli and at_cli_commons.

gkc · 2024-05-07T13:04:07Z

packages/at_onboarding_cli/lib/src/onboard/at_onboarding_service_impl.dart

-    final Duration retryInterval = Duration(minutes: pkamRetryIntervalMins);
+    retryInterval ??= Duration(
+        minutes: pkamRetryIntervalMins ??
+            atOnboardingPreference.apkamAuthRetryDurationMins);


added retryInterval as a Duration, so calling code has more control

gkc · 2024-05-07T13:04:25Z

packages/at_onboarding_cli/lib/src/onboard/at_onboarding_service_impl.dart

@@ -160,11 +166,11 @@ class AtOnboardingServiceImpl implements AtOnboardingService {
    atLookUpImpl.atChops = AtChopsImpl(atChopsKeys);

    // Pkam auth will be attempted asynchronously until enrollment is approved/denied
-    _attemptPkamAuthAsync(
+    await _attemptPkamAuthAsync(


added missing await

gkc · 2024-05-07T13:06:20Z

packages/at_onboarding_cli/lib/src/onboard/at_onboarding_service_impl.dart

@@ -174,12 +180,13 @@ class AtOnboardingServiceImpl implements AtOnboardingService {
    return enrollmentResponse;
  }

-  void _listenToPkamSuccessStream(
+  Future<void> _listenToPkamSuccessStream (


Made _listenToPkamSuccessStream return a Future which is only completed when we've actually processed the success

gkc · 2024-05-07T13:08:26Z

packages/at_onboarding_cli/lib/src/util/print_full_parser_usage.dart

+
+import 'package:args/args.dart';
+
+extension PrintAllArgParserUsage on ArgParser {


A little extension to help with pretty printing of the auth_cli's ArgParsers' usage when there are subcommands involved

gkc · 2024-05-07T13:10:24Z

packages/at_onboarding_cli/lib/src/cli/auth_cli.dart

+  final first = arguments.first;
+  if (first.startsWith('-') && first != '-h' && first != '--help') {
+    // no command found ... legacy ... insert 'onboard' as the command
+    arguments = ['onboard', ...arguments];


This is the only tricky bit of logic to be aware of, to allow us to most easily provide backwards compatibility

murali-shris · 2024-05-09T10:17:56Z

@gkc

murali@Muralidharans-MacBook-Pro at_onboarding_cli % dart bin/activate_cli.dart enroll -s 5KSNW3  -r vip.ve.atsign.zone -p buzz -d pixel -n “buzz:rw” -a @alice🛠 -k /Users/murali/.atsign/keys/@alice🛠_buzz.atKeys

Can we log the enrollment response from server after running the above command. I had to copy the enrollmentId from the server logs and pass it to the approve command.

murali-shris · 2024-05-09T10:19:00Z

With dart 3.3.4, I am getting this warning every time I run activate_cli

murali@Muralidharans-MacBook-Pro at_onboarding_cli % dart bin/activate_cli.dart enroll -s 5KSNW3  -r vip.ve.atsign.zone -p buzz -d pixel -n “buzz:rw” -a @alice🛠 -k /Users/murali/.atsign/keys/@alice🛠_buzz.atKeys
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/macs/cbc_block_cipher_mac.dart:103:46: Warning: Operand of null-aware operation '!' has type 'Padding' which excludes null.
 - 'Padding' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
    var paddingName = _padding != null ? '/${_padding!.algorithmName}' : '';
                                             ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/macs/cbc_block_cipher_mac.dart:203:7: Warning: Operand of null-aware operation '!' has type 'Padding' which excludes null.
 - 'Padding' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      _padding!.addPadding(_buf, _bufOff);
      ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/signers/ecdsa_signer.dart:94:41: Warning: Operand of null-aware operation '!' has type 'Mac' which excludes null.
 - 'Mac' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      kCalculator = _RFC6979KCalculator(_kMac!, n, _pvkey!.d!, message);
                                        ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/signers/ecdsa_signer.dart:166:7: Warning: Operand of null-aware operation '!' has type 'Digest' which excludes null.
 - 'Digest' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      _digest!.reset();
      ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/signers/ecdsa_signer.dart:167:14: Warning: Operand of null-aware operation '!' has type 'Digest' which excludes null.
 - 'Digest' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      return _digest!.process(message);

gkc · 2024-05-13T14:12:39Z

With dart 3.3.4, I am getting this warning every time I run activate_cli

murali@Muralidharans-MacBook-Pro at_onboarding_cli % dart bin/activate_cli.dart enroll -s 5KSNW3  -r vip.ve.atsign.zone -p buzz -d pixel -n “buzz:rw” -a @alice🛠 -k /Users/murali/.atsign/keys/@alice🛠_buzz.atKeys
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/macs/cbc_block_cipher_mac.dart:103:46: Warning: Operand of null-aware operation '!' has type 'Padding' which excludes null.
 - 'Padding' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
    var paddingName = _padding != null ? '/${_padding!.algorithmName}' : '';
                                             ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/macs/cbc_block_cipher_mac.dart:203:7: Warning: Operand of null-aware operation '!' has type 'Padding' which excludes null.
 - 'Padding' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      _padding!.addPadding(_buf, _bufOff);
      ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/signers/ecdsa_signer.dart:94:41: Warning: Operand of null-aware operation '!' has type 'Mac' which excludes null.
 - 'Mac' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      kCalculator = _RFC6979KCalculator(_kMac!, n, _pvkey!.d!, message);
                                        ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/signers/ecdsa_signer.dart:166:7: Warning: Operand of null-aware operation '!' has type 'Digest' which excludes null.
 - 'Digest' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      _digest!.reset();
      ^
../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/signers/ecdsa_signer.dart:167:14: Warning: Operand of null-aware operation '!' has type 'Digest' which excludes null.
 - 'Digest' is from 'package:pointycastle/api.dart' ('../../../../../.pub-cache/hosted/pub.dev/pointycastle-3.9.0/lib/api.dart').
      return _digest!.process(message);

Should not occur if you do dart pub upgrade to pull in the latest pointycastle

gkc · 2024-05-13T14:13:05Z

@gkc
murali@Muralidharans-MacBook-Pro at_onboarding_cli % dart bin/activate_cli.dart enroll -s 5KSNW3  -r vip.ve.atsign.zone -p buzz -d pixel -n “buzz:rw” -a @alice🛠 -k /Users/murali/.atsign/keys/@alice🛠_buzz.atKeys
Can we log the enrollment response from server after running the above command. I had to copy the enrollmentId from the server logs and pass it to the approve command.

Done in latest commit

…o some refactoring - Deprecated `AtOnboardingPreference.apkamAuthRetryDurationMins` - Added three new methods to AtOnboardingService - sendEnrollRequest, awaitApproval and createAtKeysFile. Extracted those methods from AtOnboardingServiceImpl.enroll so it now just calls those three methods. The refactoring provides more control to application code. - For readability, refactored the code related to pkam auth in the context of enrollment success checking

gkc · 2024-05-14T09:45:43Z

@murali-shris please can you re-review?

gkc added 22 commits March 6, 2024 08:37

chore: AtOnboardingPreference: remove unnecessary overrides of AtCien…

8633f39

…tPreference fields

feat: new apkam-aware activate / onboarding CLI: interim commit

8c32f11

Merge remote-tracking branch 'origin/trunk' into gkc/apkam-aware-cli

26c3bbb

Merge remote-tracking branch 'origin/trunk' into gkc/apkam-aware-cli

c58804d

# Conflicts: # packages/at_onboarding_cli/bin/activate_cli.dart # packages/at_onboarding_cli/pubspec.yaml

feat: add Duration? retryInterval param to AtOnboardingService.enroll…

9d9be70

…; deprecate the int? pkamRetryIntervalMins parameter

feat: new apkam-aware cli for onboarding / enrollment / enrollment ma…

895d1c2

…nagement. Interim commit: mostly structural changes for testability, readability etc

fix: Fixed async-await bug in at_onboarding_service_impl. Added more …

6998e6a

…lint rules to analysis_options.yaml including the unawaited futures rule so we don't have this happen anywhere else.

feat: new at_activate cli working fully; needs a couple of changes to…

624ae47

… go to prod swarms before can be used for prod

use new enroll:fetch:$id to fetch a specific enrollment

8608953

Merge remote-tracking branch 'origin/trunk' into gkc/apkam-aware-cli

b67ec15

Merge remote-tracking branch 'origin/trunk' into gkc/apkam-aware-cli

66193d3

docs: update CHANGELOG

459bce5

Merge remote-tracking branch 'origin/trunk' into gkc/apkam-aware-cli

3419b72

feat: at_onboarding_cli: Added regex support for list / approve / den…

a0349bc

…y / revoke in auth_cli

build: at_onboarding_cli: pubspec and CHANGELOG for 1.5.0

6ebe04b

docs: at_onboarding_cli: tweaked pub description

9466d64

feat: at_onboarding_cli: auth_cli throw ArgumentError when appropriate

6341a37

fix: auth_cli: write generated OTP to stdout

e0ecbc9

build: at_onboarding_cli: upgrade at_cli_commons dependency

0b7b023

feat: auth_cli: add maxConnectAttempts param to auth_cli

675cb2f

build: using published version 1.1.0 of at_cli_commons

29b129b

test: modify cli functional tests pubspec to use at_onboarding_cli fr…

7fb44de

…om pub.dev rather than local path. This is slightly inconvenient but we have a circular dependency now between at_onboarding_cli and at_cli_commons.

gkc commented May 7, 2024

View reviewed changes

gkc requested review from srieteja, sitaram-kalluri and murali-shris May 7, 2024 13:11

gkc mentioned this pull request May 7, 2024

test: Add e2e tests using APKAM keys atsign-foundation/noports#1037

Merged

gkc added 2 commits May 13, 2024 15:41

chore: run dart format

ac7fd0f

gkc marked this pull request as ready for review May 14, 2024 12:47

sitaram-kalluri approved these changes May 15, 2024

View reviewed changes

gkc merged commit c8dd65f into trunk May 15, 2024
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: apkam-aware activate_cli #576

feat: apkam-aware activate_cli #576

gkc commented May 7, 2024 •

edited

Loading

gkc May 7, 2024

gkc May 7, 2024

gkc May 7, 2024

gkc May 7, 2024

gkc May 7, 2024

murali-shris commented May 9, 2024

murali-shris commented May 9, 2024

gkc commented May 13, 2024

gkc commented May 13, 2024

gkc commented May 14, 2024


		import 'package:args/args.dart';

		extension PrintAllArgParserUsage on ArgParser {

feat: apkam-aware activate_cli #576

feat: apkam-aware activate_cli #576

Conversation

gkc commented May 7, 2024 • edited Loading

gkc May 7, 2024

Choose a reason for hiding this comment

gkc May 7, 2024

Choose a reason for hiding this comment

gkc May 7, 2024

Choose a reason for hiding this comment

gkc May 7, 2024

Choose a reason for hiding this comment

gkc May 7, 2024

Choose a reason for hiding this comment

murali-shris commented May 9, 2024

murali-shris commented May 9, 2024

gkc commented May 13, 2024

gkc commented May 13, 2024

gkc commented May 14, 2024

gkc commented May 7, 2024 •

edited

Loading