ld-cryptosuite-registry/index.js

Linked Data Cryptographic Suite Registry as a module

'use strict'

// https://w3c-ccg.github.io/didm-veres-one/
const kEd25519SignatureAuthentication2018 = 'Ed25519SignatureAuthentication2018'

// https://w3c-dvcg.github.io/lds-ed25519-2018/
const kEd25519VerificationKey2018 = 'Ed25519VerificationKey2018'

// https://w3c-dvcg.github.io/lds-koblitz2016/
const kEdDsaSAPublicKeySecp256k1 = 'EdDsaSAPublicKeySecp256k1'

// https://w3c-dvcg.github.io/lds-rsa2018/
const kRsaVerificationKey2018 = 'RsaVerificationKey2018'
const kRsaSignature2018 = 'RsaSignature2018'

// https://w3c-dvcg.github.io/lds-merkleproof2017/
const kMerkleProof2017 = 'MerkleProof2017'

// https://github.com/uport-project/ethr-did
const kSecp256k1VerificationKey2018 = 'Secp256k1VerificationKey2018'

// https://github.com/uport-project/ethr-did
const kSecp256k1SignatureAuthentication2018 = 'Secp256k1SignatureAuthentication2018'

// https://ldapwiki.com/wiki/ES256
const kES256Signature2018 = 'ES256Signature2018'
const kES256VerificationKey2018 = 'ES256VerificationKey2018'

// https://github.com/uport-project/nacl-did
const kCurve25519EncryptionPublicKey = 'Curve25519EncryptionPublicKey'
const kED25519SignatureVerification = 'ED25519SignatureVerification'

// ld-cryptosuite-registry set
const registry = new Set([
  kEd25519SignatureAuthentication2018,
  kEd25519VerificationKey2018,

  kEdDsaSAPublicKeySecp256k1,
  kRsaVerificationKey2018,
  kRsaSignature2018,
  kMerkleProof2017,

  kSecp256k1VerificationKey2018,
  kSecp256k1SignatureAuthentication2018,

  kES256Signature2018,
  kES256VerificationKey2018,

  // uport
  kCurve25519EncryptionPublicKey,
  kED25519SignatureVerification,
])

// exported constants
Object.assign(registry, {
  kEd25519SignatureAuthentication2018,
  kEd25519VerificationKey2018,

  kEdDsaSAPublicKeySecp256k1,
  kRsaVerificationKey2018,
  kRsaSignature2018,
  kMerkleProof2017,

  kSecp256k1VerificationKey2018,
  kSecp256k1SignatureAuthentication2018,

  kES256Signature2018,
  kES256VerificationKey2018,

  //u port
  kCurve25519EncryptionPublicKey,
  kED25519SignatureVerification,
})

// exported values
Object.assign(registry, {
  Ed25519SignatureAuthentication2018: kEd25519SignatureAuthentication2018,
  Ed25519VerificationKey2018: kEd25519VerificationKey2018,

  EdDsaSAPublicKeySecp256k1: kEdDsaSAPublicKeySecp256k1,
  RsaVerificationKey2018: kRsaVerificationKey2018,
  RsaSignature2018: kRsaSignature2018,
  MerkleProof2017: kMerkleProof2017,

  Secp256k1VerificationKey2018: kSecp256k1VerificationKey2018,
  Secp256k1SignatureAuthentication2018: kSecp256k1SignatureAuthentication2018,

  ES256Signature2018: kES256Signature2018,
  ES256VerificationKey2018: kES256VerificationKey2018,

  // uport
  Curve25519EncryptionPublicKey: kCurve25519EncryptionPublicKey,
  ED25519SignatureVerification: kED25519SignatureVerification,
})

// disable destructive methods
Object.assign(registry, {
  add: warn('add'),
  clear: warn('clear'),
  delete: warn('delete'),
})

function warn(method) {
  return () => {
    console.warn("ld-cryptosuite-registry: warn: %s does nothing", method)
  }
}

module.exports = registry