Protection Profiles¶

3.1.1 Maximum File Size¶

The maximum file size, in Bytes, that the engine will process. Files with size above this value will be ignorred by the engine.

Supported values >= 0 where 0 means no limit.

Recommended: 10485760 (10MB more than enough for typical documents)

{
  "settings" : {
    "text_extractor" : {
      "max_file_size" : 2048
    }
  }
}

3.1.2 Maximum Recursion Level¶

The maximum recursion level to search inside archives (useful to avoid zip bombs).

Supported file types are: compound document format based files (doc, xls, ppt), PDF, office open XML files (.docx, .xlsx, .pptx) and ZIP archives.

Supported values must be in interval [2 - 8].

{
  "settings" : {
    "text_extractor" : {
      "max_recursion_level" : 3
    }
  }
}

3.1.3 Extract Metadata¶

For supported file types, you can extract content also from Metadata/File Properties

Supported values:

• true
• false

Defaults to false.

{
  "settings" : {
    "text_extractor" : {
      "extract_metadata" : true
    }
  }
}

3.1.4 Ignored Mime Types¶

sensitivity.io engine will ignore these mime-types. If present, mime types can not be empty.

Format:

"ignored_mime_types": [
                    "application/x-executable",
                    "application/x-ms-dos-executable",
                    "application/x-sharedlib",
                    "application/x-object"
                    ]

3.1.5 Ignored File Extensions¶

sensitivity.io engine will ignore these file extensions. An empty extension may represent Unix executable but this is risky, better use mimetype for this case.

Format:

"ignored_extensions": [
                    "exe",
                    "so",
                    "dll",
                    "dylib",
                    "a",
                    "lib",
                    "o",
                    "obj"
                    ]

3.2.1 Email¶

Scanning for emails.

Supported values:

• true
• false

"email" : true

3.2.2 Credit Card¶

Scanning for credit card numbers.

Supported credit card formats:

• Mastercard

• Visa

• American Express - The American Express Company, also known as Amex

• JCB - Credit card company based in Tokyo, Japan

• Diners - Diners Club International (DCI), founded as Diners Club

• Discover - The Discover Card is a credit card, issued primarily in the United States

• MIR - Payment system established by the Central Bank of Russia

• Maestro - Multinational debit card service owned by Mastercard

• China UnionPay - China UnionPay, also known under its abbreviation, CUP, is a Chinese financial services corporation

• Carte Blanche - Carte Blanche is a Diners Club Card

  "credit_card" : {
    "amex" : true,
    "china_unionpay" : true,
    "carte_blanche" : true,
    "diners" : true,
    "discover" : true,
    "jcb" : true,
    "maestro" : true,
    "mastercard" : true,
    "mir" : true,
    "visa" : true
  }
  

3.2.3 Date¶

Scanning for dates like birthdays, calendar events, meetings etc.

Supported values:

• true
• false

"date" : true

3.2.4 IBAN¶

Scanning for IBANs.

Supported values:

• true
• false

"iban" : true

3.2.5 SWIFT¶

Scanning for swift code numbers.

Supported values:

• true
• false

"swift" : true

3.2.6 Social Security Number (SSN)¶

Scanning for country specific social security or insurance numbers.

Supported countries for SSN:

• at - Austria
• ca - Canada
• ch - Switzerland
• cy - Cyprus
• de - Germany
• es - Spain
• fr - France
• gb - United Kingdom
• gr - Grece
• hu - Hungary
• ie - Ireland
• jp - Japan
• kr - Korea
• lu - Luxembourg
• nl - Netherlands
• pl - Poland
• ro - Romania
• ru - Russia
• tw - Taiwan
• us - United States

"ssn" : {
  "at" : true,
  "ca" : true,
  "ch" : true,
  "cy" : true,
  "de" : true,
  "es" : true,
  "fr" : true,
  "gb" : true,
  "gr" : true,
  "hu" : true,
  "ie" : true,
  "jp" : true,
  "kr" : true,
  "lu" : true,
  "nl" : true,
  "pl" : true,
  "ro" : true,
  "ru" : true,
  "tw" : true,
  "us" : true
}

3.2.7 Passport¶

Scanning for country specific passport numbers.

Supported countries for Passport:

• ca - Canada
• cn - China Mainland
• de - Germany
• fi - Finland
• fr - France
• gb - United Kingdom
• hk - Hong Kong
• ie - Ireland
• jp - Japan
• kr - Korea
• mo - Macao

"passport" : {
  "ca" : true,
  "cn" : true,
  "de" : true,
  "fi" : true,
  "fr" : true,
  "gb" : true,
  "hk" : true,
  "ie" : true,
  "jp" : true,
  "kr" : true,
  "mo" : true
}

3.2.8 Driver’s License¶

Scanning for country specific driver’s license numbers.

Supported countries for Driver’s License:

• de - Germany
• gb - Great Britain
• it - Italy
• kr - Korea

"driving_license" : {
  "de" : true,
  "gb" : true,
  "it" : true,
  "kr" : true
}

3.2.9 Health Insurance Number¶

Scanning for country specific health insurance numbers

Supported countries for health insurance numbers:

• ca - Canada
• au - Australia
• gb - United Kingdom
• kr - Korea

"health_insurance_number" : {
  "ca" : true,
  "au" : true,
  "gb" : true,
  "kr" : true
}

3.2.10 ID Card¶

Scanning for country specific identification cards.

Supported countries for ID Card:

• ae - United Arab Emirates
• al - Albania
• be - Belgium
• bg - Bulgaria
• br - Brazil
• cl - Chile
• cn - China Mainland
• cz - Czech
• de - Germany
• dk - Denmark
• ec - Ecuador
• ee - Estonia
• fi - Finland
• fr - France
• gr - Greece
• hk - Hong Kong
• hr - Croatia
• id - Indonesia
• il - Israel
• in - India
• is - Iceland
• it - Italy
• kz - Kazakhstan
• lt - Lithuania
• lv - Latvia
• mo - Macao
• mx - Mexico
• my - Malaysia
• no - Norway
• pe - Peru
• pl - Poland
• pt - Portugal
• se - Sweden
• sg - Singapore
• th - Thailand
• tr - Turkey
• yu - Yugoslavia
• za - South Africa

"id_card" : {
  "ae" : true,
  "al" : true,
  "be" : true,
  "bg" : true,
  "br" : true,
  "cl" : true,
  "cn" : true,
  "cz" : true,
  "de" : true,
  "dk" : true,
  "ec" : true,
  "ee" : true,
  "hk" : true,
  "hr" : true,
  "fi" : true,
  "fr" : true,
  "gr" : true,
  "id" : true,
  "il" : true,
  "in" : true,
  "is" : true,
  "it" : true,
  "kz" : true,
  "lt" : true,
  "lv" : true,
  "mo" : true,
  "mx" : true,
  "my" : true,
  "no" : true,
  "pe" : true,
  "pl" : true,
  "pt" : true,
  "se" : true,
  "sg" : true,
  "th" : true,
  "tr" : true,
  "yu" : true,
  "za" : true
}

3.2.11 Phone Number¶

Scanning for country specific phone numbers.

Supported countries for Phone Number:

• cn - China Mainland
• co - Colombia
• de - Germany
• hk - Hong Kong
• in - India
• intl - International
• jp - Japan
• kr - Korea
• local - Local phone number - matching a lot of local numbers - use with precaution
• mo - Macao
• tr - Turkey
• ua - Ukraine
• us - United States

"phone_number" : {
  "cn" : true,
  "co" : true,
  "de" : true,
  "hk" : true,
  "in" : true,
  "intl" : true,
  "jp" : true,
  "kr" : true,
  "local": false,
  "mo" : true,
  "tr" : true,
  "ua" : true,
  "us" : true
}

3.2.12 Tax ID¶

Scanning for country specific tax identification numbers.

Supported countries for Tax ID:

• au - Australia
• bg - Bulgaria
• br - Brazil
• ec - Ecuador
• es - Spain
• intl - International
• it - Italy
• pe - Peru
• pl - Poland
• us - United States

"tax_id" : {
  "au" : true,
  "bg" : true,
  "br" : true,
  "ec" : true,
  "es" : true,
  "intl" : true,
  "it" : true,
  "pe" : true,
  "pl" : true,
  "us" : true,
}

3.2.13 VAT Number¶

Scanning for country specific VAT numbers.

Supported countries for VAT Number:

• de - Germany
• fi - Finland
• gr - Greece
• ie - Ireland
• it - Italy
• lu - Luxembourg
• si - Slovenia

"vat_number" : {
  "de": true,
  "fi": true,
  "gr": true,
  "ie": true,
  "it": true,
  "lu": true,
  "si": true
}

3.2.14 Foreign Registration Number¶

Scanning for country specific foreign registration numbers.

Supported countries for Foreign Registration Numbers:

• kr - Korea

"foreign_registration_number" : {
  "kr" : true
}

3.2.15 Address¶

Scanning for country specific addresses.

Supported countries for addresses:

• co - Colombia
• de - Germany
• in - India
• us - United States

"address" : {
  "co" : true,
  "de" : true,
  "in" : true,
  "us" : true
}

3.2.16 Dictionaries¶

Scanning for specific terms (words or whole phrases)

Options:

• case_sensitive: boolean - Scan case sensitive
• disable: boolean - Present in settings, but inactive, won’t scan for these terms
• name: string - Name for this group of terms
• whole_words_only: boolean - Scan for whole specified term only or for each of the words in the term
• words: list - Words or phrases to scan for

Format:

"dictionaries" : [
  {
    "case_sensitive" : false,
    "disable" : false,
    "name" : "Lite - Confidential Dictionary",
    "whole_words_only" : false,
    "words" : [ "Confidential", "Restricted", "Secret", "Sensitive", "Financial" ]
  },
  {
    "case_sensitive" : true,
    "disable" : false,
    "name" : "Case and Whole Dictionary",
    "whole_words_only" : false,
    "words" : [ "Monthly internal report", "Another strict secret" ]
  }
]

3.2.17 Regular Expression¶

Scan for regular expressions

Options:

• name: string - Name for this regular expression
• value: string - Regular expression - regexp

Format:

"regexps": [
  {
    "name": "IPv4",
    "value": "(10.[0-9]{1,3}|172.(3[01]|2[0-9]|1[6-9])|192.168).[0-9]{1,3}.[0-9]{1,3}"
  },
  {
    "name": "IPv6",
    "value": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))"
  }
]

3.2.18 Mime Type Alerts¶

sensitivity.io engine will display information when specific file types (mime-types) are found.

Options:

• name: string - Name for this group of mime-types
• mime_types: list of mime-types - Mime-types that will display an alert if found

Format:

"mime_type_alerts": [
  {
    "mime_types": ["application/x-cpt"],
    "name": "Corel Photo-Paint"
  },
  {
    "mime_types": ["application/jnt-file"],
    "name": "Journal files"
  },
  {
    "mime_types": ["application/x-bzip2"],
    "name": "bz2"
  },
  {
    "mime_types": ["application/x-gzip"],
    "name": "GZ"
  },
  {
    "mime_types": ["application/x-gzip"],
    "name": "GZ"
  },
  {
    "name": "ZIP",
    "mime_types": ["application/x-compress", "application/zip"]
  }
]

3.3.1 Minimum Word Length¶

The minimum word length the classification engine will include in the model, expressed in number of characters.

Supported values >= 0 where 0 means no restriction.

Recommended: 2

"word_min_length": 2

3.3.2 Maximum Word Length¶

The maximum word length the classification engine will include in the model expressed in number of characters.

Supported values >= 0 where 0 means no restriction.

Recommended: 15

"word_max_length": 15

3.3.3 Vocabulary¶

List of words the model uses for creating a pattern. It is mandatory, the list can not be empty and the contained words can not be empty.

Format:

"vocabulary": [
                "a",
                "adding",
                "and",
                "are",
                "buy",
                "by",
                "cheap",
                "cialis",
                "dog",
                "drugs",
                "ed",
                "email"
              ]

3.3.4 Ignored Words¶

List of words that sensitivity.io engine will ignore when classifying. If present words can not be empty.

Format:

"ignored_words": [
                    "foo",
                    "bar"
                  ]

3.3.5 Model¶

sensitivity.io engine will use this SVM model to classify documents. It is always required.

Format:

"model": "svm_type c_svc\nkernel_type rbf\ngamma 0.0263158\nnr_class 2\ntotal_sv 10\nrho 0.23536\nlabel 1 0\nnr_sv 5 5\nSV\n1 30982880:1.5832638e-316 0:0 25:1 29:1 36:1 \n1 8:1 11:1 27:1 34:1 \n1 3:1 5:1 8:1 10:1 20:1 27:1 29:1 34:1 \n1 5:1 6:1 10:1 22:1 \n1 5:1 7:1 34:1 \n-1 1:1 9:1 16:1 18:1 19:1 24:1 26:1 28:1 \n-1 1:1 9:1 23:1 26:1 28:1 31:1 38:1 \n-1 1:1 4:1 13:1 14:1 19:1 30:1 33:1 35:1 37:1 \n-1 2:1 12:1 19:1 21:1 32:1 33:1 \n-1 4:1 15:1 17:1 19:1 37:1 \n"