SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-03-31 06:34:19 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Add support for rotating signing keys on expiry #313

New Issue
Closed
opened 2025-11-20 05:09:28 -05:00 by saavagebueno · 3 comments
saavagebueno commented 2025-11-20 05:09:28 -05:00
Owner
Copy Link

Originally created by @Thunderbottom on GitHub (Apr 13, 2023).

Describe the problem
Currently, signing keys are loaded on management startup, and are never refreshed on key expiry. IdPs often rotate these keys at a set interval for added security.

To Reproduce
Steps to reproduce the behavior:

  1. Set up an IdP that rotates signing key at set intervals, eg. dexIdP
  2. Integrate the IdP with Netbird and start the Netbird management server, this should load the signing key from the IdP on startup.
  3. Wait for the signing key to expire, in the case of dexIdP, the default expiry is set to 6h.
  4. Try to login to the management service and see:
    image

Additional management service logs:

infrastructure_files-management-1  | 2023-04-06T12:55:11Z DEBG management/server/jwtclaims/jwtValidator.go:135: error parsing token: unable to find appropriate key
infrastructure_files-management-1  | 2023-04-06T12:55:11Z DEBG management/server/http/middleware/auth_middleware.go:60: Error when validating JWT claims: Error parsing token: unable to find appropriate key
infrastructure_files-management-1  | 2023-04-06T12:55:11Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 4198917813: GET /api/users status 401
infrastructure_files-management-1  | 2023-04-06T12:55:11Z DEBG management/server/jwtclaims/jwtValidator.go:135: error parsing token: unable to find appropriate key
infrastructure_files-management-1  | 2023-04-06T12:55:11Z DEBG management/server/http/middleware/auth_middleware.go:60: Error when validating JWT claims: Error parsing token: unable to find appropriate key
infrastructure_files-management-1  | 2023-04-06T12:55:11Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1761936853: GET /api/users status 401
infrastructure_files-management-1  | 2023-04-06T12:55:11Z DEBG management/server/jwtclaims/jwtValidator.go:135: error parsing token: unable to find appropriate key
infrastructure_files-management-1  | 2023-04-06T12:55:11Z DEBG management/server/http/middleware/auth_middleware.go:60: Error when validating JWT claims: Error parsing token: unable to find appropriate key
infrastructure_files-management-1  | 2023-04-06T12:55:11Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1177296465: GET /api/groups status 401

Expected behavior
Netbird reloads the signing key after IdP signing key rotation.

Originally created by @Thunderbottom on GitHub (Apr 13, 2023). **Describe the problem** Currently, signing keys are loaded on management startup, and are never refreshed on key expiry. IdPs often rotate these keys at a set interval for added security. **To Reproduce** Steps to reproduce the behavior: 1. Set up an IdP that rotates signing key at set intervals, eg. [dexIdP](https://dexidp.io) 2. Integrate the IdP with Netbird and start the Netbird management server, this should load the signing key from the IdP on startup. 3. Wait for the signing key to expire, in the case of dexIdP, the default expiry is set to `6h`. 4. Try to login to the management service and see: ![image](https://user-images.githubusercontent.com/11243138/231723454-9e3fa3d3-ae2f-4a91-87b0-c47174b55c49.png) **Additional management service logs:** ``` infrastructure_files-management-1 | 2023-04-06T12:55:11Z DEBG management/server/jwtclaims/jwtValidator.go:135: error parsing token: unable to find appropriate key infrastructure_files-management-1 | 2023-04-06T12:55:11Z DEBG management/server/http/middleware/auth_middleware.go:60: Error when validating JWT claims: Error parsing token: unable to find appropriate key infrastructure_files-management-1 | 2023-04-06T12:55:11Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 4198917813: GET /api/users status 401 infrastructure_files-management-1 | 2023-04-06T12:55:11Z DEBG management/server/jwtclaims/jwtValidator.go:135: error parsing token: unable to find appropriate key infrastructure_files-management-1 | 2023-04-06T12:55:11Z DEBG management/server/http/middleware/auth_middleware.go:60: Error when validating JWT claims: Error parsing token: unable to find appropriate key infrastructure_files-management-1 | 2023-04-06T12:55:11Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1761936853: GET /api/users status 401 infrastructure_files-management-1 | 2023-04-06T12:55:11Z DEBG management/server/jwtclaims/jwtValidator.go:135: error parsing token: unable to find appropriate key infrastructure_files-management-1 | 2023-04-06T12:55:11Z DEBG management/server/http/middleware/auth_middleware.go:60: Error when validating JWT claims: Error parsing token: unable to find appropriate key infrastructure_files-management-1 | 2023-04-06T12:55:11Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1177296465: GET /api/groups status 401 ``` **Expected behavior** Netbird reloads the signing key after IdP signing key rotation.
saavagebueno commented 2025-11-20 05:09:29 -05:00
Author
Owner
Copy Link

@Thunderbottom commented on GitHub (Apr 13, 2023):

A hacky workaround right now is to extend the signing key expiry period (if possible) at the IdP level to a large number, eg. 180d, or disable the expiry altogether.

@Thunderbottom commented on GitHub (Apr 13, 2023): A hacky workaround right now is to extend the signing key expiry period (if possible) at the IdP level to a large number, eg. `180d`, or disable the expiry altogether.
saavagebueno commented 2025-11-20 05:09:29 -05:00
Author
Owner
Copy Link

@mlsmaycon commented on GitHub (Jun 16, 2023):

Support was added in PR #808; you can set it with the flag: --idp-sign-key-refresh-enabled

@mlsmaycon commented on GitHub (Jun 16, 2023): Support was added in PR #808; you can set it with the flag: `--idp-sign-key-refresh-enabled`
saavagebueno commented 2025-11-20 05:09:29 -05:00
Author
Owner
Copy Link

@Fantu commented on GitHub (Oct 9, 2023):

hi, today is the second time (the previous was days ago) I have this issue (or atleast seems from same error logs) and I need to reboot the netbird server to "solve" because with page refresh don't solve and don't show the login page
after reboot return working and also don't require google auth again (I use google auth setted following https://docs.netbird.io/selfhosted/identity-providers#google-workspace)
this setting should solves?
if yes how to set it?
in setup.env I don't found it (I suppose not added looking the PR)
but I also not sure how to add it to management.json (after the configure), looking https://github.com/netbirdio/netbird/pull/808/files config.HttpConfig.IdpSignKeyRefreshEnabled = idpSignKeyRefreshEnabled I suppose i should add:

"HttpConfig": {
        ...
        "IdpSignKeyRefreshEnabled": true
    },

is it correct? I suppose add it in default management.json and probably a variable for it also in setup.env can be useful to make easier/faster change it

@Fantu commented on GitHub (Oct 9, 2023): hi, today is the second time (the previous was days ago) I have this issue (or atleast seems from same error logs) and I need to reboot the netbird server to "solve" because with page refresh don't solve and don't show the login page after reboot return working and also don't require google auth again (I use google auth setted following https://docs.netbird.io/selfhosted/identity-providers#google-workspace) this setting should solves? if yes how to set it? in setup.env I don't found it (I suppose not added looking the PR) but I also not sure how to add it to management.json (after the configure), looking https://github.com/netbirdio/netbird/pull/808/files `config.HttpConfig.IdpSignKeyRefreshEnabled = idpSignKeyRefreshEnabled` I suppose i should add: ``` "HttpConfig": { ... "IdpSignKeyRefreshEnabled": true }, ``` is it correct? I suppose add it in default management.json and probably a variable for it also in setup.env can be useful to make easier/faster change it
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#313
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?