Skip to content

Created wolfSSL FIPS FAQ #198

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
Binary file not shown.
Binary file added wolfBoot/.DS_Store
Binary file not shown.
Binary file added wolfCLU/.DS_Store
Binary file not shown.
Binary file added wolfCrypt-JNI/.DS_Store
Binary file not shown.
Binary file added wolfEngine/.DS_Store
Binary file not shown.
Binary file added wolfHSM/.DS_Store
Binary file not shown.
Binary file added wolfMQTT/.DS_Store
Binary file not shown.
Binary file added wolfProvider/.DS_Store
Binary file not shown.
Binary file added wolfSSH/.DS_Store
Binary file not shown.
Binary file added wolfSSL-FAQ/.DS_Store
Binary file not shown.
22 changes: 22 additions & 0 deletions wolfSSL-FIPS-FAQ/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
-include ../common/common.am
.DEFAULT_GOAL := all
all: pdf html

SOURCES = section01.md \
section02.md

ifeq ($(DOC_LANG),JA)
PDF = wolfSSL-FIPS-FAQ-jp.pdf
else
PDF = wolfSSL-FIPS-FAQ.pdf
endif

DOXYFILE = Doxyfile


.PHONY: html-prep
html-prep:

.PHONY: pdf-prep
pdf-prep:

21 changes: 21 additions & 0 deletions wolfSSL-FIPS-FAQ/header.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
% wolfSSL FIPS FAQ ![](logo.png)

---
header-includes:
# Blank pages on new sections
- \usepackage{titlesec}
- \newcommand{\sectionbreak}{\clearpage}
# Fancy page headers
- \usepackage{fancyhdr}
- \pagestyle{fancy}
- \fancyfoot[LO,RE]{COPYRIGHT \copyright 2025 wolfSSL Inc.}
# Wrap long syntax highlighting code blocks
- \usepackage{fvextra}
- \DefineVerbatimEnvironment{Highlighting}{Verbatim}{breaklines,commandchars=\\\{\}}
# Wrap long non-sytax highlighted code blocks
- \usepackage{listings}
- \let\verbatim\undefined
- \let\verbatimend\undefined
- \lstnewenvironment{verbatim}{\lstset{breaklines,basicstyle=\ttfamily}}{}
subparagraph: yes
---
25 changes: 25 additions & 0 deletions wolfSSL-FIPS-FAQ/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
site_name: wolfSSL FIPS FAQ
site_url: https://wolfssl.com/
docs_dir: build/html/
site_dir: html/
copyright: Copyright © 2025 wolfSSL Inc.
nav:
- "1. Introduction": index.md
- "2. FAQ": section02.md
theme:
name: null
custom_dir: ../mkdocs-material/material
language: en
palette:
primary: indigo
accent: indigo
font:
text: roboto
code: roboto mono
icon: "logo.png"
logo: logo.png
favicon: logo.png
feature:
tabs: true
extra_css: [skin.css]
use_directory_urls: false
14 changes: 14 additions & 0 deletions wolfSSL-FIPS-FAQ/src/section01.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Introduction

This page lists some of the most common issues and questions that are recieved by our wolfSSL security experts, along with their responses. This FAQ is useful for solving general questions that pertain to building/implementing wolfSSL FIPS. If this page does not provide an answer toyour question, please feel free to check the wolfSSL Manual, or contact us at [email protected].
Copy link
Member

Choose a reason for hiding this comment

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

toyour should be to your


## Questions

1. [Why did I receive wolfSSL_X.X.X_commercial-fips-OE-v2.7z when we validated with Y.Y.Y?](./section02.md#why-did-i-receive-wolfssl-xxx-xommercial-fips-oe-v27z-when-we=validated-with-yyy)
2. [How do I know if I am using the FIPS module?](./section02.md#how-do-i-if-i-am-using-the-fips-module)
3. [Does the Power On Self Test (POST) really have to run every time?](./section02.md#does-the-power-on-self-test-post-really-have-to-run-every-teime)
4. [Followup POST Q: What about this feature NO_Followup POST Q: What about this feature NO_ATTRIBUTE_CONSTRUCTOR? Can I use that to by-pass the POST by not running it in the constructor?](./section02.md#followup-post-q-what-about-this-feature-no-attribute-constructor-can-i-use-that-to-by-pass-the-post-by-not-running-it-in-the-constructor)
Copy link
Member

Choose a reason for hiding this comment

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

Remove duplicate Followup POST Q: What about this feature NO_.

Also, questions 4-7 are sub-items of number 3. I don't think 4-7 should be listed here, and just be inside the text section for 3.

5. [Followup POST Q: Why is the feature NO_ATTRIBUTE_CONSTRUCTOR there then if I can not use it?](./section02.md#followup-post-q-why-is-the-feature-no-attribute-constructor-there-then-if-i-can-not-use-it)
6. [Followup POST Q: Who can determine when NO_ATTRIBUTE_CONSTRUCTOR is allowed?](./section02.md#followup-post-q-who-can-determine-when-no-attribute-constructor-is-allowed)
7. [Followup POST Q: What about with fips-ready, can I use NO_ATTRIBUTE_CONSTRUCTOR with fips-ready?](./section02.md#followup-post-q-what-about-with-fips-ready-can-i-use-no-attribute-constructor-with-fips-ready)
8. [WhatWhat can go wrong for the end user after basic testing?](./section02.md#what-can-go-wrong-for-the-end-user-after-basic-testing)
Copy link
Member

Choose a reason for hiding this comment

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

Remove duplicate What at beginning of list item

323 changes: 323 additions & 0 deletions wolfSSL-FIPS-FAQ/src/section02.md

Large diffs are not rendered by default.

Binary file added wolfSSL-FIPS-Ready/.DS_Store
Binary file not shown.
Binary file added wolfSSL-JNI/.DS_Store
Binary file not shown.
Binary file added wolfSSL-Porting/.DS_Store
Binary file not shown.
Binary file added wolfSSL-Tuning/.DS_Store
Binary file not shown.
Binary file added wolfSSL/.DS_Store
Binary file not shown.
Binary file added wolfSentry/.DS_Store
Binary file not shown.
Binary file added wolfTPM/.DS_Store
Binary file not shown.