Skip to content

Commit 7ed7cd6

Browse files
committed
Add some documentation for the FIPS configs
1 parent dc9321b commit 7ed7cd6

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

ide/winvs/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,32 @@ To stop the service run the following in an adminstrator power shell session:
7171

7272
To delete the service run
7373
`sc.exe delete wolfSSHd`
74+
75+
76+
FIPS Build Configurations
77+
-------------------------
78+
79+
The solution includes FIPS build configurations to support building wolfSSH
80+
with the FIPS build of wolfSSL. These configurations are designed to work
81+
with wolfSSL FIPS builds that are located in the `IDE\WIN10` directory
82+
structure.
83+
84+
The following FIPS configurations are available:
85+
86+
- **DebugFIPS** (Win32 and x64): For debugging FIPS builds using static libraries
87+
- **ReleaseFIPS** (Win32 and x64): For release FIPS builds using static libraries
88+
- **DLL DebugFIPS** (Win32 and x64): For debugging FIPS builds using dynamic libraries
89+
- **DLL ReleaseFIPS** (Win32 and x64): For release FIPS builds using dynamic libraries
90+
91+
### Matching wolfSSL FIPS Builds
92+
93+
When building wolfSSH with FIPS configurations, ensure that the corresponding
94+
wolfSSL FIPS build is available.
95+
96+
If you build the wolfSSL FIPS code in the **Release x64** configuration,
97+
then you should build wolfSSH with the **ReleaseFIPS x64** configuration.
98+
99+
Similarly:
100+
- wolfSSL **Debug x64** → wolfSSH **DebugFIPS x64**
101+
- wolfSSL **Release Win32** → wolfSSH **ReleaseFIPS Win32**
102+
- wolfSSL **DLL Release x64** → wolfSSH **DLL ReleaseFIPS x64**

0 commit comments

Comments
 (0)