User Credential (1079+)

API Declaration

Add the following configuration to the features attribute in the manifest.json file:

{ "name": "service.keyring" }

Module Import

Add the following configuration to the script element on the page where the API will be called:

import keyring from '@service.keyring'

Or

var keyring = require('@service.keyring')

Application Scope

Definition

[h2]keyring.getProvider() (1079+)

Description

Obtains the service provider.

Returns

A character string, which is the service provider code (for example, the English brand name of the vendor), is returned. If the service does not exist, an empty string is returned. If so, do not call other APIs of the service. Otherwise, an exception will occur.

Sample code

functionGetProvider() {
  keyring.getProvider({
    success: function (msg) {
      prompt.showToast({
        message: msg,
        duration: 2000,
        gravity: 'bottom'
      })
    },
    fail: function (msg) {
      prompt.showToast({
        message: msg,
        duration: 2000,
        gravity: 'bottom'
      })
    }
  })
}

[h2]keyring.saveCredential(OBJECT) (1079+)

Description

Saves the information about the user credential. If the call is successful, success is returned. Otherwise, an error message is returned.

OBJECT parameters

AppIdentity description

Result codes returned in fail

Sample code

To save the new data:

keyring.saveCredential({
  type: 0,
  syncable: "false",
  userAuth: "true",
  username: "Zhang San",
  newContent: "123456",
  success: function (msg) {
    prompt.showToast({
      message: msg,
      duration: 2000,
      gravity: 'bottom'
    })
  },
  fail: function (code,msg) {
    prompt.showToast({
      message: code + msg,
      duration: 2000,
      gravity: 'bottom'
    })
  }
})

To save the updated data:

keyring.saveCredential({
  type: 0,
  syncable: false,
  userAuth: true,
  username: "Zhang San",
  newContent: "12345678",
  sharedWith: [{
    certHash: "${Signing certificate fingerprint}",
    name: "${App name}",
    packageName: "${App package name}",
    type: "android_app"
  },
  {
    name: "${website name}",
    domain: "${website domain name}",
    type: "web"
  }],
  owner: {
    certHash: "3a:25:d7:19:53:9b:39:b9:67:48:c4:85:86:bb:d7:f1:dd:53:e5:e9:29:12:77:0e:f2:5f:4e:7e:9a:b3:7f:cc",
    name: "Keyring_Test",
    packageName: "com.huawei.keyring",
    type: "quick_app"
  },
  success: function (msg) {
    prompt.showToast({
      message: msg,
      duration: 2000,
      gravity: 'bottom'
    })
  },
  fail: function (msg) {
    prompt.showToast({
      message: msg,
      duration: 2000,
      gravity: 'bottom'
    })
  }
})

[h2]keyring.deleteCredential(OBJECT) (1079+)

Description

Deletes the information about the user credential saved by the app. If the call is successful, success is returned. Otherwise, an error message is returned.

OBJECT parameters

AppIdentity description

Result codes returned in fail

Sample code

keyring.deleteCredential({
  owner: {
    certHash: "3a:25:d7:19:53:9b:39:b9:67:48:c4:85:86:bb:d7:f1:dd:53:e5:e9:29:12:77:0e:f2:5f:4e:7e:9a:b3:7f:cc",
    name: "Keyring_Test",
    packageName: "com.huawei.keyring",
    type: "quick_app"
  },
  "type": 0,
  "username": "Zhang San",
  success: function (msg) {
    prompt.showToast({
      message: msg,
      duration: 2000,
      gravity: 'bottom'
    })
  },
  fail: function (code, msg) {
    prompt.showToast({
      message: code + msg,
      duration: 2000,
      gravity: 'bottom'
    })
  }
})

[h2]keyring.findCredential(OBJECT) (1079+)

Description

Queries user credentials used in app sign-in. If the call is successful, the queried credential list is returned. Otherwise, an error message is returned.

OBJECT parameters

AppIdentity description

Parameters returned in success

Result codes returned in fail

Sample code

keyring.findCredential({
  trustedApps: [{
      type: 'quick_app',
      name: 'AndroidAppIdentity',
      packageName: 'com.huawei.hms.keyring.test',
      certHash: "3C:99:C3:69:27:75:46:FD:E4:14:82:C0:C1:FB:75:54:94:A7:A8:63:CA:9C:A7:BB:4B:9D:48:C4:04:86:9A:93"
    }],
  success: function (data) {
    credential = data // Returned credential list.
    prompt.showToast({
      message: data,
      duration: 2000,
      gravity: 'bottom'
    })
  },
  fail: function (code, msg) {
    prompt.showToast({
      message: code + msg,
      duration: 2000,
      gravity: 'bottom'
    })
  }
})

[h2]keyring.getCredentialContent(OBJECT) (1079+)

Description

Obtains the sensitive information about the target credential according to the credential list returned by keyring.findCredential. If the call is successful, the queried information is returned. Otherwise, an error message is returned.

OBJECT parameters

AppIdentity description

Parameters returned in success

Result codes returned in fail

Sample code

keyring.getCredentialContent({
  owner: {
    certHash: "3C:99:C3:69:27:75:46:FD:E4:14:82:C0:C1:FB:75:54:94:A7:A8:63:CA:9C:A7:BB:4B:9D:48:C4:04:86:9A:93",
    name: "AndroidAppIdentity",
    packageName: "com.huawei.hms.keyring.test",
    type: "quick_app"
  },
  type: 0,
  username: "Zhang San",
  success: function (data) {
    prompt.showToast({
      message: data, // Returned sensitive information.
      duration: 2000,
      gravity: 'bottom'
    })
  },
  fail: function (msg, code) {
    prompt.showToast({
      message: code + msg,
      duration: 2000,
      gravity: 'bottom'
    })
  }
})

Demo

<template>
  <!-- Only one root node is allowed in template. -->
  <div class="container">
    <text class="title" onclick="functionGetProvider">getprovider</text>
    <text class="title" onclick="new">newCredential</text>
    <text class="title" onclick="update">updateCredential</text>
    <text class="title" onclick="find">find</text>
    <text class="title" onclick="delete">delete</text>
    <text class="title" onclick="getCredential">getCredential</text>
    <text class="content">{{content}}</text>
  </div>
</template>

<style>
  .container {
    flex-direction: column;
    justify-content: center;
    align-items: center;
  }

  .title {
    font-size: 40px;
    border-radius: 20px;
    margin-top: 10px;
    width: 400px;
    height: 80px;
    text-align: center;
    background-color: #00fa9a;
  }
  .content {
    margin-top: 20px;
    width: 90%;
    height: 600px;
    border: 2px solid #000000;
    border-radius: 10px;
  }
</style>

<script>
  import prompt from '@system.prompt';
  import keyring from '@service.keyring';
  module.exports = {
    data: {
      componentData: {},
      newcertHash: '',
      arr: [],
      content: '',
    },
    functionGetProvider() {
      keyring.getProvider({
        success: function (msg) {
          prompt.showToast({
            message: msg,
            duration: 2000,
            gravity: 'bottom'
          })
        },
        fail: function (msg) {
          prompt.showToast({
            message: msg,
            duration: 2000,
            gravity: 'bottom'
          })
        }
      })
    },
    new() {
      keyring.saveCredential({
        type: 0,
        syncable: "false",
        userAuth: "true",
        username: "newCredential",
        displayName: "newCredential",
        newContent: "123456",
        sharedWith: [
          {
            'type': "quick_app",
            'name': "keyringg",
            'packageName': "com.huawei.keyringg",
            'certHash': "a7:69:69:7d:68:5b:b4:ba:aa:30:8e:07:94:11:3e:8b:64:90:ac:61:f4:d7:e1:ac:58:d5:87:f3:7e:5c:9f:20",
          }],
        success: function (msg) {
          console.log("newCredential " + msg);
          prompt.showToast({
            message: msg,
            duration: 2000,
            gravity: 'bottom'
          })
        },
        fail: function (code, msg) {
          console.log("newCredential " + code + msg);
          prompt.showToast({
            message: 'newCredential' + code + msg,
            duration: 2000,
            gravity: 'bottom'
          })
        }
      })
    },
    update() {
      keyring.saveCredential({
        type: 0,
        syncable: "false",
        userAuth: "true",
        username: "updateCredential",
        displayName: "updateCredential",
        newContent: "123456",
        owner: {
          type: 'quick_app',
          name: 'keyring',
          packageName: 'com.huawei.keyring',
          certHash: "cc:88:3d:9b:99:39:d1:b3:a9:92:e9:bd:a0:49:f6:d4:97:a9:e2:11:19:31:a4:98:1a:8c:77:55:7d:15:3e:43"
        },
        sharedWith: [
          {
            'type': "quick_app",
            'name': "keyringg",
            'packageName': "com.huawei.keyringg",
            'certHash': "a7:69:69:7d:68:5b:b4:ba:aa:30:8e:07:94:11:3e:8b:64:90:ac:61:f4:d7:e1:ac:58:d5:87:f3:7e:5c:9f:20",
          }],
        success: function (msg) {
          console.log("updateCredential " + msg);
          prompt.showToast({
            message: 'updateCredential success',
            duration: 2000,
            gravity: 'bottom'
          })
        },
        fail: function (code, msg) {
          console.log("updateCredential " + code + msg);
          prompt.showToast({
            message: msg + code,
            duration: 2000,
            gravity: 'bottom'
          })
        }
      })
    },
    find() {
      var that = this
      keyring.findCredential({
        trustedApps: [{
          type: 'quick_app',
          name: 'keyring',
          packageName: 'com.huawei.keyring',
          certHash: "cc:88:3d:9b:99:39:d1:b3:a9:92:e9:bd:a0:49:f6:d4:97:a9:e2:11:19:31:a4:98:1a:8c:77:55:7d:15:3e:43"
        }],
        success: function (data) {
          console.log("findCredential success", JSON.stringify(data));
          that.content = data
        },
        fail: function (code, msg) {
          console.log("findCredential fail" + code + msg);
        }
      })
    },
    delete() {
      keyring.deleteCredential({
        owner: {
          type: 'quick_app',
          name: 'keyring',
          packageName: 'com.huawei.keyring',
          certHash: "cc:88:3d:9b:99:39:d1:b3:a9:92:e9:bd:a0:49:f6:d4:97:a9:e2:11:19:31:a4:98:1a:8c:77:55:7d:15:3e:43"
        },
        "type": 0,
        "username": "newCredential",
        success: function (msg) {
          console.log("delete" + msg);
        },
        fail: function (code, msg) {
          console.log("delete" + code + msg);
        }
      })
    },
    getCredential() {
      keyring.getCredentialContent({
        owner: {
          type: 'quick_app',
          name: 'keyring',
          packageName: 'com.huawei.keyring',
          certHash: "cc:88:3d:9b:99:39:d1:b3:a9:92:e9:bd:a0:49:f6:d4:97:a9:e2:11:19:31:a4:98:1a:8c:77:55:7d:15:3e:43"
        },
        type: 0,
        username: "hanjingjing",
        success: function (msg) {
          console.log("get" + msg);
        },
        fail: function (code, msg) {
          console.log("get" + code + msg);
        }
      })
    }
  }
</script>

The following figure shows the final effect.

Version Change History