void rec_init(struct db_main *db, void (*save_mode)(FILE *file))
{
rec_done(1);
if (!rec_argc) return;
rec_name_complete();
if ((rec_fd = open(path_expand(rec_name), O_RDWR | O_CREAT, 0600)) < 0)
pexit("open: %s", path_expand(rec_name));
rec_lock();
if (!(rec_file = fdopen(rec_fd, "w"))) pexit("fdopen");
rec_db = db;
rec_save_mode = save_mode;
}
void rec_restore_mode(int (*restore_mode)(FILE *file))
{
rec_name_complete();
if (!rec_file) return;
if (restore_mode)
if (restore_mode(rec_file)) rec_format_error("fscanf");
/*
* Unlocking the file explicitly is normally not necessary since we're about to
* close it anyway (which would normally release the lock). However, when
* we're the main process running with --fork, our newborn children may hold a
* copy of the fd for a moment (until they close the fd themselves). Thus, if
* we don't explicitly remove the lock, there may be a race condition between
* our children closing the fd and us proceeding to re-open and re-lock it.
*/
rec_unlock();
if (fclose(rec_file)) pexit("fclose");
rec_file = NULL;
rec_restoring_now = 0;
}
static void rec_name_complete(void)
{
if (rec_name_completed)
return;
#ifndef HAVE_MPI
if (options.fork && !john_main_process) {
#else
if (!john_main_process && options.node_min) {
#endif
char *suffix = mem_alloc(1 + 20 + strlen(RECOVERY_SUFFIX) + 1);
sprintf(suffix, ".%u%s", options.node_min, RECOVERY_SUFFIX);
rec_name = path_session(rec_name, suffix);
MEM_FREE(suffix);
} else {
rec_name = path_session(rec_name, RECOVERY_SUFFIX);
}
rec_name_completed = 1;
}
#if OS_FLOCK || FCNTL_LOCKS
static void rec_lock(int shared)
{
int lockmode;
#if FCNTL_LOCKS
int blockmode;
struct flock lock;
#endif
/*
* In options.c, MPI code path call rec_restore_args(mpi_p)
* relying on anything >1 meaning LOCK_SH. After restore, the
* root node must block, in case some other node has not yet
* closed the original file
*/
if (shared == 1) {
#if FCNTL_LOCKS
lockmode = F_WRLCK;
blockmode = F_SETLKW;
#else
lockmode = LOCK_EX;
#endif
#ifdef HAVE_MPI
if (!rec_restored || mpi_id || mpi_p == 1)
#endif
#if FCNTL_LOCKS
blockmode = F_SETLK;
#else
lockmode |= LOCK_NB;
#endif
} else
#if FCNTL_LOCKS
{
lockmode = F_RDLCK;
blockmode = F_SETLK;
}
#else
lockmode = LOCK_SH | LOCK_NB;
#endif
#ifdef LOCK_DEBUG
fprintf(stderr, "%s(%u): Locking session file...\n", __FUNCTION__, options.node_min);
#endif
#if FCNTL_LOCKS
memset(&lock, 0, sizeof(lock));
lock.l_type = lockmode;
if (fcntl(rec_fd, blockmode, &lock)) {
if (errno == EAGAIN || errno == EACCES) {
#else
if (flock(rec_fd, lockmode)) {
if (errno == EWOULDBLOCK) {
#endif
#ifdef HAVE_MPI
fprintf(stderr, "Node %d@%s: Crash recovery file is"
" locked: %s\n", mpi_id + 1, mpi_name,
path_expand(rec_name));
#else
fprintf(stderr, "Crash recovery file is locked: %s\n",
path_expand(rec_name));
#endif
error();
} else
#if FCNTL_LOCKS
pexit("fcntl()");
#else
pexit("flock()");
#endif
}
#ifdef LOCK_DEBUG
fprintf(stderr, "%s(%u): Locked session file (%s)\n", __FUNCTION__, options.node_min, shared == 1 ? "exclusive" : "shared");
#endif
}
static void rec_unlock(void)
{
#if FCNTL_LOCKS
struct flock lock = { 0 };
lock.l_type = F_UNLCK;
#endif
#ifdef LOCK_DEBUG
fprintf(stderr, "%s(%u): Unlocking session file\n", __FUNCTION__, options.node_min);
#endif
#if FCNTL_LOCKS
if (fcntl(rec_fd, F_SETLK, &lock))
pexit("fcntl(F_UNLCK)");
#else
if (flock(rec_fd, LOCK_UN))
pexit("flock(LOCK_UN)");
#endif
}
#else
#define rec_lock(lock) \
{}
#define rec_unlock() \
{}
#endif
void rec_init(struct db_main *db, void (*save_mode)(FILE *file))
{
rec_done(1);
if (!rec_argc) return;
rec_name_complete();
if ((rec_fd = open(path_expand(rec_name), O_RDWR | O_CREAT, 0600)) < 0)
pexit("open: %s", path_expand(rec_name));
rec_lock(1);
if (!(rec_file = fdopen(rec_fd, "w"))) pexit("fdopen");
rec_db = db;
rec_save_mode = save_mode;
}
void rec_save(void)
{
int save_format;
#ifdef HAVE_MPI
int fake_fork;
#endif
int add_argc = 0, add_enc = 1, add_2nd_enc = 1;
int add_mkv_stats = (options.mkv_stats ? 1 : 0);
long size;
char **opt;
log_flush();
if (!rec_file) return;
if (fseek(rec_file, 0, SEEK_SET)) pexit("fseek");
#ifdef _MSC_VER
if (_write(fileno(rec_file), "", 0)) pexit("ftruncate");
#elif __CYGWIN__
if (ftruncate(rec_fd, 0)) pexit("ftruncate");
#endif
save_format = !options.format && rec_db->loaded;
#ifdef HAVE_MPI
fake_fork = (mpi_p > 1);
#endif
opt = rec_argv;
while (*++opt) {
#ifdef HAVE_MPI
if (!strncmp(*opt, "--fork", 6))
fake_fork = 0;
else
#endif
if (!strncmp(*opt, "--encoding", 10) ||
!strncmp(*opt, "--input-encoding", 16))
add_enc = 0;
else if (!strncmp(*opt, "--internal-encoding", 19) ||
!strncmp(*opt, "--target-encoding", 17))
add_2nd_enc = 0;
else if (!strncmp(*opt, "--mkv-stats", 11))
add_mkv_stats = 0;
}
if (add_2nd_enc && (options.flags & FLG_STDOUT) &&
(pers_opts.input_enc != UTF_8 || pers_opts.target_enc != UTF_8))
add_2nd_enc = 0;
add_argc = add_enc + add_2nd_enc + add_mkv_stats;
#ifdef HAVE_MPI
add_argc += fake_fork;
#endif
fprintf(rec_file, RECOVERY_V "\n%d\n",
rec_argc + (save_format ? 1 : 0) + add_argc);
opt = rec_argv;
while (*++opt)
{
/* Add defaults as if they were actually on **argv */
if (options.wordlist &&
!(strcmp(*opt, "--wordlist") && strcmp(*opt, "--loopback")))
fprintf(rec_file, "%s=%s\n", *opt, options.wordlist);
else if (!strcmp(*opt, "--rules"))
fprintf(rec_file, "%s=%s\n", *opt,
pers_opts.activewordlistrules);
else if (!strcmp(*opt, "--single"))
fprintf(rec_file, "%s=%s\n", *opt,
pers_opts.activesinglerules);
else if (!strcmp(*opt, "--incremental"))
fprintf(rec_file, "%s=%s\n", *opt,
options.charset);
else if (!strcmp(*opt, "--markov"))
fprintf(rec_file, "%s=%s\n", *opt,
options.mkv_param);
else
fprintf(rec_file, "%s\n", *opt);
}
if (save_format)
fprintf(rec_file, "--format=%s\n",
rec_db->format->params.label);
if (add_enc)
fprintf(rec_file, "--input-encoding=%s\n",
cp_id2name(pers_opts.input_enc));
if (add_2nd_enc && pers_opts.input_enc == UTF_8 &&
pers_opts.target_enc == UTF_8)
fprintf(rec_file, "--internal-encoding=%s\n",
cp_id2name(pers_opts.internal_enc));
else if (add_2nd_enc)
fprintf(rec_file, "--target-encoding=%s\n",
cp_id2name(pers_opts.target_enc));
if (add_mkv_stats)
fprintf(rec_file, "--mkv-stats=%s\n", options.mkv_stats);
#ifdef HAVE_MPI
if (fake_fork)
fprintf(rec_file, "--fork=%d\n", mpi_p);
#endif
fprintf(rec_file, "%u\n%u\n%x\n%x\n%x\n%x\n%x\n%x\n%x\n"
"%d\n%d\n%d\n%x\n",
status_get_time() + 1,
status.guess_count,
status.combs.lo,
status.combs.hi,
status.combs_ehi,
status.crypts.lo,
status.crypts.hi,
status.cands.lo,
status.cands.hi,
status.compat,
status.pass,
status_get_progress ? (int)status_get_progress() : -1,
rec_check);
if (rec_save_mode) rec_save_mode(rec_file);
if (options.flags & FLG_MASK_STACKED)
mask_save_state(rec_file);
if (ferror(rec_file)) pexit("fprintf");
if ((size = ftell(rec_file)) < 0) pexit("ftell");
if (fflush(rec_file)) pexit("fflush");
#ifndef _MSC_VER
if (ftruncate(rec_fd, size)) pexit("ftruncate");
#endif
#if HAVE_WINDOWS_H==0
if (!options.fork && fsync(rec_fd))
pexit("fsync");
#endif
}
void rec_restore_args(int lock)
{
char line[LINE_BUFFER_SIZE];
int index, argc;
char **argv;
char *save_rec_name;
rec_name_complete();
if (!(rec_file = fopen(path_expand(rec_name), "r+"))) {
if (options.fork && !john_main_process && errno == ENOENT) {
fprintf(stderr, "%u Session completed\n",
options.node_min);
if (options.flags & FLG_STATUS_CHK)
return;
log_event("No crash recovery file, terminating");
log_done();
exit(0);
}
pexit("fopen: %s", path_expand(rec_name));
}
rec_fd = fileno(rec_file);
if (lock) rec_lock();
if (!fgetl(line, sizeof(line), rec_file)) rec_format_error("fgets");
rec_version = 0;
if (!strcmp(line, RECOVERY_V4)) rec_version = 4; else
if (!strcmp(line, RECOVERY_V3)) rec_version = 3; else
if (!strcmp(line, RECOVERY_V2)) rec_version = 2; else
if (!strcmp(line, RECOVERY_V1)) rec_version = 1; else
if (strcmp(line, RECOVERY_V0)) rec_format_error(NULL);
if (fscanf(rec_file, "%d\n", &argc) != 1)
rec_format_error("fscanf");
if (argc < 2)
rec_format_error(NULL);
argv = mem_alloc_tiny(sizeof(char *) * (argc + 1), MEM_ALIGN_WORD);
argv[0] = "john";
for (index = 1; index < argc; index++)
if (fgetl(line, sizeof(line), rec_file))
argv[index] = str_alloc_copy(line);
else
rec_format_error("fgets");
argv[argc] = NULL;
save_rec_name = rec_name;
opt_init(argv[0], argc, argv);
rec_name = save_rec_name;
rec_name_completed = 1;
if (fscanf(rec_file, "%u\n%u\n%x\n%x\n",
&status_restored_time,
&status.guess_count,
&status.combs.lo,
&status.combs.hi) != 4)
rec_format_error("fscanf");
if (!status_restored_time)
status_restored_time = 1;
if (rec_version >= 4) {
if (fscanf(rec_file, "%x\n%x\n%x\n%x\n%x\n%d\n",
&status.combs_ehi,
&status.crypts.lo,
&status.crypts.hi,
&status.cands.lo,
&status.cands.hi,
&status.compat) != 6)
rec_format_error("fscanf");
} else {
/* Historically, we were reusing what became the combs field for candidates
* count when in --stdout mode */
status.cands = status.combs;
status.compat = 1;
}
if (rec_version == 0) {
status.pass = 0;
status.progress = -1;
} else
if (fscanf(rec_file, "%d\n%d\n", &status.pass, &status.progress) != 2)
rec_format_error("fscanf");
if (status.pass < 0 || status.pass > 3)
rec_format_error(NULL);
if (rec_version < 3)
rec_check = 0;
else
if (fscanf(rec_file, "%x\n", &rec_check) != 1)
rec_format_error("fscanf");
rec_restoring_now = 1;
}
void rec_restore_args(int lock)
{
char line[LINE_BUFFER_SIZE];
int index, argc;
char **argv;
char *save_rec_name;
rec_name_complete();
if (!(rec_file = fopen(path_expand(rec_name), "r+"))) {
#ifndef HAVE_MPI
if (options.fork && !john_main_process && errno == ENOENT) {
#else
if (options.node_min > 1 && errno == ENOENT) {
#endif
fprintf(stderr, "%u Session completed\n",
options.node_min);
if (options.flags & FLG_STATUS_CHK)
return;
log_event("No crash recovery file, terminating");
log_done();
#ifdef HAVE_MPI
mpi_teardown();
#endif
exit(0);
}
#ifdef HAVE_MPI
if (mpi_p > 1) {
fprintf(stderr, "%u@%s: fopen: %s: %s\n",
mpi_id + 1, mpi_name,
path_expand(rec_name), strerror(errno));
error();
}
#endif
pexit("fopen: %s", path_expand(rec_name));
}
rec_fd = fileno(rec_file);
if (lock) rec_lock(lock);
if (!fgetl(line, sizeof(line), rec_file)) rec_format_error("fgets");
rec_version = 0;
if (!strcmp(line, RECOVERY_V4)) rec_version = 4; else
if (!strcmp(line, RECOVERY_V3)) rec_version = 3; else
if (!strcmp(line, RECOVERY_V2)) rec_version = 2; else
if (!strcmp(line, RECOVERY_V1)) rec_version = 1; else
if (strcmp(line, RECOVERY_V0)) rec_format_error(NULL);
if (fscanf(rec_file, "%d\n", &argc) != 1)
rec_format_error("fscanf");
if (argc < 2)
rec_format_error(NULL);
argv = mem_alloc_tiny(sizeof(char *) * (argc + 1), MEM_ALIGN_WORD);
argv[0] = "john";
for (index = 1; index < argc; index++)
if (fgetl(line, sizeof(line), rec_file))
argv[index] = str_alloc_copy(line);
else
rec_format_error("fgets");
argv[argc] = NULL;
save_rec_name = rec_name;
opt_init(argv[0], argc, argv, 0);
rec_name = save_rec_name;
rec_name_completed = 1;
if (fscanf(rec_file, "%u\n%u\n%x\n%x\n",
&status_restored_time,
&status.guess_count,
&status.combs.lo,
&status.combs.hi) != 4)
rec_format_error("fscanf");
if (!status_restored_time)
status_restored_time = 1;
if (rec_version >= 4) {
if (fscanf(rec_file, "%x\n%x\n%x\n%x\n%x\n%d\n",
&status.combs_ehi,
&status.crypts.lo,
&status.crypts.hi,
&status.cands.lo,
&status.cands.hi,
&status.compat) != 6)
rec_format_error("fscanf");
} else {
/* Historically, we were reusing what became the combs field for candidates
* count when in --stdout mode */
status.cands = status.combs;
status.compat = 1;
}
if (rec_version == 0) {
status.pass = 0;
status.progress = -1;
} else
if (fscanf(rec_file, "%d\n%d\n", &status.pass, &status.progress) != 2)
rec_format_error("fscanf");
if (status.pass < 0 || status.pass > 3)
rec_format_error(NULL);
if (rec_version < 3)
rec_check = 0;
else
if (fscanf(rec_file, "%x\n", &rec_check) != 1)
rec_format_error("fscanf");
rec_restoring_now = 1;
}
void rec_restore_mode(int (*restore_mode)(FILE *file))
{
rec_name_complete();
if (!rec_file) return;
if (restore_mode)
if (restore_mode(rec_file)) rec_format_error("fscanf");
if (options.flags & FLG_MASK_STACKED)
if (mask_restore_state(rec_file)) rec_format_error("fscanf");
/*
* Unlocking the file explicitly is normally not necessary since we're about to
* close it anyway (which would normally release the lock). However, when
* we're the main process running with --fork, our newborn children may hold a
* copy of the fd for a moment (until they close the fd themselves). Thus, if
* we don't explicitly remove the lock, there may be a race condition between
* our children closing the fd and us proceeding to re-open and re-lock it.
*/
rec_unlock();
if (fclose(rec_file)) pexit("fclose");
rec_file = NULL;
rec_restoring_now = 0;
}
