plex-rule-exclusions-plugin/plugin.yaml at main · davidscarth/plex-rule-exclusions-plugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# OWASP CRS Plugin Descriptor
# See https://github.com/coreruleset/plugin-registry for the schema definition.

schema_version: 1

plugin:
  name: "plex-rule-exclusions-plugin"
  description: "Rule exclusions Plex Media Server needs to run behind OWASP CRS at paranoia level 1."
  long_description: |
    Removes the OWASP CRS false positives that otherwise break Plex Media
    Server playback, search, library filters, thumbnails, client log uploads
    and artwork and subtitle uploads at paranoia level 1. Every exclusion is
    scoped to one endpoint. Pairs with plex-hardening-plugin, which adds
    detection rules and owner-only endpoint denies on top.
  type: "3rd-party"
  category: "rule-exclusion"
  status: "tested"
  license: "Apache-2.0"
  authors:
    - name: "David Scarth"
      url: "https://github.com/davidscarth"
  repository: "https://github.com/davidscarth/plex-rule-exclusions-plugin"
  keywords:
    - "plex"
    - "media server"
    - "rule exclusions"
    - "false positives"

rule_id_range:
  start: 9530000
  end: 9530999

compatibility:
  crs_version: ">=4.25.2"

configuration:
  file: "plugins/plex-rule-exclusions-config.conf"
  variables:
    - name: "tx.plex-rule-exclusions-plugin_enabled"
      type: "boolean"
      default: 1
      description: "Enables or disables the plugin (0 to disable)."
      required: false
    - name: "tx.plex-rule-exclusions-plugin_hosts"
      type: "list"
      separator: " "
      prefix: "/"
      suffix: "/"
      description: "Space-separated, slash-wrapped scope entries the plugin applies to: /name/, /name:port/, /ip:port/ or /:port/. Unset applies the plugin to every request; set it only when the WAF also fronts other applications."
      required: false
      example: "/plex.example.com/"