Skip to content

Commit 0b8963c

Browse files
dodmidodmi
authored
2x: Cleanup magic numbers and constants (#524)
Replaced some magic numbers by constants, moved constants to helper.jsm.js
1 parent c56c924 commit 0b8963c

File tree

5 files changed

+35
-31
lines changed

5 files changed

+35
-31
lines changed

‎chrome/content/dkim.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ DKIM_Verifier.Display = (function() {
213213
version : "2.0",
214214
result : "TEMPFAIL",
215215
errorType : e.errorType,
216-
res_num : 20,
216+
res_num : DKIM_Verifier.authVerifier.DKIM_RES.TEMPFAIL,
217217
result_str : dkimStrings.getString("DKIM_INTERNALERROR_NAME"),
218218
};
219219
let authResult = {

‎modules/arhVerifier.jsm.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,16 +278,16 @@ function checkSignatureAlgorithm(dkimSigResult) {
278278

279279
if (dkimSigResult.algorithmSignature === "rsa" && dkimSigResult.algorithmHash === "sha1") {
280280
switch (prefs.getIntPref("error.algorithm.sign.rsa-sha1.treatAs")) {
281-
case 0: { // error
281+
case PREF.TREATAS.ERROR: {
282282
dkimSigResult.result = "PERMFAIL";
283283
dkimSigResult.errorType = "DKIM_SIGERROR_INSECURE_A";
284284
dkimSigResult.warnings = [];
285285
break;
286286
}
287-
case 1: // warning
287+
case PREF.TREATAS.WARNING:
288288
dkimSigResult.warnings.push({ name: "DKIM_SIGERROR_INSECURE_A" });
289289
break;
290-
case 2: // ignore
290+
case PREF.TREATAS.NOTHING:
291291
break;
292292
default: // should not happen
293293
throw new Error("invalid error.algorithm.sign.rsa-sha1.treatAs");

‎modules/dkimPolicy.jsm.js

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -441,12 +441,6 @@ var Policy = {
441441
checkHeadersSigned: function Policy_checkHeadersSigned(msgHeaders, DKIMSignature) {
442442
"use strict";
443443

444-
const POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE = {
445-
RELAXED : 10,
446-
RECOMMENDED : 20,
447-
STRICT : 30
448-
};
449-
450444
// The list of recommended headers to sign is mostly based on
451445
// https://www.rfc-editor.org/rfc/rfc6376.html#section-5.4.
452446
const SIGNEDHEADERS = {
@@ -503,9 +497,9 @@ var Policy = {
503497
}
504498
};
505499

506-
const relaxedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE.RELAXED;
507-
const recommendedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE.RECOMMENDED;
508-
const strictEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= POLICY_DKIM_UNSIGNED_HEADERS_WARNING_MODE.STRICT;
500+
const relaxedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= PREF.POLICY.UNSIGNED_HEADERS_WARNING_MODE.RELAXED;
501+
const recommendedEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= PREF.POLICY.UNSIGNED_HEADERS_WARNING_MODE.RECOMMENDED;
502+
const strictEnabled = prefs.getIntPref("dkim.unsignedHeadersWarning.mode") >= PREF.POLICY.UNSIGNED_HEADERS_WARNING_MODE.STRICT;
509503

510504
for (const header of SIGNEDHEADERS.REQUIRED) {
511505
checkSignedHeader(header, relaxedEnabled);

‎modules/dkimVerifier.jsm.js

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
// options for ESLint
2828
/* eslint strict: ["warn", "function"] */
2929
/* global Components, Services */
30-
/* global Logging, Key, Policy, msgReader, rfcParser */
30+
/* global Logging, Key, Policy, msgReader, rfcParser, PREF */
3131
/* global dkimStrings, addrIsInDomain2, domainIsInDomain, stringEndsWith, stringEqual, writeStringToTmpFile, toType, DKIM_SigError, DKIM_TempError, DKIM_Error, copy */
3232
/* exported EXPORTED_SYMBOLS, Verifier */
3333

@@ -325,13 +325,13 @@ var Verifier = (function() {
325325
} else if (keyInfo.keyLength < 2048) {
326326
// weak key
327327
switch (prefs.getIntPref("error.algorithm.rsa.weakKeyLength.treatAs")) {
328-
case 0: // error
328+
case PREF.TREATAS.ERROR:
329329
throw new DKIM_SigError("DKIM_SIGWARNING_KEY_IS_WEAK");
330-
case 1: // warning
330+
case PREF.TREATAS.WARNING:
331331
warnings.push({name: "DKIM_SIGWARNING_KEY_IS_WEAK"});
332332
log.debug("Warning: DKIM_SIGWARNING_KEY_IS_WEAK");
333333
break;
334-
case 2: // ignore
334+
case PREF.TREATAS.NOTHING:
335335
break;
336336
default:
337337
throw new Error("invalid error.algorithm.rsa.weakKeyLength.treatAs");
@@ -470,12 +470,12 @@ var Verifier = (function() {
470470
// all is fine, nothing to do at the moment
471471
} else if (algorithmTag[0] === "rsa-sha1") {
472472
switch (prefs.getIntPref("error.algorithm.sign.rsa-sha1.treatAs")) {
473-
case 0: // error
473+
case PREF.TREATAS.ERROR:
474474
throw new DKIM_SigError("DKIM_SIGERROR_INSECURE_A");
475-
case 1: // warning
475+
case PREF.TREATAS.WARNING:
476476
DKIMSignature.warnings.push({ name: "DKIM_SIGERROR_INSECURE_A" });
477477
break;
478-
case 2: // ignore
478+
case PREF.TREATAS.NOTHING:
479479
break;
480480
default:
481481
throw new Error("invalid error.algorithm.sign.rsa-sha1.treatAs");
@@ -615,12 +615,12 @@ var Verifier = (function() {
615615
exception.errorType === "DKIM_SIGERROR_ILLFORMED_I")
616616
{
617617
switch (prefs.getIntPref("error.illformed_i.treatAs")) {
618-
case 0: // error
618+
case PREF.TREATAS.ERROR:
619619
throw exception;
620-
case 1: // warning
620+
case PREF.TREATAS.WARNING:
621621
DKIMSignature.warnings.push({ name: "DKIM_SIGERROR_ILLFORMED_I" });
622622
break;
623-
case 2: // ignore
623+
case PREF.TREATAS.NOTHING:
624624
break;
625625
default:
626626
throw new Error("invalid error.illformed_i.treatAs");
@@ -675,12 +675,12 @@ var Verifier = (function() {
675675
var sub_domain_ = "(?:[A-Za-z0-9_](?:[A-Za-z0-9_-]*[A-Za-z0-9_])?)";
676676
SelectorTag = rfcParser.parseTagValue(tagMap, "s", `${sub_domain_}(?:\\.${sub_domain_})*`);
677677
switch (prefs.getIntPref("error.illformed_s.treatAs")) {
678-
case 0: // error
678+
case PREF.TREATAS.ERROR:
679679
throw exception;
680-
case 1: // warning
680+
case PREF.TREATAS.WARNING:
681681
DKIMSignature.warnings.push({name: "DKIM_SIGERROR_ILLFORMED_S"});
682682
break;
683-
case 2: // ignore
683+
case PREF.TREATAS.NOTHING:
684684
break;
685685
default:
686686
throw new Error("invalid error.illformed_s.treatAs");
@@ -1168,13 +1168,13 @@ var Verifier = (function() {
11681168
// if key is not signed by DNSSEC
11691169
if (!DKIMSignature.keyQueryResult.secure) {
11701170
switch (prefs.getIntPref("error.policy.key_insecure.treatAs")) {
1171-
case 0: // error
1171+
case PREF.TREATAS.ERROR:
11721172
throw new DKIM_SigError("DKIM_POLICYERROR_KEY_INSECURE");
1173-
case 1: // warning
1173+
case PREF.TREATAS.WARNING:
11741174
DKIMSignature.warnings.push({name: "DKIM_POLICYERROR_KEY_INSECURE"});
11751175
log.debug("Warning: DKIM_POLICYERROR_KEY_INSECURE");
11761176
break;
1177-
case 2: // ignore
1177+
case PREF.TREATAS.NOTHING:
11781178
break;
11791179
default:
11801180
throw new Error("invalid error.policy.key_insecure.treatAs");
@@ -1237,7 +1237,7 @@ var Verifier = (function() {
12371237
} finally {
12381238
DKIMSignature.a_keylength = keyInfo.keyLength;
12391239
}
1240-
if (!isValid && prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") > 0) {
1240+
if (!isValid && prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") > PREF.TREATAS.ERROR) {
12411241
log.debug("Try with removed quotes in Content-Type charset.");
12421242
const contentTypeField = msg.headerFields.get("content-type")[0];
12431243
const sanitizedContentTypeField = contentTypeField.replace(/charset="([^"]+)"/i, "charset=$1");
@@ -1251,7 +1251,7 @@ var Verifier = (function() {
12511251
keyInfo = {};
12521252
isValid = verifyFunction(DKIMSignature.DKIMKey.p, headerHashInput,
12531253
DKIMSignature.a_hash, DKIMSignature.b, DKIMSignature.warnings, keyInfo);
1254-
if (prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") === 1) {
1254+
if (prefs.getIntPref("error.contentTypeCharsetAddedQuotes.treatAs") === PREF.TREATAS.WARNING) {
12551255
DKIMSignature.warnings.push({name: "DKIM_SIGERROR_CONTENT_TYPE_CHARSET_ADDED_QUOTES"});
12561256
log.debug("Warning: DKIM_SIGERROR_CONTENT_TYPE_CHARSET_ADDED_QUOTES");
12571257
}

‎modules/helper.jsm.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@ const PREF = {
7070
TRUE: 1,
7171
FALSE: 2,
7272
},
73+
TREATAS: {
74+
ERROR: 0,
75+
WARNING: 1,
76+
NOTHING: 2,
77+
},
7378
KEY: {
7479
STORING: {
7580
DISABLED: 0,
@@ -86,6 +91,11 @@ const PREF = {
8691
BASE_DOMAIN: 2,
8792
}
8893
}
94+
},
95+
UNSIGNED_HEADERS_WARNING_MODE: {
96+
RELAXED : 10,
97+
RECOMMENDED : 20,
98+
STRICT : 30
8999
}
90100
},
91101
SHOW: {

0 commit comments

Comments
 (0)