passport-uconn

This is a custom Passport.js authentication strategy for integrating with UConn's SSO implementation.

Installation

Use npm to install passport-uconn.

npm install @uconn-its/passport-uconn

Usage

import passport from 'passport';

import { CasStrategy } from '@uconn-its/passport-uconn';

passport.use(new CasStrategy({
    serverBaseURL: 'https://endpoints.its.uconn.edu',
    serviceURL: 'https://endpoints.its.uconn.edu/login',
    passReqToCallback: false
}, async (req, profile, done) => {
    // Do any additional verification on the CAS user with the profile variable (ex: check groups)
    
    // Deny User
    if (profile.user === 'jpr21010') {
        return done(null, false, {
            message: 'You are banned from this app'
        });
    }

    // Error during logic
    if (anErrorHappens) {
        return done(new Error('An error occurred while getting something'), null);
    }

    // Approve User
    return done(null, {
        netId: profile.user,
        someCustomSessionProp: profile.someValue,
        foo: 'bar'
    });
}));

passport.authenticate('cas', ...);

Publishing

To publish an update to this package follow these steps;

1. Make sure your git directory is clean by commiting or stashing all changes.
2. Move the .env.example to .envand change the NPMRC_TOKEN variable to a token with access to @uconn-its (Found in LastPass under ITS WebDev -- NPM/uconn-its NPM Access Token).
3. Increment the package version by either manually changing the package.json file or running npm version <major/minor/patch>.
4. Publish the package to the registry by running npm publish. (Note: If you get a 404 error, simply run npm publish again.)

License

GPL-3.0