Documentation for static_analysis/code.rs

[Razican]

Most of the code is still not documented. This is the tracking issue for static_analysis/code.rs file documentation.

• Module level documentation.
• code_analysis() function:
  • Function level documentation.
  • Inline comments.
• analyze_file() function:
  • Function level documentation.
  • Inline comments.
• get_line_for() function.
• add_files_to_vec() function:
  • Function level documentation.
  • Inline comments.
• Rule struct:
  • Struct level documentation.
  • get_regex() function..
  • get_permissions() function.
  • get_forward_check() function.
  • get_max_sdk() function.
  • get_label() function.
  • get_description() function.
  • get_criticity() function.
  • get_whitelist() function.
• load_rules() function:
  • Function level documentation.
  • Inline comments.
• Tests:
  • check_match() function.
  • it_url_regex() function.
  • it_catch_exception() function.
  • it_throws_exception() function.
  • it_hidden_fields() function.
  • it_ipv4_disclosure() function.
  • it_math_random() function.
  • it_log() function.
  • it_file_separator() function.
  • it_weak_algs() function.
  • it_sleep_method() function.
  • it_world_readable_permissions() function.
  • it_world_writable_permissions() function.
  • it_external_storage_write_read() function.
  • it_temp_file() function.
  • it_webview_xss() function.
  • it_webview_ssl_errors() function.
  • it_sql_injection() function.
  • it_ssl_accepting_all_certificates() function.
  • it_sms_mms_sending() function.
  • it_superuser_privileges() function.
  • it_superuser_device_detection() function.
  • it_base_station_location() function.
  • it_get_device_id() function.
  • it_get_sim_serial() function.
  • it_gps_location() function.
  • it_base64_encode() function.
  • it_base64_decoding() function.
  • it_infinite_loop() function.
  • it_email_disclosure() function.
  • it_hardcoded_certificate() function.
  • it_get_sim_operator() function.
  • it_get_sim_operatorname() function.
  • it_obfuscation() function.
  • it_command_exec() function.
  • it_ssl_getinsecure_method() function.
  • it_finally_with_return() function.
  • it_sleep_method_notvalidated() function.