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"
  
  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_DOCUMENTS;
  static const char *HASH_NAME      = "PDF 1.7 Level 8 (Acrobat 10 - 11)";
  static const u64   KERN_TYPE      = 10700;
  static const u32   OPTI_TYPE      = OPTI_TYPE_ZERO_BYTE;
  static const u64   OPTS_TYPE      = OPTS_TYPE_PT_GENERATE_LE
                                    | OPTS_TYPE_HASH_COPY;
  static const u32   SALT_TYPE      = SALT_TYPE_EMBEDDED;
  static const char *ST_PASS        = "hashcat";
  static const char *ST_HASH        = "$pdf$5*6*256*-1028*1*16*62137640825124540503886403748430*127*0391647179352257f7181236ba371e540c2dbb82fac1c462313eb58b772a54956213764082512454050388640374843000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000*127*00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000*32*0000000000000000000000000000000000000000000000000000000000000000*32*0000000000000000000000000000000000000000000000000000000000000000";
  
  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 pdf
  {
    int  V;
    int  R;
    int  P;
  
    int  enc_md;
  
    u32  id_buf[8];
    u32  u_buf[32];
    u32  o_buf[32];
  
    int  id_len;
    int  o_len;
    int  u_len;
  
    u32  rc4key[2];
    u32  rc4data[2];
  
  } pdf_t;
  
  typedef struct pdf17l8_tmp
  {
    union
    {
      u32 dgst32[16];
      u64  dgst64[8];
    } d;
  
    u32 dgst_len;
    u32 W_len;
  
  } pdf17l8_tmp_t;
  
  static const char *SIGNATURE_PDF  = "$pdf$";
  static const int   ROUNDS_PDF17L8 = 64;
  
  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 (pdf_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 (pdf17l8_tmp_t);
  
    return tmp_size;
  }
  
  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)
  {
    const bool optimized_kernel = (hashconfig->opti_type & OPTI_TYPE_OPTIMIZED_KERNEL);
  
    u32 pw_max = 127; // https://www.pdflib.com/knowledge-base/pdf-password-security/encryption/
  
    if (optimized_kernel == true)
    {
       pw_max = 16;
    }
  
    return pw_max;
  }
  
  bool module_unstable_warning (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const user_options_t *user_options, MAYBE_UNUSED const user_options_extra_t *user_options_extra, MAYBE_UNUSED const hc_device_param_t *device_param)
  {
    // l_opencl_p_18.1.0.013: Segmentation fault
    if (device_param->device_vendor_id == VENDOR_ID_INTEL_SDK)
    {
      if ((hashconfig->opti_type & OPTI_TYPE_OPTIMIZED_KERNEL) == 1)
      {
        return true;
      }
    }
  
    // amdgpu-pro-18.50-708488-ubuntu-18.04: Segmentation fault
    if ((device_param->device_vendor_id == VENDOR_ID_AMD) && (device_param->has_vperm == false))
    {
      if ((hashconfig->opti_type & OPTI_TYPE_OPTIMIZED_KERNEL) == 1)
      {
        return true;
      }
    }
  
    return false;
  }
  
  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;
  
    pdf_t *pdf = (pdf_t *) esalt_buf;
  
    token_t token;
  
    token.token_cnt  = 16;
  
    token.signatures_cnt    = 1;
    token.signatures_buf[0] = SIGNATURE_PDF;
  
    token.len[0]     = 5;
    token.attr[0]    = TOKEN_ATTR_FIXED_LENGTH
                     | TOKEN_ATTR_VERIFY_SIGNATURE;
  
    token.len_min[1] = 1;
    token.len_max[1] = 1;
    token.sep[1]     = '*';
    token.attr[1]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[2] = 1;
    token.len_max[2] = 1;
    token.sep[2]     = '*';
    token.attr[2]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[3] = 3;
    token.len_max[3] = 3;
    token.sep[3]     = '*';
    token.attr[3]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[4] = 1;
    token.len_max[4] = 6;
    token.sep[4]     = '*';
    token.attr[4]    = TOKEN_ATTR_VERIFY_LENGTH;
  
    token.len_min[5] = 1;
    token.len_max[5] = 1;
    token.sep[5]     = '*';
    token.attr[5]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[6] = 1;
    token.len_max[6] = 4;
    token.sep[6]     = '*';
    token.attr[6]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[7] = 0;
    token.len_max[7] = 1024;
    token.sep[7]     = '*';
    token.attr[7]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_HEX;
  
    token.len_min[8] = 1;
    token.len_max[8] = 4;
    token.sep[8]     = '*';
    token.attr[8]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[9] = 0;
    token.len_max[9] = 1024;
    token.sep[9]     = '*';
    token.attr[9]    = TOKEN_ATTR_VERIFY_LENGTH
                     | TOKEN_ATTR_VERIFY_HEX;
  
    token.len_min[10] = 1;
    token.len_max[10] = 4;
    token.sep[10]     = '*';
    token.attr[10]    = TOKEN_ATTR_VERIFY_LENGTH
                      | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[11] = 0;
    token.len_max[11] = 1024;
    token.sep[11]     = '*';
    token.attr[11]    = TOKEN_ATTR_VERIFY_LENGTH
                      | TOKEN_ATTR_VERIFY_HEX;
  
    token.len_min[12] = 1;
    token.len_max[12] = 4;
    token.sep[12]     = '*';
    token.attr[12]    = TOKEN_ATTR_VERIFY_LENGTH
                      | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[13] = 0;
    token.len_max[13] = 1024;
    token.sep[13]     = '*';
    token.attr[13]    = TOKEN_ATTR_VERIFY_LENGTH
                      | TOKEN_ATTR_VERIFY_HEX;
  
    token.len_min[14] = 1;
    token.len_max[14] = 4;
    token.sep[14]     = '*';
    token.attr[14]    = TOKEN_ATTR_VERIFY_LENGTH
                      | TOKEN_ATTR_VERIFY_DIGIT;
  
    token.len_min[15] = 0;
    token.len_max[15] = 1024;
    token.sep[15]     = '*';
    token.attr[15]    = TOKEN_ATTR_VERIFY_LENGTH
                      | TOKEN_ATTR_VERIFY_HEX;
  
    const int rc_tokenizer = input_tokenizer ((const u8 *) line_buf, line_len, &token);
  
    if (rc_tokenizer != PARSER_OK) return (rc_tokenizer);
  
    const u8 *V_pos      = token.buf[1];
    const u8 *R_pos      = token.buf[2];
    const u8 *bits_pos   = token.buf[3];
    const u8 *enc_md_pos = token.buf[5];
    const u8 *u_len_pos  = token.buf[8];
    const u8 *u_buf_pos  = token.buf[9];
  
    // validate data
  
    const int V = strtol ((const char *) V_pos, NULL, 10);
    const int R = strtol ((const char *) R_pos, NULL, 10);
  
    int vr_ok = 0;
  
    if ((V == 5) && (R == 5)) vr_ok = 1;
    if ((V == 5) && (R == 6)) vr_ok = 1;
  
    if (vr_ok == 0) return (PARSER_SALT_VALUE);
  
    const int bits = strtol ((const char *) bits_pos, NULL, 10);
  
    if (bits != 256) return (PARSER_SALT_VALUE);
  
    int enc_md = strtol ((const char *) enc_md_pos, NULL, 10);
  
    if ((enc_md != 0) && (enc_md != 1)) return (PARSER_SALT_VALUE);
  
    const u32 u_len  = hc_strtoul ((const char *) u_len_pos,  NULL, 10);
  
    // copy data to esalt
  
    if (u_len < 40) return (PARSER_SALT_VALUE);
  
    if (is_valid_hex_string (u_buf_pos, 80) == false) return (PARSER_SALT_ENCODING);
  
    for (int i = 0, j = 0; i < 8 + 2; i += 1, j += 8)
    {
      pdf->u_buf[i] = hex_to_u32 ((const u8 *) &u_buf_pos[j]);
    }
  
    salt->salt_buf[0] = pdf->u_buf[8];
    salt->salt_buf[1] = pdf->u_buf[9];
  
    salt->salt_len  = 8;
    salt->salt_iter = ROUNDS_PDF17L8;
  
    digest[0] = byte_swap_32 (pdf->u_buf[0]);
    digest[1] = byte_swap_32 (pdf->u_buf[1]);
    digest[2] = byte_swap_32 (pdf->u_buf[2]);
    digest[3] = byte_swap_32 (pdf->u_buf[3]);
    digest[4] = byte_swap_32 (pdf->u_buf[4]);
    digest[5] = byte_swap_32 (pdf->u_buf[5]);
    digest[6] = byte_swap_32 (pdf->u_buf[6]);
    digest[7] = byte_swap_32 (pdf->u_buf[7]);
  
    return (PARSER_OK);
  }
  
  int module_hash_encode (MAYBE_UNUSED const hashconfig_t *hashconfig, MAYBE_UNUSED const void *digest_buf, MAYBE_UNUSED const salt_t *salt, MAYBE_UNUSED const void *esalt_buf, MAYBE_UNUSED const void *hook_salt_buf, MAYBE_UNUSED const hashinfo_t *hash_info, char *line_buf, MAYBE_UNUSED const int line_size)
  {
    const int line_len = snprintf (line_buf, line_size, "%s", hash_info->orighash);
  
    return line_len;
  }
  
  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_DEFAULT;
    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_DEFAULT;
    module_ctx->module_hash_binary_save         = MODULE_DEFAULT;
    module_ctx->module_hash_decode_outfile      = 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              = module_hash_encode;
    module_ctx->module_hash_init_selftest       = MODULE_DEFAULT;
    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_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_DEFAULT;
    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_DEFAULT;
    module_ctx->module_outfile_check_nocomp     = MODULE_DEFAULT;
    module_ctx->module_potfile_disable          = MODULE_DEFAULT;
    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_DEFAULT;
    module_ctx->module_unstable_warning         = module_unstable_warning;
    module_ctx->module_warmup_disable           = MODULE_DEFAULT;
  }
  