npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

passport-zoib

v0.3.1

Published

ZOIB authentication strategy for Passport.

Downloads

17

Readme

passport-ZOIB

Passport strategy for authenticating with ZOIB using the ZOIB authentication.

This module lets you authenticate using ZOIB in your Node.js applications. By plugging into Passport, ZOIB authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-zoib

Usage

Create a ZOIB function

Before using passport-ZOIB, you must create a ZOIB function the user (or a group which contains the user) need to have access to.

Configure Strategy

The ZOIB authentication strategy authenticates users using a ZOIB account and a ZOIB function. The strategy also requires a verify callback, which receives the profile which contains the authenticated user's ZOIB profile. The verify callback must call cb providing a user to complete authentication.

passport.use(new ZOIBStrategy({
		zoibURL: "https://zoib.salamalecs.dev.digitalairways.com",
		localZoibURL: "http://zoib-user:13511", //optionnal, only if you use docker & zoib-user is in the same network
		zoibFunction: "salamalecs_grant_authentication",
		authorizationURL: "https://passport-zoib.salamalecs.dev.digitalairways.com",
		callbackURL: "https://salamalec.salamalecs.dev.digitalairways.com/auth/strategy/callback",
		logoURL: "https://pbs.twimg.com/profile_images/124145879/Logo_Happy_RGB_400x400.jpg", //optional
		color: "FFDE75", //optional
		title: "ZOIB authentication" //optional
	},
	function(profile, cb) {
		user = profile;
		delete user.token;
		cb(null, user);
	}
));

Authenticate Requests

Use passport.authenticate(), specifying the 'ZOIB' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/ZOIB',
	passport.authenticate('ZOIB'));

app.get('/auth/ZOIB/callback', 
	passport.authenticate('ZOIB', { failureRedirect: '/login' }),
	function(req, res) {
		// Successful authentication, redirect home.
		res.redirect('/');
	});

####protect your NodeRed using passport-ZOIB

Uncomment the adminAuth parameter in your settings.js file and set his value:

adminAuth: {
	type:"strategy",
	strategy: {
		name: "ZOIB",
		label: 'Sign in with ZOIB',
		icon:"fa-smile-beam",
		strategy: require("passport-zoib").Strategy,
		options: {
			zoibURL: process.env.ZOIB_URL,
			localZoibURL: process.env.LOCAL_ZOIB_URL, //optionnal, only if you use docker & zoib-user is in the same network
			zoibFunction: process.env.ALLOWING_ZOIB_FUNCTION,
			authorizationURL: process.env.ZOIB_PASSPORT_URL,
			callbackURL: "https://" + process.env.VIRTUAL_HOST + "/auth/strategy/callback",
			logoURL: "https://pbs.twimg.com/profile_images/124145879/Logo_Happy_RGB_400x400.jpg", //optional
			color: "FFDE75", //optional
			title: "ZOIB authentication" //optional
		}
	},
	users: function(username) {
		return new Promise(function(resolve) {
			var user = {username: username, permissions: "*"};
			resolve(user);
		});
	}
},

If you want to skip the button click: ...

If you want to keep the ZOIB token (as Salamalecs wants to) in the NodeRed session, add the following parameter to adminAuth:

authenticate: function(profile) {
	return new Promise(function(resolve) {
		resolve(profile);
	});
}

Then you need to patch NodeRed using the following patch: svn://daw.digitalairways.com/digitalairways/Customers/Fundatrix/TheThingBox/Patchs/zoib_keepZoibToken

If you also want to have a way to retrieve this ZOIB token, you will need to patch NodeRed using the following patch: svn://daw.digitalairways.com/digitalairways/Customers/Fundatrix/TheThingBox/Patchs/zoib_getZoibToken