Skip to content

Permissions and Security

Martin Pihrt edited this page Oct 13, 2026 · 1 revision

Permissions and security

Every plugin.json declares only the capabilities used by that plug-in. OSPy shows the complete set before newly installed code starts. Adding a permission in an update requires another administrator approval.

Permission approval is administrative consent and an audit record, not an operating-system sandbox. Plug-in Python code normally runs with the same operating-system identity and access as OSPy.

Permission Meaning
network Connect to local or Internet services.
files Read or write plug-in data, logs, exports or backups.
i2c Access devices on the Raspberry Pi I²C bus.
gpio Read or control Raspberry Pi GPIO pins.
email Send or receive e-mail through configured services.
subprocess Run a bounded external operating-system command.
system Inspect or change system-level state required by the plug-in.

Review checklist

  • Confirm that each requested permission matches the purpose documented on the plug-in page.
  • Treat subprocess and system as high-impact permissions and inspect the source before approving an unfamiliar plug-in.
  • Store passwords, API tokens and service credentials only in their intended protected setting fields; never post them in issues or diagnostics.
  • Restrict OSPy network exposure and use authentication for every shared, wireless, routed or remote network.
  • Keep OSPy, plug-ins and the Raspberry Pi operating system updated and backed up.

Back to the documentation home

Clone this wiki locally