Feature: add custom id claim (#667)

This feature allows using the custom claim in the JWT token as a user ID.

Refactor claims extractor with options support

Add is_current to the user API response

infrastructure_files/docker-compose.yml.tmpl

@@ -30,7 +30,7 @@ services:
       - $SIGNAL_VOLUMENAME:/var/lib/netbird
     ports:
       - 10000:80
-  #     # port and command for Let's Encrypt validation
+  #      # port and command for Let's Encrypt validation
   #      - 443:443
   #    command: ["--letsencrypt-domain", "$NETBIRD_DOMAIN", "--log-file", "console"]
   # Management
@@ -45,7 +45,7 @@ services:
       - ./management.json:/etc/netbird/management.json
     ports:
       - $NETBIRD_MGMT_API_PORT:443 #API port
-  #     # command for Let's Encrypt validation without dashboard container
+  #    # command for Let's Encrypt validation without dashboard container
   #    command: ["--letsencrypt-domain", "$NETBIRD_DOMAIN", "--log-file", "console"]
     command: ["--port", "443", "--log-file", "console", "--disable-anonymous-metrics=$NETBIRD_DISABLE_ANONYMOUS_METRICS", "--single-account-mode-domain=$NETBIRD_MGMT_SINGLE_ACCOUNT_MODE_DOMAIN", "--dns-domain=$NETBIRD_MGMT_DNS_DOMAIN"]
   # Coturn
@@ -60,7 +60,6 @@ services:
     network_mode: host
     command:
       - -c /etc/turnserver.conf
-      
 volumes:
   $MGMT_VOLUMENAME:
   $SIGNAL_VOLUMENAME:

infrastructure_files/management.json.tmpl

@@ -32,6 +32,7 @@
         "AuthIssuer": "$NETBIRD_AUTH_AUTHORITY",
         "AuthAudience": "$NETBIRD_AUTH_AUDIENCE",
         "AuthKeysLocation": "$NETBIRD_AUTH_JWT_CERTS",
+        "AuthUserIDClaim": "$NETBIRD_AUTH_USER_ID_CLAIM",
         "CertFile":"$NETBIRD_MGMT_API_CERT_FILE",
         "CertKey":"$NETBIRD_MGMT_API_CERT_KEY_FILE",
         "OIDCConfigEndpoint":"$NETBIRD_AUTH_OIDC_CONFIGURATION_ENDPOINT"
@@ -49,4 +50,4 @@
           "DeviceAuthEndpoint": "$NETBIRD_AUTH_DEVICE_AUTH_ENDPOINT"
          }
     }
-}
+}

infrastructure_files/setup.env.example

@@ -7,6 +7,8 @@ NETBIRD_AUTH_OIDC_CONFIGURATION_ENDPOINT=""
 NETBIRD_AUTH_AUDIENCE=""
 # e.g. netbird-client
 NETBIRD_AUTH_CLIENT_ID=""
+# 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"