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.

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

Restore derived key default exportable to false, provide option to make exportable #38

Merged
merged 1 commit into from
Nov 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export async function encryptWithDetail<R>(
dataObj: R,
salt = generateSalt(),
): Promise<DetailedEncryptionResult> {
const key = await keyFromPassword(password, salt);
const key = await keyFromPassword(password, salt, true);
const exportedKeyString = await exportKey(key);
const vault = await encrypt(password, dataObj, key, salt);

Expand Down Expand Up @@ -137,7 +137,7 @@ export async function decryptWithDetail(
): Promise<DetailedDecryptResult> {
const payload = JSON.parse(text);
const { salt } = payload;
const key = await keyFromPassword(password, salt);
const key = await keyFromPassword(password, salt, true);
const exportedKeyString = await exportKey(key);
const vault = await decrypt(password, text, key);

Expand Down Expand Up @@ -216,11 +216,13 @@ export async function exportKey(key: CryptoKey): Promise<string> {
*
* @param password - The password to use to generate key.
* @param salt - The salt string to use in key derivation.
* @param exportable - Should the derived key be exportable.
* @returns A CryptoKey for encryption and decryption.
*/
export async function keyFromPassword(
password: string,
salt: string,
exportable = false,
): Promise<CryptoKey> {
const passBuffer = Buffer.from(password, STRING_ENCODING);
const saltBuffer = Buffer.from(salt, 'base64');
Expand All @@ -242,7 +244,7 @@ export async function keyFromPassword(
},
key,
{ name: DERIVED_KEY_FORMAT, length: 256 },
true,
exportable,
['encrypt', 'decrypt'],
);

Expand Down
31 changes: 31 additions & 0 deletions test/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ test('encryptor:encryptWithDetail returns vault', async ({ page }) => {
{ data, password },
);
expect(typeof encryptedDetail.vault).toBe('string');
expect(typeof encryptedDetail.exportedKeyString).toBe('string');
});

test('encryptor:encrypt & decrypt with wrong password', async ({ page }) => {
Expand Down Expand Up @@ -207,6 +208,9 @@ test('encryptor:decryptWithDetail returns same vault as decrypt', async ({
JSON.stringify(decryptWithDetailResult.vault),
);
expect(Object.keys(decryptWithDetailResult).length).toBe(3);
expect(typeof decryptWithDetailResult.exportedKeyString).toStrictEqual(
'string',
);
});

test('encryptor:encrypt using key then decrypt', async ({ page }) => {
Expand Down Expand Up @@ -555,3 +559,30 @@ test('encryptor:encryptWithKey works with decryptWithKey', async ({ page }) => {
JSON.stringify(newData),
);
});

test('encryptor:keyFromPassword cannot be exported by default', async ({
page,
}) => {
const password = 'a sample passw0rd';
const data = { foo: 'data to encrypt' };
const salt = await page.evaluate(() => window.encryptor.generateSalt());

const exportResult = await page.evaluate(
async (args) => {
const key = await window.encryptor.keyFromPassword(
args.password,
args.salt,
);

try {
const result = await window.encryptor.exportKey(key);
return result;
} catch (e) {
return 'error';
}
},
{ data, password, salt },
);

expect(exportResult).toStrictEqual('error');
});