Adding capabilities in tauri v2 beta for my custom plugin

[thepyper]

Hi everybody!
I've updated tauri from 2.0.0-alpha.21 to 2.0.0-beta.2, and I figured out that ACL is now denying my app to work :)
I've added capabilities file (in src-tauri/capabilities) to allow all built-in plugins, that solved part of issues (many errors about mouse movement) but I cannot figure out how to allow my own plugin to work.. it worked before, now all it's commands are denied in my TypeScript part with errors like "<my_plugin_name>.<my_plugin_command> not allowed. Plugin did not define its manifest"

Let's say my plugin is called "doggy" and has a "bark" command, how should I allow my main window (or even better any window) to interact with that command?

Thanks!!

[thepyper]

Ok, I dig in documentation and code, and found out some things I was missing. So, now I'm at that point:

1. I have a crate with name "cy3" in which a plugin is defined, and is named "scada";
2. In crate "cy3" I added the build script that uses tauri_plugin::Builder to build the "permissions" dir/files, that now exists;
3. I have another crate with name "usv5" which is tauri app, and here I want to use the "scada" plugin;
4. In crate "usv5" I added manually (any other way?) a "capabilities" directory with a manually added "builtin.json", containing:

{
  "$schema": "./schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    "path:default",
    "event:default",
    "window:default",
    "app:default",
    "resources:default",
    "menu:default",
    "tray:default",
    "window:allow-set-title"
  ]
}

This way, app starts but still I have no permission to use my plugin.
So, to do a simple test I modify "builtin.json" with an unexistent permission, like that:

{
  "$schema": "./schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    "path:default",
    "event:default",
    "window:default",
    "app:default",
    "resources:default",
    "menu:default",
    "tray:default",
    "window:allow-set-title",
    "this_permission:does_not_exist"
  ]
}

This shows me a build error, with that output:

...
Permission this_permission:does_not_exist not found, expected one of app:default, app:allow-app-hide, app:allow-app-show, app:allow-name, app:allow-tauri-version, app:allow-version, app:deny-app-hide, app:deny-app-show, app:deny-name, app:deny-tauri-ve
rsion, app:deny-version, cy3:allow-translate, cy3:deny-translate, event:default, event:allow-emit, event:allow-emit-to, event:allow-listen, event:allow-unlisten, event:deny-emit, event:deny-emit-to, event:deny-listen, event:deny-unl
isten, menu:default, menu:allow-append, menu:allow-create-default, menu:allow-get, menu:allow-insert, menu:allow-is-checked, menu:allow-is-enabled, menu:allow-items, menu:allow-new, menu:allow-popup, menu:allow-prepend, menu:allow-r
emove, menu:allow-remove-at, menu:allow-set-accelerator, menu:allow-set-as-app-menu, menu:allow-set-as-help-menu-for-nsapp, menu:allow-set-as-window-menu, menu:allow-set-as-windows-menu-for-nsapp, menu:allow-set-checked, menu:allow-
set-enabled, menu:allow-set-icon, menu:allow-set-text, menu:allow-text, menu:deny-append, menu:deny-create-default, menu:deny-get, menu:deny-insert, menu:deny-is-checked, menu:deny-is-enabled, menu:deny-items, menu:deny-new, menu:de
ny-popup, menu:deny-prepend, menu:deny-remove, menu:deny-remove-at, menu:deny-set-accelerator, menu:deny-set-as-app-menu, menu:deny-set-as-help-menu-for-nsapp, menu:deny-set-as-window-menu, menu:deny-set-as-windows-menu-for-nsapp, m
enu:deny-set-checked, menu:deny-set-enabled, menu:deny-set-icon, menu:deny-set-text, menu:deny-text, path:default, path:allow-basename, path:allow-dirname, path:allow-extname, path:allow-is-absolute, path:allow-join, path:allow-norm
alize, path:allow-resolve, path:allow-resolve-directory, path:deny-basename, path:deny-dirname, path:deny-extname, path:deny-is-absolute, path:deny-join, path:deny-normalize, path:deny-resolve, path:deny-resolve-directory, resources
:default, resources:allow-close, resources:deny-close, tray:default, tray:allow-new, tray:allow-set-icon, tray:allow-set-icon-as-template, tray:allow-set-menu, tray:allow-set-show-menu-on-left-click, tray:allow-set-temp-dir-path, tr
ay:allow-set-title, tray:allow-set-tooltip, tray:allow-set-visible, tray:deny-new, tray:deny-set-icon, tray:deny-set-icon-as-template, tray:deny-set-menu, tray:deny-set-show-menu-on-left-click, tray:deny-set-temp-dir-path, tray:deny
-set-title, tray:deny-set-tooltip, tray:deny-set-visible, webview:default, webview:allow-create-webview, webview:allow-create-webview-window, webview:allow-internal-toggle-devtools, webview:allow-print, webview:allow-set-webview-foc
us, webview:allow-set-webview-position, webview:allow-set-webview-size, webview:allow-webview-close, webview:allow-webview-position, webview:allow-webview-size, webview:deny-create-webview, webview:deny-create-webview-window, webvie
w:deny-internal-toggle-devtools, webview:deny-print, webview:deny-set-webview-focus, webview:deny-set-webview-position, webview:deny-set-webview-size, webview:deny-webview-close, webview:deny-webview-position, webview:deny-webview-s
ize, window:default, window:allow-available-monitors, window:allow-center, window:allow-close, window:allow-create, window:allow-current-monitor, window:allow-destroy, window:allow-hide, window:allow-inner-position, window:allow-inn
er-size, window:allow-internal-on-mousedown, window:allow-internal-on-mousemove, window:allow-internal-toggle-maximize, window:allow-is-closable, window:allow-is-decorated, window:allow-is-focused, window:allow-is-fullscreen, window
:allow-is-maximizable, window:allow-is-maximized, window:allow-is-minimizable, window:allow-is-minimized, window:allow-is-resizable, window:allow-is-visible, window:allow-maximize, window:allow-minimize, window:allow-outer-position,
 window:allow-outer-size, window:allow-primary-monitor, window:allow-request-user-attention, window:allow-scale-factor, window:allow-set-always-on-bottom, window:allow-set-always-on-top, window:allow-set-closable, window:allow-set-c
ontent-protected, window:allow-set-cursor-grab, window:allow-set-cursor-icon, window:allow-set-cursor-position, window:allow-set-cursor-visible, window:allow-set-decorations, window:allow-set-effects, window:allow-set-focus, window:
allow-set-fullscreen, window:allow-set-icon, window:allow-set-ignore-cursor-events, window:allow-set-max-size, window:allow-set-maximizable, window:allow-set-min-size, window:allow-set-minimizable, window:allow-set-position, window:
allow-set-progress-bar, window:allow-set-resizable, window:allow-set-shadow, window:allow-set-size, window:allow-set-skip-taskbar, window:allow-set-title, window:allow-set-visible-on-all-workspaces, window:allow-show, window:allow-s
tart-dragging, window:allow-theme, window:allow-title, window:allow-toggle-maximize, window:allow-unmaximize, window:allow-unminimize, window:deny-available-monitors, window:deny-center, window:deny-close, window:deny-create, window
:deny-current-monitor, window:deny-destroy, window:deny-hide, window:deny-inner-position, window:deny-inner-size, window:deny-internal-on-mousedown, window:deny-internal-on-mousemove, window:deny-internal-toggle-maximize, window:den
y-is-closable, window:deny-is-decorated, window:deny-is-focused, window:deny-is-fullscreen, window:deny-is-maximizable, window:deny-is-maximized, window:deny-is-minimizable, window:deny-is-minimized, window:deny-is-resizable, window
:deny-is-visible, window:deny-maximize, window:deny-minimize, window:deny-outer-position, window:deny-outer-size, window:deny-primary-monitor, window:deny-request-user-attention, window:deny-scale-factor, window:deny-set-always-on-b
ottom, window:deny-set-always-on-top, window:deny-set-closable, window:deny-set-content-protected, window:deny-set-cursor-grab, window:deny-set-cursor-icon, window:deny-set-cursor-position, window:deny-set-cursor-visible, window:den
y-set-decorations, window:deny-set-effects, window:deny-set-focus, window:deny-set-fullscreen, window:deny-set-icon, window:deny-set-ignore-cursor-events, window:deny-set-max-size, window:deny-set-maximizable, window:deny-set-min-si
ze, window:deny-set-minimizable, window:deny-set-position, window:deny-set-progress-bar, window:deny-set-resizable, window:deny-set-shadow, window:deny-set-size, window:deny-set-skip-taskbar, window:deny-set-title, window:deny-set-v
isible-on-all-workspaces, window:deny-show, window:deny-start-dragging, window:deny-theme, window:deny-title, window:deny-toggle-maximize, window:deny-unmaximize, window:deny-unminimize

In this long output I can see that my plugin permissions exist, under name "cy3:allow-translate" and "cy3:deny-translate".
(is it correct that name is from crate name, not from plugin name? is this supposed to be?)

Then, I try adding my capabilities to file "builtin.json", like that:

{
  "$schema": "./schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    "path:default",
    "event:default",
    "window:default",
    "app:default",
    "resources:default",
    "menu:default",
    "tray:default",
    "window:allow-set-title",
    "cy3:allow-translate"
  ]
}

This way, I get a build error:

error: failed to run custom build command for `usv5 v5.0.13 (C:\Works2\Union\022_902.Pyser\src\usv5\src-tauri)`
note: To improve backtraces for build dependencies, set the CARGO_PROFILE_DEV_BUILD_OVERRIDE_DEBUG=true environment variable to enable debug information generation.

Caused by:
  process didn't exit successfully: `C:\Works2\Union\022_902.Pyser\src\usv5\src-tauri\target\debug\build\usv5-d56aa3da88fd7cf0\build-script-build` (exit code: 1)
  --- stdout
  cargo:rerun-if-env-changed=TAURI_CONFIG
  cargo:rerun-if-changed=tauri.conf.json
  cargo:rustc-cfg=desktop
  cargo:rustc-env=TAURI_ANDROID_PACKAGE_PREFIX=com_unioncontrolli
  cargo:rustc-cfg=dev
  cargo:rerun-if-changed=capabilities
  failed to parse JSON: data did not match any variant of untagged enum CapabilityFile: data did not match any variant of untagged enum CapabilityFile

I tried to dig in tauri_build code, and from what I'm understanding the only file that could cause this problem is actually the "builtin.json", but I'm not figuring out why that file is failing in parsing... there is no syntax error, and capability "cy3:allow-translate" is existing.

The only other json file that is involved (maybe?) in this process is in crate "cy3" /permissions/schemas/schema.json, but that's autogenerated and looks like a "PermissionFile" and not a "CapabilityFile"...

Any clue?
Thanks!!

[thepyper]

Ok, I dig even more, and found out that parsing error happens because of Identifier failing to be parsed
(see https://github.com/tauri-apps/tauri/blob/dev/core/tauri-utils/src/acl/identifier.rs)
and that happens because my crate has a number into it's name ("cy3", the "3" is not a "ValidByte" according to definition).

I'll open an issue about that, because I see that in identifier.rs many failure cases are possible, but error message popping out is not helpful,
I had to dig deep in code to figure out :)

BTW, is there any reason why a number cannot be in an identifier? why not traditional "alpha" + many "alpha_or_digit" pattern for identifier?

Thanks!!

[FabianLars]

BTW, is there any reason why a number cannot be in an identifier? why not traditional "alpha" + many "alpha_or_digit" pattern for identifier?

I assume this was just an oversight because numbers are somewhat rare in this context. But we'll see what the other say about your GitHub issue :)

[thepyper]

Ok, thanks :)

At end I solved by changing the plugin name, but I don't understand why it works :)
To do that, in my "cy3" in "Cargo.toml" I changed one line, from:
links = "cy3"
to
links = "scada"

This puzzles me :)
In rust book "links" seems to be something about project dependencies, instead here somehow it becomes an output of something.
Why? Is there some black magic? I've found somewhere in code some CARGO_MANIFEST_LINKS constant but I'm not understanding
the logic there...

anyway :) now works!!

[FabianLars]

In rust book "links" seems to be something about project dependencies, instead here somehow it becomes an output of something.
Why? Is there some black magic? I've found somewhere in code some CARGO_MANIFEST_LINKS constant but I'm not understanding
the logic there...

Me neither, let's ask @lucasfernog :) (tldr: What's the links config used for?)

[lucasfernog]

the links attribute let's use pass information from a build script to its upstream crate (the crate that has it as dependency) we use it as a way to pass plugin permission data to the app build script, but the value shouldn't matter unless (maybe) you're also linking something