Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create rule S6985 : Usage of "torch.load" can lead to untrusted code execution #3976

Merged
merged 5 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions rules/S6985/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{
}
25 changes: 25 additions & 0 deletions rules/S6985/python/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"title": "Usage of \"torch.load\" can lead to untrusted code execution",
"type": "SECURITY_HOTSPOT",
"status": "ready",
"remediation": {
"func": "Constant\/Issue",
"constantCost": "15min"
},
"tags": [
"pytorch",
"machine-learning"
],
"defaultSeverity": "Major",
"ruleSpecification": "RSPEC-6985",
"sqKey": "S6985",
"scope": "All",
"defaultQualityProfiles": ["Sonar way"],
"quickfix": "infeasible",
"code": {
"impacts": {
"SECURITY": "HIGH"
},
"attribute": "CONVENTIONAL"
}
}
64 changes: 64 additions & 0 deletions rules/S6985/python/rule.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
This rule raises an issue when `pytorch.load` is used to load a model.

== Why is this an issue?

In PyTorch, it is common to load serialized models using the `torch.load` function.
Under the hood, `torch.load` uses the `pickle` library to load the model and the weights.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could add just a small introduction line. In PyTorch it is common practice to load a serialized model or something like that.

If the model comes from an untrusted source, an attacker could inject a malicious payload which would be executed during the deserialization.

== How to fix it

Use a safer alternative to load the model, such as `safetensors.torch.load_model`. Alternatively, PyTorch can be instructed to only load
the weights by setting the parameter `weights_only=True`. This avoids the use of the `pickle` library and is therefore safe. Note that the
use of `weights_only` requires saving only the `state_dict` of a model instead of the whole model.

=== Code examples

==== Noncompliant code example

[source,python,diff-id=1,diff-type=noncompliant]
----
import torch

model = torch.load('model.pth') # Noncompliant: torch.load is used to load the model
----

==== Compliant solution

[source,python,diff-id=1,diff-type=compliant]
----
import torch
import safetensors

model = MyModel()
safetensors.torch.load_model(model, 'model.pth')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I would only provide the code that would fix the issue in the Noncompliant section. So I would remove the line 36, from this example. And if you want to showcase it, I would create a different code example, but frankly I do not think it is worth it here.

----

== Resources
=== Documentation

* Pytorch documentation: https://pytorch.org/tutorials/beginner/saving_loading_models.html#save-load-entire-model[Save/Load Entire Model]


ifdef::env-github,rspecator-view[]

(visible only on this page)

== Implementation specification

All usages of torch.load

=== Message

Primary : Replace this call with a safe alternative


=== Issue location

Primary : name of the function call

=== Quickfix

No

endif::env-github,rspecator-view[]
Loading