Skip to content

docs: add fips usage to build workflow #330

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.

Sign up for GitHub

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

Merged
thomasten merged 1 commit into from
Mar 13, 2026
Merged

docs: add fips usage to build workflow #330

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions docs/docs/workflows/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,16 @@
You can set the `OE_SIMULATION=1` environment variable if you want to simulate the enclave, e.g. for development on hardware that doesn't support enclaves.

Look at the [example collection](../getting-started/examples.md) if you want to see the build process in action.

## FIPS 140 cryptography

Check warning on line 29 in docs/docs/workflows/build.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'FIPS' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'FIPS' has no definition.", "location": {"path": "docs/docs/workflows/build.md", "range": {"start": {"line": 29, "column": 4}}}, "severity": "INFO"}

Check warning on line 29 in docs/docs/workflows/build.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.

Raw Output:
{"message": "[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.", "location": {"path": "docs/docs/workflows/build.md", "range": {"start": {"line": 29, "column": 4}}}, "severity": "INFO"}

EGo optionally supports FIPS 140-compliant cryptography.

Check warning on line 31 in docs/docs/workflows/build.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'FIPS' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'FIPS' has no definition.", "location": {"path": "docs/docs/workflows/build.md", "range": {"start": {"line": 31, "column": 25}}}, "severity": "INFO"}

Build your app with the Go FIPS 140 module enabled:

Check warning on line 33 in docs/docs/workflows/build.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'FIPS' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'FIPS' has no definition.", "location": {"path": "docs/docs/workflows/build.md", "range": {"start": {"line": 33, "column": 28}}}, "severity": "INFO"}

```bash
GOFIPS140=latest ego-go build
```

Then sign and run as usual.
EGo automatically uses the corresponding FIPS 140-enabled runtime.

Check warning on line 40 in docs/docs/workflows/build.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'FIPS' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'FIPS' has no definition.", "location": {"path": "docs/docs/workflows/build.md", "range": {"start": {"line": 40, "column": 42}}}, "severity": "INFO"}
Loading