Skip to content

Commit 9505e50

Browse files
cconloncconlon
authored
Merge pull request #202 from ShizukaIshikiriyama/fixerror
Add wolfSSL FIPS FAQ
2 parents 1713527 + 2e57dc0 commit 9505e50

File tree

6 files changed

+432
-1
lines changed

6 files changed

+432
-1
lines changed

‎Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ endif
66
# Handy debugging trick: `DOCKER_CMD_EXTRA_ARGS="--progress=plain" make` to see all the output
77
DOCKER_CMD=DOCKER_BUILDKIT=1 docker build $(DOCKER_CMD_EXTRA_ARGS) -t doc_build --build-arg MANPATH=$(MANPATH) --build-arg PDFFILE=$(PDFFILE) --build-arg V=$(V) --target=manual --output=build -f Dockerfile .
88

9-
all: wolfssl wolfssh wolfboot wolfclu wolfcrypt-jni wolfmqtt wolfsentry wolfssl-jni wolftpm wolfhsm wolfengine wolfprovider fips-ready tuning porting faq
9+
all: wolfssl wolfssh wolfboot wolfclu wolfcrypt-jni wolfmqtt wolfsentry wolfssl-jni wolftpm wolfhsm wolfengine wolfprovider fips-ready tuning porting faq fips-faq
1010

1111
build:
1212
$(Q)mkdir -p build
@@ -107,5 +107,11 @@ faq: PDFFILE=wolfSSL-FAQ.pdf
107107
faq: build
108108
@$(DOCKER_CMD)
109109

110+
.PHONY: fips-faq
111+
fips-faq: MANPATH=wolfSSL-FIPS-FAQ
112+
fips-faq: PDFFILE=wolfSSL-FIPS-FAQ.pdf
113+
fips-faq: build
114+
@$(DOCKER_CMD)
115+
110116
clean:
111117
$(Q)rm -rf build

‎wolfSSL-FIPS-FAQ/Makefile

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
-include ../common/common.am
2+
.DEFAULT_GOAL := all
3+
all: pdf html
4+
5+
SOURCES = section01.md \
6+
section02.md
7+
8+
ifeq ($(DOC_LANG),JA)
9+
PDF = wolfSSL-FIPS-FAQ-jp.pdf
10+
else
11+
PDF = wolfSSL-FIPS-FAQ.pdf
12+
endif
13+
14+
DOXYFILE = Doxyfile
15+
16+
17+
.PHONY: html-prep
18+
html-prep:
19+
20+
.PHONY: pdf-prep
21+
pdf-prep:

‎wolfSSL-FIPS-FAQ/header.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
% wolfSSL FIPS FAQ ![](logo.png)
2+
3+
---
4+
header-includes:
5+
# Blank pages on new sections
6+
- \usepackage{titlesec}
7+
- \newcommand{\sectionbreak}{\clearpage}
8+
# Fancy page headers
9+
- \usepackage{fancyhdr}
10+
- \pagestyle{fancy}
11+
- \fancyfoot[LO,RE]{COPYRIGHT \copyright 2025 wolfSSL Inc.}
12+
# Wrap long syntax highlighting code blocks
13+
- \usepackage{fvextra}
14+
- \DefineVerbatimEnvironment{Highlighting}{Verbatim}{breaklines,commandchars=\\\{\}}
15+
# Wrap long non-sytax highlighted code blocks
16+
- \usepackage{listings}
17+
- \let\verbatim\undefined
18+
- \let\verbatimend\undefined
19+
- \lstnewenvironment{verbatim}{\lstset{breaklines,basicstyle=\ttfamily}}{}
20+
subparagraph: yes
21+
---

‎wolfSSL-FIPS-FAQ/mkdocs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
site_name: wolfSSL FIPS FAQ
2+
site_url: https://wolfssl.com/
3+
docs_dir: build/html/
4+
site_dir: html/
5+
copyright: Copyright © 2025 wolfSSL Inc.
6+
nav:
7+
- "1. Introduction": index.md
8+
- "2. FAQ": section02.md
9+
theme:
10+
name: null
11+
custom_dir: ../mkdocs-material/material
12+
language: en
13+
palette:
14+
primary: indigo
15+
accent: indigo
16+
font:
17+
text: roboto
18+
code: roboto mono
19+
icon: "logo.png"
20+
logo: logo.png
21+
favicon: logo.png
22+
feature:
23+
tabs: true
24+
extra_css: [skin.css]
25+
use_directory_urls: false

‎wolfSSL-FIPS-FAQ/src/section01.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Introduction
2+
3+
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 to your question, please feel free to check the wolfSSL Manual, or contact us at [email protected].
4+
5+
## Questions
6+
7+
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)
8+
2. [How do I know if I am using the FIPS module?](./section02.md#how-do-i-know-if-i-am-using-the-fips-module)
9+
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-time)
10+
1. [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#does-the-power-on-self-test-post-really-have-to-run-every-time)
11+
2. [Followup Post Q: Why is the feature NO_ATTRIBUTE_CONSTRUCTOR there then if I can not use it?](./section02.md#does-the-power-on-self-test-post-really-have-to-run-every-time)
12+
3. [Followup Post Q: Who can determine when NO_ATTRIBUTE_CONSTRUCTOR is allowed?](./section02.md#does-the-power-on-self-test-post-really-have-to-run-every-time)
13+
4. [Followup Post Q: What about with fips-ready, can I use NO_ATTRIBUTE_CONSTRUCTOR with fips-ready?](./section02.md#does-the-power-on-self-test-post-really-have-to-run-every-time)
14+
4. [What can go wrong for the end user after basic testing?](./section02.md#what-can-go-wrong-for-the-end-user-after-basic-testing)

0 commit comments

Comments
 (0)