LockerKeysPutRequest locker.keys-put-request@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
network
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/locker/keys-put-request.v1.json

locker.keys-put-request@1: what a person sends to set their locker keys. The public keys and the fingerprint are readable by anyone; the private keys go in the backup, wrapped by a key from the locker passphrase, so the server never holds an unwrapped key.

Fields

FieldTypeRequiredDescriptionConstraints
ecdhlocker.public-keyyes
signinglocker.public-keyyes
fingerprintstringyes
  • pattern ^[a-z]+ [a-z]+ [a-z]+ [a-z]+ · [a-z]+ [a-z]+ [a-z]+ [a-z]+$
fingerprint_signaturestringyes
  • pattern ^[A-Za-z0-9+/]{86}==$
backuplocker.key-backupyes

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: example
{
  "ecdh": {
    "kty": "EC",
    "crv": "P-256",
    "x": "eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHg",
    "y": "eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXk"
  },
  "signing": {
    "kty": "EC",
    "crv": "P-256",
    "x": "eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHg",
    "y": "eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXk"
  },
  "fingerprint": "amber quiet harbor cedar · mist dawn ember willow",
  "fingerprint_signature": "Z2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZw==",
  "backup": {
    "method": "passphrase",
    "kdf": "PBKDF2-SHA-256",
    "iterations": 600000,
    "salt": "c3Nzc3Nzc3Nzc3Nzc3Nzcw==",
    "nonce": "bm5ubm5ubm5ubm5u",
    "wrapped_keys": "d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3d3"
  }
}
Rejected: no-backup
{
  "ecdh": {
    "kty": "EC",
    "crv": "P-256",
    "x": "eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHg",
    "y": "eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXk"
  },
  "signing": {
    "kty": "EC",
    "crv": "P-256",
    "x": "eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHg",
    "y": "eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXl5eXk"
  },
  "fingerprint": "amber quiet harbor cedar · mist dawn ember willow",
  "fingerprint_signature": "Z2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZw=="
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('locker.keys-put-request@1', value);   // { valid, errors: [{ path, message }] }