Win10/UWP开发—凭据保险箱PasswordVault

PasswordVault用户凭据保险箱其实并不算是Win10的新功能，早在Windows 8.0时代就已经存在了，本文仅仅是介绍在UWP应用中如何使用凭据保险箱进行安全存储和检索用户凭据。

那么什么是凭据保险箱呢？简单的说就是开发者可以在用户输入完凭证(一般是用户名和密码)，凭证有效的情况下将该凭证存储在叫做"凭据保险箱"里，该凭据保险箱里的用户凭据将会自动漫游到用户设备的Windows账户中并随时能够再次被App获取。

例如：有一个UWP的App运行在PC上，某用户在使用该App时登录了自己的账户并允许将账户凭据保存在"凭据保险箱"中，那么当该用户再使用平板电脑、手机或者其他同一个Windows账户的Windows设备时第一次打开该App，我们就可以从Windows账户中将该用户的数据漫游到新设备进行用户登录的操作。

说的简单点就是用户的账户和密码会被漫游到Windows账户中，日后及时是跨设备使用该App，只要设备Windows账户没变，就可以实现在新设备上快捷登陆的功能。

要想使用"凭据保险箱"，我们需要了解以下几个类：

– Windows.Security.Credentials.PasswordVault 表示凭据的"凭据保险箱"

保险箱的内容特定于应用程序或服务。应用程序和服务无法访问与其他应用程序或服务关联的凭据。

– PasswordVault.Add(PasswordCredential credential); 添加一个凭证保险箱

– PasswordVault.Remove(PasswordCredential credential); 移除一个凭证保险箱

– PasswordVault.Retrieve(System.String resource, System.String userName); 读取一个凭证保险箱

– PasswordVault.FindAllByResource(System.String resource); 搜索与指定资源相匹配的凭据保险箱

– Windows.Security.Credentials.PasswordCredential 表示凭据对象

– PasswordCredential.PasswordCredential(System.String resource, System.String userName, System.String password); 创建一个凭据对象

– PasswordCredential.UserName 凭据对象存储的UserName

– PasswordCredential.Resource 凭据对象所属的资源名

– PasswordCredential.Password 凭据对象存储的密码

我们通过例子来看一下"凭据保险箱"是如何工作的（注：本文不考虑实现 记住密码 自动登陆 功能）

首先创建一个UWP通用项目，

然后新建一个LoginPage页面，并将起始页改为LoginPage页面

在LoginPage上布局出一个登陆框如下:

xaml代码：

 <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
     <StackPanel Margin="0,0,0,128" HorizontalAlignment="Center" VerticalAlignment="Center">
         <StackPanel Orientation="Horizontal">
             <TextBlock Text="账  户："/>
             <TextBox Text="{x:Bind UserName,Mode=TwoWay}" PlaceholderText="请输入您的账户" Width="240"/>
         </StackPanel>
         <StackPanel Margin="0,4" Orientation="Horizontal">
             <TextBlock Text="密  码："/>
             <PasswordBox PlaceholderText="请输入您的密码" Password="{x:Bind Psw,Mode=TwoWay}" Width="240"/>
         </StackPanel>

         <CheckBox IsChecked="{x:Bind RoamCredential,Mode=TwoWay}"  Content="漫游我的登录凭证" HorizontalAlignment="Right" ToolTipService.ToolTip="勾选漫游凭证后，您的登录信息将被漫游到本机WindowsLive账户"  />

         <Grid Margin="0,12,0,0" >
             <Button  Click="{x:Bind QuickLogin}" Content="WindowsLive快捷登陆"/>
             <Button Click="{x:Bind Login}" Content="登  录" HorizontalAlignment="Right"/>
         </Grid>
     </StackPanel>
 </Grid>

后台代码中，我们先实现"登录按钮"的Click方法：

         private async void Login(object sender, RoutedEventArgs args)
         {
             // 假设做用户账户和密码的验证工作（这里不考虑登录是否成功 一律登录成功）
             await ShowLoding();
             if (RoamCredential != true) return;
             //添加用户凭证到 PasswordVault
             var vault = new PasswordVault();
             vault.Add(new PasswordCredential(
                 _resourceName, UserName, Psw));
         }

         /// <summary>
         /// 显示登陆中Tip 并跳转到MainPage
         /// </summary>
         /// <returns>Null</returns>
         private async Task ShowLoding()
         {
             var dialog = new ContentDialog
             {
                 Title = "提示",
                 Content = "正在登录",
                 IsPrimaryButtonEnabled = true
             };
 #pragma warning disable CS4014 // 由于此调用不会等待，因此在调用完成前将继续执行当前方法
             dialog.ShowAsync();
 #pragma warning restore CS4014 // 由于此调用不会等待，因此在调用完成前将继续执行当前方法

             await Task.Delay();
             dialog.Content = "登录成功";
             await Task.Delay();
             dialog.Hide();
             Frame.Navigate(typeof(MainPage), _userName);
         }

假设用户的用户名和密码验证通过情况下，如果用户允许保存凭据到 "凭据保险箱"，我们就可以使用PasswordVault对象的Add方法添加到"凭据保险箱"里一个PasswordCredential 凭据对象，然后跳转到MainPage，并传递用户名。

当用户点击使用"Windows账户快捷登陆"按钮时，我们首先去检测在该App的ResourceName下，一共有几个用户凭据，如果有多个则需要让用户选择一个账户进行登陆，代码如下：

 private async void QuickLogin(object sender, RoutedEventArgs args)
 {
     var credential = await GetCredentialFromLocker();
     if (credential == null) return;
     UserName = credential.UserName;
     Psw = credential.Password;
     await ShowLoding();
 }
 /// <summary>
 /// 获取密码凭证
 /// </summary>
 /// <returns>PasswordCredential</returns>
 private async Task<PasswordCredential> GetCredentialFromLocker()
 {
     PasswordCredential credential = null;

     var vault = new PasswordVault();
     var credentialList = vault.FindAllByResource(_resourceName);
     if (credentialList.Count > )
     {
         if (credentialList.Count == )
         {
             credential = credentialList[];
         }
         else
         {
             _defaultUserName = await GetDefaultUserNameUI(credentialList.Select(s => s.UserName));
             if (!string.IsNullOrEmpty(_defaultUserName))
             {
                 //读取凭证
                 credential = vault.Retrieve(_resourceName, _defaultUserName);
             }
         }
     }

     return credential;
 }

 /// <summary>
 /// 获取一个用户名，如果存在多个用户凭证则选择一个
 /// </summary>
 /// <param name="userList">用户名集合</param>
 /// <returns>UserName</returns>
 private async Task<string> GetDefaultUserNameUI(IEnumerable<string> userList)
 {
     var userName = string.Empty;
     var dialog = new ContentDialog
     {
         Title = "账户选择",
         IsPrimaryButtonEnabled = true,
         IsSecondaryButtonEnabled = true,
         BorderThickness = new Thickness(, , , ),
         PrimaryButtonText = "确定",
         SecondaryButtonText = "取消"
     };
     var sp = new StackPanel();
     var tb = new TextBlock { Text = "请选择您要登录哪个账户：" };
     var cm = new ComboBox();
     foreach (var user in userList)
     {
         // ReSharper disable once PossibleNullReferenceException
         cm.Items.Add(new TextBlock
         {
             Text = user
         });
     }
     cm.SelectedIndex = ;
     sp.Children.Add(tb);
     sp.Children.Add(cm);
     dialog.Content = sp;
     dialog.PrimaryButtonClick += (s, a) =>
     {
         // ReSharper disable once PossibleNullReferenceException
         userName = (cm.SelectedItem as TextBlock).Text;
     };
     dialog.SecondaryButtonClick += (s, a) => { dialog.Hide(); };
     await dialog.ShowAsync();
     return userName;
 }

至此我们的App就支持了使用“凭据保险箱”功能，只要Windows账户一致，不论在什么windows设备上我们都可以做快捷登陆，下面是效果（本机demo的Win账户是公司的账户，和自己的手机上账户不一致，没法演示跨设备，不过我们可以使用删除App重新安装的方式来查看凭据是否被漫游了，答案是肯定的）

推荐一个UWP开发群：53078485 大家可以进来一起学习