目录

接入钥匙环服务

检测是否支持钥匙环功能

调用钥匙环API之前,需要先检测浏览器是否支持钥匙环特性,参考代码如下:

if (navigator.sharedCredentials) //浏览器是否支持Keyring
{
  navigator.sharedCredentials.isSupported().then((supported)=>{
    //HMS Core是否支持Keyring
    console.info("SharedCredentials isSupported : " + supported);
    }, (err) => {
            console.error("SharedCredentials Error: ", err);
    });
}
else
{
  console.info("SharedCredentials is not supported on HuaweiBrowser");
}

保存用户凭证信息

用户登录您的Web应用后,可以把凭据保存下来,以便提升用户下次登录的体验,您还可以把凭据共享给您的其它Android应用、快应用或Web应用,当用户打开关联应用时,实现无缝登录。为了共享给Android应用和快应用,您需要了解目标应用的包名、证书指纹,关于如何计算证书指纹请参考相应的指南。您可以参考以下代码把凭据保存到Keyring中:

var android = new AndroidAppIdentity({name:"your android app name", packageName:"your android app package name",certHash:"0E:01:BA:63….4F"});
var quick = new QuickAppIdentity({name:"your quick app name",packageName:"your quick app package name", certHash: "E3:04:02:C3….1E"});
var web = new WebAppIdentity({name:"your web app name", domain:"domain:port"});
var trustedApps = [android,web,quick];
 
var cre = new SharedCredential({
    username: 'John',
    type: SharedCredential.PASSWORD,
    content:(new TextEncoder()).encode("John's password").buffer,
    userAuth: true,
    displayName: "John's nickname",
    avatarUrl: 'xxxx.html',
    tag: 'John password',
    syncAble: false,
    sharedWith: trustedApps 
  });
  
navigator.sharedCredentials.save(cre).then(() => {
         console.info("SharedCredential saved successfully.");
}, (err) => {
         console.error("Error while saving the SharedCredential: ", err);
});

查找并使用用户凭证信息

用户打开您的Web应用后,您可以尝试在Keyring中查找是否有可用的凭据,提示用户是否以用该用户登录。您可以参考以下代码查找并使用Keyring中的凭据:

var android = new AndroidAppIdentity({name:"your android app name", packageName:"your android app package name",certHash:"0E:01:BA:63….4F"});
var quick = new QuickAppIdentity({name:"your quick app name",packageName:"your quick app package name", certHash: "E3:04:02:C3….1E"});
var web = new WebAppIdentity({name:"your web app name", domain:"domain:port"});
var trustedApps = [android,web,quick];
 
navigator.sharedCredentials.find(trustedApps).then((credentials)=>{
  for (var credential of credentials) {
    console.info("username : " + credential.username);
    console.info("type : " + credential.type);
    console.info("displayName : " + credential.displayName);
    credential.getContent().then((content)=>{
      // handle content buffer
      //ConvertToString(content)
    })
  }
})

删除用户凭证信息

用户退出或者销户后,需要删除Keyring中保存的凭据,参考代码如下:

var android = new AndroidAppIdentity({name:"your android app name", packageName:"your android app package name",certHash:"0E:01:BA:63….4F"});
var quick = new QuickAppIdentity({name:"your quick app name",packageName:"your quick app package name", certHash: "E3:04:02:C3….1E"});
var web = new WebAppIdentity({name:"your web app name", domain:"domain:port"});
var trustedApps = [android,web,quick];
 
navigator.sharedCredentials.find(trustedApps).then((credentials)=>{
  for (var credential of credentials) {
    if(credential.username=="your username") {
      navigator.sharedCredentials.delete(credential).then(() => {
        console.info(credential.username + "deleted.");
      }, (err) => {
        console.error("Error while deleting the SharedCredential: ", err);
      });
    }
  }
})

隐私声明和合规使用指南

隐私声明和合规使用指南请参考《SDK隐私声明》和《SDK合规使用指南》