refactoring, improving security

marcomq · marcomq · commit f98ecf3946cf · 2025-01-01T17:48:14.000+01:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tauri-plugin-python"
-version = "0.1.0"
+version = "0.2.0"
 authors = [ "Marco Mengelkoch" ]
 description = ""
 edition = "2021"
diff --git a/build.rs b/build.rs
@@ -12,7 +12,7 @@ const COMMANDS: &[&str] = &[
 
 fn main() {
     tauri_plugin::Builder::new(COMMANDS)
-        .global_api_script_path("dist-js/index.iife.js")
+        .global_api_script_path("./dist-js/index.iife.js")
         .android_path("android")
         .ios_path("ios")
         .build();
diff --git a/examples/plain-javascript/package.json b/examples/plain-javascript/package.json
@@ -4,10 +4,6 @@
   "version": "0.1.0",
   "type": "module",
   "scripts": {
-    "mkdirJs": "node -e \"const fs = require('fs'); if (!fs.existsSync('src/tauri-plugin-python-api')) { fs.mkdirSync('src/tauri-plugin-python-api');};\"",
-    "copyJs": "node -e \"const fs = require('fs'); const data = fs.readFileSync('node_modules/tauri-plugin-python-api/dist-js/index.iife.js'); fs.writeFileSync('src/tauri-plugin-python-api/index.iife.js', data);\"",
-    "build": "npm run mkdirJs & npm run copyJs",
-    "pretauri": "npm run build",
     "tauri": "tauri"
   },
   "dependencies": {
diff --git a/examples/plain-javascript/src-tauri/src/lib.rs b/examples/plain-javascript/src-tauri/src/lib.rs
@@ -8,7 +8,7 @@ fn greet_rust(name: &str) -> String {
 pub fn run() {
     tauri::Builder::default()
         .invoke_handler(tauri::generate_handler![greet_rust])
-        .plugin(tauri_plugin_python::init())
+        .plugin(tauri_plugin_python::init(vec!["greet_python"]))
         .run(tauri::generate_context!())
         .expect("error while running tauri application");
 }
diff --git a/examples/plain-javascript/src/index.html b/examples/plain-javascript/src/index.html
@@ -6,7 +6,6 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Tauri App</title>
     <script type="module" src="/main.js" defer></script>
-    <script type="module" src="/tauri-plugin-python-api/index.iife.js" defer></script>
   </head>
 
   <body>
diff --git a/examples/plain-javascript/src/main.js b/examples/plain-javascript/src/main.js
@@ -5,14 +5,14 @@ let outputEl;
 
 async function greet_rust() {
   // Learn more about Tauri commands at https://tauri.app/develop/calling-rust/
-  outputEl.textContent = await tauri.invoke("greet_rust", { name: inputField.value });
+  outputEl.textContent = await tauri.core.invoke("greet_rust", { name: inputField.value });
 }
 async function greet_python() {
   outputEl.textContent = await tauri.python.call.greet_python(inputField.value);
 }
 
 window.addEventListener("DOMContentLoaded", () => {
-  tauri.python.registerFunction("greet_python", 1);
+  tauri.python.registerJs("greet_python");
   inputField = document.querySelector("#input-field");
   outputEl = document.querySelector("#output-element");
   document.querySelector("#callback-form").addEventListener("submit", (e) => {
diff --git a/guest-js/index.ts b/guest-js/index.ts
@@ -37,7 +37,7 @@ export async function registerFunction(
       numberOfArgs
     },
   }).then((r: any) => {
-    registerJsOnly(pythonFunctionCall, jsFunctionName);
+    registerJs(pythonFunctionCall, jsFunctionName);
     return r.value;
   });
 }
@@ -50,7 +50,7 @@ export async function registerFunction(
  *  @param {string} pythonFunctionCall - The python function call, can contain one dot
  *  @param {string} [jsFunctionName] - Name that is used in javscript: "call.jsFunctionName". Must not contain dots.
  */
-export async function registerJsOnly(pythonFunctionCall: string, jsFunctionName?: string) {
+export async function registerJs(pythonFunctionCall: string, jsFunctionName?: string) {
   if (jsFunctionName === undefined) {
     jsFunctionName = pythonFunctionCall.replace(".", "_");
   }
diff --git a/permissions/autogenerated/reference.md b/permissions/autogenerated/reference.md
@@ -2,7 +2,6 @@
 
 Default permissions for the plugin
 
-- `allow-register-function`
 - `allow-call-function`
 - `allow-read-variable`
 
diff --git a/permissions/default.toml b/permissions/default.toml
@@ -1,4 +1,5 @@
 [default]
 description = "Default permissions for the plugin"
-permissions = ["allow-register-function", "allow-call-function", "allow-read-variable"]
-# "allow-run-python" is not enabled by default for security reasons
+permissions = ["allow-call-function", "allow-read-variable"]
+# "allow-register-function" is disabled due to the "secure by default" concept. It can be enabled if the UI isn't exposed via network and secured against XSS sufficiently.
+# "allow-run-python" is also disabled as it allows to run random python code. It must not be enabled if the UI is exposed via network.
diff --git a/src/lib.rs b/src/lib.rs
@@ -19,7 +19,6 @@ mod commands;
 mod error;
 mod models;
 mod py_lib;
-mod py_main_import;
 
 pub use error::{Error, Result};
 
@@ -40,7 +39,7 @@ impl<R: Runtime, T: Manager<R>> crate::PythonExt<R> for T {
 }
 
 /// Initializes the plugin.
-pub fn init<R: Runtime>() -> TauriPlugin<R> {
+pub fn init<R: Runtime>(python_functions: Vec<&'static str>) -> TauriPlugin<R> {
     Builder::new("python")
         .invoke_handler(tauri::generate_handler![
             commands::run_python,
@@ -54,6 +53,9 @@ pub fn init<R: Runtime>() -> TauriPlugin<R> {
             #[cfg(desktop)]
             let python = desktop::init(app, api)?;
             app.manage(python);
+            for function_name in python_functions {
+                py_lib::register_function_str(function_name.into(), None)?;
+            }
             Ok(())
         })
         .build()
diff --git a/src/py_lib.rs b/src/py_lib.rs
@@ -3,6 +3,8 @@
 //  Licensed under MIT License, see License file for more details
 //  git clone https://github.com/marcomq/tauri-plugin-python
 
+use std::env;
+use std::path::PathBuf;
 use std::sync::atomic::AtomicBool;
 use std::{collections::HashMap, ffi::CString, sync::Mutex};
 
@@ -13,23 +15,33 @@ use pyo3::PyErr;
 use pyo3::{marker, types::PyDict, Py, PyAny, PyResult};
 
 use crate::models::*;
-use crate::py_main_import;
 
 lazy_static! {
     static ref INIT_BLOCKED: AtomicBool = false.into();
     static ref FUNCTION_MAP: Mutex<HashMap<String, Py<PyAny>>> = Mutex::new(HashMap::new());
     static ref GLOBALS: Mutex<Py<PyDict>> =
         Mutex::new(marker::Python::with_gil(|py| { PyDict::new(py).into() }));
+} 
+
+fn get_py_path() -> PathBuf {
+    env::current_dir().unwrap().join("src-python")
+}
+
+fn read_main_py<'a>() -> String {
+    let py_file_path = get_py_path().join("main.py");
+    std::fs::read_to_string(py_file_path).unwrap_or_default()
+    // include_str!(concat!(env!("PWD"),  "/src-tauri/src-python/main.py"))
 }
+
 pub fn init_python() -> PyResult<()> {
-    let code = py_main_import::read_at_startup();
+    let code = read_main_py();
     let c_code = CString::new(code).expect("error creating cstring from code");
     marker::Python::with_gil(|py| -> PyResult<()> {
         let syspath = py
             .import("sys")?
             .getattr("path")?
             .downcast_into::<PyList>()?;
-        syspath.insert(0, py_main_import::get_py_path().to_str())?;
+        syspath.insert(0, get_py_path().to_str())?;
         let globals = GLOBALS.lock().unwrap().clone_ref(py).into_bound(py);
         py.run(&c_code, Some(&globals), None)
     })
@@ -43,7 +55,10 @@ pub fn run_python(payload: StringRequest) -> PyResult<()> {
     })
 }
 pub fn register_function(payload: RegisterRequest) -> PyResult<()> {
-    let fn_name = payload.python_function_call;
+    register_function_str(payload.python_function_call, payload.number_of_args)
+}
+
+pub fn register_function_str(fn_name: String, number_of_args: Option<u8>) -> PyResult<()> {
     // TODO, check actual function signature
     if INIT_BLOCKED.load(std::sync::atomic::Ordering::Relaxed) {
         return Err(pyo3::exceptions::PyException::new_err(
@@ -72,7 +87,7 @@ pub fn register_function(payload: RegisterRequest) -> PyResult<()> {
                 &fn_name
             )));
         }
-        if let Some(num_args) = payload.number_of_args {
+        if let Some(num_args) = number_of_args {
             let py_analyze_sig = format!(
                 r#"
 if True:
diff --git a/src/py_main_import.rs b/src/py_main_import.rs

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ fn greet_rust(name: &str) -> String {`
`8`	`8`	`pub fn run() {`
`9`	`9`	`tauri::Builder::default()`
`10`	`10`	`.invoke_handler(tauri::generate_handler![greet_rust])`
`11`		`- .plugin(tauri_plugin_python::init())`
	`11`	`+ .plugin(tauri_plugin_python::init(vec!["greet_python"]))`
`12`	`12`	`.run(tauri::generate_context!())`
`13`	`13`	`.expect("error while running tauri application");`
`14`	`14`	`}`