mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-05-30 23:40:40 +02:00
[PR #1636] [MERGED] Integrate passportjs for muti-strategy authentication and SSO #3589
Assignees
adam (Adam Melkus)
Clear assignees
adam (Adam Melkus)
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/audiobookshelf#3589
Reference in New Issue
Block a user
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?
📋 Pull Request Information
Original PR: https://github.com/advplyr/audiobookshelf/pull/1636
Author: @lukeIam
Created: 3/24/2023
Status: ✅ Merged
Merged: 11/19/2023
Merged by: @advplyr
Base:
master← Head:auth_passportjs📝 Commits (10+)
e1ddb95Inital passportjs integrationbe53b31Merge remote-tracking branch 'origin/master' into auth_passportjs08676a6Fix: small problem with this context in Auth.js62b0940Added passport-openidconnect implementation812395bMerge remote-tracking branch 'origin/master' into auth_passportjs7010a13Fixes for passport local and allow empty password8d00647Merge branch 'master' into auth_passportjs8b68543Merge4359ca2Fix XAccel issue95e6fefMerge remote-tracking branch 'origin/master' into auth_passportjs📊 Changes
23 files changed (+1906 additions, -260 deletions)
View changed files
📝
client/assets/app.css(+20 -0)📝
client/components/app/ConfigSideNav.vue(+5 -0)📝
client/components/ui/Btn.vue(+2 -22)📝
client/pages/config.vue(+1 -0)➕
client/pages/config/authentication.vue(+229 -0)📝
client/pages/login.vue(+67 -12)📝
client/store/index.js(+1 -1)📝
client/strings/en-us.json(+1 -0)📝
package-lock.json(+472 -21)📝
package.json(+5 -0)📝
server/Auth.js(+501 -159)📝
server/Server.js(+63 -6)📝
server/SocketAuthority.js(+22 -3)📝
server/controllers/MiscController.js(+106 -5)📝
server/controllers/SessionController.js(+10 -10)📝
server/controllers/UserController.js(+2 -2)➕
server/libs/passportLocal/LICENSE(+20 -0)➕
server/libs/passportLocal/index.js(+20 -0)➕
server/libs/passportLocal/strategy.js(+119 -0)📝
server/models/User.js(+108 -11)...and 3 more files
📄 Description
As I wrote in the SSO issue (https://github.com/advplyr/audiobookshelf/issues/998#issuecomment-1454735891) I would suggest to integrate a well supported auth middleware instead of implementing single protocols by hand.
This PR shows a possible integration of passortjs into the server code of audiobookshelf.
Login with username + password and google oauth2 integrated and working so far. But other auth providers can be integrated really easily with a few lines of code (supported strategies).
My current implementation is not final nor ready to be merged - it is more meant as a PoC.
But if you (@advplyr and also others) decide that you want to go in this direction I'm happy to develop/contribute to a stable implementation.
I don't have a client implementation atm - I'm testing with postman...
Login via:
POST /loginfor username + passwordGET /auth/googleredirects to google loginThe response returns the known json with a token but also a cookie is set containing the session.
For the further API communication either the token (Bearer header) or the cookie can be used if authentication.
Maybe the cookie simplifies the handling in the webclients of the apps.
Most of the changes where done in the
Auth.jsfile - I tried to not touch the other code where possible.So what do you think? Is
passportjsa good idea or do you prefer to go in another direction?🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.