uuid-apikey
Advanced tools
Comparing version 1.4.2 to 1.4.3
{ | ||
"name": "uuid-apikey", | ||
"version": "1.4.2", | ||
"version": "1.4.3", | ||
"description": "A Base32-Crockford encoded API Key generator, validator, and converter to turn UUIDs into human readable API Keys", | ||
@@ -35,14 +35,14 @@ "main": "index.js", | ||
"codacy-coverage": "^3.4.0", | ||
"eslint": "^5.12.0", | ||
"eslint": "^5.16.0", | ||
"gulp": "^4.0.0", | ||
"gulp-eslint": "^5.0.0", | ||
"gulp-mocha": "^6.0.0", | ||
"gulp-prettier": "^2.0.0", | ||
"mocha": "^5.2.0", | ||
"nyc": "^13.1.0", | ||
"prettier": "^1.15.3" | ||
"gulp-prettier": "^2.1.0", | ||
"mocha": "^6.1.3", | ||
"nyc": "^14.0.0", | ||
"prettier": "^1.17.0" | ||
}, | ||
"dependencies": { | ||
"colors": "^1.3.2", | ||
"commander": "^2.19.0", | ||
"colors": "^1.3.3", | ||
"commander": "^2.20.0", | ||
"encode32": "^1.1.0", | ||
@@ -49,0 +49,0 @@ "uuid": "^3.3.2" |
@@ -17,9 +17,10 @@ # uuid-apikey | ||
* API Keys are 31 characters in length consisting of 4 groups of 7 characters separated by dashes *(e.g. XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX)* | ||
* They avoids the problem that Base64 encoded values can create | ||
* Fully upper-case, but treat lower-case for their equivalents *(e.g. a = A)* | ||
* No tricky characters, but treat them equivalently *(i.e. 0 = O / 1 = L = I )* | ||
* No characters that inadvertently lead to common profanities *(i.e. letter U is omitted)* | ||
* They avoids the problem that Base64 encoded values can create, such as: | ||
* API Keys are entirely in upper-case, but treat lower-case values as their upper-case counterparts *(e.g. a ≡ A)* | ||
* API Keys do not use tricky characters (i.e. the letter O, the letter L, and the letter I), but treat them equivalently with other characters they could be confused for *(i.e. 0 ≡ O ≡ o / 1 ≡ L ≡ I ≡ l ≡ i )* | ||
* API Keys omit letters which could inadvertently lead to common profanities *(i.e. the letter U)* | ||
One common use for this library is in REST APIs, by storing a UUIDs in a host DB but displaying the human-readable API Key to a user. | ||
Another use for this library is creating and validating product keys for distributed software. | ||
## 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 UUIDs for use as software license keys in software distribution. | ||
@@ -26,0 +27,0 @@ ***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 probably need to use a polyfill (e.g. babel) for compatibility. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
25599
175
Updatedcolors@^1.3.3
Updatedcommander@^2.20.0