Operations

Below are the methods exposed by the CYS keymaster client SDKs.

DID Operations

Create an Identity

Node.js

await Keymaster.createId({ name: "Paul Revere" });

Java

String did = keymaster.createId("Alice");
System.out.println("DID: " + did);

Get a DID Document

Node.js

await Keymaster.resolveDID({
  did: "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
});

Java

System.out.println(keymaster.resolveDID(did).didDocument.id);

Delete a DID

Node.js

await Keymaster.removeId({
  did: "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
});

Java

keymaster.revokeDID(did);     // deactivates DID on network
keymaster.removeId("Alice");  // removes local wallet entry

Set Current DID

Node.js

await Keymaster.setCurrentId("identity-name-1");

Java

keymaster.setCurrentId("Alice");

Templates / Schemas

Create a Template / Schema

Node.js

const schema = {
  $schema: "http://json-schema.org/draft-07/schema#",
  title: "Drivers License",
  type: "object",
  properties: {
    licenseNumber: 1234567890,
    firstName: "Paul",
    lastName: "Revere",
    isValid: true,
  },
  required: ["licenseNumber", "firstName", "lastName"],
};

await Keymaster.createSchema(schema);

Java

Map<String, Object> emailSchema = new HashMap<>();
emailSchema.put("$schema", "http://json-schema.org/draft-07/schema#");
Map<String, Object> properties = new HashMap<>();
Map<String, Object> email = new HashMap<>();
email.put("format", "email");
email.put("type", "string");
properties.put("email", email);
emailSchema.put("properties", properties);
emailSchema.put("required", List.of("email"));
emailSchema.put("type", "object");

String schemaDid = keymaster.createSchema(emailSchema);

Challenges & Responses

Create a Challenge

Node.js

await Keymaster.createChallenge({
  callback: "https://www.your-domain.com/api/auth",
});

Java

Map<String, Object> challenge = Map.of(
    "credentials",
    List.of(
        Map.of(
            "schema",
            credentialDid,
            "issuers",
            List.of(alice)
        )
    )
);
String challengeDid = keymaster.createChallenge(challenge);

Create a Response

Node.js

await Keymaster.createResponse(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
);

Java

String responseDid = keymaster.createResponse(challengeDid);

Verify Response

Node.js

await Keymaster.verifyResponse(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
);

Java

Map<String, Object> verify = keymaster.verifyResponse(responseDid);
System.out.println(verify.get("match"));

Credentials

Issue Credential

Node.js

await Keymaster.issueCredential(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
);

Java

String credentialDid = keymaster.issueCredential(bound);

Bind Credential

Node.js

await Keymaster.bindCredential(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZw",
);

Java

Map<String, Object> bound = keymaster.bindCredential(schemaDid, aliceDid);

Get Credential

Node.js

await Keymaster.getCredential(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
);

Java

@SuppressWarnings("unchecked")
Map<String, Object> vc = (Map<String, Object>) keymaster.getCredential(credentialDid);

Update a Credential

Node.js

await Keymaster.updateCredential(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
  {},
);

Java

keymaster.updateCredential(credentialDid, vc);

Accept Credentials

Node.js

await Keymaster.acceptCredential(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
);

Java

keymaster.acceptCredential(credentialDid);

Decrypt Message

Node.js

await Keymaster.decryptMessage(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
);

Java

String message = keymaster.decryptMessage(cipherDid);
System.out.println(message);

Publish Credentials

Node.js

await Keymaster.publishCredential(
  "did:test:z3v8AuagJiXARFGw3B8Mc6DrLBC2thMzjgeUZWQvHcyPVBxAYZv",
  { reveal: true },
);

Java

PublishCredentialOptions publish = new PublishCredentialOptions();
publish.reveal = true;
keymaster.publishCredential(credentialDid, publish);

Custom Headers

Add Custom Header

Node.js

await Keymaster.addCustomHeader("authorization", "base64-encoded-string");

Java

// Not supported in Java Keymaster API.
// Java Keymaster runs as an in-process library, not a hosted SDK service.
// Set HTTP headers in your application's own transport/client layer.

Remove Custom Header

Node.js

await Keymaster.removeCustomHeader("authorization");

Java

// Not supported in Java Keymaster API.
// Java Keymaster runs as an in-process library, not a hosted SDK service.
// Clear HTTP headers in your application's own transport/client layer.