Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • createProfile:  This API creates user's wallet profile and returns info of profile created (ID and any other information needed by client). It returns error if wallet profile is already created or if profile creation fails.
    Here are the arguments that can be used to create user profile
    • username: unique loginname to identity user. This parameter will also be used as db namespace,
    • authURIremoteKMS options:
      • key server URL: webkms key server URI
      , if not provided then this profile will use localkms.authString
    • local KMS options:
      • passphrase: secret in case of localkms
      or auth token in case of webkms
      (Note: in case of localkms a masterkey will be generated and will be encrypted by user's secret)
      • . VC wallet will create `hkdf` masterlocker(secret lock service) using this passphrase to encrypt master key.
      • secret lock service: (for SDK binding only), If client doesn't want to share passphrase then client can provide secret lock service which will be used by VCwallet to encrypt master key.


  • getProfile: Takes a username string and returns profile info containing profile ID or any other information needed for client. 

...

  • updateProfile: Client can change its KMS settings anytime by using update profile. Wallet contents will be preserved, but client may lose its keys depending on KMS setting updates.
    For example, client changes its passphrase in case of localkms or secret service.


Open & Close wallet APIs (need naming suggestions):

Since profile KMS requires locking/unlocking features, it is not a good idea to expect user kms secret/token in each wallet api calls due to below reasons.

...


Solution: client has to unlock the wallet before calling any wallet interface APIs and lock the wallet back when he/she is done. Wallet will also auto lock if unused for certain amount of time.
This leads to introduction of 2 more APIs given below: 

...