fix: update pkam verb syntax to include SHA512 as hashing algo (#622)

* fix: update pkam verb regex to accept sha512 hashing algo
atsign-foundation · Sep 16, 2024 · 54ab42c · 54ab42c
1 parent cf4c22f
commit 54ab42c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/packages/at_commons/CHANGELOG.md b/packages/at_commons/CHANGELOG.md
@@ -1,10 +1,12 @@
 ## 4.1.2
+- fix: update pkam regex to accept sha512 as hashing algo
 - feat: Add "expiry" enroll params to support apkam keys to auto expiry after specified time duration
 ## 4.1.1
 - feat: Add "delete" operation to the enroll verb to allow deletion of denied enrollments
 ## 4.1.0
 - feat: Add "unrevoke" operation to the enroll verb to restore revoked APKAM keys
 - fix: Add isEncrypted flag to notify command for both true and false
+
 ## 4.0.11
 - chore: deprecate MessageTypeEnum.text
 - fix: remove deprecated annotation from Metadata.pubKeyCS

diff --git a/packages/at_commons/lib/src/verb/syntax.dart b/packages/at_commons/lib/src/verb/syntax.dart
@@ -7,7 +7,7 @@ class VerbSyntax {
   static const pol = r'^pol$';
   static const cram = r'^cram:(?<digest>.+$)';
   static const pkam =
-      r'^pkam:(signingAlgo:(?<signingAlgo>ecc_secp256r1|rsa2048):)?(hashingAlgo:(?<hashingAlgo>sha256):)?(enrollmentId:(?<enrollmentId>.+):)?(?<signature>.+$)';
+      r'^pkam:(signingAlgo:(?<signingAlgo>ecc_secp256r1|rsa2048):)?(hashingAlgo:(?<hashingAlgo>sha256|sha512):)?(enrollmentId:(?<enrollmentId>.+):)?(?<signature>.+$)';
   static const llookup = r'^llookup'
       r'(:(?<operation>meta|all))?'
       r'(:cached)?'

diff --git a/packages/at_commons/test/syntax_test.dart b/packages/at_commons/test/syntax_test.dart
@@ -51,19 +51,22 @@ void main() {
               e.message == 'command does not match the regex')));
     });
   });
+
   group('A group of tests to verify pkam verb regex', () {
     test('pkam regex without signing algo', () {
       var command = 'pkam:abcd1234';
       var verbParams = getVerbParams(VerbSyntax.pkam, command);
       expect(verbParams[AtConstants.atPkamSignature], 'abcd1234');
     });
+
     test('pkam regex with rsa2048 signing algo and sha256 hashing algo', () {
       var command = 'pkam:signingAlgo:rsa2048:hashingAlgo:sha256:abcd1234';
       var verbParams = getVerbParams(VerbSyntax.pkam, command);
       expect(verbParams[AtConstants.atPkamSigningAlgo], 'rsa2048');
       expect(verbParams[AtConstants.atPkamHashingAlgo], 'sha256');
       expect(verbParams[AtConstants.atPkamSignature], 'abcd1234');
     });
+
     test('pkam regex with ecc signing algo and sha256 hashing algo', () {
       var command =
           'pkam:signingAlgo:ecc_secp256r1:hashingAlgo:sha256:abcd1234';
@@ -72,17 +75,37 @@ void main() {
       expect(verbParams[AtConstants.atPkamHashingAlgo], 'sha256');
       expect(verbParams[AtConstants.atPkamSignature], 'abcd1234');
     });
+
+    test('pkam regex with ecc signing algo and sha512 hashing algo', () {
+      var command =
+          'pkam:signingAlgo:ecc_secp256r1:hashingAlgo:sha512:abcd1234';
+      var verbParams = getVerbParams(VerbSyntax.pkam, command);
+      expect(verbParams[AtConstants.atPkamSigningAlgo], 'ecc_secp256r1');
+      expect(verbParams[AtConstants.atPkamHashingAlgo], 'sha512');
+      expect(verbParams[AtConstants.atPkamSignature], 'abcd1234');
+    });
+
+    test('pkam regex with rsa signing algo and sha512 hashing algo', () {
+      var command = 'pkam:signingAlgo:rsa2048:hashingAlgo:sha512:abcd1234';
+      var verbParams = getVerbParams(VerbSyntax.pkam, command);
+      expect(verbParams[AtConstants.atPkamSigningAlgo], 'rsa2048');
+      expect(verbParams[AtConstants.atPkamHashingAlgo], 'sha512');
+      expect(verbParams[AtConstants.atPkamSignature], 'abcd1234');
+    });
+
     test('pkam regex with invalid signing algo', () {
       var command = 'pkam:signingAlgo:ecc:abcd1234';
       var verbParams = getVerbParams(VerbSyntax.pkam, command);
       expect(verbParams[AtConstants.atPkamSigningAlgo], isNull);
     });
+
     test('pkam regex with invalid hashing algo', () {
       var command = 'pkam:hashingAlgo:md5:abcd1234';
       var verbParams = getVerbParams(VerbSyntax.pkam, command);
       expect(verbParams[AtConstants.atPkamHashingAlgo], isNull);
     });
   });
+
   group('A group of positive tests to verify keys verb regex', () {
     test('keys verb  - put public key', () {
       var command =