Add Liberty documentation for HSM configuration (for FIPS 140-3 & PQC readiness)

Aperta
  • Qualcosa non va?
#8,336 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
java
Ambito
documentation, security

Direzione di ricerca

Inizia esaminando il README e i passaggi di configurazione del repository collegato HSM_ConfigSteps_Liberty_Distributed_For_Review, quindi confrontali con le due pagine di supporto IBM z/OS indicate. Adatta il materiale esaminato alla documentazione Liberty relativa all’integrazione di HSM per gli ambienti distribuiti e z/OS, inclusi i passaggi di configurazione Java richiesti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Description

Currently, IBM Liberty documentation does not include guidance for configuring Hardware Security Modules (HSMs), which is becoming increasingly important for modern security requirements.
With the push toward:
FIPS 140-3 compliance (driving increased need for high-performance cryptographic processing), and
Post-Quantum Cryptography (PQC) readiness, aligned with IBM’s strategic direction,

It is essential that Liberty provides clear, supported documentation for integrating with modern hardware crypto devices. Modern HSMs are capable of efficiently supporting both FIPS 140-3 and PQC-ready algorithms. Providing official documentation will help customers adopt these capabilities proactively.

The HSM configuration steps include Java-related configuration steps required for proper integration with Liberty runtimes. I would like to review this content with the documentation team to determine whether it fits within IBM Docs. If it does not, I plan to publish the material as a Technote and/or community blog. In either case, I am opening this issue to both engage the doc team and retain the information here for reference.

Proposal

Create a new Liberty documentation section that covers:

  • HSM integration and configuration steps
  • Guidance for both Liberty on distributed and z/OS environments

Reference Material

A customer-validated and approved draft of the configuration steps for Liberty on distributed is available here:
👉 https://github.com/una-tapa/HSM_ConfigSteps_Liberty_Distributed_For_Review
The WAS on z/OS support team vaidated the following steps with multiple customers:
👉 Enabling hardware cryptography for Liberty for z/OS using Java 8
👉Enabling hardware cryptography for Liberty for z/OS using Java 11, Java 17, or Java 21
The README in this repository provides important background.

The content has been reviewed and approved by a customer for Community & OpenLiberty blog
The contributing customer wishes to remain anonymous

Notes

This is not a net-new requirement; it has been missing from Liberty documentation to date
The referenced material can be generalized and adapted for official Liberty documentation
Since the customer used Luna HSM device, the next steps for IBM doc would be:

  • The doc team to review the referenced repository content
  • Generalize and adapt into Liberty documentation format
Lingua principale
Nessun dato sulla lingua
Stelle
14
Fork
58
Merge medio
1h
PR unite (30g)
25

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenLiberty/docs

Tutte le issue di OpenLiberty/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.