OpenID for node.js is (yes, you guessed it) an OpenID implementation for node.js.
Highlights and features include:
The library can be reviewed and retrieved from GitHub.
If you use npm, simply do npm install openid.
If you don't use npm, you should. Alternatively, you can download the library, and move the
lib folder and openid.js to where you want them, and then require('openid').
(Remember to do require.paths.unshift on the directory you put the file in unless it's
already in your require.paths.)
Instead of walking through step-by-step, here's a very simple server using OpenID for node.js for authentication:
var openid = require('openid');
var url = require('url');
var querystring = require('querystring');
var relyingParty = new openid.RelyingParty(
'http://example.com/verify', // Verification URL (yours)
null, // Realm (optional, specifies realm for OpenID authentication)
false, // Use stateless verification
false, // Strict mode
[]); // List of extensions to enable and include
var server = require('http').createServer(
function(req, res)
{
var parsedUrl = url.parse(req.url);
if(parsedUrl.pathname == '/authenticate')
{
// User supplied identifier
var query = querystring.parse(parsedUrl.query);
var identifier = query.openid_identifier;
// Resolve identifier, associate, and build authentication URL
relyingParty.authenticate(identifier, false, function(authUrl)
{
if (!authUrl)
{
res.writeHead(500);
res.end(error);
}
else
{
res.writeHead(302, { Location: authUrl });
res.end();
}
});
}
else if(parsedUrl.pathname == '/verify')
{
// Verify identity assertion
// NOTE: Passing just the URL is also possible
relyingParty.verifyAssertion(req, function(result)
{
res.writeHead(200);
res.end(result.authenticated
? 'Success :)'
: 'Failure :(');
});
}
else
{
// Deliver an OpenID form on all other URLs
res.writeHead(200);
res.end('<!DOCTYPE html><html><body>'
+ '<form method="get" action="/authenticate">'
+ '<p>Login using OpenID</p>'
+ '<input name="openid_identifier" />'
+ '<input type="submit" value="Login" />'
+ '</form></body></html>');
}
});
server.listen(80);
A more elaborate example can be found in sample.js in the GitHub repository.
To provide a way to save/load association state, you need to mix-in two functions in
the openid module:
saveAssociation(type, handle, secret, expiry_time) is called when a new association is established during authenticationloadAssociation(handle) is used to retrieve the association identified by handle when verification happensThe openid module includes default implementations for these functions using a simple object to store the associations in-memory.
OpenID for node.js is licensed under the MIT license. See LICENSE for further details.
The libary includes bigint functionality released by Tom Wu under the BSD license,
and Base64 functions released by Nick Galbreath under the MIT license. Please see
lib/bigint.js and lib/base64.js for the details of the licenses for these functions.
FAQs
OpenID 1.1/2.0 library for Node.js
The npm package openid receives a total of 12,902 weekly downloads. As such, openid popularity was classified as popular.
We found that openid demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.