tauri-apps / tauri-apps/tauri-docs

[request] Include list of all core permissions in documentation

Open
#2,966 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discuss enhancement
Dominant language
MDX
Stars
1.1k
Forks
887
Avg merge
2d 8h
Merged PRs (30d)
48

Description

Question you want answered

where can I find list of all core permissions?

Where did you look for an answer?

I started locking down my app with permissions, but was unable to find a list of all core permissions on the documentation page.

Basically I started browsing through the sites in roughly this order:

  • Guides/Security/Capabilities
  • Guides/Develop/ConfigurationFiles
  • Guides/Security/Command Scopes
  • Guides/Security/Permissions
  • Reference/Security/*
  • Reference/Configuration

At first I had a feeling that the documentation about permissions would be geared more towards plugin and tauri(core) developers than users, but then again just a feeling, I must admit that I just skimmed over the content and didn't study it.

Page URL

No response

Additional context

Then I asked on discord and got this link from @FabianLars: https://github.com/tauri-apps/tauri/tree/dev/crates/tauri/permissions

He asked me to create this issue here.

secdude suggested running:

tauri permission list

Even though it is not that readable in console it is still a good to know option IMO, so documentation site should also have it.

I think a mention in https://tauri.app/security/capabilities/ makes sense and additionally a page with all permissions on in the References tab.

PS: At first it was also not very clear to me how the capability / permission system works, probably I haven't read enough, so I didn't understand where to put the permissions and also didn't understand that core permissions need to be prefixed with core:. But that's not enough info for a concrete issue yet, also I don't have any suggestions yet.

Are you willing to work on this yourself?
  • I want to work on this myself

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the permissions source at crates/tauri/permissions and the existing Guides/Security/Capabilities and Reference/Security documentation. Check the tauri permission list output to identify the complete core-permission list and document where permissions belong and that core permissions use the core: prefix. Done means users can find the list from the capabilities page and in the References section.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.