{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "PermissionFile", "description": "Permission file that can define a default permission, a set of permissions or a list of inlined permissions.", "type": "object", "properties": { "default": { "description": "The default permission set for the plugin", "anyOf": [ { "$ref": "#/definitions/DefaultPermission" }, { "type": "null" } ] }, "set": { "description": "A list of permissions sets defined", "type": "array", "items": { "$ref": "#/definitions/PermissionSet" } }, "permission": { "description": "A list of inlined permissions", "default": [], "type": "array", "items": { "$ref": "#/definitions/Permission" } } }, "definitions": { "DefaultPermission": { "description": "The default permission set of the plugin.\n\nWorks similarly to a permission with the \"default\" identifier.", "type": "object", "required": [ "permissions" ], "properties": { "version": { "description": "The version of the permission.", "type": [ "integer", "null" ], "format": "uint64", "minimum": 1.0 }, "description": { "description": "Human-readable description of what the permission does. Tauri convention is to use

headings in markdown content for Tauri documentation generation purposes.", "type": [ "string", "null" ] }, "permissions": { "description": "All permissions this set contains.", "type": "array", "items": { "type": "string" } } } }, "PermissionSet": { "description": "A set of direct permissions grouped together under a new name.", "type": "object", "required": [ "description", "identifier", "permissions" ], "properties": { "identifier": { "description": "A unique identifier for the permission.", "type": "string" }, "description": { "description": "Human-readable description of what the permission does.", "type": "string" }, "permissions": { "description": "All permissions this set contains.", "type": "array", "items": { "$ref": "#/definitions/PermissionKind" } } } }, "Permission": { "description": "Descriptions of explicit privileges of commands.\n\nIt can enable commands to be accessible in the frontend of the application.\n\nIf the scope is defined it can be used to fine grain control the access of individual or multiple commands.", "type": "object", "required": [ "identifier" ], "properties": { "version": { "description": "The version of the permission.", "type": [ "integer", "null" ], "format": "uint64", "minimum": 1.0 }, "identifier": { "description": "A unique identifier for the permission.", "type": "string" }, "description": { "description": "Human-readable description of what the permission does. Tauri internal convention is to use

headings in markdown content for Tauri documentation generation purposes.", "type": [ "string", "null" ] }, "commands": { "description": "Allowed or denied commands when using this permission.", "default": { "allow": [], "deny": [] }, "allOf": [ { "$ref": "#/definitions/Commands" } ] }, "scope": { "description": "Allowed or denied scoped when using this permission.", "allOf": [ { "$ref": "#/definitions/Scopes" } ] }, "platforms": { "description": "Target platforms this permission applies. By default all platforms are affected by this permission.", "type": [ "array", "null" ], "items": { "$ref": "#/definitions/Target" } } } }, "Commands": { "description": "Allowed and denied commands inside a permission.\n\nIf two commands clash inside of `allow` and `deny`, it should be denied by default.", "type": "object", "properties": { "allow": { "description": "Allowed command.", "default": [], "type": "array", "items": { "type": "string" } }, "deny": { "description": "Denied command, which takes priority.", "default": [], "type": "array", "items": { "type": "string" } } } }, "Scopes": { "description": "An argument for fine grained behavior control of Tauri commands.\n\nIt can be of any serde serializable type and is used to allow or prevent certain actions inside a Tauri command. The configured scope is passed to the command and will be enforced by the command implementation.\n\n## Example\n\n```json { \"allow\": [{ \"path\": \"$HOME/**\" }], \"deny\": [{ \"path\": \"$HOME/secret.txt\" }] } ```", "type": "object", "properties": { "allow": { "description": "Data that defines what is allowed by the scope.", "type": [ "array", "null" ], "items": { "$ref": "#/definitions/Value" } }, "deny": { "description": "Data that defines what is denied by the scope. This should be prioritized by validation logic.", "type": [ "array", "null" ], "items": { "$ref": "#/definitions/Value" } } } }, "Value": { "description": "All supported ACL values.", "anyOf": [ { "description": "Represents a null JSON value.", "type": "null" }, { "description": "Represents a [`bool`].", "type": "boolean" }, { "description": "Represents a valid ACL [`Number`].", "allOf": [ { "$ref": "#/definitions/Number" } ] }, { "description": "Represents a [`String`].", "type": "string" }, { "description": "Represents a list of other [`Value`]s.", "type": "array", "items": { "$ref": "#/definitions/Value" } }, { "description": "Represents a map of [`String`] keys to [`Value`]s.", "type": "object", "additionalProperties": { "$ref": "#/definitions/Value" } } ] }, "Number": { "description": "A valid ACL number.", "anyOf": [ { "description": "Represents an [`i64`].", "type": "integer", "format": "int64" }, { "description": "Represents a [`f64`].", "type": "number", "format": "double" } ] }, "Target": { "description": "Platform target.", "oneOf": [ { "description": "MacOS.", "type": "string", "enum": [ "macOS" ] }, { "description": "Windows.", "type": "string", "enum": [ "windows" ] }, { "description": "Linux.", "type": "string", "enum": [ "linux" ] }, { "description": "Android.", "type": "string", "enum": [ "android" ] }, { "description": "iOS.", "type": "string", "enum": [ "iOS" ] } ] }, "PermissionKind": { "type": "string", "oneOf": [ { "description": "This enables all permissions for network plugin", "type": "string", "const": "allow-all" }, { "description": "Enables the execute command without any pre-configured scope.", "type": "string", "const": "allow-execute" }, { "description": "Denies the execute command without any pre-configured scope.", "type": "string", "const": "deny-execute" }, { "description": "Enables the find_available_port command without any pre-configured scope.", "type": "string", "const": "allow-find-available-port" }, { "description": "Denies the find_available_port command without any pre-configured scope.", "type": "string", "const": "deny-find-available-port" }, { "description": "Enables the get_interfaces command without any pre-configured scope.", "type": "string", "const": "allow-get-interfaces" }, { "description": "Denies the get_interfaces command without any pre-configured scope.", "type": "string", "const": "deny-get-interfaces" }, { "description": "Enables the get_non_empty_interfaces command without any pre-configured scope.", "type": "string", "const": "allow-get-non-empty-interfaces" }, { "description": "Denies the get_non_empty_interfaces command without any pre-configured scope.", "type": "string", "const": "deny-get-non-empty-interfaces" }, { "description": "Enables the is_http_port_open command without any pre-configured scope.", "type": "string", "const": "allow-is-http-port-open" }, { "description": "Denies the is_http_port_open command without any pre-configured scope.", "type": "string", "const": "deny-is-http-port-open" }, { "description": "Enables the is_port_taken command without any pre-configured scope.", "type": "string", "const": "allow-is-port-taken" }, { "description": "Denies the is_port_taken command without any pre-configured scope.", "type": "string", "const": "deny-is-port-taken" }, { "description": "Enables the local_server_is_running command without any pre-configured scope.", "type": "string", "const": "allow-local-server-is-running" }, { "description": "Denies the local_server_is_running command without any pre-configured scope.", "type": "string", "const": "deny-local-server-is-running" }, { "description": "Enables the non_localhost_networks command without any pre-configured scope.", "type": "string", "const": "allow-non-localhost-networks" }, { "description": "Denies the non_localhost_networks command without any pre-configured scope.", "type": "string", "const": "deny-non-localhost-networks" }, { "description": "Enables the ping command without any pre-configured scope.", "type": "string", "const": "allow-ping" }, { "description": "Denies the ping command without any pre-configured scope.", "type": "string", "const": "deny-ping" }, { "description": "Enables the scan_local_network_online_hosts_by_port command without any pre-configured scope.", "type": "string", "const": "allow-scan-local-network-online-hosts-by-port" }, { "description": "Denies the scan_local_network_online_hosts_by_port command without any pre-configured scope.", "type": "string", "const": "deny-scan-local-network-online-hosts-by-port" }, { "description": "Enables the scan_online_ip_port_pairs command without any pre-configured scope.", "type": "string", "const": "allow-scan-online-ip-port-pairs" }, { "description": "Denies the scan_online_ip_port_pairs command without any pre-configured scope.", "type": "string", "const": "deny-scan-online-ip-port-pairs" }, { "description": "Enables the scan_online_ips_by_port command without any pre-configured scope.", "type": "string", "const": "allow-scan-online-ips-by-port" }, { "description": "Denies the scan_online_ips_by_port command without any pre-configured scope.", "type": "string", "const": "deny-scan-online-ips-by-port" } ] } } }