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

Replace tweetnacl-util with @stablelib packages #149

Merged
merged 5 commits into from
Jul 8, 2024
Merged

Replace tweetnacl-util with @stablelib packages #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2f243da
Remove "tweetnacl-util" package
CassioMG Jul 4, 2024
d0dbf65
Add @stablelib packages
CassioMG Jul 4, 2024
034fbaf
Use @stablelib to encode/decode utf8 and base64
CassioMG Jul 4, 2024
d6729ce
Fix jest tests
CassioMG Jul 4, 2024
47c3ce0
Fix e2e and integration tests
CassioMG Jul 4, 2024
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
5 changes: 3 additions & 2 deletions @stellar/typescript-wallet-sdk-km/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,15 @@
"@albedo-link/intent": "^0.12.0",
"@ledgerhq/hw-app-str": "^6.28.4",
"@ledgerhq/hw-transport-u2f": "^5.36.0-deprecated",
"@stablelib/base64": "^2.0.0",
"@stablelib/utf8": "^2.0.0",
"@stellar/freighter-api": "^2.0.0",
"@stellar/stellar-sdk": "12.1.0",
"@trezor/connect-plugin-stellar": "^9.0.2",
"bignumber.js": "^9.1.2",
"scrypt-async": "^2.0.1",
"trezor-connect": "^8.2.12",
"tweetnacl": "^1.0.3",
"tweetnacl-util": "^0.15.1"
"tweetnacl": "^1.0.3"
},
"scripts": {
"test": "jest --watchAll",
Expand Down
16 changes: 10 additions & 6 deletions @stellar/typescript-wallet-sdk-km/src/Helpers/scryptEncryption.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { encode as utf8Encode, decode as utf8Decode } from "@stablelib/utf8";
import {
encode as base64Encode,
decode as base64Decode,
} from "@stablelib/base64";
import scrypt from "scrypt-async";
import nacl from "tweetnacl";
import naclutil from "tweetnacl-util";

export interface ScryptPassParams {
password: string;
Expand Down Expand Up @@ -65,7 +69,7 @@ function scryptPass(params: ScryptPassParams): Promise<Uint8Array> {
}

function generateSalt(): string {
return naclutil.encodeBase64(nacl.randomBytes(SALT_BYTES));
return base64Encode(nacl.randomBytes(SALT_BYTES));
}

/**
Expand All @@ -84,7 +88,7 @@ export async function encrypt(params: EncryptParams): Promise<EncryptResponse> {

const secretboxNonce = nonce || nacl.randomBytes(NONCE_BYTES);
const scryptedPass = await scryptPass({ password, salt: secretboxSalt });
const textBytes = naclutil.decodeUTF8(phrase);
const textBytes = utf8Encode(phrase);
const cipherText = nacl.secretbox(textBytes, secretboxNonce, scryptedPass);

if (!cipherText) {
Expand All @@ -99,7 +103,7 @@ export async function encrypt(params: EncryptParams): Promise<EncryptResponse> {
bundle.set(cipherText, 1 + secretboxNonce.length);

return {
encryptedPhrase: naclutil.encodeBase64(bundle),
encryptedPhrase: base64Encode(bundle),
salt: secretboxSalt,
};
}
Expand All @@ -108,7 +112,7 @@ export async function decrypt(params: DecryptParams): Promise<string> {
const { phrase, password, salt } = params;
const scryptedPass = await scryptPass({ password, salt });

const bundle = naclutil.decodeBase64(phrase);
const bundle = base64Decode(phrase);
const version = bundle[0];
let decryptedBytes;
if (version === CRYPTO_V1) {
Expand All @@ -121,5 +125,5 @@ export async function decrypt(params: DecryptParams): Promise<string> {
if (!decryptedBytes) {
throw new Error("That passphrase wasn’t valid.");
}
return naclutil.encodeUTF8(decryptedBytes);
return utf8Decode(decryptedBytes);
}
1 change: 1 addition & 0 deletions @stellar/typescript-wallet-sdk/jest.e2e.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
module.exports = {
rootDir: "./",
preset: "ts-jest",
transformIgnorePatterns: [`/node_modules/(?!${["@stablelib"].join("|")})`],
transform: {
"^.+\\.(ts|tsx)?$": "ts-jest",
"^.+\\.(js|jsx)$": "babel-jest",
Expand Down
1 change: 1 addition & 0 deletions @stellar/typescript-wallet-sdk/jest.integration.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
module.exports = {
rootDir: "./",
preset: "ts-jest",
transformIgnorePatterns: [`/node_modules/(?!${["@stablelib"].join("|")})`],
transform: {
"^.+\\.(ts|tsx)?$": "ts-jest",
"^.+\\.(js|jsx)$": "babel-jest",
Expand Down
3 changes: 2 additions & 1 deletion @stellar/typescript-wallet-sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
"webpack-cli": "^5.1.1"
},
"dependencies": {
"@stablelib/base64": "^2.0.0",
"@stablelib/utf8": "^2.0.0",
"@stellar/stellar-sdk": "12.1.0",
"axios": "^1.4.0",
"base64url": "^3.0.1",
Expand All @@ -53,7 +55,6 @@
"query-string": "^7.1.3",
"stream-http": "^3.2.0",
"tweetnacl": "^1.0.3",
"tweetnacl-util": "^0.15.1",
"url": "^0.11.0",
"util": "^0.12.5",
"utility-types": "^3.10.0",
Expand Down
8 changes: 3 additions & 5 deletions @stellar/typescript-wallet-sdk/src/walletSdk/Auth/AuthHeaderSigner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { AxiosInstance } from "axios";
import { encode as utf8Encode } from "@stablelib/utf8";
import { StrKey } from "@stellar/stellar-sdk";
import nacl from "tweetnacl";
import naclUtil from "tweetnacl-util";
import base64url from "base64url";

import { SigningKeypair } from "../Horizon/Account";
Expand Down Expand Up @@ -66,12 +66,10 @@ export class DefaultAuthHeaderSigner implements AuthHeaderSigner {
const encodedPayload = base64url(
JSON.stringify({ ...claims, exp: timeExp, iat: issuedAt }),
);
const utf8Jwt = utf8Encode(`${encodedHeader}.${encodedPayload}`);

// sign JWT and create signature
const signature = nacl.sign.detached(
naclUtil.decodeUTF8(`${encodedHeader}.${encodedPayload}`),
naclKP.secretKey,
);
const signature = nacl.sign.detached(utf8Jwt, naclKP.secretKey);
const encodedSignature = base64url(Buffer.from(signature));

const jwt = `${encodedHeader}.${encodedPayload}.${encodedSignature}`;
Expand Down
1 change: 1 addition & 0 deletions jest.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
const commonConfigs = {
transformIgnorePatterns: [`/node_modules/(?!${["@stablelib"].join("|")})`],
transform: {
"^.+\\.(js|jsx|ts|tsx|mjs)$": ["babel-jest"],
},
Expand Down
15 changes: 10 additions & 5 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2521,6 +2521,16 @@
resolved "https://registry.yarnpkg.com/@sinonjs/text-encoding/-/text-encoding-0.7.2.tgz#5981a8db18b56ba38ef0efb7d995b12aa7b51918"
integrity sha512-sXXKG+uL9IrKqViTtao2Ws6dy0znu9sOaP1di/jKGW1M6VssO8vlpXCQcpZ+jisQ1tTFAC5Jo/EOzFbggBagFQ==

"@stablelib/base64@^2.0.0":
version "2.0.0"
resolved "https://registry.yarnpkg.com/@stablelib/base64/-/base64-2.0.0.tgz#f13a98549cd5ca0750cd177bbd08b599d24e5f8e"
integrity sha512-ffSfySa1ZpZYzM5FQ2xILQ2jifQ+GlgbDJzRTCtaB0sqta88KYghB/tlSV2VS2iHRCvMdUvJlLOW1rmSkziWnw==

"@stablelib/utf8@^2.0.0":
version "2.0.0"
resolved "https://registry.yarnpkg.com/@stablelib/utf8/-/utf8-2.0.0.tgz#05725ef9d39ed10a017e1b6e01374bd998c83167"
integrity sha512-bHaUduwFKYgj6rRvA5udyyg+ASx6gJZiQaXvfBHb7A2r+X9tRIKJ/VmpQKFQnEMInpBTh7jJLy+Gt99GH9YZ9g==

"@stellar/freighter-api@^2.0.0":
version "2.0.0"
resolved "https://registry.yarnpkg.com/@stellar/freighter-api/-/freighter-api-2.0.0.tgz#488915a4aa0cec8c9a3fc84ef31e21cd5ec41343"
Expand Down Expand Up @@ -7573,11 +7583,6 @@ tslib@^2.5.0:
resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.5.0.tgz#42bfed86f5787aeb41d031866c8f402429e0fddf"
integrity sha512-336iVw3rtn2BUK7ORdIAHTyxHGRIHVReokCR3XjbckJMK7ms8FysBfhLR8IXnAgy7T0PTPNBWKiH514FOW/WSg==

tweetnacl-util@^0.15.1:
version "0.15.1"
resolved "https://registry.yarnpkg.com/tweetnacl-util/-/tweetnacl-util-0.15.1.tgz#b80fcdb5c97bcc508be18c44a4be50f022eea00b"
integrity sha512-RKJBIj8lySrShN4w6i/BonWp2Z/uxwC3h4y7xsRrpP59ZboCd0GpEVsOnMDYLMmKBpYhb5TgHzZXy7wTfYFBRw==

tweetnacl@^1.0.3:
version "1.0.3"
resolved "https://registry.yarnpkg.com/tweetnacl/-/tweetnacl-1.0.3.tgz#ac0af71680458d8a6378d0d0d050ab1407d35596"
Expand Down
Loading