Registry / auth-security / brightspace-auth-provisioning

brightspace-auth-provisioning

library9.0.1jsnpmunverified

The `brightspace-auth-provisioning` library facilitates the creation and assertion of access tokens against a Brightspace authentication service. It abstracts the complexities of token generation, allowing developers to provision tokens with specific claims such as scopes, tenant IDs, user IDs, impersonator IDs, and Caliper FSIDs. The current stable version is `9.0.1`, which requires Node.js version `20.x` or higher. The package sees active development with major versions released periodically (e.g., v7, v8, v9) and more frequent patch and minor releases. Its key differentiator is its tight integration with the Brightspace authentication ecosystem, providing a specific API for generating tokens that adhere to Brightspace's assertion requirements, including a flexible `keyLookup` mechanism for signing keys and support for caching mechanisms.

auth-security http-networking

npm install brightspace-auth-provisioning

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · BRIGHTSPACE-AUTH-P

brightspace-auth-provisioning

auth-securityjavascriptv9.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AuthTokenProvisioner

✓ import { AuthTokenProvisioner } from 'brightspace-auth-provisioning';

✗ const AuthTokenProvisioner = require('brightspace-auth-provisioning');

While the README shows CommonJS `require`, modern Node.js projects (especially with `node >=20.x`) typically use ES Modules. Both are generally supported, but `import` is preferred for new code.

AbstractProvisioningCache

✓ import { AbstractProvisioningCache } from 'brightspace-auth-provisioning';

✗ const AbstractProvisioningCache = require('brightspace-auth-provisioning').AbstractProvisioningCache;

This is an abstract class intended for extension, available as a named export. Ensure you import it correctly for type hinting or extension.

AuthTokenProvisioner

✓ const { AuthTokenProvisioner } = require('brightspace-auth-provisioning');

✗ import AuthTokenProvisioner from 'brightspace-auth-provisioning';

The primary class is a named export, not a default export. Using `require` directly on the package returns an object with named exports.

This quickstart demonstrates how to instantiate `AuthTokenProvisioner`, provide a `keyLookup` function returning a `KeyObject`, and then use it to provision an access token with specified claims.

import { AuthTokenProvisioner } from 'brightspace-auth-provisioning'; import { KeyObject, generateKeyPairSync } from 'node:crypto'; async function provisionExampleToken() { // Generate a dummy key pair for demonstration purposes // In a real application, you would load this securely const { privateKey } = generateKeyPairSync('ec', { namedCurve: 'P-256', publicKeyEncoding: { type: 'spki', format: 'pem' }, privateKeyEncoding: { type: 'pkcs8', format: 'pem' } }); const provisioner = new AuthTokenProvisioner({ issuer: 'ece083bc-e6ac-11e4-8e1b-54ee750fffa4', // Replace with your service's issuer GUID keyLookup: async () => { return { kid: '0a9e68f6-e6ad-11e4-8ab6-54ee750fffa4', // Replace with your key ID key: privateKey, // Must be a node:crypto KeyObject alg: 'ES256' }; } }); try { const token = await provisioner.provisionToken({ user: '32647', impersonator: '30882', tenant: '5492ff8a-e6ad-11e4-84d6-54ee750fffa4', scopes: ['updates:feed-items:read', 'core:*:*'], fsid: 'eyJhbGciOiJIUzI1Ni...' // Optional Caliper FSID }); console.log('Successfully provisioned token:', token); return token; } catch (error) { console.error('Error provisioning token:', error); throw error; } } provisionExampleToken();

Debug

Known issues

breakingVersion 9.x (and potentially prior major versions) requires Node.js runtime version 20.x or higher. Running on older Node.js versions will result in errors.

fix

Upgrade your Node.js environment to version 20.x or newer. Use `nvm install 20 && nvm use 20` or similar version management tools.

affects: >=9.0.0

gotchaThe `keyLookup` option for `AuthTokenProvisioner` must return a Promise resolving to an object where the `key` property is a `node:crypto.KeyObject`, not a raw key string or buffer. Incorrect key types will lead to signing errors.

fix

Ensure that your `keyLookup` function correctly loads and returns a `KeyObject` (e.g., from a PEM string using `crypto.createPrivateKey`).

affects: >=6.0.0

breakingMajor version updates (e.g., v6.x to v7.x, v7.x to v8.x, v8.x to v9.x) typically introduce breaking changes in the API or required options. Always consult the release notes when upgrading between major versions.

fix

Review the specific release notes or changelog for the version you are upgrading to and adapt your code accordingly. Pay close attention to constructor options and method signatures.

affects: >=6.0.0

Errors

Common errors & fixes

Cannot find package 'brightspace-auth-keys' imported from ...

The `brightspace-auth-keys` package is a peer dependency but was not installed in your project.

fix

Install the peer dependency: `npm install brightspace-auth-keys` or `yarn add brightspace-auth-keys`.

TypeError: AuthTokenProvisioner is not a constructor

Attempting to use `require('brightspace-auth-provisioning')` and then calling it as a default export, or using `import AuthTokenProvisioner from '...'`. The class is a named export.

fix

For CommonJS, use `const { AuthTokenProvisioner } = require('brightspace-auth-provisioning');`. For ES Modules, use `import { AuthTokenProvisioner } from 'brightspace-auth-provisioning';`.

Error: privateKey is not a KeyObject

The object returned by `keyLookup` has a `key` property that is not an instance of `node:crypto.KeyObject`.

fix

Ensure that the `key` property in the object returned by `keyLookup` is a properly instantiated `KeyObject`. Use `crypto.createPrivateKey()` to convert PEM strings or other formats.

Upgrade

Version history

9.0.1latest on npm

Audit

Dependencies

brightspace-auth-keysrequiredRequired for looking up and managing authentication keys, as indicated by the peer dependency.

Agent activity

19 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/Brightspace/node-auth ↗

packagehttps://www.npmjs.com/package/brightspace-auth-provisioning ↗

homepagehttps://www.d2l.com ↗