Skip to content

Commit b60bf3f

Browse files
committed
added YubiKey for Android
1 parent 92bcd21 commit b60bf3f

File tree

2 files changed

+103
-14
lines changed

2 files changed

+103
-14
lines changed

articles/active-directory/authentication/concept-certificate-based-authentication-mobile-android.md

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ services: active-directory
66
ms.service: active-directory
77
ms.subservice: authentication
88
ms.topic: how-to
9-
ms.date: 10/05/2022
9+
ms.date: 10/27/2022
1010

1111
ms.author: justinha
1212
author: vimrang
@@ -61,6 +61,99 @@ Certain Exchange ActiveSync applications on Android 5.0 (Lollipop) or later are
6161

6262
To determine if your email application supports Azure AD CBA, contact your application developer.
6363

64+
## Support for certificates on hardware security key (preview)
65+
66+
Certificates can be provisioned in external devices like hardware security keys along with a PIN to protect private key access. Azure AD supports CBA with YubiKey.
67+
68+
### Advantages of certificates on hardware security key
69+
70+
Security keys with certificates:
71+
72+
- Has the roaming nature of security key, which allows users to use the same certificate on different devices
73+
- Are hardware-secured with a PIN, which makes them phishing-resistant
74+
- Provide multifactor authentication with a PIN as second factor to access the private key of the certificate
75+
- Satisfy the industry requirement to have MFA on separate device
76+
- Help in future proofing where multiple credentials can be stored including Fast Identity Online 2 (FIDO2) keys.
77+
78+
### Steps to test YubiKey on Microsoft apps on Android
79+
80+
1. Install the latest Microsoft Authenticator app.
81+
1. Open Outlook and plug in your YubiKey.
82+
1. Select **Add account** and enter your user principal name (UPN).
83+
1. Click **Continue**. A dialog should immediately pop up asking for permission to access your YubiKey. Click **OK**.
84+
1. Select **Use Certificate or smart card**. A custom certificate picker will appear.
85+
1. Select the certificate associated with the user’s account. Click **Continue**.
86+
1. Enter the PIN to access YubiKey and select **Unlock**.
87+
88+
The user should be successfully logged in and redirected to the Outlook homepage.
89+
90+
>[!NOTE]
91+
>For a smooth CBA flow, plug in YubiKey as soon as the application is opened and accept the consent dialog from YubiKey before selecting the link **Use Certificate or smart card**.
92+
93+
### Troubleshoot certificates on hardware security key
94+
95+
#### What will happen if the user has certificates both on the Android device and YubiKey?
96+
97+
- If the user has certificates both on the android device and YubiKey, then if the YubiKey is plugged in before user clicks **Use Certificate or smart card**, the user will be shown the certificates in the YubiKey.
98+
- If the YubiKey is not plugged in before user clicks **Use Certificate or smart card**, the user will be shown all the certificates on the device. The user can **Cancel** the certificate picker, plug in the YubiKey, and restart the CBA process with YubiKey.
99+
100+
#### My YubiKey is locked after incorrectly typing PIN three times. How do I fix it?
101+
102+
- Users should see a dialog informing you that too many PIN attempts have been made. This dialog also pops up during subsequent attempts to select **Use Certificate or smart card**.
103+
- [YubiKey Manager](https://www.yubico.com/support/download/yubikey-manager/) can reset a YubiKey’s PIN.
104+
105+
#### I have installed Microsoft authenticator but still do not see an option to do Certificate based authentication with YubiKey
106+
107+
Before installing Microsoft Authenticator, uninstall Company Portal and install it after Microsoft Authenticator installation.
108+
109+
#### Does Azure AD CBA support YubiKey via NFC?
110+
111+
This feature currently only supports using YubiKey with USB and not NFC. We are working to add support for NFC.
112+
113+
#### Once CBA fails, clicking on the CBA option again in the ‘Other ways to signin’ link on the error page fails.
114+
115+
This issue happens because of certificate caching. We are working to add a fix to clear the cache. As a workaround, clicking cancel and restarting the login flow will let the user choose a new certificate and successfully login.
116+
117+
#### Azure AD CBA with YubiKey is failing. What information would help debug the issue?
118+
119+
1. Open Microsoft Authenticator app, click the three dots icon in the top right corner and select **Send Feedback**.
120+
1. Click **Having Trouble?**.
121+
1. For **Select an option**, select **Add or sign into an account**.
122+
1. Describe any details you want to add.
123+
1. Click the send arrow in the top right corner. Note the code provided in the dialog that appears.
124+
125+
### Known Issues
126+
127+
- Sometimes, plugging in the YubiKey and providing permission via the permission dialog and clicking **Use Certificate or smart card** will still take the user to on-device CBA picker pop up (instead of the smart card CBA picker). The user will need to cancel out of the picker, unplug their key, and re-plugin their key before attempting to sign in again.
128+
- With the Most Recently Used (MRU) feature, once a user uses CBA for authentication, MRU auth method will be set to CBA. Since the user will be directly taken into CBA flow, there may not be enough time for the user to accept the Android USB consent dialog. As a workaround user needs to remove and re-plugin the YubiKey, accept the consent dialog from YubiKey then click the back button and try again to complete CBA authentication flow.
129+
- Azure AD CBA with YubiKey on latest Outlook and Teams fail at times. This could be due to a keyboard configuration change when the YubiKey is plugged in. This can be solved by:
130+
- Plug in YubiKey as soon as the application is opened.
131+
- Accept the consent dialog from YubiKey before selecting the link **Use Certificate or smart card**.
132+
133+
### Supported platforms
134+
135+
- Applications using the latest Microsoft Authentication Library (MSAL) or Microsoft Authenticator can do CBA
136+
- Microsoft first-party apps with latest MSAL libraries or Microsoft Authenticator can do CBA
137+
138+
#### Supported operating systems
139+
140+
|Operating system | Certificate on-device/Derived PIV | Smart cards |
141+
|:----------------|:---------------------------------:|:---------------------:|
142+
| Android | ✅ | Supported vendors only|
143+
144+
#### Supported browsers
145+
146+
|Operating system | Chrome certificate on-device | Chrome smart card | Safari certificate on-device | Safari smart card | Edge certificate on-device | Edge smart card |
147+
|:----------------|:---------------------------------:|:---------------------:|:---------------------------------:|:---------------------:|:---------------------------------:|:---------------------:|
148+
| Android | ✅ | ❌|N/A | N/A | ❌ | ❌|
149+
150+
### Security key providers
151+
152+
|Provider | Android |
153+
|:-------------------|:------------------------------:|
154+
| YubiKey | ✅ |
155+
156+
64157
## Next steps
65158

66159
- [Overview of Azure AD CBA](concept-certificate-based-authentication.md)

articles/active-directory/authentication/concept-certificate-based-authentication-mobile-ios.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,10 @@ Certificates can be provisioned in external devices like hardware security keys
9292
Security keys with certificates:
9393

9494
- Can be used on any device, and don't need a certificate to be provisioned on every device the user has
95-
9695
- Are hardware-secured with a PIN, which makes them phishing-resistant
97-
9896
- Provide multifactor authentication with a PIN as second factor to access the private key of the certificate
99-
10097
- Satisfy the industry requirement to have MFA on separate device
101-
102-
- helps in future proofing where multiple credentials can be stored including FIDO2 (Fast Identity Online 2) keys.
98+
- Help in future proofing where multiple credentials can be stored including Fast Identity Online 2 (FIDO2) keys
10399

104100
### One-time registration prerequisite
105101

@@ -119,34 +115,34 @@ Security keys with certificates:
119115

120116
The user should be successfully logged in and redirected to the Outlook homepage.
121117

122-
## Troubleshoot certificates on hardware security key
118+
### Troubleshoot certificates on hardware security key
123119

124-
### What will happen if the user has certificates both on the iOS device and YubiKey?
120+
#### What will happen if the user has certificates both on the iOS device and YubiKey?
125121

126122
The iOS certificate picker will show all the certificates on both iOS device and the ones copied from YubiKey into iOS device. Depending on the certificate user picks they will be either taken to YubiKey authenticator to enter PIN or directly authenticated.
127123

128-
### My YubiKey is locked after incorrectly typing PIN 3 times. How do I fix it?
124+
#### My YubiKey is locked after incorrectly typing PIN 3 times. How do I fix it?
129125

130126
- Users should see a dialog informing you that too many PIN attempts have been made. This dialog also pops up during subsequent attempts to select **Use Certificate or smart card**.
131127
- [YubiKey Manager](https://www.yubico.com/support/download/yubikey-manager/) can reset a YubiKey’s PIN.
132128

133-
### Once CBA fails, clicking on the CBA option again in the ‘Other ways to signin’ link on the error page fails.
129+
#### Once CBA fails, clicking on the CBA option again in the ‘Other ways to signin’ link on the error page fails.
134130

135131
This issue happens because of certificate caching. We are working to add a fix to clear the cache. As a workaround, clicking cancel and restarting the login flow will let the user choose a new certificate and successfully login.
136132

137-
### Azure AD CBA with YubiKey is failing. What information would help debug the issue?
133+
#### Azure AD CBA with YubiKey is failing. What information would help debug the issue?
138134

139135
1. Open Microsoft Authenticator app, click the three dots icon in the top right corner and select **Send Feedback**.
140136
1. Click **Having Trouble?**.
141137
1. For **Select an option**, select **Add or sign into an account**.
142138
1. Describe any details you want to add.
143139
1. Click the send arrow in the top right corner. Note the code provided in the dialog that appears.
144140

145-
### How can I enforce phishing-resistant MFA using a hardware security key on browser-based applications on mobile?
141+
#### How can I enforce phishing-resistant MFA using a hardware security key on browser-based applications on mobile?
146142

147-
Certificate based authentication + Conditional access auth strength capability makes it powerful for customers to enforce authentication needs. Edge as a profile (add an account) will work with a hardware security key like YubiKey and conditional access policy with authentication strength capability can enforce phishing resistant authentication with CBA
143+
Certificate based authentication and Conditional Access authentication strength capability makes it powerful for customers to enforce authentication needs. Edge as a profile (add an account) will work with a hardware security key like YubiKey and conditional access policy with authentication strength capability can enforce phishing-resistant authentication with CBA.
148144

149-
CBA support for YubiKey is available in the latest MSAL (Microsoft Authentication Library) libraries, any third-party application that integrates the latest MSAL as well as all Microsoft first party applications can leverage CBA + CA Auth strength.
145+
CBA support for YubiKey is available in the latest Microsoft Authentication Library (MSAL) libraries, any third-party application that integrates the latest MSAL, and all Microsoft first party applications can leverage CBA and Conditional Access authentication strength.
150146

151147
### Supported operating systems
152148

0 commit comments

Comments
 (0)