Editing Test Day:2023-09-21 Passkey authentication centrally managed users

{{Infobox_group
| name = '''Passkey authentication centrally managed users'''
| image = [[File:test-days-banner.svg|300px|link=QA/Test Days]]
| date = '''2023-09-21'''
| time = all day
| website = [[QA/Test Days]]
| matrix = [https://matrix.to/#/#test-day:fedoraproject.org #test-day:fedoraproject.org]
| irc = [irc://irc.libera.chat/#fedora-test-day #fedora-test-day] ([https://web.libera.chat/#fedora-test-day webirc])
| fedora_mailing_list = test
}}

{{admon/note | Can't make the date? | If you come to this page after the test day is completed, your testing is still valuable, and you can use the information on this page to test, file any bugs you find, and add your results to the results section. If this page is more than a month old when you arrive here, please check the [[QA/Test_Days|current schedule]] and see if a similar but more recent Test Day is planned or has already happened.}}

== What to test? ==

This [[QA/Test Days|Test Day]] will focus on '''[[Changes/Passkey authentication centrally managed users|Passkey authentication for centrally managed users]]'''

== Who's available ==

The following cast of characters will be available testing, workarounds, bug fixes, and general discussion:
* Development - [[User:ipedrosa|ipedrosa]] (ipedrosa), [[User:ftrivino|ftrivino]] (ftrivino), [[User:abbra|abbra]] (abbra), [[User:jstephen|jstephen]] (jstephen)
* Quality Assurance - [[User:Sumantrom|Sumantro Mukherjee]] (sumantrom), [[User:coremodule|Geoffrey Marr]] (coremodule), [[User:kparal|Kamil Paral]] (kparal), [[User:adamw|Adam Williamson]] (adamw)

You can chat with us on [[Communicating and getting help#Matrix_for_interactive_community_support|Matrix]] or [[How to use IRC|IRC]]. See the infobox on top of the page to learn where to join.

== Prerequisite for Test Day == 

* A virtual machine or a bare metal machine
* An installation of Fedora 39 (any Edition or Spin). Make sure to fully update your system. If installing a fresh system, it's recommended to use the latest [https://www.happyassassin.net/nightlies.html nightly image].
* A FreeIPA server using Fedora 39. If you don’t have one you can use the FreeIPA demo server. If that doesn’t suit you, you can also use sssd-ci-containers to set up a set of containers that can be used to test the feature. Follow the instructions in the README to set up the environment.
* USB-based FIDO2 token. We have tested Yubikeys, Token2, SoloKeys, and Google's Titan keys.
* (Some) LDAP knowledge ([https://access.redhat.com/documentation/en-us/red_hat_directory_server/12 link] to general documentation)
* The fido2-tools package (<code># dnf install fido2-tools</code>)

=== Prepared FreeIPA demo server ===

FreeIPA project provides a demo instance to test without installing FreeIPA server. For the purpose of the Fedora 39 Passkey authentication test day, a separate system was set up as Fedora 39 is not released yet. Please connect to the [https://ipa.demo-passkey.freeipa.org/ ipa.demo-passkey.freeipa.org server] to access the demo system, following instructions from [https://www.freeipa.org/page/Demo FreeIPA demo page].

Since passkey authentication is done locally, the tests against FreeIPA demo instance would ideally need to run in a virtual machine that is enrolled against the FreeIPA server. Use `demo-passkey.freeipa.org` as an IPA domain to enroll into.

== How to test? ==

Visit the '''[http://testdays.fedoraproject.org/events/168 results page]''' and click on the column title links to see the tests that need to be run: most column titles are links to a specific test case. Follow the instructions there, then enter your results by clicking the ''Enter result'' button for the test.

== Reporting bugs ==

Perhaps you've found an already-reported bug. Please look at:
* [https://qa.fedoraproject.org/blockerbugs/milestone/39/beta/buglist Fedora 39 Beta blocker bugs]
* [https://qa.fedoraproject.org/blockerbugs/milestone/39/final/buglist Fedora 39 Final blocker bugs]

 A less-preferred alternative is to file them into '''[https://bugzilla.redhat.com Red Hat Bugzilla]''', in most cases against the <code>sssd-passkey</code> component. 

{{admon/tip | We really need bug reports! | Please note that just mentioning your problem into the comments section on the results page is not very helpful. Very often those problems only happen in specific circumstances, or with specific steps taken. We need the logs and screenshots, and we need to be able to ask you followup questions. Please file bug reports, it's much more useful than a short comment. Thank you!}}

When filing the bug, it's very helpful to include:
* exact steps you've performed (and whether you can reproduce it again)
* screenshots or videos, if applicable
* system journal (log), which you can retrieve by <code>journalctl -b > journal.txt</code>
* sssd logs, follow the instructions at [[#How to debug]] section
* all output in a terminal, if started from a terminal
* your system description

If you are unsure about exactly how to file the report or what other information to include, just [[#Who's_available|ask us]].

Please make sure to link to the bug when submitting your test result, thanks!

== Test Results ==

=== Reg Key ===
{| class="wikitable" width=100%
! User
! Profile
! [http://fedoraproject.org/wiki/QA:Testcase_reg_key_sssctl reg key with sssctl]
! [http://fedoraproject.org/wiki/QA:Testcase_reg_key_IPA_command reg key with IPA]
! References
|-
| [[User:mpolovka|mpolovka]]
| 
| {{result|pass}}<ref>Passed with SSH command, kerberos ticket issued</ref>{{result|fail}}<ref>kinit mpolovka@IPA.TEST
kinit: Pre-authentication failed: Invalid argument while getting initial credentials</ref>
| {{result|fail}}<ref>After three incorrect PIN entries, the user is requested to input their password, which is, however, not set up.</ref>
| 
| {{result|pass}}<ref>Enter PIN: <removed the device and input in the PIN>

Please touch the device.
A problem occurred while generating the credentials.
Error registering the key.
Command '/usr/libexec/sssd/passkey_child' failed with [1]
#</ref>
| 
| 
| <references/>
|-
| [[User:spoore|spoore]]
| Fedora-Everything-netinst-x86_64-39-20230920.n.0.iso VM
| {{result|pass}}<ref>kerberos ticket issued with su:
k-sh-5.2$ klist
klist: Credentials cache 'KCM:169000003' not found
-sh-5.2$ su - testuser1
Insert your passkey device, then press ENTER.
Enter PIN:
Last login: Fri Sep 22 14:19:06 CDT 2023 on pts/0
-sh-5.2$ klist
Ticket cache: KCM:169000003:93127
Default principal: testuser1@PASSKEY.TEST

Valid starting       Expires              Service principal
09/22/2023 14:19:29  09/23/2023 14:17:17  krbtgt/PASSKEY.TEST@PASSKEY.TEST
</ref>
| {{result|fail}}<ref>I saw no prompt/message about removing/resetting passkey device.
Removing and re-inserting however did work to allow the user to authenticate with the correct pin.</ref>
| {{result|fail}}<ref>No message was shown about resetting passkey device.  PIN was blocked though and I reset device with "ykman fido reset".   A proper unblock procedure should be listed in the test case to make this easier to perform.</ref>
| {{result|fail}}<ref>for my tests, I did not see the system exit either su or ssh when the key was removed.  I am using a VM though with the usb device shared.</ref>
| 
| 
| <references/>
|-
| [[User:sumenon|sumenon]]
| Unchecked 'Passkey' option for the ipauser1 and then login with ssh
| 
| 
| 
| 
| 
| {{result|pass}}<ref>/var/log/sssd/passkey_child.log
(2023-09-21 18:39:39): [passkey_child[8087]] [authenticate] (0x0400): Getting assert.
(2023-09-21 18:39:40): [passkey_child[8087]] [request_assert] (0x0040): fido_dev_get_assert failed [52]: FIDO_ERR_PIN_AUTH_BLOCKED.

[sumenon@fedora ~]$ ssh -l ipauser1@fedora39.test client.fedora39.test
(ipauser1@fedora39.test@client.fedora39.test) Kerberos TGT will not be granted upon login, user experience will be affected.
Insert your passkey device, then press ENTER.
</ref>
| <references/>

|-
|}

== Tips ==

=== How to set a PIN ===

When using a passkey it’s highly recommended to set a PIN (by default it’s mandatory in IPA). To achieve this, the first step is to list the FIDO2 keys connected to the system:

<code># fido2-token -L</code>

Then, the PIN can be set. In the following example the device is /dev/hidraw5.

<code># fido2-token -C /dev/hidraw5</code>

=== Enabling passkey authentication for an IPA user ===

Enable passkey authentication for a new IPA user:

<code># ipa user-add user01 --first=user --last=01 --user-auth-type=passkey</code>

Enable passkey authentication for existing IPA user:

<code># ipa user-mod user01 --first=user --last=01 --user-auth-type=passkey</code>

=== How to register a passkey ===

==== LDAP ====

The first step to use a passkey would be to register it. This is achieved by running the sssctl and providing the username and domain. Example:

<code># sssctl passkey-register --username=joe --domain=ldap.test</code>

This will output the key mapping data, which includes the key handle and the public key. Example:

<code>passkey:aEgemlnC6a/WOoEZ8qU1YMwsTW9+uwmMsJnrgOXwTID0qIBHirzHp6d+e1d3WBhcSf7t9Ji8fl3AdSPtlbdN5Q==,MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENwDQHwyZmnYaUEp0UNqqnw0tGOGnqOMBGdds6O3+JKbmmJGTn0vo7sKNNcDWDsFhJFU/RLWXmHXglxSo+yw9iQ==</code>

This information needs to be included in the user’s attributes in the LDAP server. Example:

<code>
dn: uid=joe,dc=ldap,dc=test<br>
mail: joe@ldap.test<br>
...<br>
passkey: passkey:aEgemlnC6a/WOoEZ8qU1YMwsTW9+uwmMsJnrgOXwTID0qIBHirzHp6d+e1d3WBhcSf7t9Ji8fl3AdSPtlbdN5Q==,MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENwDQHwyZmnYaUEp0UNqqnw0tGOGnqOMBGdds6O3+JKbmmJGTn0vo7sKNNcDWDsFhJFU/RLWXmHXglxSo+yw9iQ==<br>
objectclass: passkeyUser
</code>

At this point everything is ready to login.

==== IPA ====

IPA provides a single command to register the passkey and store it in the LDAP attribute by providing the username:

<code># ipa user-add-passkey joe --register</code>

Follow the application prompts:

<code>
Enter PIN for the passkey device.
Touch the device to verify it is you.
</code>

At this point everything is ready to login.

=== How to login ===

You can use your favourite login mechanism, as an example let’s try with “su”:

<code>
$ su - joe@ipa.test<br>
Insert your passkey device, then press ENTER.<br>
Enter PIN:
</code>

Confirm the Kerberos ticket is issued:
<code>
$ klist<br>
Default principal: user01@IPA.EXAMPLE.COM
</code>

=== How to debug ===

==== sssctl ====

If the sssctl command fails, and you’d like to debug it, you can append the following options to print all the information in the terminal: <code>--debug-level=9 --logger=stderr</code>

==== sssd ====

The easiest way to debug sssd is to enable the debug levels. This can be done by tuning <code>/etc/sssd/sssd.conf</code>, and setting “debug_level=9” below “[sssd]”. Example:

<code>
[sssd]<br>
…<br>
debug_level=9
</code>

Log files are availabe at <code>/var/log/sssd</code>.

=== HW enablement ===
Most of the FIDO2 keys are supported in Fedora out of the box, but some aren’t. The reason is that, by default and for security reasons, USB dongles can't be accessed by users.

In order to enable the key in your system run <code>lsusb</code> and identify your device. Then, create a file in <code>/etc/udev/rules.d</code> with the following content:

<code>
ACTION!="add|change", GOTO="fido2_end"

KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="XXXX", ATTRS{idProduct}=="XXXX", TAG+="uaccess", GROUP="plugdev", MODE="0660"

LABEL="fido2_end"
</code>

Replace the XXXX with the information provided by <code>lsusb</code>.

Reload udev rules:

<code># udevadm control --reload-rules</code>

<code># udevadm trigger</code>




[[Category:Fedora 39 Test Days]]