text: /**
   * Author......: See docs/credits.txt
   * License.....: MIT
   */
  
  #include "common.h"
  #include "types.h"
  #include "modules.h"
  #include "bitops.h"
  #include "convert.h"
  #include "shared.h"
  #include "memory.h"
  #include "cpu_crc32.h"
  #include "keyboard_layout.h"
  
  static const u32   ATTACK_EXEC    = ATTACK_EXEC_OUTSIDE_KERNEL;
  static const u32   DGST_POS0      = 0;
  static const u32   DGST_POS1      = 1;
  static const u32   DGST_POS2      = 2;
  static const u32   DGST_POS3      = 3;
  static const u32   DGST_SIZE      = DGST_SIZE_4_8;
  static const u32   HASH_CATEGORY  = HASH_CATEGORY_FDE;
  static const char *HASH_NAME      = "VeraCrypt Whirlpool + XTS 1536 bit";
  static const u64   KERN_TYPE      = 13733;
  static const u32   OPTI_TYPE      = OPTI_TYPE_ZERO_BYTE
                                    | OPTI_TYPE_SLOW_HASH_SIMD_LOOP;
  static const u64   OPTS_TYPE      = OPTS_TYPE_PT_GENERATE_LE
                                    | OPTS_TYPE_BINARY_HASHFILE
                                    | OPTS_TYPE_LOOP_EXTENDED
                                    | OPTS_TYPE_COPY_TMPS;
  static const u32   SALT_TYPE      = SALT_TYPE_EMBEDDED;
  static const char *ST_PASS        = "hashcat";
  static const char *ST_HASH        = "5eb128daef63eff7e6db6aa10a8858f89964f47844acca68df82ebb2e73866fa75e3b7a53f9d2ff1ecdd1f4dc90e9c0fdf51f60d11b1992cd2971b4889edfc8920bbf346fd7693f675b617cb9e4e9a43e6f445021068fc13453b130f2eb1d753ee83ecc61dabec293e88b62110cf6a8fab670e171f6aba2226550b54893263f5fa086b3cc41dd3db2eae07b585e5162c7a0d9723a426d408d83266c4d6018dc1b8b456d28a224033a30bfe62b1e58c2ddf596e07f7ff31849a6f5cfcc1c977b82d8484c270d44ededb0afdb781295e92968fc8cc69766af0ce1e72f02d6b4e124ba4b1af71519dcaade857bb3f371f93a350da6e65ee46c2ac782f134c75c10fe9d653fccc08c614dc362871911af8b83bdfc479f770dfe4b3c86b5d895842c53852fe4912738f848bf7c3e10b8189d25faceab9ef30b6fa0284edaa471752ac2b65335179b8d605417709f64fded7d94383618a921660d4cdb190bbb3769a8e56d2cd1ee07078ebc3b68ebeb016893f7099018e40cb326e32b29a62806eaf1a3fd382f4f876bf721eadfc019c5545813e81fd7168995f743663b136762b07910a63b6eec5b728a4ad07a689cceecb14c2802f334401a0a4fd2ec49e2da7f3cb24d6181f01ceed93ee73dedc3378133c83c9a71155c86785ff20dd5a64323d2fd4bf076bab3c17a1bb45edf81c30a7bd7dbbb097ece0dca83fff9138d56ae668";
  
  u32         module_attack_exec    (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return ATTACK_EXEC;     }
  u32         module_dgst_pos0      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return DGST_POS0;       }
  u32         module_dgst_pos1      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return DGST_POS1;       }
  u32         module_dgst_pos2      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return DGST_POS2;       }
  u32         module_dgst_pos3      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return DGST_POS3;       }
  u32         module_dgst_size      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return DGST_SIZE;       }
  u32         module_hash_category  (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return HASH_CATEGORY;   }
  const char *module_hash_name      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return HASH_NAME;       }
  u64         module_kern_type      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return KERN_TYPE;       }
  u32         module_opti_type      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return OPTI_TYPE;       }
  u64         module_opts_type      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return OPTS_TYPE;       }
  u32         module_salt_type      (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return SALT_TYPE;       }
  const char *module_st_hash        (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return ST_HASH;         }
  const char *module_st_pass        (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra) { return ST_PASS;         }
  
  typedef struct vc_tmp
  {
    u32 ipad[16];
    u32 opad[16];
  
    u32 dgst[64];
    u32 out[64];
  
    u32 pim_key[64];
    int pim; // marker for cracked
    int pim_check; // marker for _extended kernel
  
  } vc_tmp_t;
  
  typedef struct vc
  {
    u32 salt_buf[32];
    u32 data_buf[112];
    u32 keyfile_buf[16];
    u32 signature;
  
    keyboard_layout_mapping_t keyboard_layout_mapping_buf[256];
    int                       keyboard_layout_mapping_cnt;
  
    int pim_multi; // 2048 for boot (not SHA-512 or Whirlpool), 1000 for others
    int pim_start;
    int pim_stop;
  
  } vc_t;
  
  static const int   ROUNDS_VERACRYPT_500000     = 500000;
  static const float MIN_SUFFICIENT_ENTROPY_FILE = 7.0f;
  
  int module_build_plain_postprocess (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const hashes_t *hashes, MAYBE_UNUSED const void *tmps, const u32 *src_buf, MAYBE_UNUSED const size_t src_sz, MAYBE_UNUSED const int src_len, u32 *dst_buf, MAYBE_UNUSED const size_t dst_sz)
  {
    const vc_tmp_t *vc_tmp = (const vc_tmp_t *) tmps;
  
    if (vc_tmp->pim == 0)
    {
      return snprintf ((char *) dst_buf, dst_sz, "%s", (char *) src_buf);
    }
    else
    {
      return snprintf ((char *) dst_buf, dst_sz, "%s   (PIM=%d)", (char *) src_buf, vc_tmp->pim - 15);
    }
  }
  
  bool module_potfile_disable (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra)
  {
    const bool potfile_disable = true;
  
    return potfile_disable;
  }
  
  bool module_outfile_check_disable (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra)
  {
    const bool outfile_check_disable = true;
  
    return outfile_check_disable;
  }
  
  u64 module_esalt_size (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra)
  {
    const u64 esalt_size = (const u64) sizeof (vc_t);
  
    return esalt_size;
  }
  
  u64 module_tmp_size (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra)
  {
    const u64 tmp_size = (const u64) sizeof (vc_tmp_t);
  
    return tmp_size;
  }
  
  u32 module_kernel_loops_max (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra)
  {
    const u32 kernel_loops_max = 1000; // lowest PIM multiplier
  
    return kernel_loops_max;
  }
  
  u32 module_pw_max (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra)
  {
    // this overrides the reductions of PW_MAX in case optimized kernel is selected
    // IOW, even in optimized kernel mode it support length 64
  
    const u32 pw_max = 64;
  
    return pw_max;
  }
  
  int module_hash_init_selftest (MAYBE_UNUSED const hashconfig_t *hashconfig, hash_t *hash)
  {
    const size_t st_hash_len = strlen (hashconfig->st_hash);
  
    char *tmpdata = (char *) hcmalloc (st_hash_len / 2);
  
    for (size_t i = 0, j = 0; j < st_hash_len; i += 1, j += 2)
    {
      const u8 c = hex_to_u8 ((const u8 *) hashconfig->st_hash + j);
  
      tmpdata[i] = c;
    }
  
    const int parser_status = module_hash_decode (hashconfig, hash->digest, hash->salt, hash->esalt, hash->hook_salt, hash->hash_info, tmpdata, st_hash_len / 2);
  
    hcfree (tmpdata);
  
    return parser_status;
  }
  
  int module_hash_binary_parse (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra, hashes_t *hashes)
  {
    // note: if module_hash_binary_parse exists, then module_hash_decode is not called
  
    HCFILE fp;
  
    if (hc_fopen (&fp, hashes->hashfile, "rb") == false) return (PARSER_HAVE_ERRNO);
  
    #define VC_HEADER_SIZE 512
  
    char *in = (char *) hcmalloc (VC_HEADER_SIZE);
  
    const size_t n = hc_fread (in, 1, VC_HEADER_SIZE, &fp);
  
    hc_fclose (&fp);
  
    if (n != VC_HEADER_SIZE) return (PARSER_VC_FILE_SIZE);
  
    hash_t *hashes_buf = hashes->hashes_buf;
  
    hash_t *hash = &hashes_buf[0];
  
    const int parser_status = module_hash_decode (hashconfig, hash->digest, hash->salt, hash->esalt, hash->hook_salt, hash->hash_info, in, VC_HEADER_SIZE);
  
    if (parser_status != PARSER_OK) return 0;
  
    hcfree (in);
  
    // keyfiles
  
    vc_t *vc = (vc_t *) hash->esalt;
  
    if (user_options->veracrypt_keyfiles)
    {
      char *keyfiles = hcstrdup (user_options->veracrypt_keyfiles);
  
      char *saveptr = NULL;
  
      char *keyfile = strtok_r (keyfiles, ",", &saveptr);
  
      while (keyfile)
      {
        if (hc_path_read (keyfile))
        {
          cpu_crc32 (keyfile, (u8 *) vc->keyfile_buf);
        }
  
        keyfile = strtok_r ((char *) NULL, ",", &saveptr);
      }
  
      free (keyfiles);
    }
  
    // keyboard layout mapping
  
    if (user_options->keyboard_layout_mapping)
    {
      if (hc_path_read (user_options->keyboard_layout_mapping))
      {
        initialize_keyboard_layout_mapping (user_options->keyboard_layout_mapping, vc->keyboard_layout_mapping_buf, &vc->keyboard_layout_mapping_cnt);
      }
    }
  
    // veracrypt PIM
  
    salt_t *salt = hash->salt;
  
    if ((user_options->veracrypt_pim_start_chgd == true) && (user_options->veracrypt_pim_stop_chgd == true))
    {
      vc->pim_start = 15 + user_options->veracrypt_pim_start;
      vc->pim_stop  = 15 + user_options->veracrypt_pim_stop;
  
      salt->salt_iter = vc->pim_stop * 1000;
      salt->salt_iter--;
    }
  
    return 1;
  }
  
  int module_hash_decode (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED void *digest_buf, MAYBE_UNUSED salt_t *salt, MAYBE_UNUSED void *esalt_buf, MAYBE_UNUSED void *hook_salt_buf, MAYBE_UNUSED hashinfo_t *hash_info, const char *line_buf, MAYBE_UNUSED const int line_len)
  {
    u32 *digest = (u32 *) digest_buf;
  
    vc_t *vc = (vc_t *) esalt_buf;
  
    const float entropy = get_entropy ((const u8 *) line_buf, line_len);
  
    if (entropy < MIN_SUFFICIENT_ENTROPY_FILE) return (PARSER_INSUFFICIENT_ENTROPY);
  
    memcpy (vc->salt_buf, line_buf, 64);
  
    memcpy (vc->data_buf, line_buf + 64, 512 - 64);
  
    salt->salt_buf[0] = vc->salt_buf[0];
  
    salt->salt_len = 4;
  
    salt->salt_iter = ROUNDS_VERACRYPT_500000;
    salt->salt_iter--;
  
    vc->pim_multi = 1000;
    vc->pim_start = 0;
    vc->pim_stop  = 0;
  
    vc->signature = 0x41524556; // "VERA"
  
    digest[0] = vc->data_buf[0];
  
    return (PARSER_OK);
  }
  
  void module_init (module_ctx_t *module_ctx)
  {
    module_ctx->module_context_size             = MODULE_CONTEXT_SIZE_CURRENT;
    module_ctx->module_interface_version        = MODULE_INTERFACE_VERSION_CURRENT;
  
    module_ctx->module_attack_exec              = module_attack_exec;
    module_ctx->module_benchmark_esalt          = MODULE_DEFAULT;
    module_ctx->module_benchmark_hook_salt      = MODULE_DEFAULT;
    module_ctx->module_benchmark_mask           = MODULE_DEFAULT;
    module_ctx->module_benchmark_salt           = MODULE_DEFAULT;
    module_ctx->module_build_plain_postprocess  = module_build_plain_postprocess;
    module_ctx->module_deep_comp_kernel         = MODULE_DEFAULT;
    module_ctx->module_dgst_pos0                = module_dgst_pos0;
    module_ctx->module_dgst_pos1                = module_dgst_pos1;
    module_ctx->module_dgst_pos2                = module_dgst_pos2;
    module_ctx->module_dgst_pos3                = module_dgst_pos3;
    module_ctx->module_dgst_size                = module_dgst_size;
    module_ctx->module_dictstat_disable         = MODULE_DEFAULT;
    module_ctx->module_esalt_size               = module_esalt_size;
    module_ctx->module_extra_buffer_size        = MODULE_DEFAULT;
    module_ctx->module_extra_tmp_size           = MODULE_DEFAULT;
    module_ctx->module_forced_outfile_format    = MODULE_DEFAULT;
    module_ctx->module_hash_binary_count        = MODULE_DEFAULT;
    module_ctx->module_hash_binary_parse        = module_hash_binary_parse;
    module_ctx->module_hash_binary_save         = MODULE_DEFAULT;
    module_ctx->module_hash_decode_potfile      = MODULE_DEFAULT;
    module_ctx->module_hash_decode_zero_hash    = MODULE_DEFAULT;
    module_ctx->module_hash_decode              = module_hash_decode;
    module_ctx->module_hash_encode_status       = MODULE_DEFAULT;
    module_ctx->module_hash_encode_potfile      = MODULE_DEFAULT;
    module_ctx->module_hash_encode              = MODULE_DEFAULT;
    module_ctx->module_hash_init_selftest       = module_hash_init_selftest;
    module_ctx->module_hash_mode                = MODULE_DEFAULT;
    module_ctx->module_hash_category            = module_hash_category;
    module_ctx->module_hash_name                = module_hash_name;
    module_ctx->module_hashes_count_min         = MODULE_DEFAULT;
    module_ctx->module_hashes_count_max         = MODULE_DEFAULT;
    module_ctx->module_hlfmt_disable            = MODULE_DEFAULT;
    module_ctx->module_hook12                   = MODULE_DEFAULT;
    module_ctx->module_hook23                   = MODULE_DEFAULT;
    module_ctx->module_hook_salt_size           = MODULE_DEFAULT;
    module_ctx->module_hook_size                = MODULE_DEFAULT;
    module_ctx->module_jit_build_options        = MODULE_DEFAULT;
    module_ctx->module_jit_cache_disable        = MODULE_DEFAULT;
    module_ctx->module_kernel_accel_max         = MODULE_DEFAULT;
    module_ctx->module_kernel_accel_min         = MODULE_DEFAULT;
    module_ctx->module_kernel_loops_max         = module_kernel_loops_max;
    module_ctx->module_kernel_loops_min         = MODULE_DEFAULT;
    module_ctx->module_kernel_threads_max       = MODULE_DEFAULT;
    module_ctx->module_kernel_threads_min       = MODULE_DEFAULT;
    module_ctx->module_kern_type                = module_kern_type;
    module_ctx->module_kern_type_dynamic        = MODULE_DEFAULT;
    module_ctx->module_opti_type                = module_opti_type;
    module_ctx->module_opts_type                = module_opts_type;
    module_ctx->module_outfile_check_disable    = module_outfile_check_disable;
    module_ctx->module_outfile_check_nocomp     = MODULE_DEFAULT;
    module_ctx->module_potfile_custom_check     = MODULE_DEFAULT;
    module_ctx->module_potfile_disable          = module_potfile_disable;
    module_ctx->module_potfile_keep_all_hashes  = MODULE_DEFAULT;
    module_ctx->module_pwdump_column            = MODULE_DEFAULT;
    module_ctx->module_pw_max                   = module_pw_max;
    module_ctx->module_pw_min                   = MODULE_DEFAULT;
    module_ctx->module_salt_max                 = MODULE_DEFAULT;
    module_ctx->module_salt_min                 = MODULE_DEFAULT;
    module_ctx->module_salt_type                = module_salt_type;
    module_ctx->module_separator                = MODULE_DEFAULT;
    module_ctx->module_st_hash                  = module_st_hash;
    module_ctx->module_st_pass                  = module_st_pass;
    module_ctx->module_tmp_size                 = module_tmp_size;
    module_ctx->module_unstable_warning         = MODULE_DEFAULT;
    module_ctx->module_warmup_disable           = MODULE_DEFAULT;
  }
  