decentralized-identity/ion

CLI creates payload is outdated key type

Open

#229 ouverte le 7 sept. 2021

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)HTML (1 219 stars) (168 forks)batch import
good first issuehigh prioirtyimprovement

Description

As of

  "name": "ion",
  "version": "1.0.3",

{
        "action": "replace",
        "document": {
          "publicKeys": [
            {
              "id": "signing-key",
              "type": "EcdsaSecp256k1VerificationKey2019",
              "publicKeyJwk": {
                "kty": "EC",
                "crv": "secp256k1",
                "x": "qp0Ezzc4YhA196COYKa-RHrCom-0LgFtAf8FqvcntN0",
                "y": "zWcbbbg9w1m-DNOszvM68TD0_vFBtWyc18S06c8cULU"
              }
            }
          ]
        }
      }

Should be

{
        "action": "replace",
        "document": {
          "publicKeys": [
            {
              "id": "signing-key",
              "type": "JsonWebKey2020",
              "publicKeyJwk": {
                "kty": "EC",
                "crv": "secp256k1",
                "x": "qp0Ezzc4YhA196COYKa-RHrCom-0LgFtAf8FqvcntN0",
                "y": "zWcbbbg9w1m-DNOszvM68TD0_vFBtWyc18S06c8cULU"
              }
            }
          ]
        }
      }

This is low priority, but will harm interoperability with JsonWebSignature2020, better not to encourage that key type to be used.

Guide contributeur

Stack technique
Aucun
Domaine
cli
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic JSON syntaxfamiliarity with ION CLI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
The issue is to change a hardcoded key type string in the CLI code that generates the payload. Locate the template or function that outputs the JSON with 'EcdsaSecp256k1VerificationKey2019' and replace it with 'JsonWebKey2020'. The code is in the ION repository, likely under a directory for the CLI (e.g., packages/cli). The relevant file may be something like 'create payload.ts' or similar. The change is trivial and well described in the issue.