The @zcloak/login-verify module offers functionalities for verifying zkID Login information using either Decentralized Identifiers (DID) or Verifiable Credentials (VCs).

Integration Steps

1. Installation: yarn add @zcloak/login-verify
2. Import the necessary classes and functions

import { verifyDidLogin } from '@zcloak/login-verify';
...

Key Classes and Functions

Verifying DID

The method:

verifyDidLogin(params)

export async function verifyDidLogin<T extends 'did_login' | 'did_login$Kilt' = 'did_login'>(
  message: HexString | Uint8Array | string,
  data: RequestRpcs<T>[T][1],
  resolver?: DidResolver
): Promise<boolean> {
    //......
}

• Description: Helps developers to authenticate users. This should be invoked after using the didLogin(params) function in the Provider, verifyDidLogin(params) function helps verify whether the User is actually the Owner of the DID.
• Params:
  • message - the message which the User signed on (this should be the same with the massage in didLogin(params))
  • signature - the signature on that message, started with '0x'
  • publicKey - the publicKey of User's AuthenticationKey, which is contains in the DID info (can be obtained by getCurrentDid() function in the Provider.
• Return: Boolean - Whether the signature is actually signed by the User (in other word -- Whether developers should allow the User to login)

Verifying Credential

Key methods include:

verifyCredentialDigest(params)

export async function verifyCredentialDigest<
  T extends
    | 'did_requestCredentialDigest'
    | 'did_requestCredentialDigest$Kilt' = 'did_requestCredentialDigest'
>(
  credentialDigest: RequestRpcs<T>[T][1],
  challenge: string,
  owner: T extends 'did_requestCredentialDigest' ? DidUrl : DidUri,
  resolver?: DidResolver
): Promise<boolean> {
//......
}

• Description: This verifyCredentialDigest method provided in our SDK can be used to check whether the Digest Disclosure is valid, whether the User is the Credential’s Owner.
• Params:
  • credentialDigest - the RequestCredentialDigestReponse of login-rpc, can be obtained use did_requestCredentialDigest method
  • challenge - a random string, the same with the challenge in the did_requestCredentialDigest method
  • owner - the credential owner