Add option --mask-internal-target=N

This overrides format's algorithm for selecting the target multiplier,
or disables internal mask completely for N=0.

Closes #4876

Author: magnumripper

doc/NEWS

@@ -234,6 +234,10 @@ Major changes from 1.9.0-jumbo-1 (May 2019) in this bleeding-edge version:
 - Added apop2john.py: script to extract and format POP3 APOP challenge/responses
   [Mark Silinio; 2021]
 
+- Added option --mask-internal-target=N for overriding format's idea of how
+  large portion of a mask should be generated on device-side (or completely
+  disabling internal mask).  [magnum; 2021]
+
 
 Major changes from 1.8.0-jumbo-1 (December 2014) to 1.9.0-jumbo-1 (May 2019):
 

src/bench.c

@@ -51,6 +51,7 @@
 #include "gpu_common.h"
 #include "opencl_common.h"
 #include "mask.h"
+#include "mask_ext.h"
 #include "aligned.h"
 
 #ifndef BENCH_BUILD
@@ -833,6 +834,13 @@ int benchmark_all(void)
 		if ((options.flags & FLG_LOOPTEST_CHK) && john_main_process)
 			printf("#%u ", loop_total);
 #endif
+#if defined(HAVE_OPENCL) || defined(HAVE_ZTEX)
+		int using_int_mask = (format->params.flags & FMT_MASK) && (options.flags & FLG_MASK_CHK) &&
+			options.req_int_cand_target != 0 && mask_int_cand_target;
+#else
+		int using_int_mask = 0;
+#endif
+
 		if (john_main_process)
 		printf("%s: %s%s%s%s [%s%s%s%s]... ",
 		    benchmark_time ? "Benchmarking" : "Testing",
@@ -844,8 +852,7 @@ int benchmark_all(void)
 #ifndef BENCH_BUILD
 #define ENC_SET (!options.default_enc && options.target_enc != ENC_RAW && options.target_enc != ISO_8859_1)
 
-		    (benchmark_time && format->params.flags & FMT_MASK &&
-		     (options.flags & FLG_MASK_CHK)) ? "/mask accel" : "",
+		    (benchmark_time && using_int_mask) ? "/mask accel" : "",
 		    ENC_SET ? ", " : "",
 		    ENC_SET ? cp_id2name(options.target_enc) : "");
 #else

src/mask.c

@@ -2400,13 +2400,20 @@ static void finalize_mask(int len)
 			mask_add_len = len;
 	}
 
-	if (options.rule_stack && (mask_fmt->params.flags & FMT_MASK)) {
+	if ((mask_fmt->params.flags & FMT_MASK) && options.rule_stack) {
 		mask_int_cand_target = 0;
 		if (john_main_process) {
 			fprintf(stderr, "Note: Disabling internal mask due to stacked rules\n");
 			log_event("- Disabling internal mask due to stacked rules");
 		}
 	}
+#if defined(HAVE_OPENCL) || defined(HAVE_ZTEX)
+	else if ((mask_fmt->params.flags & FMT_MASK) && options.req_int_cand_target >= 0) {
+		log_event("- Overriding format's target internal mask factor of %d with user requested %d",
+		          mask_int_cand_target, options.req_int_cand_target);
+		mask_int_cand_target = options.req_int_cand_target;
+	}
+#endif
 
 #ifdef MASK_DEBUG
 	fprintf(stderr, "%s() qw %d minlen %d maxlen %d max_key_len %d mask_add_len %d mask len %d\n", __FUNCTION__, mask_num_qw, options.eff_minlength, max_keylen, len, mask_add_len, mask_len(mask));
@@ -2468,7 +2475,8 @@ static void finalize_mask(int len)
 	}
 	mask_tot_cand = cand * mask_int_cand.num_int_cand;
 
-	if ((john_main_process || !cfg_get_bool(SECTION_OPTIONS, SUBSECTION_MPI, "MPIAllGPUsSame", 0)) && mask_int_cand_target)
+	if ((john_main_process || !cfg_get_bool(SECTION_OPTIONS, SUBSECTION_MPI, "MPIAllGPUsSame", 0)) &&
+		mask_int_cand.num_int_cand > 1)
 		log_event("- Requested internal mask factor: %d, actual now %d",
 		          mask_int_cand_target, mask_int_cand.num_int_cand);
 }

src/options.c

@@ -191,6 +191,7 @@ static struct opt_entry opt_list[] = {
 	{"gws", FLG_ONCE, 0, 0, USUAL_REQ_CLR | FLG_STDOUT | OPT_REQ_PARAM, Zu, &options.gws},
 #endif
 #if defined(HAVE_OPENCL) || defined(HAVE_ZTEX)
+	{"mask-internal-target", FLG_ONCE, 0, 0, USUAL_REQ_CLR | FLG_STDOUT | OPT_REQ_PARAM, "%d", &options.req_int_cand_target},
 	{"devices", FLG_ONCE, 0, 0, USUAL_REQ_CLR | FLG_STDOUT | OPT_REQ_PARAM, OPT_FMT_ADD_LIST_MULTI, &options.acc_devices},
 #endif
 	{"skip-self-tests", FLG_NOTESTS, FLG_NOTESTS, 0, USUAL_REQ_CLR | FLG_STDOUT},
@@ -368,6 +369,7 @@ FUZZ_USAGE \
 #define JOHN_USAGE_GPU \
 "\nOpenCL options:\n" \
 "--devices=N[,..]           Set OpenCL device(s) (see --list=opencl-devices)\n" \
+"--mask-internal-target=N   Request a specific internal mask target\n" \
 "--force-scalar             Force scalar mode\n" \
 "--force-vector-width=N     Force vector width N\n" \
 "--lws=N                    Force local worksize N\n" \
@@ -376,7 +378,8 @@ FUZZ_USAGE \
 "                           or set ZTEX device(s) by its(their) serial number(s)\n"
 #elif defined(HAVE_ZTEX)
 #define JOHN_USAGE_ZTEX \
-"--devices=N[,..]           Set ZTEX device(s) by its(their) serial number(s)\n"
+"--devices=N[,..]           Set ZTEX device(s) by its(their) serial number(s)\n" \
+"--mask-internal-target=N   Request a specific internal mask target\n"
 #endif
 
 static void opt_banner(char *name)
@@ -440,6 +443,8 @@ void opt_init(char *name, int argc, char **argv)
 	list_init(&options.loader.shells);
 #if defined(HAVE_OPENCL) || defined(HAVE_ZTEX)
 	list_init(&options.acc_devices);
+
+	options.req_int_cand_target = -1;
 #endif
 
 	options.length = -1;

src/options.h

@@ -457,6 +457,10 @@ struct options_main {
 	int crack_status;
 /* --catch-up=oldsession */
 	char *catchup;
+#if defined(HAVE_OPENCL) || defined(HAVE_ZTEX)
+/* --mask-internal-target=N */
+	int req_int_cand_target;
+#endif
 };
 
 extern struct options_main options;