SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-07-22 05:53:39 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

No error-information when auth succeeded in dashboard, but failed in backend #299

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

Originally created by @Ruakij on GitHub (Mar 21, 2023).

Describe the problem
When auth was setup in a way that allows the dashboard to accept it, but the backend does not, no useful error-information is logged.
(Why auth fails is still beyond me, unfortunately the auth-docs for other auth-providers is still sparse)

The dashboard is easily satisfied as it assumes auth was perfectly fine as soon as it comes back with a token (of any kind!).

To Reproduce
Steps to reproduce the behavior:

  1. Setup application in IdP (i chose Zitadel)

  2. Configuration:
    image
    image
    Also mind the Auth Token Type which is, by-default, "Bearer" which the Dashboard doesnt like: TypeError: e.split(...)[1] is undefined (add docs about requiring JWT!)
    image
    Also add docs about the redirect-uri being like this, some IdPs require this and only allow auth, when its set correctly.

  3. Open netbird, login with IdP

  4. See error
    image

Management logs:

netbird-management-1  | 2023-03-21T10:32:17Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1083634288: GET /api/users status 500
netbird-management-1  | 2023-03-21T10:32:18Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 2813638850: GET /api/peers status 500
netbird-management-1  | 2023-03-21T10:32:18Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1697663107: GET /api/groups status 500
netbird-management-1  | 2023-03-21T10:32:18Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 3157473669: GET /api/routes status 500

Expected behavior
A proper error-message, both in the dashboard and the management-logs about what exactly went wrong.

I havent tried other IdPs yet, but switchged to Auth0 to test if thats the problem, the errors went away.
Maybe i did something wrong with my IdP setup (which is kinda badly documented), but i'd expect helpful error-logs.

I'll try the setup with Authentik as IdP next.
Once i find out what works and how i'll write some more generic docs for IdPs.

Originally created by @Ruakij on GitHub (Mar 21, 2023). **Describe the problem** When auth was setup in a way that allows the dashboard to accept it, but the backend does not, no useful error-information is logged. (Why auth fails is still beyond me, unfortunately the auth-docs for other auth-providers is still sparse) The dashboard is easily satisfied as it assumes auth was perfectly fine as soon as it comes back with a token (of any kind!). **To Reproduce** Steps to reproduce the behavior: 1. Setup application in IdP (i chose Zitadel) 2. Configuration: ![image](https://user-images.githubusercontent.com/54639830/226579153-01ad2fb0-325a-4a0c-b63f-9cc19a760f0e.png) ![image](https://user-images.githubusercontent.com/54639830/226579221-379e446f-467b-4e32-9438-48a54c50ea6e.png) Also mind the *Auth Token Type* which is, by-default, "Bearer" which the Dashboard doesnt like: `TypeError: e.split(...)[1] is undefined` (add docs about requiring JWT!) ![image](https://user-images.githubusercontent.com/54639830/226580281-fdef6b02-98fa-4a40-8a51-9756154245b9.png) Also add docs about the redirect-uri being like this, some IdPs require this and only allow auth, when its set correctly. 4. Open netbird, login with IdP 5. See error ![image](https://user-images.githubusercontent.com/54639830/226580748-90b19334-2776-45de-80ed-c3eaf861799f.png) Management logs: ``` netbird-management-1 | 2023-03-21T10:32:17Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1083634288: GET /api/users status 500 netbird-management-1 | 2023-03-21T10:32:18Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 2813638850: GET /api/peers status 500 netbird-management-1 | 2023-03-21T10:32:18Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 1697663107: GET /api/groups status 500 netbird-management-1 | 2023-03-21T10:32:18Z ERRO management/server/telemetry/http_api_metrics.go:150: HTTP response 3157473669: GET /api/routes status 500 ``` **Expected behavior** A proper error-message, both in the dashboard and the management-logs about what exactly went wrong. --- I havent tried other IdPs yet, but switchged to Auth0 to test if thats the problem, the errors went away. Maybe i did something wrong with my IdP setup (which is kinda badly documented), but i'd expect helpful error-logs. I'll try the setup with Authentik as IdP next. Once i find out what works and how i'll write some more generic docs for IdPs.
saavagebueno commented 2025-11-20 05:09:18 -05:00
Author
Owner
Copy Link

@gigovich commented on GitHub (Mar 22, 2023):

@Ruakij thank you for this detailed report, could you please provide your management configuration and OpenID configuration endpoint (or content from this endpoint)?

@gigovich commented on GitHub (Mar 22, 2023): @Ruakij thank you for this detailed report, could you please provide your management configuration and OpenID configuration endpoint (or content from this endpoint)?
saavagebueno commented 2025-11-20 05:09:18 -05:00
Author
Owner
Copy Link

@Ruakij commented on GitHub (Mar 22, 2023):

Sure.

I assume this is the part you need:

setup.env:

# -------------------------------------------
# OIDC
#  e.g., https://example.eu.auth0.com/.well-known/openid-configuration
# -------------------------------------------
NETBIRD_AUTH_OIDC_CONFIGURATION_ENDPOINT="https://auth.ruekov.eu/.well-known/openid-configuration"
NETBIRD_AUTH_AUDIENCE="https://netbird.ruekov.eu"
# e.g. netbird-client
NETBIRD_AUTH_CLIENT_ID="206188055046988264@media"
# if you want to use a custom claim for the user ID instead of 'sub', set it here
# NETBIRD_AUTH_USER_ID_CLAIM=""
# indicates whether to use Auth0 or not: true or false
NETBIRD_USE_AUTH0="false"
NETBIRD_AUTH_DEVICE_AUTH_PROVIDER="none"
NETBIRD_AUTH_DEVICE_AUTH_CLIENT_ID=""

Dont think Auth audience is necessary for Zitadel

management.json:

{
    "HttpConfig": {
        "Address": "0.0.0.0:443",
        "AuthIssuer": "https://auth.ruekov.eu",
        "AuthAudience": "https://netbird.ruekov.eu",
        "AuthKeysLocation": "https://auth.ruekov.eu/oauth/v2/keys",
        "AuthUserIDClaim": "",
        "CertFile":"",
        "CertKey":"",
        "OIDCConfigEndpoint":"https://auth.ruekov.eu/.well-known/openid-configuration"
    },
    "IdpManagerConfig": {
        "Manager": "none"
     },
    "DeviceAuthorizationFlow": {
        "Provider": "none",
        "ProviderConfig": {
          "Audience": "https://netbird.ruekov.eu",
          "Domain": "",
          "ClientID": "",
          "TokenEndpoint": "https://auth.ruekov.eu/oauth/v2/token",
          "DeviceAuthEndpoint": "null"
         }
    }
}

Netbird is running behind Traefik with a setup that works. (thats why no certs are in use)

Feel free to test against https://auth.ruekov.eu.
I'll also do some tests with Authentik today, maybe Zitadel is just not reacting how it should?
Or I miconfigured it. (after all, docs are very.. limited right now :D)

@Ruakij commented on GitHub (Mar 22, 2023): Sure. I assume this is the part you need: `setup.env`: ```env # ------------------------------------------- # OIDC # e.g., https://example.eu.auth0.com/.well-known/openid-configuration # ------------------------------------------- NETBIRD_AUTH_OIDC_CONFIGURATION_ENDPOINT="https://auth.ruekov.eu/.well-known/openid-configuration" NETBIRD_AUTH_AUDIENCE="https://netbird.ruekov.eu" # e.g. netbird-client NETBIRD_AUTH_CLIENT_ID="206188055046988264@media" # if you want to use a custom claim for the user ID instead of 'sub', set it here # NETBIRD_AUTH_USER_ID_CLAIM="" # indicates whether to use Auth0 or not: true or false NETBIRD_USE_AUTH0="false" NETBIRD_AUTH_DEVICE_AUTH_PROVIDER="none" NETBIRD_AUTH_DEVICE_AUTH_CLIENT_ID="" ``` *Dont think Auth audience is necessary for Zitadel* `management.json`: ```json { "HttpConfig": { "Address": "0.0.0.0:443", "AuthIssuer": "https://auth.ruekov.eu", "AuthAudience": "https://netbird.ruekov.eu", "AuthKeysLocation": "https://auth.ruekov.eu/oauth/v2/keys", "AuthUserIDClaim": "", "CertFile":"", "CertKey":"", "OIDCConfigEndpoint":"https://auth.ruekov.eu/.well-known/openid-configuration" }, "IdpManagerConfig": { "Manager": "none" }, "DeviceAuthorizationFlow": { "Provider": "none", "ProviderConfig": { "Audience": "https://netbird.ruekov.eu", "Domain": "", "ClientID": "", "TokenEndpoint": "https://auth.ruekov.eu/oauth/v2/token", "DeviceAuthEndpoint": "null" } } } ``` Netbird is running behind Traefik with a setup that works. (thats why no certs are in use) Feel free to test against `https://auth.ruekov.eu`. I'll also do some tests with Authentik today, maybe Zitadel is just not reacting how it should? Or I miconfigured it. (after all, docs are very.. limited right now :D)
saavagebueno commented 2025-11-20 05:09:18 -05:00
Author
Owner
Copy Link

@mlsmaycon commented on GitHub (Mar 23, 2023):

@Ruakij I've open a PR #760 that will log the JWT validation in the management service to improve the feedback.

In the next releases we will improve the errors to integrate better with the Dashboard.

@mlsmaycon commented on GitHub (Mar 23, 2023): @Ruakij I've open a PR #760 that will log the JWT validation in the management service to improve the feedback. In the next releases we will improve the errors to integrate better with the Dashboard.
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#299
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?