Skip to content

Cleanup readme #78

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
doanac merged 1 commit into from
Feb 12, 2026
Merged

Cleanup readme #78

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
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Fioconfig

This is a simple daemon designed to manage configuration data for an
embedded device. Its based on a customized OTA Community Edition
embedded device. It is based on a customized OTA Community Edition
device-gateway endpoint, but the idea used could be generic to any
system wanting to employ secure configuration management.

Expand All @@ -8,17 +10,17 @@ system wanting to employ secure configuration management.
OTA devices communicate with a device-gateway using SSL client
authentication. This means the public key of each device is known. By
default, devices will have Elliptical Curve keys. Using a technique
known as [ECIES](https://cryptopp.com/wiki/Elliptic_Curve_Integrated_Encryption_Scheme)
a the configuration values can be encrypted client-side and sent to
known as [ECIES](https://cryptopp.com/wiki/Elliptic_Curve_Integrated_Encryption_Scheme),
the configuration values can be encrypted client-side and sent to
the device-gateway so that it has no knowledge of a device's configuration
values. The device can then pull down the encrypted configuration and
use its private key to decrypt.

The encrypted file is stored to a persistent location on disk. At boot,
a fioconfig can extract this data to tmpfs (/var/run/secrets) so that
fioconfig can extract this data to `tmpfs` (`/var/run/secrets`) so that
they are only available at runtime.

## How to Build

## How to build
`make bin/fioconfig-linux-amd64`
`make test`
Loading