vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #22068 from brikou/feature/jsonwebtoken

Browse Source 
[jsonwebtoken] change decode object signature to be less restrictive
This commit is contained in:
Arthur Ozga 2018-03-16 14:02:28 -07:00 committed by GitHub
commit a088ce7c57
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 48 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
types/jsonwebtoken/index.d.ts vendored
View File

@ -1,4 +1,4 @@
// Type definitions for jsonwebtoken 7.2.1
// Type definitions for jsonwebtoken 7.2.2
// Project: https://github.com/auth0/node-jsonwebtoken
// Definitions by: Maxime LUCE <https://github.com/SomaticIT>,
// Daniel Heim <https://github.com/danielheim>,
@ -167,4 +167,4 @@ declare function verify(
declare function decode(
token: string,
options?: DecodeOptions,
): null | object | string;
): null | { [key: string]: any } | string;

80
types/jsonwebtoken/jsonwebtoken-tests.ts
View File

@ -11,39 +11,44 @@ var token: string;
var cert: Buffer;
interface ITestObject {
'foo': string
foo: string;
}
const testObject = { foo: 'bar' }
const testObject = { foo: "bar" };
/**
* jwt.sign
* https://github.com/auth0/node-jsonwebtoken#usage
*/
// sign with default (HMAC SHA256)
token = jwt.sign(testObject, 'shhhhh');
token = jwt.sign(testObject, "shhhhh");
// sign with default (HMAC SHA256) and single audience
token = jwt.sign(testObject, 'shhhhh', { audience: "theAudience"});
token = jwt.sign(testObject, "shhhhh", { audience: "theAudience" });
// sign with default (HMAC SHA256) and multiple audiences
token = jwt.sign(testObject, 'shhhhh', { audience: ["audience1", "audience2"]});
token = jwt.sign(testObject, "shhhhh", {
audience: ["audience1", "audience2"],
});
// sign with default (HMAC SHA256) and a keyid
token = jwt.sign(testObject, 'shhhhh', { keyid: "theKeyId"});
token = jwt.sign(testObject, "shhhhh", { keyid: "theKeyId" });
// sign with RSA SHA256
cert = fs.readFileSync('private.key'); // get private key
token = jwt.sign(testObject, cert, { algorithm: 'RS256'});
cert = fs.readFileSync("private.key"); // get private key
token = jwt.sign(testObject, cert, { algorithm: "RS256" });
// sign with encrypted RSA SHA256 private key (only PEM encoding is supported)
const privKey: Buffer = fs.readFileSync('encrypted_private.key'); // get private key
const secret = {key: privKey.toString(), passphrase: 'keypwd'}
token = jwt.sign(testObject, secret, { algorithm: 'RS256' }); // the algorithm option is mandatory in this case
const privKey: Buffer = fs.readFileSync("encrypted_private.key"); // get private key
const secret = { key: privKey.toString(), passphrase: "keypwd" };
token = jwt.sign(testObject, secret, { algorithm: "RS256" }); // the algorithm option is mandatory in this case
// sign asynchronously
jwt.sign(testObject, cert, { algorithm: 'RS256' }, function(err: Error, token: string) {
console.log(token);
jwt.sign(testObject, cert, { algorithm: "RS256" }, function(
err: Error,
token: string,
) {
console.log(token);
});
/**
@ -51,10 +56,10 @@ jwt.sign(testObject, cert, { algorithm: 'RS256' }, function(err: Error, token: s
* https://github.com/auth0/node-jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback
*/
// verify a token symmetric
jwt.verify(token, 'shhhhh', function(err, decoded) {
const result = decoded as ITestObject
jwt.verify(token, "shhhhh", function(err, decoded) {
const result = decoded as ITestObject;
console.log(result.foo) // bar
console.log(result.foo); // bar
});
// use external time for verifying
@ -65,41 +70,44 @@ jwt.verify(token, 'shhhhh', { clockTimestamp: 1 }, function(err, decoded) {
});
// invalid token
jwt.verify(token, 'wrong-secret', function(err, decoded) {
// err
// decoded undefined
jwt.verify(token, "wrong-secret", function(err, decoded) {
// err
// decoded undefined
});
// verify a token asymmetric
cert = fs.readFileSync('public.pem'); // get public key
jwt.verify(token, cert, function (err, decoded) {
const result = decoded as ITestObject
cert = fs.readFileSync("public.pem"); // get public key
jwt.verify(token, cert, function(err, decoded) {
const result = decoded as ITestObject;
console.log(result.foo) // bar
console.log(result.foo); // bar
});
// verify audience
cert = fs.readFileSync('public.pem'); // get public key
jwt.verify(token, cert, { audience: 'urn:foo' }, function(err, decoded) {
// if audience mismatch, err == invalid audience
cert = fs.readFileSync("public.pem"); // get public key
jwt.verify(token, cert, { audience: "urn:foo" }, function(err, decoded) {
// if audience mismatch, err == invalid audience
});
// verify issuer
cert = fs.readFileSync('public.pem'); // get public key
jwt.verify(token, cert, { audience: 'urn:foo', issuer: 'urn:issuer' }, function(err, decoded) {
// if issuer mismatch, err == invalid issuer
cert = fs.readFileSync("public.pem"); // get public key
jwt.verify(token, cert, { audience: "urn:foo", issuer: "urn:issuer" }, function(
err,
decoded,
) {
// if issuer mismatch, err == invalid issuer
});
// verify algorithm
cert = fs.readFileSync('public.pem'); // get public key
jwt.verify(token, cert, { algorithms: ['RS256'] }, function(err, decoded) {
// if algorithm mismatch, err == invalid algorithm
cert = fs.readFileSync("public.pem"); // get public key
jwt.verify(token, cert, { algorithms: ["RS256"] }, function(err, decoded) {
// if algorithm mismatch, err == invalid algorithm
});
// verify without expiration check
cert = fs.readFileSync('public.pem'); // get public key
cert = fs.readFileSync("public.pem"); // get public key
jwt.verify(token, cert, { ignoreExpiration: true }, function(err, decoded) {
// if ignoreExpration == false and token is expired, err == expired token
// if ignoreExpration == false and token is expired, err == expired token
});
/**
@ -110,6 +118,10 @@ var decoded = jwt.decode(token);
decoded = jwt.decode(token, { complete: false });
if (decoded !== null && typeof decoded === "object") {
console.log(decoded.foo);
}
decoded = jwt.decode(token, { json: false });
decoded = jwt.decode(token, { complete: false, json: false });