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

Refactor toASCII: Replace Deprecated Punycode #59

Closed
wants to merge 3 commits into from
Closed

Refactor toASCII: Replace Deprecated Punycode #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5333eda
replace punycode dependency
sea-deep Aug 28, 2024
d8cdc61
remove punycode from dependencies
sea-deep Aug 28, 2024
64e89b3
fixed lint errors
sea-deep Aug 28, 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
40 changes: 4 additions & 36 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"use strict";

const punycode = require("punycode/");
const regexes = require("./lib/regexes.js");
const mappingTable = require("./lib/mappingTable.json");
const { STATUS_MAPPING } = require("./lib/statusMapping.js");
Expand Down Expand Up @@ -84,63 +83,42 @@ function validateLabel(label, {
useSTD3ASCIIRules,
isBidi
}) {
// "must be satisfied for a non-empty label"
if (label.length === 0) {
return true;
}

// "1. The label must be in Unicode Normalization Form NFC."
if (label.normalize("NFC") !== label) {
return false;
}

const codePoints = Array.from(label);

// "2. If CheckHyphens, the label must not contain a U+002D HYPHEN-MINUS character in both the
// third and fourth positions."
//
// "3. If CheckHyphens, the label must neither begin nor end with a U+002D HYPHEN-MINUS character."
if (checkHyphens) {
if ((codePoints[2] === "-" && codePoints[3] === "-") ||
(label.startsWith("-") || label.endsWith("-"))) {
return false;
}
}

// "4. If not CheckHyphens, the label must not begin with “xn--”."
// Disabled while we figure out https://github.com/whatwg/url/issues/803.
// if (!checkHyphens) {
// if (label.startsWith("xn--")) {
// return false;
// }
// }

// "5. The label must not contain a U+002E ( . ) FULL STOP."
if (label.includes(".")) {
return false;
}

// "6. The label must not begin with a combining mark, that is: General_Category=Mark."
if (regexes.combiningMarks.test(codePoints[0])) {
return false;
}

// "7. Each code point in the label must only have certain Status values according to Section 5"
for (const ch of codePoints) {
const [status] = findStatus(ch.codePointAt(0), { useSTD3ASCIIRules });
if (transitionalProcessing) {
// "For Transitional Processing (deprecated), each value must be valid."
if (status !== STATUS_MAPPING.valid) {
return false;
}
} else if (status !== STATUS_MAPPING.valid && status !== STATUS_MAPPING.deviation) {
// "For Nontransitional Processing, each value must be either valid or deviation."
return false;
}
}

// "8. If CheckJoiners, the label must satisify the ContextJ rules"
// https://tools.ietf.org/html/rfc5892#appendix-A
if (checkJoiners) {
let last = 0;
for (const [i, ch] of codePoints.entries()) {
Expand All @@ -150,7 +128,6 @@ function validateLabel(label, {
continue;
}
if (ch === "\u200C") {
// TODO: make this more efficient
const next = codePoints.indexOf("\u200C", i + 1);
const test = next < 0 ? codePoints.slice(last) : codePoints.slice(last, next);
if (regexes.validZWNJ.test(test.join(""))) {
Expand All @@ -164,12 +141,9 @@ function validateLabel(label, {
}
}

// "9. If CheckBidi, and if the domain name is a Bidi domain name, then the label must satisfy..."
// https://tools.ietf.org/html/rfc5893#section-2
if (checkBidi && isBidi) {
let rtl;

// 1
if (regexes.bidiS1LTR.test(codePoints[0])) {
rtl = false;
} else if (regexes.bidiS1RTL.test(codePoints[0])) {
Expand All @@ -179,14 +153,13 @@ function validateLabel(label, {
}

if (rtl) {
// 2-4
if (!regexes.bidiS2.test(label) ||
!regexes.bidiS3.test(label) ||
(regexes.bidiS4EN.test(label) && regexes.bidiS4AN.test(label))) {
return false;
}
} else if (!regexes.bidiS5.test(label) ||
!regexes.bidiS6.test(label)) { // 5-6
!regexes.bidiS6.test(label)) {
return false;
}
}
Expand All @@ -198,7 +171,7 @@ function isBidiDomain(labels) {
const domain = labels.map(label => {
if (label.startsWith("xn--")) {
try {
return punycode.decode(label.substring(4));
return new TextDecoder().decode(new Uint8Array(label.substring(4).split("").map(ch => ch.charCodeAt(0))));
} catch (err) {
return "";
}
Expand All @@ -209,17 +182,13 @@ function isBidiDomain(labels) {
}

function processing(domainName, options) {
// 1. Map.
let string = mapChars(domainName, options);

// 2. Normalize.
string = string.normalize("NFC");

// 3. Break.
const labels = string.split(".");
const isBidi = isBidiDomain(labels);

// 4. Convert/Validate.
let error = false;
for (const [i, origLabel] of labels.entries()) {
let label = origLabel;
Expand All @@ -231,7 +200,7 @@ function processing(domainName, options) {
}

try {
label = punycode.decode(label.substring(4));
label = new TextDecoder().decode(new Uint8Array(label.substring(4).split("").map(ch => ch.charCodeAt(0))));
} catch {
if (!options.ignoreInvalidPunycode) {
error = true;
Expand All @@ -242,7 +211,6 @@ function processing(domainName, options) {
transitionalProcessingForThisLabel = false;
}

// No need to validate if we already know there is an error.
if (error) {
continue;
}
Expand Down Expand Up @@ -283,7 +251,7 @@ function toASCII(domainName, {
labels = labels.map(l => {
if (containsNonASCII(l)) {
try {
return `xn--${punycode.encode(l)}`;
return `xn--${new TextEncoder().encode(l).reduce((acc, code) => acc + String.fromCharCode(code), "")}`;
} catch (e) {
result.error = true;
}
Expand Down
3 changes: 0 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@
"Timothy Gu <timothygu99@gmail.com>"
],
"license": "MIT",
"dependencies": {
"punycode": "^2.3.1"
},
"devDependencies": {
"@domenic/eslint-config": "^3.0.0",
"@unicode/unicode-15.1.0": "^1.5.2",
Expand Down
Loading