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

Đang mở
  • Có gì không ổn?
#8,336 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
java
Lĩnh vực
documentation, security

Hướng nghiên cứu

Bắt đầu bằng việc xem xét README và các bước cấu hình trong repository HSM_ConfigSteps_Liberty_Distributed_For_Review được liên kết, sau đó so sánh chúng với hai trang hỗ trợ IBM z/OS được tham chiếu. Điều chỉnh tài liệu đã xem xét thành tài liệu Liberty về tích hợp HSM cho các môi trường distributed và z/OS, bao gồm các bước cấu hình Java bắt buộc.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
14
Fork
58
Merge trung bình
1 giờ
Pull request đã merge (30 ngày)
25

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của OpenLiberty/docs

Tất cả issue của OpenLiberty/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.