Skip to content

Commit fabd66d

Browse files
committed
docs: document auth configuration in server config templates
Add a commented auth section to all three server config templates (manufacturing, owner, rendezvous) showing how to enable API key authentication and seed an initial admin user. Notes that FDO protocol endpoints are never affected by management API auth. Signed-off-by: Miguel Martín <mmartinv@redhat.com>
1 parent 6f3ecbf commit fabd66d

3 files changed

Lines changed: 37 additions & 0 deletions

File tree

configs/manufacturing.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,15 @@ device_ca:
2121
owner:
2222
cert: "/etc/pki/go-fdo-server/owner-example.crt"
2323

24+
# Authentication and authorization configuration.
25+
# When enabled, management API endpoints require valid credentials.
26+
# FDO protocol endpoints (/fdo/101/msg/*, /fdo/200/msg/*) are never affected.
27+
#auth:
28+
# enabled: true
29+
# mechanisms:
30+
# api_key:
31+
# enabled: true
32+
# seed:
33+
# admin:
34+
# name: "admin"
35+
# email: "admin@example.com"

configs/owner.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,15 @@ owner:
1919
cert: "/etc/pki/go-fdo-server/owner-example.crt"
2020
key: "/etc/pki/go-fdo-server/owner-example.key"
2121

22+
# Authentication and authorization configuration.
23+
# When enabled, management API endpoints require valid credentials.
24+
# FDO protocol endpoints (/fdo/101/msg/*, /fdo/200/msg/*) are never affected.
25+
#auth:
26+
# enabled: true
27+
# mechanisms:
28+
# api_key:
29+
# enabled: true
30+
# seed:
31+
# admin:
32+
# name: "admin"
33+
# email: "admin@example.com"

configs/rendezvous.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,16 @@ rendezvous:
4949
# allowing the server to start serving requests before running potentially heavy cleanup operations.
5050
# Default: 300 (5 minutes)
5151
##initial_cleanup_delay: 300
52+
53+
# Authentication and authorization configuration.
54+
# When enabled, management API endpoints require valid credentials.
55+
# FDO protocol endpoints (/fdo/101/msg/*, /fdo/200/msg/*) are never affected.
56+
#auth:
57+
# enabled: true
58+
# mechanisms:
59+
# api_key:
60+
# enabled: true
61+
# seed:
62+
# admin:
63+
# name: "admin"
64+
# email: "admin@example.com"

0 commit comments

Comments
 (0)