Registry / auth-security / opentok-token

opentok-token

JSON →
library1.1.1jsnpmunverified

The `opentok-token` package is a low-level utility designed to generate `X-TB-TOKEN-AUTH` headers for authentication with the OpenTok REST API. As of its current stable version, 1.1.1, it focuses solely on the encoding process, transforming provided token data, an API key, and an API secret into a JWT string. A critical characteristic of this package is its explicit lack of input validation; it does not check if the provided data aligns with OpenTok REST API semantics, allowing for the generation of syntactically correct but functionally invalid tokens. It offers default values for `create_time`, `expire_time`, `role`, and `nonce` if these properties are omitted from the token data. Its primary distinction is its role as a simple encoder, contrasting with the more comprehensive `opentok-node` server SDK, which provides a full suite of API interactions including data validation. Given its last update several years ago, the package is effectively no longer maintained, indicating an inactive release cadence.

auth-security
npm install opentok-token
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · OPENTOK-TOKEN
O
opentok-token
auth-securityjavascriptv1.1.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.

encodeToken
✓ import encodeToken from 'opentok-token';
✗ const { encodeToken } = require('opentok-token');
The package's primary export is a default function. While CommonJS `require` works, direct named import for ESM might not be ideal without a transpiler or specific Node.js configuration for older packages.
encodeToken (CommonJS)
✓ const encodeToken = require('opentok-token');
This is the documented and most reliable import method for this older package, which was written prior to widespread ESM adoption.

Demonstrates how to generate an OpenTok API token using `opentok-token`, including setting a role and connection data, with a note on required API credentials.

const encodeToken = require('opentok-token'); // IMPORTANT: Replace with your actual OpenTok API Key and Secret const apiKey = process.env.OPENTOK_API_KEY ?? 'YOUR_API_KEY'; const apiSecret = process.env.OPENTOK_API_SECRET ?? 'YOUR_API_SECRET'; const sessionId = 'SESSIONID_FROM_OPENTOK'; // Replace with a valid OpenTok Session ID // Token data for a moderator role, expiring in 24 hours const tokenData = { session_id: sessionId, // create_time and nonce will default to now and a random number if not specified role: 'moderator', // expire_time will default to now + 1 day if not specified connection_data: JSON.stringify({ 'user_id': 'user123', 'level': 'gold' }) }; try { const token = encodeToken(tokenData, apiKey, apiSecret); console.log('Generated OpenTok Token:', token); // You would typically use this token in the X-TB-TOKEN-AUTH header // when making requests to the OpenTok REST API. } catch (error) { console.error('Error generating token:', error.message); }
Debug
Known issues
gotchaThis module explicitly states it does not validate the data provided for token encoding against OpenTok REST API semantics. You can generate a syntactically correct token that is functionally invalid, leading to API authentication failures.
fix
Manually ensure all `tokenData` properties conform to OpenTok's specifications for roles, expiry, and session IDs. For more robust handling and validation, consider using the official `opentok-node` SDK instead.
affects: >=1.0.0
gotchaThe `opentok-token` package appears to be abandoned, with no significant updates or commits in several years. This means it may not receive security patches, bug fixes, or compatibility updates for newer Node.js versions or OpenTok API changes.
fix
Evaluate your project's long-term stability and security needs. For new projects or critical applications, it is strongly recommended to use the actively maintained `opentok-node` SDK or a similar up-to-date solution.
affects: >=1.0.0
gotchaThe package primarily uses CommonJS (`require`). While modern Node.js environments might allow `import` statements, direct ESM imports could lead to issues if your project's module resolution isn't configured correctly or if the package lacks proper `exports` map.
fix
For maximum compatibility, especially in older Node.js environments or mixed CJS/ESM projects, use the `require()` syntax: `const encodeToken = require('opentok-token');`.
affects: >=1.0.0
Errors
Common errors & fixes
OpenTok API returns '403 Forbidden' or 'Invalid Token'
The token generated was either syntactically incorrect (e.g., wrong API Key/Secret) or semantically invalid for the requested operation/session (e.g., expired role, invalid session ID, malformed connection data). The `opentok-token` package does not validate input data.
fix
Double-check `apiKey`, `apiSecret`, and all `tokenData` properties (especially `session_id`, `role`, and `expire_time`) against OpenTok's API documentation. Ensure `connection_data` is a properly JSON-stringified string. Consider using `opentok-node` for automatic validation.
TypeError: encodeToken is not a function (or similar import error)
Incorrect import statement or module resolution issue, especially when trying to use ESM `import` with a CommonJS-first package, or attempting to destructure a default export.
fix
Ensure you are importing the default export correctly. For CommonJS, use `const encodeToken = require('opentok-token');`. For ESM, use `import encodeToken from 'opentok-token';` and ensure your Node.js environment or build setup properly handles CJS interoperability.
Upgrade
Version history
1.1.1latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
11 hits · last 30 days
node
10
OpenAI (training)
1
Resources
githubhttps://github.com/opentok/token-encoder ↗
packagehttps://www.npmjs.com/package/opentok-token ↗
homepagehttps://tokbox.com ↗
opentok-token — npm install opentok-token · libregistry