uuid-apikey

v1.5.3

A Base32-Crockford encoded API Key generator, validator, and converter to turn UUIDs into human readable API Keys For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

48 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.5.3	\|	07/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.6	\|	10/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.5	\|	05/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.3	\|	07/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.4	\|	07/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (7,279)

GitHub Stars: 60
Forks: 13
Contributors: 1

Direct Usage Popularity

The npm package uuid-apikey receives a total of 7,279 downloads a week. As such, we scored uuid-apikey popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package uuid-apikey, we found that it has been starred 60 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like uuid-apikey is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 13
Last Release: 3 years ago
Last Commit: 3 years ago

Further analysis of the maintenance status of uuid-apikey based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for uuid-apikey is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 4 Direct
Versions: 30
Install Size: 37 kB
Dist-tags: 1
# of Files: 19
Maintainers: 1
TS Typings: No

uuid-apikey has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

uuid-apikey

"API Keys are for people"

This module is a generator, validator, and converter that transforms UUIDs into human-readable Base32-Crockford encoded API Keys.

It turns this:

9b3ac4c9-0228-4e42-a244-927059b1a5ea

into this:

KCXC9JD-08M4WGH-M9294W1-B6RTBTH

Notes about Base32-Crockford API Keys

API Keys are 31 characters in length and consist of 4 groups of 7 characters separated by dashes (e.g. XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX)
API Keys are ideal for readable transports where they may be manually entered by a human and similarty character glyphs within the printed typeface may cause confusion. "Is that an O or a 0?"

Base32-Crockford API Keys it avoids these problems by doing the following:

API Keys have no lower-case characters. The API Key parser handles all lower-case characters as their upper-case equivalent. (e.g. a ≡ A)
API Keys do not use similar characters glyphs which can be confused in some typefaces. The parser handles confusing characters as the same values.
- the letters O, o, and the number 0
- the letters L, l, I, i, and the number 1
API Keys do not use the letter U which could inadvertently lead to common English profanities.

Common Uses

Generating and using REST API Keys where a UUID is stored in a host DB but the API Key is shown to the user.
Generating APIKeys and storing the associated equivalent UUIDs values for use as software license keys in software distribution.

NOTE: This package makes use of ES6 and ES7 functionality. If you are using a version of node prior to version 8 then you will need to use a polyfill (e.g. babel) for compatibility.

Installation

You can install uuid-apikey with NPM.

npm install uuid-apikey

Usage

const uuidAPIKey = require('uuid-apikey');

console.log(uuidAPIKey.create());

Output:

{ uuid: '0b9ca335-92a8-46d8-b477-eb2ed83ac927',
  apiKey: '1EEA6DC-JAM4DP2-PHVYPBN-V0XCJ9X' }

Command Line

uuid-apikey installs with a command line tool. The tool is available using the command apiKeyTool which can be install globally using:

  npm install uuid-apikey -g

Options

$ apiKeyTool.js

  Usage: apiKeyTool [options]


  Options:

    -V, --version          output the version number
    -g, --generate         Create a new API Key/UUID pair. Ignores other parameters if passed.
    -u, --uuid       UUID for operation. If no other parameter is passed this is converted to an API Key.
    -a, --apikey   API Key for operation. If no other parameter is passed this is converted to an UUID.
    -c, --check            Check the API Key and/or UUID provided are valid. If both API Key and UUID are passed then they are checked against each other.
    -h, --help             output usage information

Examples

Generation

$ apiKeyTool.js -g

  UUID(9b3ac4c9-0228-4e42-a244-927059b1a5ea)
APIKey(KCXC9JD-08M4WGH-M9294W1-B6RTBTH)

Conversion

$ apiKeyTool.js -a KCXC9JD-08M4WGH-M9294W1-B6RTBTH -u 9b3ac4c9-0228-4e42-a244-927059b1a5ea

UUID(9b3ac4c9-0228-4e42-a244-927059b1a5ea) =&gt; APIKey(KCXC9JD-08M4WGH-M9294W1-B6RTBTH)
APIKey(KCXC9JD-08M4WGH-M9294W1-B6RTBTH)    =&gt; UUID(9b3ac4c9-0228-4e42-a244-927059b1a5ea)

Testing

$ apiKeyTool.js -a KCXC9JD-08M4WGH-M9294W1-B6RTBTH -u 9b3ac4c9-0228-4e42-a244-927059b1a5ea -c

UUID(9b3ac4c9-0228-4e42-a244-927059b1a5ea) : valid
APIKey(KCXC9JD-08M4WGH-M9294W1-B6RTBTH)    : valid
UUID &amp; APIKey are identical                : true

API Reference

.isUUID(uuid)

Tests if the UUID string passed is a valid UUID.

uuidAPIKey.isUUID('0b9ca335-92a8-46d8-b477-eb2ed83ac927');
uuidAPIKey.isUUID('NodeJS');

Output:

true
false

.isAPIKey(apiKey)

Tests if the API Key string passed is a valid API Key.

uuidAPIKey.isAPIKey('1EEA6DC-JAM4DP2-PHVYPBN-V0XCJ9X');
uuidAPIKey.isAPIKey('NodeJS');

Output:

true
false

.toAPIKey(uuid, [options])

Converts a valid UUID into an API Key. Throws a TypeError if the UUID is invalid.

uuidAPIKey.toAPIKey('0b9ca335-92a8-46d8-b477-eb2ed83ac927');
uuidAPIKey.toAPIKey('0b9ca335-92a8-46d8-b477-eb2ed83ac927', { 'noDashes': true });

Output:

'1EEA6DC-JAM4DP2-PHVYPBN-V0XCJ9X'
'1EEA6DCJAM4DP2PHVYPBNV0XCJ9X'

Options

Option	Type	Desc
noDashes	boolean	Generates an APIKey without dashes

.toUUID(apiKey)

Converts a valid API Key into an UUID. Throws a TypeError if the API Key is invalid.

uuidAPIKey.toUUID('1EEA6DC-JAM4DP2-PHVYPBN-V0XCJ9X');

Output:

'0b9ca335-92a8-46d8-b477-eb2ed83ac927'

.check(apiKey, uuid)

Test that an API Key and a UUID are identical. Throws a TypeError if either the API Key or the UUID is invalid.

uuidAPIKey.check('1EEA6DC-JAM4DP2-PHVYPBN-V0XCJ9X', '0b9ca335-92a8-46d8-b477-eb2ed83ac927');

Output:

true

.create([options])

Returns a new UUID and API Key pair

uuidAPIKey.create();

Output:

{ uuid: '0b9ca335-92a8-46d8-b477-eb2ed83ac927',
  apiKey: '1EEA6DC-JAM4DP2-PHVYPBN-V0XCJ9X' }

Options

Option	Type	Desc
noDashes	boolean	Generates an APIKey without dashes

License

uuid-apikey dependencies

colors commander encode32 uuid

uuid-apikey development dependencies

chai codacy-coverage eslint gulp gulp-eslint gulp-mocha gulp-prettier mocha nyc prettier

FAQs

What is uuid-apikey?

A Base32-Crockford encoded API Key generator, validator, and converter to turn UUIDs into human readable API Keys. Visit Snyk Advisor to see a full health score report for uuid-apikey, including popularity, security, maintenance & community analysis.

Is uuid-apikey popular?

The npm package uuid-apikey receives a total of 7,279 weekly downloads. As such, uuid-apikey popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is uuid-apikey well maintained?

We found indications that uuid-apikey is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is uuid-apikey safe to use?

The npm package uuid-apikey was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 6 December-2024, at 05:16 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (7,279)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

uuid-apikey

Notes about Base32-Crockford API Keys

Common Uses

Installation

Usage

Command Line

Options

Examples

Generation

Conversion

Testing

API Reference

.isUUID(uuid)

.isAPIKey(apiKey)

.toAPIKey(uuid, [options])

.toUUID(apiKey)

.check(apiKey, uuid)

.create([options])

License

uuid-apikey dependencies

uuid-apikey development dependencies

FAQs

What is uuid-apikey?

Is uuid-apikey popular?

Is uuid-apikey well maintained?

Is uuid-apikey safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues