README
@oauth-everything/passport-fimfiction
A Passport strategy for authenticating with Fimfiction using OAuth 2.0 and the Fimfiction API.
This module lets you authenticate using Fimfiction in your Node.js applications. By plugging into Passport, Fimfiction authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
Install
$ npm install @oauth-everything/passport-fimfiction
Configure Strategy
The Fimfiction authentication strategy authenticates users using a Fimfiction
account and OAuth 2.0 tokens. The app ID and secret obtained when creating an
application are supplied as options when creating the strategy. The strategy
also requires a verify callback, which receives the access token and optional
refresh token, as well as profile which contains the authenticated user's
Fimfiction profile. The verify callback must call cb providing a user to
complete authentication.
passport.use(new Strategy(
{
clientID: FIMFICTION_APP_ID,
clientSecret: FIMFICTION_APP_SECRET,
callbackURL: "http://localhost:3000/auth/fimfiction/callback"
},
(accessToken: string, refreshToken: string, profile: Profile, cb: VerifyCallback<User>) => {
User.findOrCreate({ fimfictionId: profile.id }, (err: Error, user: User) => {
return cb(err, user);
});
}
));
Authenticate Requests
Use passport.authenticate(), specifying the 'fimfiction' strategy, to
authenticate requests.
For example, as route middleware in an Express application:
app.get('/auth/fimfiction',
passport.authenticate('fimfiction'));
app.get('/auth/fimfiction/callback',
passport.authenticate('fimfiction', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});