Open Raven

The Open Raven Documentation Site

Welcome to the Open Raven Documentation Site. You'll find comprehensive guides and documentation to help you start working with Open Raven as quickly as possible, as well as support if you get stuck. Let's jump right in.

Guides    

The Data Scan feature uses machine learning and pattern matching to identify and classify your sensitive data in AWS S3 Buckets.

Activating Data Scanning will enable you to discover sensitive data such as:

  • Sensitive personal information
  • Developer secrets and credentials
  • Financial and health data.

Data Scanning uses the following concepts:

  1. Data Classes, e.g., US Social Security number.
  2. Data Collections (a group of data classes), e.g., Privacy Data.
  3. Data Scan Jobs.

Open Raven comes with a number of Default Data Classes and Default Data Collections. You can also Create a Data Class and Create a Data Collection. Data Scan Jobs run as specified by you, scanning for specific Data Classes and Data Collections in a target Asset Group on a scheduled cadence.

Supported file formats

Open Raven analyzes S3 bucket data in many different formats. When running a Data Scan Job, the full file and its contents are inspected. The type of file is determined by its MIME type. The following table describes the file formats that Open Raven supports today.

File Type

File Extensions or MIME Type

Description

Text-Based

.txt, .log, .json, .yml, .html, .htm, .csv, and others with MIME types

text/plain, text/csv, application/json, text/html, application/xhtml+xml

Text files such as comma-separated values (CSV) files, Hypertext Markup Language (HTML) files, JavaScript Object Notation (JSON) files, plain-text documents, and more.

Document

.pdf, .doc, .docx, .ppt, .xls, .xlsx, .odt, .ods, .odp and others with MIME types

application/pdf, application/msword, application/vnd.ms-powerpoint, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.visio, application/vnd.ms-project, application/x-vnd.oasis.opendocument.text, application/vnd.oasis.opendocument.text, application/x-vnd.oasis.opendocument.presentation, application/vnd.oasis.opendocument.presentation

Common document file formats like Adobe PDF files, Microsoft Word, Powerpoint, and Excel files, and more.

Big Data

Files with MIME types

application/x-parquet, application/avro

Apache Parquet files and Avro object containers.

If there's a file format you wish to see supported by Open Raven, please reach out to us at [email protected].

Updated 3 months ago


What's Next

Data Classes

Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.