# passport-brightspace-auth

> A Passport.js strategy for authenticating against the Brightspace Authentication service

Latest version **1.0.4** (published 2016-06-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install passport-brightspace-auth
pnpm add passport-brightspace-auth
yarn add passport-brightspace-auth
bun add passport-brightspace-auth
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2016-06-07 |
| First published | 2016-06-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Chris Carleton |
| Maintainers | d2l-travis-deploy |
| Keywords | Brightspace, auth, authentication, passport, strategy |

## Links

- npm: https://www.npmjs.com/package/passport-brightspace-auth
- Repository: https://github.com/Brightspace/passport-brightspace-auth
- Homepage: https://github.com/Brightspace/passport-brightspace-auth#readme
- Issues: https://github.com/Brightspace/passport-brightspace-auth/issues
- npm.io page: https://npm.io/package/passport-brightspace-auth

## Dependencies (3)

- [bluebird](https://npm.io/package/bluebird.md) ^3.4.0
- [passport-strategy](https://npm.io/package/passport-strategy.md) ^1.0.0
- [brightspace-auth-validation](https://npm.io/package/brightspace-auth-validation.md) ^5.2.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2016-06-07
- 1.0.3 — 2016-06-07

## README

# Brightspace Passport Authentication Strategy

[![Build Status](https://travis-ci.org/Brightspace/passport-brightspace-auth.svg?branch=master)](https://travis-ci.org/Brightspace/passport-brightspace-auth)

This is a Passport.js strategy for authenticating requests against the Brightspace authentication service.

## Usage

To add this library as a dependency to your project run
``` npm install --save passport-brightspace-auth ```

Configure it just as you would with any other Passport strategy and then you can use the Passport middleware to authenticate requests.

```
var BrightspaceStrategy = require('passport-brightspace-auth');
var app = require('express')();
var passport = require('passport');

passport.use(new BrightspaceStrategy());
app.use(passport.initialize());

app.get('/', passport.authenticate('brightspace'), function(req, res) {
	// req.user will be an instance of BrightspaceAuthToken
	// See https://github.com/Brightspace/node-auth-token
	res.send('You are authenticated!');
});

```

### Options
The strategy also supports a few configuration options:

```
var opts = {
	issuer: 'https://auth.brightspace.com/core',
	maxClockSkew: 300
};

passport.use(new BrightspaceStrategy(opts));
```
#### issuer
A String specifying the auth instance to connect to. If omitted, the default is https://auth.brightspace.com/core.

#### maxClockSkew
A Number specifying the allowed clock skew, in seconds, when validating time-based claims.  If omitted, the default is 300.

---
_Source: https://npm.io/package/passport-brightspace-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._