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-xapo

v0.0.1

Published

XAPO authentication strategy for Passport

Downloads

4

Readme

passport-xapo

License

Passport strategy for authenticating with Xapo access tokens using the OAuth 2.0 API.

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

Installation

$ npm install passport-xapo

Usage

Create an Application

Before using passport-xapo, you must register an application with Xapo. If you have not already done so, a new application can be created at Xapo Developers. Your application will be issued a client ID and client secret, which need to be provided to the strategy. You will also need to configure a redirect URI which matches the route in your application.

Configure Strategy

The Xapo authentication strategy authenticates users using a Xapo account and OAuth 2.0 tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a client ID, client secret and callback URL.

const XapoStrategy = require('passport-xapo')

passport.use(new XapoStrategy({
    clientID: XAPO_CLIENT_ID,
    clientSecret: XAPO_CLIENT_SECRET,
    callbackURL: 'https://www.example.net/auth/example/callback',
  }, (accessToken, refreshToken, profile, done) => {
    User.findOrCreate({ xapoId: profile.id }, (err, user) => {
      return done(err, user)
    })
  }
))

Authenticate Requests

Use passport.authenticate(), specifying the 'xapo' strategy, to authenticate requests. The permissions can be requested via the scope option.

NOTE: You need to provide the 'users' scope to be able to retrieve the user's profile otherwise the library will throw an error

app.get('/auth/xapo',
  passport.authenticate('xapo', { scope: ['users'] })
);

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

Client Requests

Clients can send requests to routes that use passport-xapo authentication using query params, body, or HTTP headers. Clients will need to transmit the access_token and optionally the refresh_token that are received from xapo after login.

Sending access_token as a Query parameter

GET /auth/xapo?access_token=<ACCESS_TOKEN>

Sending access token as an HTTP header

Clients can choose to send the access token using the Oauth2 Bearer token (RFC 6750) compliant format

GET /auth/xapo HTTP/1.1
Host: server.example.com
Authorization: Bearer <BASE64_ACCESS_TOKEN_STRING>

optionally a client can send via a custom (default access_token) header

GET /auth/xapo HTTP/1.1
Host: server.example.com
access_token: <BASE64_ACCESS_TOKEN_STRING>

Sending access token as an HTTP body

Clients can transmit the access token via the body

POST /auth/xapo HTTP/1.1
Host: server.example.com

access_token=<BASE64_ACCESS_TOKEN_STRING>

Credits

License

Licensed under the MIT License, Copyright © 2017 Airfill Prepaid AB.

See LICENSE for more information.