-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary Adds S502 rule for the [flake8-bandit](https://github.com/tylerwince/flake8-bandit) plugin port. Checks for calls to any function with keywords arguments `ssl_version` or `method` or for kwargs `method` in calls to `OpenSSL.SSL.Context` and `ssl_version` in calls to `ssl.wrap_socket` which have an insecure ssl_version valu. See also https://bandit.readthedocs.io/en/latest/_modules/bandit/plugins/insecure_ssl_tls.html#ssl_with_bad_version ## Test Plan Fixture added ## Issue Link Refers: #1646
- Loading branch information
Showing
8 changed files
with
203 additions
and
0 deletions.
There are no files selected for viewing
16 changes: 16 additions & 0 deletions
16
crates/ruff_linter/resources/test/fixtures/flake8_bandit/S502.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import ssl | ||
from ssl import wrap_socket | ||
from OpenSSL import SSL | ||
from OpenSSL.SSL import Context | ||
|
||
wrap_socket(ssl_version=ssl.PROTOCOL_SSLv3) # S502 | ||
ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1) # S502 | ||
ssl.wrap_socket(ssl_version=ssl.PROTOCOL_SSLv2) # S502 | ||
SSL.Context(method=SSL.SSLv2_METHOD) # S502 | ||
SSL.Context(method=SSL.SSLv23_METHOD) # S502 | ||
Context(method=SSL.SSLv3_METHOD) # S502 | ||
Context(method=SSL.TLSv1_METHOD) # S502 | ||
|
||
wrap_socket(ssl_version=ssl.PROTOCOL_TLS_CLIENT) # OK | ||
SSL.Context(method=SSL.TLS_SERVER_METHOD) # OK | ||
func(ssl_version=ssl.PROTOCOL_TLSv1_2) # OK |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
crates/ruff_linter/src/rules/flake8_bandit/rules/ssl_insecure_version.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
use ruff_diagnostics::{Diagnostic, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::{self as ast, Expr, ExprCall}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// Checks for function calls with parameters that indicate the use of insecure | ||
/// SSL and TLS protocol versions. | ||
/// | ||
/// ## Why is this bad? | ||
/// Several highly publicized exploitable flaws have been discovered in all | ||
/// versions of SSL and early versions of TLS. The following versions are | ||
/// considered insecure, and should be avoided: | ||
/// - SSL v2 | ||
/// - SSL v3 | ||
/// - TLS v1 | ||
/// - TLS v1.1 | ||
/// | ||
/// This method supports detection on the Python's built-in `ssl` module and | ||
/// the `pyOpenSSL` module. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// import ssl | ||
/// | ||
/// ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1) | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// import ssl | ||
/// | ||
/// ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1_2) | ||
/// ``` | ||
#[violation] | ||
pub struct SslInsecureVersion { | ||
protocol: String, | ||
} | ||
|
||
impl Violation for SslInsecureVersion { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
let SslInsecureVersion { protocol } = self; | ||
format!("Call made with insecure SSL protocol: `{protocol}`") | ||
} | ||
} | ||
|
||
/// S502 | ||
pub(crate) fn ssl_insecure_version(checker: &mut Checker, call: &ExprCall) { | ||
let Some(keyword) = checker | ||
.semantic() | ||
.resolve_call_path(call.func.as_ref()) | ||
.and_then(|call_path| match call_path.as_slice() { | ||
["ssl", "wrap_socket"] => Some("ssl_version"), | ||
["OpenSSL", "SSL", "Context"] => Some("method"), | ||
_ => None, | ||
}) | ||
else { | ||
return; | ||
}; | ||
|
||
let Some(keyword) = call.arguments.find_keyword(keyword) else { | ||
return; | ||
}; | ||
|
||
match &keyword.value { | ||
Expr::Name(ast::ExprName { id, .. }) => { | ||
if is_insecure_protocol(id) { | ||
checker.diagnostics.push(Diagnostic::new( | ||
SslInsecureVersion { | ||
protocol: id.to_string(), | ||
}, | ||
keyword.range(), | ||
)); | ||
} | ||
} | ||
Expr::Attribute(ast::ExprAttribute { attr, .. }) => { | ||
if is_insecure_protocol(attr) { | ||
checker.diagnostics.push(Diagnostic::new( | ||
SslInsecureVersion { | ||
protocol: attr.to_string(), | ||
}, | ||
keyword.range(), | ||
)); | ||
} | ||
} | ||
_ => {} | ||
} | ||
} | ||
|
||
/// Returns `true` if the given protocol name is insecure. | ||
fn is_insecure_protocol(name: &str) -> bool { | ||
matches!( | ||
name, | ||
"PROTOCOL_SSLv2" | ||
| "PROTOCOL_SSLv3" | ||
| "PROTOCOL_TLSv1" | ||
| "PROTOCOL_TLSv1_1" | ||
| "SSLv2_METHOD" | ||
| "SSLv23_METHOD" | ||
| "SSLv3_METHOD" | ||
| "TLSv1_METHOD" | ||
| "TLSv1_1_METHOD" | ||
) | ||
} |
72 changes: 72 additions & 0 deletions
72
...rules/flake8_bandit/snapshots/ruff_linter__rules__flake8_bandit__tests__S502_S502.py.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/flake8_bandit/mod.rs | ||
--- | ||
S502.py:6:13: S502 Call made with insecure SSL protocol: `PROTOCOL_SSLv3` | ||
| | ||
4 | from OpenSSL.SSL import Context | ||
5 | | ||
6 | wrap_socket(ssl_version=ssl.PROTOCOL_SSLv3) # S502 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S502 | ||
7 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1) # S502 | ||
8 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_SSLv2) # S502 | ||
| | ||
|
||
S502.py:7:17: S502 Call made with insecure SSL protocol: `PROTOCOL_TLSv1` | ||
| | ||
6 | wrap_socket(ssl_version=ssl.PROTOCOL_SSLv3) # S502 | ||
7 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1) # S502 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S502 | ||
8 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_SSLv2) # S502 | ||
9 | SSL.Context(method=SSL.SSLv2_METHOD) # S502 | ||
| | ||
|
||
S502.py:8:17: S502 Call made with insecure SSL protocol: `PROTOCOL_SSLv2` | ||
| | ||
6 | wrap_socket(ssl_version=ssl.PROTOCOL_SSLv3) # S502 | ||
7 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1) # S502 | ||
8 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_SSLv2) # S502 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ S502 | ||
9 | SSL.Context(method=SSL.SSLv2_METHOD) # S502 | ||
10 | SSL.Context(method=SSL.SSLv23_METHOD) # S502 | ||
| | ||
|
||
S502.py:9:13: S502 Call made with insecure SSL protocol: `SSLv2_METHOD` | ||
| | ||
7 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1) # S502 | ||
8 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_SSLv2) # S502 | ||
9 | SSL.Context(method=SSL.SSLv2_METHOD) # S502 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ S502 | ||
10 | SSL.Context(method=SSL.SSLv23_METHOD) # S502 | ||
11 | Context(method=SSL.SSLv3_METHOD) # S502 | ||
| | ||
|
||
S502.py:10:13: S502 Call made with insecure SSL protocol: `SSLv23_METHOD` | ||
| | ||
8 | ssl.wrap_socket(ssl_version=ssl.PROTOCOL_SSLv2) # S502 | ||
9 | SSL.Context(method=SSL.SSLv2_METHOD) # S502 | ||
10 | SSL.Context(method=SSL.SSLv23_METHOD) # S502 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^ S502 | ||
11 | Context(method=SSL.SSLv3_METHOD) # S502 | ||
12 | Context(method=SSL.TLSv1_METHOD) # S502 | ||
| | ||
|
||
S502.py:11:9: S502 Call made with insecure SSL protocol: `SSLv3_METHOD` | ||
| | ||
9 | SSL.Context(method=SSL.SSLv2_METHOD) # S502 | ||
10 | SSL.Context(method=SSL.SSLv23_METHOD) # S502 | ||
11 | Context(method=SSL.SSLv3_METHOD) # S502 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ S502 | ||
12 | Context(method=SSL.TLSv1_METHOD) # S502 | ||
| | ||
|
||
S502.py:12:9: S502 Call made with insecure SSL protocol: `TLSv1_METHOD` | ||
| | ||
10 | SSL.Context(method=SSL.SSLv23_METHOD) # S502 | ||
11 | Context(method=SSL.SSLv3_METHOD) # S502 | ||
12 | Context(method=SSL.TLSv1_METHOD) # S502 | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ S502 | ||
13 | | ||
14 | wrap_socket(ssl_version=ssl.PROTOCOL_TLS_CLIENT) # OK | ||
| | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.