Skip to content

DOC-479: add setup FIPS tips #1757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

DOC-479: add setup FIPS tips #1757

wants to merge 9 commits into from

Conversation

amandalindsay
Copy link
Contributor

Added FIPS setup troubleshooting tips to address support issue: https://hazelcast.atlassian.net/browse/SUP-897
See Docs ticket: DOC-479.
OlgaS kindly supplied the fix, and feedback on the supporting docs

@amandalindsay amandalindsay requested a review from shultseva July 10, 2025 09:49
Copy link

netlify bot commented Jul 10, 2025

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit 7c6ddfa
🔍 Latest deploy log https://app.netlify.com/projects/hardcore-allen-f5257d/deploys/68765f189edd880008f2c76a
😎 Deploy Preview https://deploy-preview-1757--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@amandalindsay amandalindsay marked this pull request as ready for review July 14, 2025 14:26
@amandalindsay amandalindsay requested a review from a team as a code owner July 14, 2025 14:26
Copy link
Contributor

@Rob-Hazelcast Rob-Hazelcast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, but I suspect this could be more helpful with a little more detail.

Unless it's very basic or relating to third-party technologies, it isn't sufficient to tell users to do something, we need to tell them how. Especially when it comes to troubleshooting. Doesn't need much - might be as simple as referencing parameter names from earlier in this section.

@@ -222,3 +222,58 @@ For the
information, e.g., `TLSv1.3`. It ensures the engine won't allow a fallback to an old, insecure version.

* `validateIdentity`: Flag which allows enabling endpoint identity validation. It means, during the TLS handshake client verifies if the server's hostname (or IP address) matches the information in X.509 certificate (Subject Alternative Name extension). Possible values are `"true"` and `"false"` (default).

== Troubleshooting FIPS setup
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would fit better in security/fips-140-2. Most users of this section won't be interested in FIPS; 100% of users of that section will be. It's already linked from the relevant config field here.

Maybe sub-headings, a bulleted list or a table would make it a bit easier to read too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shultseva Where is this information best located for readers: in the advanced security/fips-140-2 section, or where it currently is in integrating Open/BoringSSL?


To ensure the correct library is used, specify the platform-specific netty-tcnative jar file. For example, for aarch_64:

`netty-tcnative-2.0.69.Final-linux-aarch_64.jar`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where do you specify this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let @shultseva comment and, if necessary, provide more information beyond what's in the support ticket.


**Resolution**

Switch to BCFKS for the keystore and truststore to resolve the problem.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let @shultseva comment and, if necessary, provide more information beyond what's in the support ticket.


**Resolution**

Try adding the export option to the Java command. One method is to include the following in your Java command to allow access to internal classes:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What Java command? The rest of this section is all file-based configuration.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let @shultseva comment and, if necessary, provide more information beyond what's in the support ticket.

amandalindsay and others added 2 commits July 15, 2025 14:54
Co-authored-by: Rob Swain <rob.swain@hazelcast.com>
Co-authored-by: Rob Swain <rob.swain@hazelcast.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants