README.md

indicator-extractor

Extract indicators (IP, domain, email, hashes, Bitcoin addresses, Litecoin addresses, etc.) from a string or a PDF file written in Rust.

An online playground is available at ioc-extractor.jeaurond.dev.

Usage - Rust

The crate is available on crates.io and can be installed like the following:

cargo add indicator-extractor

To extract indicators from a string/bytes

use indicator_extractor::parser::extract_indicators;

let result = extract_indicators("https://github.com".as_bytes());
println!("{:?}", result); // Ok(([], [Indicator::Url("https://github.com")])

To extract indicators from a PDF file

use indicator_extractor::{data::extract_text_pdf, parser::extract_indicators};

let pdf_data = std::fs::read("./somewhere/pdf_file_path.pdf").unwrap();
let pdf_string = extract_text_pdf(&pdf_data);
let result = extract_indicators(pdf_string.as_bytes());

To scrape a website

use indicator_extractor::data::scrape_website;

let result = scrape_website("https://github.com").await;

Usage - Web

A WebAssembly build is available on npm and can be installed like the following:

npm install indicator-extractor

Then you can use it like this:

import {
  extractIndicators,
  extractIndicatorsBytes,
  parsePdf,
  scrapeWebsite,
  Indicator,
} from "indicator-extractor/indicator_extractor";

// Extract indicators from a string
const indicators: Indicator[] = extractIndicators("https://github.com");
console.log(indicators); // [{"kind":"url","value":"https://github.com"}]

// Or if you prefer bytes
const extractPdf: Indicator[] = extractIndicatorsBytes(new Uint8Array());

// You can also parse a PDF file to get its text
const pdfData: string = parsePdf(new Uint8Array());
// Where you can then use `extractIndicators` on the text
const pdfIndicators: Indicator[] = extractIndicators(pdfData);

// Or scrape a website
const websiteText: string = scrapeWebsite("https://github.com");
// Where you can then use `extractIndicators` on the text
const websiteIndicators: Indicator[] = extractIndicators(websiteText);