-
Notifications
You must be signed in to change notification settings - Fork 3k
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.
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
feat: Imprement jwt-auth header auth method #2961
Changes from all commits
916c868
7e448d7
19a366b
aedd3fc
d19962b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
package auth | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"net/http" | ||
"os" | ||
"sync" | ||
|
||
"github.com/coreos/go-oidc/v3/oidc" | ||
|
||
fbErrors "github.com/filebrowser/filebrowser/v2/errors" | ||
"github.com/filebrowser/filebrowser/v2/settings" | ||
"github.com/filebrowser/filebrowser/v2/users" | ||
) | ||
|
||
// MethodJWTAuth is used to identify JWTAuth auth. | ||
const MethodJWTAuth settings.AuthMethod = "jwt-header" | ||
|
||
// JWTAuth is a JWTAuth implementation of an auther. | ||
type JWTAuth struct { | ||
CertsURL string `json:"certsurl"` | ||
Aud string `json:"aud"` | ||
Iss string `json:"iss"` | ||
UsernameClaim string `json:"usernameClaim"` | ||
Header string `json:"header"` | ||
remoteKeySet *oidc.RemoteKeySet | ||
init sync.Once | ||
} | ||
|
||
// Auth authenticates the user via a JWT token in an HTTP header. | ||
func (a *JWTAuth) Auth(r *http.Request, usr users.Store, stg *settings.Settings, srv *settings.Server) (*users.User, error) { | ||
a.init.Do(func() { | ||
a.remoteKeySet = oidc.NewRemoteKeySet(context.Background(), a.CertsURL) | ||
}) | ||
|
||
accessJWT := r.Header.Get(a.Header) | ||
if accessJWT == "" { | ||
return nil, os.ErrPermission | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would be nice to log an error here |
||
} | ||
|
||
// The Application Audience (AUD) tag for your application | ||
config := &oidc.Config{ | ||
ClientID: a.Aud, | ||
} | ||
|
||
verifier := oidc.NewVerifier(a.Iss, a.remoteKeySet, config) | ||
Comment on lines
+42
to
+47
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looks like a good candidate to be moved into the constructor |
||
|
||
token, err := verifier.Verify(r.Context(), accessJWT) | ||
if err != nil { | ||
return nil, os.ErrPermission | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please log the original error |
||
} | ||
|
||
payload := map[string]any{} | ||
err = token.Claims(&payload) | ||
if err != nil { | ||
return nil, os.ErrPermission | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please log the original error |
||
} | ||
|
||
user, err := usr.Get(srv.Root, payload[a.UsernameClaim]) | ||
if errors.Is(err, fbErrors.ErrNotExist) { | ||
return nil, os.ErrPermission | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please log the original error |
||
} | ||
|
||
return user, err | ||
} | ||
|
||
// LoginPage tells that proxy auth doesn't require a login page. | ||
func (a *JWTAuth) LoginPage() bool { | ||
return false | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's better to do it in the constructor func