Editing Test Day:Test Day:2024-07-09 IPA HSM

<!-- Make sure the pages is named as "Test Day:YYYY-MM-DD topic" -->

{{Infobox_group
| name = IPA HSM Test DAy
| image = [[File:test-days-banner.svg|300px|link=QA/Test Days]]
| date = 2024-07-09 to 2024-07-11
<!-- The testdays app will parse this, so please make sure to have it in format 'date = YYYY-MM-DD' or 'date = YYYY-MM-DD to YYYY-MM-DD' -->
| time = all day
| website = [[QA/Test Days]]
| matrix = {{matrix|#test-day:fedoraproject.org}}
| 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? ==

<!-- Describe in detail what this test day is about and why would users want to participate in it. What makes this interesting for them? What's new and exciting in your software or a feature? -->

This [[QA/Test Days|Test Day]] will focus on '''FreeIPA HSM'''

== Who's available ==

The following cast of characters will be available testing, workarounds, bug fixes, and general discussion:
* Development - [[User:Developer1|rcritten]] (rcritten)

You can chat with me on [https://docs.fedoraproject.org/en-US/project/communications/ Matrix]. 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 40 (ideally Server). 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].

== What to test ==

This will focus on testing IPA support for generating and storing CA private keys on a Hardware Security Module (HSM).

There are two supported HSMs: the nCipher nShield Connect XC (High) and the Thales TCT Luna Network HSM Luna-T7. Firmware versions can vary so only specific ones are supported.

Using softhsm2 as an HSM is usable for testing. It is not recommended for production because it is not a truly networked HSM and the private keys live on a file system (protected yes but not at a hardware level). Because it is not networked, users will need to carefully synchronize the token files whenever any private key generation is done to ensure the contents are identical.

== How to test? ==

=== Install freeIPA packages ===
# dnf -y install freeipa-server-dns

=== Pre-configure the HSM ===

If you are using softhsm2, grant read access to the tokens: 

  # usermod pkiuser -a -G ods

=== Set up environment variables on each machine/VM ===

  # export TOKEN_PASSWORD=password
  # export ADMIN_PASSWORD=password
  # export DM_PASSWORD=password

If using a supported hardware HSM ensure that it is working properly and have the token name and PKCS#11 library path handy.

=== In between tests ===

To re-use test machines in between installations:

On replica (if there is one)
  # ipa server-del $HOSTNAME
  # ipa-server-install –uninstall -U

On the initial IPA server

  # ipa-server-install –uninstall -U

If using softhsm2 you will also need to delete and re-create the token. To delete the token:

  # softhsm2-util --delete-token --token ipa_token

This should return the machine(s) to the pre-installed state.

Visit the '''[http://testdays.fedoraproject.org/events/191 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 ==

<!--
If there are multiple places where to report bugs (e.g. general GNOME bugs go into upstream GNOME GitLab, and only packaging issues or non-GNOME bugs go to Red Hat Bugzilla), mention it and advise users where to file which issues.
-->

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

All new bugs should be reported into the [https://pagure.io/freeipa/issues upstream bug tracker]. A less-preferred alternative is to file them into [https://issues.redhat.com Red Hat JIRA], in most cases against the <code>ipa</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>
* 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 ==

Visit the '''[http://testdays.fedoraproject.org/events/191 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.

=== Basic ===
{| class="wikitable" width=100%
! User
! Profile
! [http://fedoraproject.org/wiki/QA:Testcase_basicIPA_with_HSM basicIPAwithHSM]
! [http://fedoraproject.org/wiki/QA:Testcase_IPA_server_replica_HSM IPA server with replica HSM]
! References
|-
| [[User:felipetg|felipetg]]
| VM using Fedora Rawhide (latest iso available)
| {{result|fail}}<ref>Issue 9623 created</ref>
| 
| <references/>
|-
| [[User:sumenon|sumenon]]
| 
| {{result|pass}}{{result|pass}}<ref>Ignore https://pagure.io/freeipa/issue/9622</ref>{{result|fail}}<ref>https://pagure.io/freeipa/issue/9622</ref>
| {{result|pass}}
| <references/>

|-
|}

=== Key Recovery Authority (KRA) ===
{| class="wikitable" width=100%
! User
! Profile
! [http://fedoraproject.org/wiki/QA:Testcase_Install_IPA_with_KRA IPA with KRA]
! [http://fedoraproject.org/wiki/QA:Testcase_Install_IPA_Server_replica_with_KRA IPA Server replica with KRA]
! References
|-
| [[User:sumenon|sumenon]]
| Fedora41
| {{result|pass}}<ref>KRA install is successful with the --token-password and --token-name option.
ipatoken: storageCert(u,u,u), auditSigningCert(u,u,Pu), transportCert(u,u,u), subsystemCert(u,u,u) are listed using 'certutil -L -d /etc/pki/pki-tomcat/alias -h ipa_token'
Vault can be added, data can be archived and retrieved.
</ref>
| {{result|pass}}<ref>Installation of Replica prompts 'Enter Password or Pin for "ipa_token": 
The TOKEN_PASSWORD is already specified in the command.
https://pagure.io/freeipa/issue/9603</ref>
| <references/>

|-
|}

=== Certificate Reissue ===
{| class="wikitable" width=100%
! User
! Profile
! [http://fedoraproject.org/wiki/QA:Testcase_Install_IPA_HSM_renew_cert Outisde grace period]
! [http://fedoraproject.org/wiki/QA:Testcase_Install_IPA_HSM_renew_cert_within_grace Within grace period]
! References
|-
| [[User:sumenon|sumenon]]
| Fedora41
| {{result|pass}}<ref>IPA certs expire in 2years
Current Date: Thu Jul 11 02:44:31 PM IST 2024
Cert Expires: 2026-07-01 14:32:04 IST
Modified Time: date -s +1years+11months+20days, Wed Jul  1 02:45:06 PM IST 2026
root@server:~# ipa-cert-fix
Becoming renewal master.
Restarting IPA
The ipa-cert-fix command was successful
getcert list | grep status -- the certificates go through different states  and finally in MONITORING state.
Certificates (excluding the CA cert) are re-issued correctly when expired.
</ref>
| {{result|pass}}<ref>ALL Certs are VALID and in MONTORING State after certmonger renews them.</ref>{{result|pass}}<ref>For this test the system date is to be moved within 30 days of expiration to test that certmonger would renew things.
Seeing ca-error: Server at "http://server.fedora41.test:8080/ca/ee/ca/profileSubmit" replied: access denied ("java.io.FilePermission" "/var/lib/pki/pki-tomcat/logs/ca" "read") which is known issue for pki.
Current Date: Wed Jul 10 07:13:59 PM IST 2024
Certs Expire: 2026-06-30 12:02:08 IST 
Modified Date: date -s 'Wed Jun 07 06:54:58 PM IST 2026'
Restart ipactl.





</ref>
| <references/>

|-
|}

 


<!--
If you're not using TestDays app for submitting test results, and want to let users input results directly into wiki, here's an example results table:
{|
! User
! [[QA:Testcase_example_1|Example test 1]]
! [[QA:Testcase_example_2|Example test 2]]
! [[QA:Testcase_example_3|Example test 3]]
! [[QA:Testcase_example_4|Example test 4]]
! References
|-
| [[User:ExampleUser|Example User]]
| {{result|none}} 
| {{result|pass}}
| {{result|warn}} <ref>Test pass, but also encountered {{bz|54321}}</ref>
| {{result|fail}} <ref>{{bz|12345}}</ref>
| <references/>
|-
|}
-->

<!-- uncomment this line when creating a real Test Day
[[Category:Fedora 41 Test Days]]
-->

<!-- remove the line below when creating a real Test Day -->
[[Category:QA Templates]]