Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add alias for obtaining the public key #119

Merged
merged 5 commits into from
Jan 21, 2020
Merged

Add alias for obtaining the public key #119

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1d998ca
add test for multiple pubkey source
lbalmaceda Jan 17, 2020
5b3e4d2
add getPublicKey method on each key
lbalmaceda Jan 20, 2020
2a1da8b
update ts definitions
lbalmaceda Jan 20, 2020
5dbf5c6
update README.md file
lbalmaceda Jan 20, 2020
73266e8
refactor the jwk object creation code
lbalmaceda Jan 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ declare namespace JwksRsa {
interface CertSigningKey {
kid: string;
nbf: string;
pem: string;
damieng marked this conversation as resolved.
Show resolved Hide resolved
lbalmaceda marked this conversation as resolved.
Show resolved Hide resolved
publicKey: string;
}

Expand All @@ -52,6 +53,7 @@ declare namespace JwksRsa {
interface RsaSigningKey {
kid: string;
nbf: string;
pem: string;
rsaPublicKey: string;
}

Expand Down
23 changes: 12 additions & 11 deletions src/JwksClient.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,20 @@ export class JwksClient {
return ((key.x5c && key.x5c.length) || (key.n && key.e));
})
.map(key => {
if (key.x5c && key.x5c.length) {
return {
kid: key.kid,
nbf: key.nbf,
publicKey: certToPEM(key.x5c[0])
};
const hasCertificateChain = key.x5c && key.x5c.length;
const pem = hasCertificateChain ? certToPEM(key.x5c[0]) : rsaPublicKeyToPEM(key.n, key.e);
const jwk = {
kid: key.kid,
nbf: key.nbf,
pem
};
//below is for backwards compatibility
if (hasCertificateChain) {
lbalmaceda marked this conversation as resolved.
Show resolved Hide resolved
jwk.publicKey = pem;
} else {
return {
kid: key.kid,
nbf: key.nbf,
rsaPublicKey: rsaPublicKeyToPEM(key.n, key.e)
};
jwk.rsaPublicKey = pem;
}
return jwk;
});

if (!signingKeys.length) {
Expand Down
54 changes: 54 additions & 0 deletions tests/jwksClient.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,55 @@ describe("JwksClient", () => {
});
});

it("should return signing keys (with x5c and mod/exp)", done => {
nock(jwksHost)
.get("/.well-known/jwks.json")
.reply(200, {
keys: [
{
alg: "RS256",
kty: "RSA",
use: "sig",
x5c: [
"MIIDDTCCAfWgAwIBAgIJAJVkuSv2H8mDMA0GCSqGSIb3DQEBBQUAMB0xGzAZBgNVBAMMEnNhbmRyaW5vLmF1dGgwLmNvbTAeFw0xNDA1MTQyMTIyMjZaFw0yODAxMjEyMTIyMjZaMB0xGzAZBgNVBAMMEnNhbmRyaW5vLmF1dGgwLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL6jWASkHhXz5Ug6t5BsYBrXDIgrWu05f3oq2fE+5J5REKJiY0Ddc+Kda34ZwOptnUoef3JwKPDAckTJQDugweNNZPwOmFMRKj4xqEpxEkIX8C+zHs41Q6x54ZZy0xU+WvTGcdjzyZTZ/h0iOYisswFQT/s6750tZG0BOBtZ5qS/80tmWH7xFitgewdWteJaASE/eO1qMtdNsp9fxOtN5U/pZDUyFm3YRfOcODzVqp3wOz+dcKb7cdZN11EYGZOkjEekpcedzHCo9H4aOmdKCpytqL/9FXoihcBMg39s1OW3cfwfgf5/kvOJdcqR4PoATQTfsDVoeMWVB4XLGR6SC5kCAwEAAaNQME4wHQYDVR0OBBYEFHDYn9BQdup1CoeoFi0Rmf5xn/W9MB8GA1UdIwQYMBaAFHDYn9BQdup1CoeoFi0Rmf5xn/W9MAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADggEBAGLpQZdd2ICVnGjc6CYfT3VNoujKYWk7E0shGaCXFXptrZ8yaryfo6WAizTfgOpQNJH+Jz+QsCjvkRt6PBSYX/hb5OUDU2zNJN48/VOw57nzWdjI70H2Ar4oJLck36xkIRs/+QX+mSNCjZboRwh0LxanXeALHSbCgJkbzWbjVnfJEQUP9P/7NGf0MkO5I95C/Pz9g91y8gU+R3imGppLy9Zx+OwADFwKAEJak4JrNgcjHBQenakAXnXP6HG4hHH4MzO8LnLiKv8ZkKVL67da/80PcpO0miMNPaqBBMd2Cy6GzQYE0ag6k0nk+DMIFn7K+o21gjUuOEJqIbAvhbf2KcM="
],
n:
"vqNYBKQeFfPlSDq3kGxgGtcMiCta7Tl_eirZ8T7knlEQomJjQN1z4p1rfhnA6m2dSh5_cnAo8MByRMlAO6DB401k_A6YUxEqPjGoSnESQhfwL7MezjVDrHnhlnLTFT5a9MZx2PPJlNn-HSI5iKyzAVBP-zrvnS1kbQE4G1nmpL_zS2ZYfvEWK2B7B1a14loBIT947Woy102yn1_E603lT-lkNTIWbdhF85w4PNWqnfA7P51wpvtx1k3XURgZk6SMR6Slx53McKj0fho6Z0oKnK2ov_0VeiKFwEyDf2zU5bdx_B-B_n-S84l1ypHg-gBNBN-wNWh4xZUHhcsZHpILmQ",
e: "AQAB",
kid: "RkI5MjI5OUY5ODc1N0Q4QzM0OUYzNkVGMTJDOUEzQkFCOTU3NjE2Rg",
x5t: "RkI5MjI5OUY5ODc1N0Q4QzM0OUYzNkVGMTJDOUEzQkFCOTU3NjE2Rg"
},
{
kid: "IdTokenSigningKeyContainer",
use: "sig",
kty: "RSA",
e: "AQAB",
n:
"tLDZVZ2Eq_DFwNp24yeSq_Ha0MYbYOJs_WXIgVxQGabu5cZ9561OUtYWdB6xXXZLaZxFG02P5U2rC_CT1r0lPfC_KHYrviJ5Y_Ekif7iFV_1omLAiRksQziwA1i-hND32N5kxwEGNmZViVjWMBZ43wbIdWss4IMhrJy1WNQ07Fqp1Ee6o7QM1hTBve7bbkJkUAfjtC7mwIWqZdWoYIWBTZRXvhMgs_Aeb_pnDekosqDoWQ5aMklk3NvaaBBESqlRAJZUUf5WDFoJh7yRELOFF4lWJxtArTEiQPWVTX6PCs0klVPU6SRQqrtc4kKLCp1AC5EJqPYRGiEJpSz2nUhmAQ"
}
]
});

const client = new JwksClient({
jwksUri: `${jwksHost}/.well-known/jwks.json`
});

client.getSigningKeys((err, keys) => {
expect(err).to.be.null;
expect(keys).not.to.be.null;
expect(keys.length).to.equal(2);
const pubkey0 = keys[0].publicKey || keys[0].rsaPublicKey
expect(pubkey0).not.to.be.null;
expect(keys[0].pem).to.equal(keys[0].publicKey);
expect(keys[1].kid).to.equal("IdTokenSigningKeyContainer");
expect(keys[0].kid).to.equal("RkI5MjI5OUY5ODc1N0Q4QzM0OUYzNkVGMTJDOUEzQkFCOTU3NjE2Rg");
const pubkey1 = keys[1].publicKey || keys[1].rsaPublicKey
expect(pubkey1).not.to.be.null;
expect(keys[1].pem).to.equal(keys[1].rsaPublicKey);
done();
});
});

it("should return signing keys (with x5c)", done => {
nock(jwksHost)
.get("/.well-known/jwks.json")
Expand Down Expand Up @@ -245,13 +294,15 @@ describe("JwksClient", () => {
expect(keys).not.to.be.null;
expect(keys.length).to.equal(2);
expect(keys[0].publicKey).not.to.be.null;
expect(keys[0].pem).to.equal(keys[0].publicKey);
expect(keys[0].kid).to.equal(
"RkI5MjI5OUY5ODc1N0Q4QzM0OUYzNkVGMTJDOUEzQkFCOTU3NjE2Rg"
);
expect(keys[1].kid).to.equal(
"NkFCNEE1NDFDNTQ5RTQ5OTE1QzRBMjYyMzY0NEJCQTJBMjJBQkZCMA"
);
expect(keys[1].publicKey).not.to.be.null;
expect(keys[1].pem).to.equal(keys[1].publicKey);
expect(keys[1].nbf).to.equal(123);
done();
});
Expand Down Expand Up @@ -308,11 +359,14 @@ describe("JwksClient", () => {
expect(keys).not.to.be.null;
expect(keys.length).to.equal(3);
expect(keys[0].rsaPublicKey).not.to.be.null;
expect(keys[0].pem).to.equal(keys[0].rsaPublicKey);
expect(keys[0].kid).to.equal("IdTokenSigningKeyContainer");
expect(keys[1].kid).to.equal("IdTokenSigningKeyContainer.v2");
expect(keys[1].rsaPublicKey).not.to.be.null;
expect(keys[1].pem).to.equal(keys[1].rsaPublicKey);
expect(keys[1].nbf).to.equal(1459289287);
expect(keys[2].rsaPublicKey).not.to.be.null;
expect(keys[2].pem).to.equal(keys[2].rsaPublicKey);
done();
});
});
Expand Down