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

未关闭
  • 哪里不对？
#8,336 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
java
领域
documentation, security

调研方向

首先查看所链接的 HSM_ConfigSteps_Liberty_Distributed_For_Review repository 中的 README 和配置步骤，然后将其与所引用的两个 IBM z/OS 支持页面进行比较。将审阅后的材料整理为涵盖 distributed 和 z/OS 环境中 HSM 集成的 Liberty 文档，其中包括所需的 Java 配置步骤。

由索引模型根据 Issue 内容生成。

描述

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
主要语言
没有语言数据
星标
14
派生
58
平均合并
1 小时
30 天内合并 PR
25

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

OpenLiberty/docs 的其他 Issue

查看 OpenLiberty/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。