Skip to content

Change local storage to session storage for keys #103

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

Closed
leeland-turnkey wants to merge 1 commit into from
Closed

Change local storage to session storage for keys #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions export-and-sign/dist/bundle.67d574dd01a5e3d636d0.js
View file
Open in desktop

Large diffs are not rendered by default.

0 ...undle.78c912c0211a44421f40.js.LICENSE.txt → ...undle.67d574dd01a5e3d636d0.js.LICENSE.txt
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions export-and-sign/dist/bundle.67d574dd01a5e3d636d0.js.map
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions export-and-sign/dist/bundle.78c912c0211a44421f40.js
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion export-and-sign/dist/bundle.78c912c0211a44421f40.js.map
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion export-and-sign/dist/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html class="no-js"><head><link rel="icon" type="image/svg+xml" href="./favicon.svg"/><meta charset="utf-8"/><title>Turnkey Export</title><meta name="viewport" content="width=device-width,initial-scale=1"/><meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'; style-src 'self'; base-uri 'self'; object-src 'none'; form-action 'none'"><link href="/styles.e084a69a94c0575bc6ba.css" rel="stylesheet"></head><body><h2>Export Key Material</h2><p><em>This public key will be sent along with a private key ID or wallet ID inside of a new <code>EXPORT_PRIVATE_KEY</code> or <code>EXPORT_WALLET</code> activity</em></p><form><label>Embedded key</label> <input name="embedded-key" id="embedded-key" disabled="disabled"/> <button id="reset">Reset Key</button></form><br/><br/><br/><h2>Inject Key Export Bundle</h2><p><em>The export bundle comes from the parent page and is composed of a public key and an encrypted payload. The payload is encrypted to this document's embedded key (stored in local storage and displayed above). The scheme relies on <a target="_blank" href="https://datatracker.ietf.org/doc/rfc9180/">HPKE (RFC 9180)</a></em>.</p><form><label>Bundle</label> <input name="key-export-bundle" id="key-export-bundle"/> <button id="inject-key">Inject Bundle</button><br/><label>Key Format</label> <select id="key-export-format" name="key-export-format"><option value="HEXADECIMAL">Hexadecimal (Default)</option><option value="SOLANA">Solana</option></select><br/><label>Organization Id</label> <input name="key-organization-id" id="key-organization-id"/></form><br/><br/><h2>Inject Wallet Export Bundle</h2><p><em>The export bundle comes from the parent page and is composed of a public key and an encrypted payload. The payload is encrypted to this document's embedded key (stored in local storage and displayed above). The scheme relies on <a target="_blank" href="https://datatracker.ietf.org/doc/rfc9180/">HPKE (RFC 9180)</a></em>.</p><form><label>Bundle</label> <input name="wallet-export-bundle" id="wallet-export-bundle"/> <button id="inject-wallet">Inject Bundle</button><br/><label>Organization Id</label> <input name="wallet-organization-id" id="wallet-organization-id"/></form><br/><br/><h2>Sign Transaction</h2><p><em>Input a serialized transaction to sign.</em></p><form><label>Transaction</label> <input name="transaction-to-sign" id="transaction-to-sign"/> <button id="sign-transaction">Sign</button></form><br/><br/><h2>Sign Message</h2><p><em>Input a serialized message to sign.</em></p><form><label>Message</label> <input name="message-to-sign" id="message-to-sign"/> <button id="sign-message">Sign</button></form><br/><br/><h2>Message log</h2><p><em>Below we display a log of the messages sent / received. The forms above send messages, and the code communicates results by sending events via the <code>postMessage</code> API.</em></p><div id="message-log"></div><div id="key-div"></div><script defer="defer" src="/bundle.df1ee7804c25796915e3.js"></script><script defer="defer" src="/bundle.78c912c0211a44421f40.js"></script></body></html>
<!doctype html><html class="no-js"><head><link rel="icon" type="image/svg+xml" href="./favicon.svg"/><meta charset="utf-8"/><title>Turnkey Export</title><meta name="viewport" content="width=device-width,initial-scale=1"/><meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'; style-src 'self'; base-uri 'self'; object-src 'none'; form-action 'none'"><link href="/styles.e084a69a94c0575bc6ba.css" rel="stylesheet"></head><body><h2>Export Key Material</h2><p><em>This public key will be sent along with a private key ID or wallet ID inside of a new <code>EXPORT_PRIVATE_KEY</code> or <code>EXPORT_WALLET</code> activity</em></p><form><label>Embedded key</label> <input name="embedded-key" id="embedded-key" disabled="disabled"/> <button id="reset">Reset Key</button></form><br/><br/><br/><h2>Inject Key Export Bundle</h2><p><em>The export bundle comes from the parent page and is composed of a public key and an encrypted payload. The payload is encrypted to this document's embedded key (stored in local storage and displayed above). The scheme relies on <a target="_blank" href="https://datatracker.ietf.org/doc/rfc9180/">HPKE (RFC 9180)</a></em>.</p><form><label>Bundle</label> <input name="key-export-bundle" id="key-export-bundle"/> <button id="inject-key">Inject Bundle</button><br/><label>Key Format</label> <select id="key-export-format" name="key-export-format"><option value="HEXADECIMAL">Hexadecimal (Default)</option><option value="SOLANA">Solana</option></select><br/><label>Organization Id</label> <input name="key-organization-id" id="key-organization-id"/></form><br/><br/><h2>Inject Wallet Export Bundle</h2><p><em>The export bundle comes from the parent page and is composed of a public key and an encrypted payload. The payload is encrypted to this document's embedded key (stored in local storage and displayed above). The scheme relies on <a target="_blank" href="https://datatracker.ietf.org/doc/rfc9180/">HPKE (RFC 9180)</a></em>.</p><form><label>Bundle</label> <input name="wallet-export-bundle" id="wallet-export-bundle"/> <button id="inject-wallet">Inject Bundle</button><br/><label>Organization Id</label> <input name="wallet-organization-id" id="wallet-organization-id"/></form><br/><br/><h2>Sign Transaction</h2><p><em>Input a serialized transaction to sign.</em></p><form><label>Transaction</label> <input name="transaction-to-sign" id="transaction-to-sign"/> <button id="sign-transaction">Sign</button></form><br/><br/><h2>Sign Message</h2><p><em>Input a serialized message to sign.</em></p><form><label>Message</label> <input name="message-to-sign" id="message-to-sign"/> <button id="sign-message">Sign</button></form><br/><br/><h2>Message log</h2><p><em>Below we display a log of the messages sent / received. The forms above send messages, and the code communicates results by sending events via the <code>postMessage</code> API.</em></p><div id="message-log"></div><div id="key-div"></div><script defer="defer" src="/bundle.df1ee7804c25796915e3.js"></script><script defer="defer" src="/bundle.67d574dd01a5e3d636d0.js"></script></body></html>
262 changes: 255 additions & 7 deletions export-and-sign/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ describe("TKHQ", () => {
global.window = dom.window;
global.document = dom.window.document;
global.localStorage = dom.window.localStorage;
global.sessionStorage = dom.window.sessionStorage;
global.crypto = crypto.webcrypto;

const module = await import("./src/turnkey-core.js");
Expand All @@ -81,11 +82,11 @@ describe("TKHQ", () => {
TKHQ = dom.window.TKHQ;
});

describe("LocalStorage with expiry", () => {
it("gets and sets items with expiry localStorage", async () => {
describe("SessionStorage with expiry", () => {
it("gets and sets items with expiry sessionStorage", async () => {
// Set a TTL of 1000ms
TKHQ.setItemWithExpiry("k", "v", 1000);
let item = JSON.parse(dom.window.localStorage.getItem("k"));
let item = JSON.parse(dom.window.sessionStorage.getItem("k"));
expect(item.value).toBe("v");
expect(item.expiry).toBeTruthy();

Expand All @@ -96,7 +97,7 @@ describe("TKHQ", () => {
// Test expired item: use setItemWithExpiry, then manually set expiry in the past
TKHQ.setItemWithExpiry("a", "b", 500);
// Verify the item was set correctly with setItemWithExpiry
let itemA = JSON.parse(dom.window.localStorage.getItem("a"));
let itemA = JSON.parse(dom.window.sessionStorage.getItem("a"));
expect(itemA.value).toBe("b");
expect(itemA.expiry).toBeTruthy();

Expand All @@ -105,19 +106,19 @@ describe("TKHQ", () => {
value: "b",
expiry: new Date().getTime() - 1000,
};
dom.window.localStorage.setItem("a", JSON.stringify(expiredItem));
dom.window.sessionStorage.setItem("a", JSON.stringify(expiredItem));
const expiredResult = TKHQ.getItemWithExpiry("a");
expect(expiredResult).toBeNull();

// Returns null if getItemWithExpiry is called for item without expiry
dom.window.localStorage.setItem("k", JSON.stringify({ value: "v" }));
dom.window.sessionStorage.setItem("k", JSON.stringify({ value: "v" }));
item = TKHQ.getItemWithExpiry("k");
expect(item).toBeNull();
});
});

describe("Embedded key management", () => {
it("gets and sets embedded key in localStorage", async () => {
it("gets and sets embedded key in sessionStorage", async () => {
expect(TKHQ.getEmbeddedKey()).toBe(null);

// Set a dummy "key"
Expand All @@ -137,6 +138,251 @@ describe("TKHQ", () => {
});
});

describe("Multi-tab isolation (simulating multiple iframe instances)", () => {
let tab1DOM
let tab2DOM;
let tab1TKHQ
let tab2TKHQ;

beforeEach(async () => {
// Simulate Tab 1: Parent website with iframe
tab1DOM = new JSDOM(html, {
runScripts: "dangerously",
url: "http://localhost",
beforeParse(window) {
window.TextDecoder = TextDecoder;
window.TextEncoder = TextEncoder;
window.__TURNKEY_SIGNER_ENVIRONMENT__ = "prod";
},
});

Object.defineProperty(tab1DOM.window, "crypto", {
value: crypto.webcrypto,
});

global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.localStorage = tab1DOM.window.localStorage;
global.sessionStorage = tab1DOM.window.sessionStorage;
global.crypto = crypto.webcrypto;

const module1 = await import("./src/turnkey-core.js");
tab1TKHQ = module1.TKHQ;
tab1DOM.window.TKHQ = tab1TKHQ;

// Simulate Tab 2: Another instance of the same parent website with iframe
tab2DOM = new JSDOM(html, {
runScripts: "dangerously",
url: "http://localhost",
beforeParse(window) {
window.TextDecoder = TextDecoder;
window.TextEncoder = TextEncoder;
window.__TURNKEY_SIGNER_ENVIRONMENT__ = "prod";
},
});

Object.defineProperty(tab2DOM.window, "crypto", {
value: crypto.webcrypto,
});

// Switch to Tab 2 context
global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.localStorage = tab2DOM.window.localStorage;
global.sessionStorage = tab2DOM.window.sessionStorage;

const module2 = await import("./src/turnkey-core.js");
tab2TKHQ = module2.TKHQ;
tab2DOM.window.TKHQ = tab2TKHQ;
});

afterEach(() => {
delete global.window;
delete global.document;
delete global.localStorage;
delete global.sessionStorage;
delete global.crypto;
});

it("should have independent embedded keys in different tabs", async () => {
// Initialize embedded keys in both tabs
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
await tab1TKHQ.initEmbeddedKey();
const tab1Key = tab1TKHQ.getEmbeddedKey();

global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
await tab2TKHQ.initEmbeddedKey();
const tab2Key = tab2TKHQ.getEmbeddedKey();

// Keys should be different (each tab generates its own)
expect(tab1Key).not.toBeNull();
expect(tab2Key).not.toBeNull();
expect(tab1Key.d).not.toEqual(tab2Key.d);
});

it("should not share embedded keys between tabs", async () => {
// Set a key in Tab 1
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
const testKey = { kty: "EC", crv: "P-256", d: "tab1-secret-key" };
tab1TKHQ.setEmbeddedKey(testKey);

// Tab 2 should not see Tab 1's key
global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
const tab2Key = tab2TKHQ.getEmbeddedKey();
expect(tab2Key).toBeNull();

// Tab 1 should still have its key
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
const tab1Key = tab1TKHQ.getEmbeddedKey();
expect(tab1Key).toEqual(testKey);
});

it("should allow each tab to set its own embedded key independently", async () => {
const tab1Key = { kty: "EC", crv: "P-256", d: "tab1-key" };
const tab2Key = { kty: "EC", crv: "P-256", d: "tab2-key" };

global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
tab1TKHQ.setEmbeddedKey(tab1Key);

global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
tab2TKHQ.setEmbeddedKey(tab2Key);

// Verify each tab has its own key
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
expect(tab1TKHQ.getEmbeddedKey()).toEqual(tab1Key);

global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
expect(tab2TKHQ.getEmbeddedKey()).toEqual(tab2Key);

global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
const tab1StoredKey = tab1TKHQ.getEmbeddedKey().d;

global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
const tab2StoredKey = tab2TKHQ.getEmbeddedKey().d;

expect(tab1StoredKey).not.toEqual(tab2StoredKey);
});


it("should clear keys independently in each tab", async () => {
const testKey = { kty: "EC", crv: "P-256", d: "test-key" };

global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
tab1TKHQ.setEmbeddedKey(testKey);

global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
tab2TKHQ.setEmbeddedKey(testKey);

// Clear key in Tab 1 only
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
tab1TKHQ.onResetEmbeddedKey();

// Tab 1 should have no key
expect(tab1TKHQ.getEmbeddedKey()).toBeNull();

// Tab 2 should still have its key
global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
expect(tab2TKHQ.getEmbeddedKey()).toEqual(testKey);
});

it("should maintain key expiry independently in each tab", async () => {
jest.useFakeTimers();

const testKey = { kty: "EC", crv: "P-256", d: "test-key" };

// Set key with 1 second TTL in Tab 1
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
tab1TKHQ.setItemWithExpiry(
"TURNKEY_EMBEDDED_KEY",
JSON.stringify(testKey),
1000
);

// Set key with 2 second TTL in Tab 2
global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
tab2TKHQ.setItemWithExpiry(
"TURNKEY_EMBEDDED_KEY",
JSON.stringify(testKey),
2000
);

// Advance time by 1.5 seconds
jest.advanceTimersByTime(1500);

// Tab 1's key should be expired
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
const tab1Key = tab1TKHQ.getItemWithExpiry("TURNKEY_EMBEDDED_KEY");
expect(tab1Key).toBeNull();

// Tab 2's key should still be valid
global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
const tab2Key = tab2TKHQ.getItemWithExpiry("TURNKEY_EMBEDDED_KEY");
expect(tab2Key).toBe(JSON.stringify(testKey));

jest.useRealTimers();
});

it("should verify sessionStorage isolation (not shared between tabs)", () => {
// Set a value in Tab 1's sessionStorage
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
tab1DOM.window.sessionStorage.setItem("test-key", "tab1-value");

// Tab 2's sessionStorage should not have this value
global.window = tab2DOM.window;
global.document = tab2DOM.window.document;
global.sessionStorage = tab2DOM.window.sessionStorage;
const tab2Value = tab2DOM.window.sessionStorage.getItem("test-key");
expect(tab2Value).toBeNull();

// Tab 1 should still have its value
global.window = tab1DOM.window;
global.document = tab1DOM.window.document;
global.sessionStorage = tab1DOM.window.sessionStorage;
const tab1Value = tab1DOM.window.sessionStorage.getItem("test-key");
expect(tab1Value).toBe("tab1-value");
});
});

describe("Key generation and cryptography", () => {
it("generates P256 keys", async () => {
let key = await TKHQ.generateTargetKey();
Expand Down Expand Up @@ -588,6 +834,7 @@ describe("Event Handler Expiration Flow", () => {
global.window = dom.window;
global.document = dom.window.document;
global.localStorage = dom.window.localStorage;
global.sessionStorage = dom.window.sessionStorage;
global.TextEncoder = TextEncoder;
global.TextDecoder = TextDecoder;
global.crypto = crypto.webcrypto;
Expand Down Expand Up @@ -641,6 +888,7 @@ describe("Event Handler Expiration Flow", () => {
delete global.window;
delete global.document;
delete global.localStorage;
delete global.sessionStorage;
delete global.crypto;
});

Expand Down
Loading
Loading