Skip to content

Commit

Permalink
clarify default changes and how to use plugin permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
tweidinger authored Aug 1, 2024
1 parent bd7cb0d commit cb6c796
Show file tree
Hide file tree
Showing 16 changed files with 39 additions and 37 deletions.
5 changes: 2 additions & 3 deletions src/content/docs/plugin/autostart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,9 @@ fn run() {

## Permissions

By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

```json title="src-tauri/capabilities/main.json"
{
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/plugin/barcode-scanner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,9 @@ scan({ windowed: true, formats: [Format.QRCode] });

## Permissions

By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

```json title="src-tauri/capabilities/mobile.json"
{
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/plugin/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -269,10 +269,9 @@ fn run() {
## Permissions
By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.
See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.
```json title="src-tauri/capabilities/main.json" ins={6}
{
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/plugin/deep-linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,9 @@ fn run() {

## Permissions

By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

```json title="src-tauri/capabilities/main.json" ins={9}
{
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/plugin/file-system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,11 @@ See [@tauri-apps/plugin-fs - Security](/reference/javascript/fs/#security) for m

## Permissions

By default all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={7-11}
{
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/plugin/global-shortcut.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,11 @@ fn run() {

## Permissions

By default all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={7-9}
{
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/plugin/logging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Install the log plugin to get started.

By default, all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={6}
{
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/plugin/os-info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,9 @@ println!("Platform: {}", platform);

## Permissions

By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

```json title="src-tauri/capabilities/main.json" ins={4-6}
{
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/plugin/positioner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,9 @@ let _ = win.as_ref().window().move_window(Position::TopRight);

## Permissions

By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

```json title="src-tauri/capabilities/main.json" ins={4}
{
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/plugin/shell.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,11 @@ if output.status.success() {

## Permissions

By default all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={6-23}
{
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/plugin/sql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -250,10 +250,9 @@ Ensure that the migrations are defined in the correct order and are safe to run
## Permissions
By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.
See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.
```json title="src-tauri/capabilities/main.json" ins={7-8}
{
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/plugin/store.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ pub fn run() {

By default, all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={6-11}
{
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/plugin/stronghold.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,11 @@ await store.remove(key);

## Permissions

By default all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={8-14}
{
Expand Down
6 changes: 4 additions & 2 deletions src/content/docs/plugin/websocket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,11 @@ await ws.disconnect();

## Permissions

By default all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={6}
{
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/plugin/window-customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Add window permissions in capability file.

By default, all plugin commands are blocked and cannot be accessed. You must define a list of permissions in your `capabilities` configuration.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information.

```json title="src-tauri/capabilities/main.json" ins={7-8}
{
Expand Down
5 changes: 2 additions & 3 deletions src/content/docs/plugin/window-state.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,9 @@ window.restore_state(StateFlags::all()); // will restore the window's state from

## Permissions

By default all plugin commands are blocked and cannot be accessed.
You must define a list of permissions in your `capabilities` configuration.
By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your `capabilities` configuration to enable these.

See [Permissions Overview](/security/permissions/) for more information.
See the [Capabilities Overview](/security/capabilities/) for more information and the [step by step guide](/learn/security/using-plugin-permissions/) to use plugin permissions.

```json title="src-tauri/capabilities/main.json" ins={4-5}
{
Expand Down

0 comments on commit cb6c796

Please sign in to comment.