Skip to content

2x: Cleanup magic numbers and constants #524

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

Merged
merged 1 commit into from
May 26, 2025
Merged

2x: Cleanup magic numbers and constants #524

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
2 changes: 1 addition & 1 deletion chrome/content/dkim.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ DKIM_Verifier.Display = (function() {
version : "2.0",
result : "TEMPFAIL",
errorType : e.errorType,
res_num : 20,
res_num : DKIM_Verifier.authVerifier.DKIM_RES.TEMPFAIL,
result_str : dkimStrings.getString("DKIM_INTERNALERROR_NAME"),
};
let authResult = {
Expand Down
6 changes: 3 additions & 3 deletions modules/arhVerifier.jsm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,16 +278,16 @@ function checkSignatureAlgorithm(dkimSigResult) {

if (dkimSigResult.algorithmSignature === "rsa" && dkimSigResult.algorithmHash === "sha1") {
switch (prefs.getIntPref("error.algorithm.sign.rsa-sha1.treatAs")) {
case 0: { // error
case PREF.TREATAS.ERROR: {
dkimSigResult.result = "PERMFAIL";
dkimSigResult.errorType = "DKIM_SIGERROR_INSECURE_A";
dkimSigResult.warnings = [];
break;
}
case 1: // warning
case PREF.TREATAS.WARNING:
dkimSigResult.warnings.push({ name: "DKIM_SIGERROR_INSECURE_A" });
break;
case 2: // ignore
case PREF.TREATAS.NOTHING:
break;
default: // should not happen
throw new Error("invalid error.algorithm.sign.rsa-sha1.treatAs");
Expand Down
12 changes: 3 additions & 9 deletions modules/dkimPolicy.jsm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,12 +441,6 @@ var Policy = {
checkHeadersSigned: function Policy_checkHeadersSigned(msgHeaders, DKIMSignature) {
"use strict";

const POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE = {
RELAXED : 10,
RECOMMENDED : 20,
STRICT : 30
};

// The list of recommended headers to sign is mostly based on
// https://www.rfc-editor.org/rfc/rfc6376.html#section-5.4.
const SIGNEDHEADERS = {
Expand Down Expand Up @@ -503,9 +497,9 @@ var Policy = {
}
};

const relaxedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE.RELAXED;
const recommendedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE.RECOMMENDED;
const strictEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE.STRICT;
const relaxedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= PREF.POLICY.UNSIGNED_HEADERS_WARNING_MODE.RELAXED;
const recommendedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= PREF.POLICY.UNSIGNED_HEADERS_WARNING_MODE.RECOMMENDED;
const strictEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= PREF.POLICY.UNSIGNED_HEADERS_WARNING_MODE.STRICT;

for (const header of SIGNEDHEADERS.REQUIRED) {
checkSignedHeader(header, relaxedEnabled);
Expand Down
36 changes: 18 additions & 18 deletions modules/dkimVerifier.jsm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
// options for ESLint
/* eslint strict: ["warn", "function"] */
/* global Components, Services */
/* global Logging, Key, Policy, msgReader, rfcParser */
/* global Logging, Key, Policy, msgReader, rfcParser, PREF */
/* global dkimStrings, addrIsInDomain2, domainIsInDomain, stringEndsWith, stringEqual, writeStringToTmpFile, toType, DKIM_SigError, DKIM_TempError, DKIM_Error, copy */
/* exported EXPORTED_SYMBOLS, Verifier */

Expand Down Expand Up @@ -325,13 +325,13 @@ var Verifier = (function() {
} else if (keyInfo.keyLength < 2048) {
// weak key
switch (prefs.getIntPref("error.algorithm.rsa.weakKeyLength.treatAs")) {
case 0: // error
case PREF.TREATAS.ERROR:
throw new DKIM_SigError("DKIM_SIGWARNING_KEY_IS_WEAK");
case 1: // warning
case PREF.TREATAS.WARNING:
warnings.push({name: "DKIM_SIGWARNING_KEY_IS_WEAK"});
log.debug("Warning: DKIM_SIGWARNING_KEY_IS_WEAK");
break;
case 2: // ignore
case PREF.TREATAS.NOTHING:
break;
default:
throw new Error("invalid error.algorithm.rsa.weakKeyLength.treatAs");
Expand Down Expand Up @@ -470,12 +470,12 @@ var Verifier = (function() {
// all is fine, nothing to do at the moment
} else if (algorithmTag[0] === "rsa-sha1") {
switch (prefs.getIntPref("error.algorithm.sign.rsa-sha1.treatAs")) {
case 0: // error
case PREF.TREATAS.ERROR:
throw new DKIM_SigError("DKIM_SIGERROR_INSECURE_A");
case 1: // warning
case PREF.TREATAS.WARNING:
DKIMSignature.warnings.push({ name: "DKIM_SIGERROR_INSECURE_A" });
break;
case 2: // ignore
case PREF.TREATAS.NOTHING:
break;
default:
throw new Error("invalid error.algorithm.sign.rsa-sha1.treatAs");
Expand Down Expand Up @@ -615,12 +615,12 @@ var Verifier = (function() {
exception.errorType === "DKIM_SIGERROR_ILLFORMED_I")
{
switch (prefs.getIntPref("error.illformed_i.treatAs")) {
case 0: // error
case PREF.TREATAS.ERROR:
throw exception;
case 1: // warning
case PREF.TREATAS.WARNING:
DKIMSignature.warnings.push({ name: "DKIM_SIGERROR_ILLFORMED_I" });
break;
case 2: // ignore
case PREF.TREATAS.NOTHING:
break;
default:
throw new Error("invalid error.illformed_i.treatAs");
Expand Down Expand Up @@ -675,12 +675,12 @@ var Verifier = (function() {
var sub_domain_ = "(?:[A-Za-z0-9_](?:[A-Za-z0-9_-]*[A-Za-z0-9_])?)";
SelectorTag = rfcParser.parseTagValue(tagMap, "s", `${sub_domain_}(?:\\.${sub_domain_})*`);
switch (prefs.getIntPref("error.illformed_s.treatAs")) {
case 0: // error
case PREF.TREATAS.ERROR:
throw exception;
case 1: // warning
case PREF.TREATAS.WARNING:
DKIMSignature.warnings.push({name: "DKIM_SIGERROR_ILLFORMED_S"});
break;
case 2: // ignore
case PREF.TREATAS.NOTHING:
break;
default:
throw new Error("invalid error.illformed_s.treatAs");
Expand Down Expand Up @@ -1168,13 +1168,13 @@ var Verifier = (function() {
// if key is not signed by DNSSEC
if (!DKIMSignature.keyQueryResult.secure) {
switch (prefs.getIntPref("error.policy.key_insecure.treatAs")) {
case 0: // error
case PREF.TREATAS.ERROR:
throw new DKIM_SigError("DKIM_POLICYERROR_KEY_INSECURE");
case 1: // warning
case PREF.TREATAS.WARNING:
DKIMSignature.warnings.push({name: "DKIM_POLICYERROR_KEY_INSECURE"});
log.debug("Warning: DKIM_POLICYERROR_KEY_INSECURE");
break;
case 2: // ignore
case PREF.TREATAS.NOTHING:
break;
default:
throw new Error("invalid error.policy.key_insecure.treatAs");
Expand Down Expand Up @@ -1237,7 +1237,7 @@ var Verifier = (function() {
} finally {
DKIMSignature.a_keylength = keyInfo.keyLength;
}
if (!isValid && prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") > 0) {
if (!isValid && prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") > PREF.TREATAS.ERROR) {
log.debug("Try with removed quotes in Content-Type charset.");
const contentTypeField = msg.headerFields.get("content-type")[0];
const sanitizedContentTypeField = contentTypeField.replace(/charset="([^"]+)"/i, "charset=$1");
Expand All @@ -1251,7 +1251,7 @@ var Verifier = (function() {
keyInfo = {};
isValid = verifyFunction(DKIMSignature.DKIMKey.p, headerHashInput,
DKIMSignature.a_hash, DKIMSignature.b, DKIMSignature.warnings, keyInfo);
if (prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") === 1) {
if (prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") === PREF.TREATAS.WARNING) {
DKIMSignature.warnings.push({name: "DKIM_SIGERROR_CONTENT_TYPE_CHARSET_ADDED_QUOTES"});
log.debug("Warning: DKIM_SIGERROR_CONTENT_TYPE_CHARSET_ADDED_QUOTES");
}
Expand Down
10 changes: 10 additions & 0 deletions modules/helper.jsm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ const PREF = {
TRUE: 1,
FALSE: 2,
},
TREATAS: {
ERROR: 0,
WARNING: 1,
NOTHING: 2,
},
KEY: {
STORING: {
DISABLED: 0,
Expand All @@ -86,6 +91,11 @@ const PREF = {
BASE_DOMAIN: 2,
}
}
},
UNSIGNED_HEADERS_WARNING_MODE: {
RELAXED : 10,
RECOMMENDED : 20,
STRICT : 30
}
},
SHOW: {
Expand Down