[WIP] Added Support for importing model from lm studio #679

ParamThakkar123 · 2025-11-13T06:04:02Z

Fixes transformerlab/transformerlab-app#160

Should I also go ahead and add a lmstudio server in plugins? Because lmstudio runs on localhost:1234

…ab-api into add/import-lm-studio

codecov · 2025-11-13T06:08:18Z

Codecov Report

❌ Patch coverage is 17.56757% with 61 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
transformerlab/models/lmstudiomodel.py	17.14%	58 Missing ⚠️
transformerlab/models/model_helper.py	25.00%	3 Missing ⚠️

📢 Thoughts on this report? Let us know!

transformerlab/models/lmstudiomodel.py

+
+    async def install(self):
+        input_model_path = self.source_id_or_path
+        if not input_model_path or not os.path.isfile(input_model_path):


To fix this vulnerability, the code must ensure that any user-supplied filename or path, when resolved, is guaranteed to remain within the intended LM Studio models directory. This should be enforced before any sensitive file system operation is performed.

Specifically, in the LMStudioModel __init__ method (or in install), after constructing the path but before assignment, the code should:

Normalize the constructed path (using os.path.abspath and os.path.normpath).

Check that it is contained within the expected models directory (lmstudio_models_dir()), using a strong prefix match (startswith only after normalization).

If this check fails, raise an exception or handle the import as invalid.

Changes to make:

In LMStudioModel.__init__, validate that the resolved absolute model path is inside the LM Studio models directory. If not, raise a ValueError.

This ensures that even if the user supplies a malicious path, they cannot escape the designated directory.

Implementation specifics:

Add a models_dir variable in __init__, resolve it via lmstudio_models_dir().

Use os.path.abspath(os.path.join(models_dir, model_path)) (or similar) to resolve any model_id as a file underneath the intended directory.

Normalize and check with startswith as in the recommendation.

Raise exception if check fails.

transformerlab/models/lmstudiomodel.py

+        output_filename = self.id
+        output_path = os.path.join(get_models_dir(), output_filename)
+
+        if os.path.exists(output_path):


To fix the uncontrolled path expression problem, we must ensure that the constructed output path (output_path) is strictly constrained to a subdirectory of the intended models directory. This is best done by:

Sanitizing the user-controlled output_filename using a function like werkzeug.utils.secure_filename to strip/replace potentially dangerous characters.

Resolving the final path (using os.path.abspath or os.path.realpath) and confirming that it starts with the trusted base directory returned by get_models_dir(). If it doesn't, we must reject the operation.

Optionally, add a check to block absolute paths or path components containing directory traversal (..).

The main places to edit:

In transformerlab/models/lmstudiomodel.py, method install():

Sanitize output_filename with secure_filename.

After constructing output_path, normalize and check that it is within the directory returned by get_models_dir(). If not, raise an error.

New import(s) for secure_filename may be required.

transformerlab/models/lmstudiomodel.py

+
+        if os.path.exists(output_path):
+            raise FileExistsError(errno.EEXIST, "Model already exists", output_path)
+        os.makedirs(output_path, exist_ok=True)


The best way to fix the problem is to validate that any untrusted path segment (here, output_filename derived from user input in self.id) does not contain directory traversal or absolute path elements before using it to construct file system paths. In particular:

Normalize the final constructed path (output_path) using os.path.normpath.

Verify that the resulting normalized path starts with the intended root directory (get_models_dir()), after normalization.

Optionally, ensure output_filename is a "secure" filename, e.g., using werkzeug.utils.secure_filename or by allowing only whitelisted model IDs.

If the path is not contained in the intended directory after normalization, abort the installation and report an error.

This affects the install method in LMStudioModel in transformerlab/models/lmstudiomodel.py, specifically around the lines where output_path is constructed and used. We will add path normalization, containment checking, and filename sanitization. We need to import werkzeug.utils.secure_filename at the top.

transformerlab/models/lmstudiomodel.py

+        os.makedirs(output_path, exist_ok=True)
+
+        link_name = os.path.join(output_path, output_filename)
+        os.symlink(input_model_path, link_name)


To fix this issue, we want to ensure that the input_model_path used in os.symlink is always inside the trusted LM Studio models directory, so that the path cannot be abused by a malicious user. This can be achieved by normalizing the input path and checking that it starts with the trusted models directory's absolute path. If it does not, an exception should be raised. This check should be performed inside the install method of LMStudioModel before os.symlink is called.

Specifically, in transformerlab/models/lmstudiomodel.py:

Inside LMStudioModel.install, after assigning input_model_path, retrieve the root trusted directory (lmstudio_models_dir()), use os.path.abspath + os.path.normpath on both the user-controlled path (input_model_path) and the root, and check that the user-controlled path starts with the root.

If the check fails, raise an exception and do not proceed.

Add import of the utility if not already present.
No existing functionality will be broken, and legitimate users are not affected.

transformerlab/models/lmstudiomodel.py

+        os.makedirs(output_path, exist_ok=True)
+
+        link_name = os.path.join(output_path, output_filename)
+        os.symlink(input_model_path, link_name)


To mitigate path traversal and arbitrary file writes, the best practice is to sanitize and constrain the filenames/paths derived from user input before using them in any filesystem operation. Specifically:

Only allow simple, safe filenames for models (output_filename).

Use werkzeug.utils.secure_filename() to strip dangerous characters and patterns.

Optionally, check that the resulting path after normalization is within the intended workspace/models root directory.

For the provided code, this means:

In LMStudioModel.install, before using self.id (output_filename) to construct output_path and link_name, sanitize it via secure_filename.

Since secure_filename is only imported in transformerlab/routers/model.py, add an import in transformerlab/models/lmstudiomodel.py.

Replace the value of output_filename with the sanitized variant.

Files/regions/lines to change:

Add from werkzeug.utils import secure_filename near the top of transformerlab/models/lmstudiomodel.py.

In install, before using self.id, sanitize it: output_filename = secure_filename(self.id).

Use output_filename as usual below, now guaranteed to be safe.

dadmobile · 2025-11-17T22:10:08Z

transformerlab/models/lmstudiomodel.py

+        }
+
+        model_info_file = os.path.join(output_path, "index.json")
+        with open(model_info_file, "w") as f:


To address this problem, we should sanitize or validate the use of user-controlled data in filesystem paths. The best general-purpose approach for this codebase is to ensure that the output_filename (derived from model_id) is a safe filename. This can be achieved by using werkzeug.utils.secure_filename, which strips dangerous characters and sub-paths (slashes, path traversal, etc.) from filenames, thereby preventing directory traversal and related issues.

The fix should be applied at the point where output_filename is derived (in LMStudioModel.install):

Import secure_filename from werkzeug.utils if not already done in this file.

Replace the assignment to output_filename with a version that passes self.id through secure_filename.

This ensures no untrusted or unsafe input is used as part of any file or directory name, mitigating the risk of path traversal regardless of any other possible input validation or lack thereof.

You can probably use this pattern anywhere that it is complaining about user-assigned values for paths.

aliasaria · 2025-11-13T15:43:44Z

@dadmobile to review

…ab-api into add/import-lm-studio

dadmobile · 2025-11-17T22:04:44Z

Is this still WIP?

There are some CodeQL issues I can help you fix...mostly just see how we use secure_filename elsewhere and copy.
If you want to try adding the LM Studio plugin let's do that in a separate PR after we migrate API over to the app. Can you remove that plugin code for now (or backup and we can discuss in a new PR).

dadmobile · 2025-11-17T22:09:17Z

transformerlab/models/model_helper.py

                return ollamamodel.OllamaModel(model_source_id)
            case "huggingface":
                return huggingfacemodel.HuggingFaceModel(model_source_id)
+            case "lmstudio":


I think you'll also have to add a case for "lmstudio" to the list_models_from_source function so they show up on the import modal.

dadmobile · 2025-11-17T22:10:08Z

transformerlab/models/lmstudiomodel.py

+        }
+
+        model_info_file = os.path.join(output_path, "index.json")
+        with open(model_info_file, "w") as f:


You can probably use this pattern anywhere that it is complaining about user-assigned values for paths.

dadmobile · 2025-11-17T22:10:39Z

transformerlab/plugins/lmstudio_server/index.json

@@ -0,0 +1,18 @@
+{
+  "name": "Google LM Studio Server",


Let's pull this for now and discuss if we actually want to add a server or not.

ParamThakkar123 · 2025-11-18T09:35:15Z

Okay @dadmobile Probably what we can do is close this PR for now and keep this as a backup and later discuss about it separately and I will open it once again

ParamThakkar123 added 3 commits November 12, 2025 19:58

Added suport for importing LM studio models

34673bd

Merge branch 'main' of https://github.com/transformerlab/transformerl…

e26e611

…ab-api into add/import-lm-studio

Removed unused glob import

e878267

github-advanced-security bot found potential problems Nov 13, 2025

View reviewed changes

Added LM Studio server plugin

ebf3f61

Merge branch 'main' of https://github.com/transformerlab/transformerl…

1362e77

…ab-api into add/import-lm-studio

dadmobile requested changes Nov 17, 2025

View reviewed changes

@@ -31,12 +31,24 @@
             class LMStudioModel(basemodel.BaseModel):
                 def __init__(self, model_path: str):
-                    filename = os.path.basename(model_path)
+                    # Validate that the user-supplied path is inside the LMStudio models directory
+                    models_dir = lmstudio_models_dir()
+                    if not models_dir:
+                        raise ValueError("Could not locate LM Studio models directory.")
+                    # Support only files underneath the models_dir
+                    # This ensures no path traversal outside the safe root
+                    abs_models_dir = os.path.abspath(models_dir)
+                    abs_model_path = os.path.abspath(os.path.join(abs_models_dir, model_path))
+                    if not abs_model_path.startswith(abs_models_dir + os.sep):
+                        raise ValueError("Requested model path is outside the LM Studio models directory.")
+                    if not os.path.isfile(abs_model_path):
+                        raise FileNotFoundError(f"Model file not found: {abs_model_path}")
+                    filename = os.path.basename(abs_model_path)
                     super().__init__(model_id=filename)
                     self.source = "lmstudio"
                     self.name = f"{os.path.splitext(filename)[0]} (LM Studio)"
-                    self.source_id_or_path = os.path.abspath(model_path)
+                    self.source_id_or_path = abs_model_path
                     self.model_filename = filename
                 async def get_json_data(self):

@@ -4,7 +4,7 @@
             import json
             import errno
             import shutil
+            from werkzeug.utils import secure_filename
             _LM_MODEL_EXTS = (".gguf", ".safetensors", ".pt", ".bin")
@@ -63,13 +63,18 @@
                     from lab.dirs import get_models_dir
-                    output_filename = self.id
-                    output_path = os.path.join(get_models_dir(), output_filename)
+                    output_filename = secure_filename(self.id)
+                    models_dir = get_models_dir()
+                    output_path = os.path.join(models_dir, output_filename)
+                    output_path = os.path.abspath(output_path)
+                    # Ensure output_path is within models_dir
+                    models_dir_abs = os.path.abspath(models_dir)
+                    if not output_path.startswith(models_dir_abs + os.sep):
+                        raise ValueError("Invalid model id/path.")
                     if os.path.exists(output_path):
                         raise FileExistsError(errno.EEXIST, "Model already exists", output_path)
                     os.makedirs(output_path, exist_ok=True)
                     link_name = os.path.join(output_path, output_filename)
                     os.symlink(input_model_path, link_name)

@@ -4,7 +4,7 @@
             import json
             import errno
             import shutil
+            from werkzeug.utils import secure_filename
             _LM_MODEL_EXTS = (".gguf", ".safetensors", ".pt", ".bin")
@@ -63,9 +63,15 @@
                     from lab.dirs import get_models_dir
-                    output_filename = self.id
-                    output_path = os.path.join(get_models_dir(), output_filename)
+                    # Sanitize and validate filename
+                    output_filename = secure_filename(self.id)
+                    if not output_filename:
+                        raise ValueError("Invalid model filename from model id.")
+                    models_root = os.path.abspath(get_models_dir())
+                    output_path = os.path.normpath(os.path.join(models_root, output_filename))
+                    # Ensure output_path is inside models_root after normalization
+                    if not output_path.startswith(models_root + os.sep):
+                        raise ValueError("Attempted path traversal detected in model id.")
                     if os.path.exists(output_path):
                         raise FileExistsError(errno.EEXIST, "Model already exists", output_path)
                     os.makedirs(output_path, exist_ok=True)

@@ -61,6 +61,12 @@
                     if not input_model_path or not os.path.isfile(input_model_path):
                         raise FileNotFoundError(errno.ENOENT, os.strerror(errno.ENOENT), input_model_path)
+                    # Validate that input_model_path is inside the trusted lmstudio models dir
+                    trusted_root = os.path.abspath(os.path.normpath(lmstudio_models_dir()))
+                    normalized_input_path = os.path.abspath(os.path.normpath(input_model_path))
+                    if not (normalized_input_path.startswith(trusted_root + os.sep)):
+                        raise PermissionError(f"Model file path {input_model_path} is outside of trusted models directory {trusted_root}.")
                     from lab.dirs import get_models_dir
                     output_filename = self.id

@@ -4,7 +4,7 @@
             import json
             import errno
             import shutil
+            from werkzeug.utils import secure_filename
             _LM_MODEL_EXTS = (".gguf", ".safetensors", ".pt", ".bin")
@@ -63,7 +63,7 @@
                     from lab.dirs import get_models_dir
-                    output_filename = self.id
+                    output_filename = secure_filename(self.id)
                     output_path = os.path.join(get_models_dir(), output_filename)
                     if os.path.exists(output_path):

[WIP] Added Support for importing model from lm studio #679

Are you sure you want to change the base?

[WIP] Added Support for importing model from lm studio #679

Conversation

ParamThakkar123 commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Nov 13, 2025

Codecov Report

Uh oh!

Check failure

Uh oh!

Uh oh!

Copilot Autofix

Check failure

Uh oh!

Copilot Autofix

Check failure

Uh oh!

Copilot Autofix

Check failure

Uh oh!

Uh oh!

Copilot Autofix

Check failure

Uh oh!

Copilot Autofix

Check failure

Uh oh!

Copilot Autofix

dadmobile Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

aliasaria commented Nov 13, 2025

Uh oh!

dadmobile commented Nov 17, 2025

Uh oh!

dadmobile Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

dadmobile Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

dadmobile Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

ParamThakkar123 commented Nov 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ParamThakkar123 commented Nov 13, 2025 •

edited

Loading