rastray 0.15.0

Blazing-fast static analysis CLI for security, dependency, and performance audits.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
use std::fs;
use std::sync::OnceLock;

use regex::Regex;

use crate::cli::Severity;
use crate::crawler::{CrawlSummary, FileKind};
use crate::reporter::{Category, Finding, Location};

use super::{Analyzer, AnalyzerError};

#[derive(Debug, Default)]
pub struct JwtAnalyzer;

impl JwtAnalyzer {
    pub fn new() -> Self {
        Self
    }
}

impl Analyzer for JwtAnalyzer {
    fn name(&self) -> &'static str {
        "jwt"
    }

    fn analyze(&self, crawl: &CrawlSummary) -> Result<Vec<Finding>, AnalyzerError> {
        let patterns = compiled_patterns()?;
        let mut findings = Vec::new();
        for file in &crawl.files {
            if file.kind != FileKind::Source {
                continue;
            }
            let Some(ext) = file
                .path
                .extension()
                .and_then(|s| s.to_str())
                .map(|s| s.to_ascii_lowercase())
            else {
                continue;
            };
            let contents = match fs::read_to_string(&file.path) {
                Ok(c) => c,
                Err(_) => continue,
            };
            for pattern in patterns {
                if !pattern.extensions.iter().any(|e| *e == ext) {
                    continue;
                }
                for m in pattern.regex.find_iter(&contents) {
                    let matched = trim_match(m.as_str());
                    let message = format!("`{matched}` {trailer}", trailer = pattern.trailer);
                    let (line, column) = byte_offset_to_line_col(&contents, m.start());
                    let location = Location::file(file.path.clone())
                        .with_span(m.start(), m.len())
                        .with_line(line, column);
                    findings.push(
                        Finding::new(pattern.code, message, pattern.severity, Category::Security)
                            .with_help(pattern.help)
                            .with_location(location),
                    );
                }
            }
        }
        Ok(findings)
    }
}

struct PatternSpec {
    code: &'static str,
    trailer: &'static str,
    severity: Severity,
    help: &'static str,
    pattern: &'static str,
    extensions: &'static [&'static str],
}

struct CompiledPattern {
    code: &'static str,
    trailer: &'static str,
    severity: Severity,
    help: &'static str,
    regex: Regex,
    extensions: &'static [&'static str],
}

const JS_EXTENSIONS: &[&str] = &["js", "jsx", "ts", "tsx", "mjs", "cjs"];
const PY_EXTENSIONS: &[&str] = &["py"];
const GO_EXTENSIONS: &[&str] = &["go"];

const TRAILER_ALG_NONE: &str =
    "accepts `alg: 'none'` (or the wildcard `algorithms: ['*']`) — an attacker can forge a token signed with the `none` algorithm and bypass authentication entirely";
const TRAILER_VERIFY_FALSE: &str =
    "skips signature verification (`verify: false` / `verify_signature: False`) — the token contents are taken at face value, defeating the whole point of JWT";
const TRAILER_HARDCODED_SECRET: &str =
    "uses a hardcoded HMAC secret in source — once the binary or repo leaks the secret leaks; rotate to an environment variable or a secret-manager fetch";
const TRAILER_MISSING_ALGORITHMS: &str =
    "verifies a token without passing an explicit `algorithms` list — accepts whatever algorithm the token header claims, enabling alg-confusion attacks (HS256 forgery using the RS256 public key)";

const HELP_JS: &str = "always pass an explicit `algorithms` list to `jwt.verify(...)` (e.g. `{ algorithms: ['RS256'] }`), never `'none'` or `'*'`; load the secret from `process.env.JWT_SECRET` rather than a string literal; the default `jsonwebtoken` config refuses `none` but `algorithms: ['none']` re-enables it explicitly";
const HELP_PY: &str = "always pass `algorithms=['RS256']` (or the specific algorithm you signed with) to `jwt.decode(...)`, never `['*']` or `['none']`; never set `options={'verify_signature': False}` on untrusted tokens; load the secret from `os.environ['JWT_SECRET']` not a string literal";
const HELP_GO: &str = "validate the token's signing method inside the keyfunc: `if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok { return nil, errors.New(\"unexpected signing method\") }`; never return a secret without checking `token.Method`; load the secret from `os.Getenv(\"JWT_SECRET\")` not a string literal";

const PATTERN_SPECS: &[PatternSpec] = &[
    PatternSpec {
        code: "RSTR-JWT-001",
        trailer: TRAILER_ALG_NONE,
        severity: Severity::Critical,
        help: HELP_JS,
        pattern: r#"\balgorithms?\s*:\s*\[?\s*['"](?:none|\*)['"]"#,
        extensions: JS_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-001",
        trailer: TRAILER_ALG_NONE,
        severity: Severity::Critical,
        help: HELP_PY,
        pattern: r#"\balgorithms\s*=\s*\[\s*['"](?:none|\*)['"]"#,
        extensions: PY_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-002",
        trailer: TRAILER_VERIFY_FALSE,
        severity: Severity::Critical,
        help: HELP_JS,
        pattern: r"\bjwt\.decode\s*\(\s*[A-Za-z_][A-Za-z0-9_]*\s*,\s*\{[^}]*\bverify\s*:\s*false\b",
        extensions: JS_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-002",
        trailer: TRAILER_VERIFY_FALSE,
        severity: Severity::Critical,
        help: HELP_PY,
        pattern: r#"\bverify_signature['"]\s*:\s*False\b"#,
        extensions: PY_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-002",
        trailer: TRAILER_VERIFY_FALSE,
        severity: Severity::Critical,
        help: HELP_PY,
        pattern: r"\bjwt\.decode\s*\([^)]*\bverify\s*=\s*False\b",
        extensions: PY_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-003",
        trailer: TRAILER_HARDCODED_SECRET,
        severity: Severity::High,
        help: HELP_JS,
        pattern: r#"\bjwt\.sign\s*\(\s*[^,]+,\s*['"][A-Za-z0-9_\-+/=!@#$%^&*]{6,}['"]"#,
        extensions: JS_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-003",
        trailer: TRAILER_HARDCODED_SECRET,
        severity: Severity::High,
        help: HELP_PY,
        pattern: r#"\bjwt\.encode\s*\(\s*[^,]+,\s*['"][A-Za-z0-9_\-+/=!@#$%^&*]{6,}['"]"#,
        extensions: PY_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-004",
        trailer: TRAILER_MISSING_ALGORITHMS,
        severity: Severity::High,
        help: HELP_JS,
        pattern: r"\bjwt\.verify\s*\(\s*[A-Za-z_][A-Za-z0-9_]*\s*,\s*[A-Za-z_][A-Za-z0-9_]*\s*\)",
        extensions: JS_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-004",
        trailer: TRAILER_MISSING_ALGORITHMS,
        severity: Severity::High,
        help: HELP_PY,
        pattern: r"\bjwt\.decode\s*\(\s*[A-Za-z_][A-Za-z0-9_]*\s*,\s*[A-Za-z_][A-Za-z0-9_]*\s*\)",
        extensions: PY_EXTENSIONS,
    },
    PatternSpec {
        code: "RSTR-JWT-005",
        trailer: TRAILER_MISSING_ALGORITHMS,
        severity: Severity::High,
        help: HELP_GO,
        pattern: r"\bjwt\.Parse(?:WithClaims)?\s*\([\s\S]{1,400}?return\s+[A-Za-z_][A-Za-z0-9_.]*\s*,\s*nil",
        extensions: GO_EXTENSIONS,
    },
];

static PATTERNS: OnceLock<Result<Vec<CompiledPattern>, regex::Error>> = OnceLock::new();

fn compiled_patterns() -> Result<&'static [CompiledPattern], AnalyzerError> {
    let cached = PATTERNS.get_or_init(|| {
        PATTERN_SPECS
            .iter()
            .map(|spec| {
                Regex::new(spec.pattern).map(|regex| CompiledPattern {
                    code: spec.code,
                    trailer: spec.trailer,
                    severity: spec.severity,
                    help: spec.help,
                    regex,
                    extensions: spec.extensions,
                })
            })
            .collect::<Result<Vec<_>, _>>()
    });
    match cached {
        Ok(v) => Ok(v.as_slice()),
        Err(e) => Err(AnalyzerError::Failed {
            name: "jwt",
            message: format!("failed to compile a builtin jwt pattern: {e}"),
        }),
    }
}

fn trim_match(raw: &str) -> String {
    let trimmed = raw.trim_end_matches([',', ' ', '\t']);
    let trimmed = if let Some(stripped) = trimmed.strip_suffix(')') {
        stripped
    } else {
        trimmed
    };
    let mut out = trimmed.to_string();
    let open = out.matches('(').count();
    let close = out.matches(')').count();
    for _ in 0..open.saturating_sub(close) {
        out.push(')');
    }
    out
}

fn byte_offset_to_line_col(text: &str, offset: usize) -> (usize, usize) {
    let mut line = 1usize;
    let mut col = 1usize;
    for (i, ch) in text.char_indices() {
        if i >= offset {
            break;
        }
        if ch == '\n' {
            line += 1;
            col = 1;
        } else {
            col += 1;
        }
    }
    (line, col)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::crawler::{CrawlSummary, DiscoveredFile, FileKind};
    use std::io::Write;
    use std::path::PathBuf;
    use std::sync::atomic::{AtomicU64, Ordering};

    static COUNTER: AtomicU64 = AtomicU64::new(0);

    fn tempdir() -> Option<PathBuf> {
        let n = COUNTER.fetch_add(1, Ordering::Relaxed);
        let dir =
            std::env::temp_dir().join(format!("rastray-jwt-test-{}-{}", std::process::id(), n));
        let _ = std::fs::remove_dir_all(&dir);
        match std::fs::create_dir_all(&dir) {
            Ok(()) => Some(dir),
            Err(_) => None,
        }
    }

    fn run_on(name: &str, body: &str) -> Vec<Finding> {
        let Some(dir) = tempdir() else {
            return Vec::new();
        };
        let path = dir.join(name);
        if let Ok(mut f) = std::fs::File::create(&path) {
            let _ = f.write_all(body.as_bytes());
        }
        let crawl = CrawlSummary {
            files: vec![DiscoveredFile {
                path: path.clone(),
                kind: FileKind::Source,
                size: Some(body.len() as u64),
            }],
            skipped: 0,
            errors: vec![],
        };
        let result = JwtAnalyzer::new().analyze(&crawl).unwrap_or_default();
        let _ = std::fs::remove_dir_all(&dir);
        result
    }

    #[test]
    fn compiled_patterns_compile_cleanly() {
        assert!(compiled_patterns().is_ok());
    }

    #[test]
    fn js_alg_none_is_flagged_as_critical() {
        let body = "jwt.verify(token, secret, { algorithms: ['none'] });";
        let findings = run_on("a.js", body);
        let found = findings.iter().find(|f| f.code == "RSTR-JWT-001");
        assert!(found.is_some());
        if let Some(f) = found {
            assert_eq!(f.severity, Severity::Critical);
        }
    }

    #[test]
    fn js_alg_wildcard_is_flagged() {
        let body = "jwt.verify(token, secret, { algorithms: ['*'] });";
        let findings = run_on("a.js", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-001"));
    }

    #[test]
    fn py_alg_none_is_flagged() {
        let body = "jwt.decode(token, key, algorithms=['none'])";
        let findings = run_on("a.py", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-001"));
    }

    #[test]
    fn js_verify_false_is_flagged() {
        let body = "const payload = jwt.decode(token, { verify: false });";
        let findings = run_on("a.js", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-002"));
    }

    #[test]
    fn py_verify_signature_false_is_flagged() {
        let body = "claims = jwt.decode(token, options={'verify_signature': False})";
        let findings = run_on("a.py", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-002"));
    }

    #[test]
    fn py_verify_false_keyword_is_flagged() {
        let body = "claims = jwt.decode(token, key, verify=False)";
        let findings = run_on("a.py", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-002"));
    }

    #[test]
    fn js_hardcoded_secret_in_sign_is_flagged() {
        let body = "const t = jwt.sign(payload, 'mySuperSecret123');";
        let findings = run_on("a.js", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-003"));
    }

    #[test]
    fn py_hardcoded_secret_in_encode_is_flagged() {
        let body = "t = jwt.encode(payload, 'mySuperSecret123', algorithm='HS256')";
        let findings = run_on("a.py", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-003"));
    }

    #[test]
    fn js_verify_without_algorithms_is_flagged() {
        let body = "const payload = jwt.verify(token, secret);";
        let findings = run_on("a.js", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-004"));
    }

    #[test]
    fn py_decode_without_algorithms_is_flagged() {
        let body = "claims = jwt.decode(token, key)";
        let findings = run_on("a.py", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-004"));
    }

    #[test]
    fn go_jwt_parse_without_alg_check_is_flagged() {
        let body = "token, err := jwt.Parse(tokenStr, func(t *jwt.Token) (interface{}, error) { return mySecret, nil })";
        let findings = run_on("a.go", body);
        assert!(findings.iter().any(|f| f.code == "RSTR-JWT-005"));
    }

    #[test]
    fn js_verify_with_algorithms_is_not_flagged() {
        let body = "const payload = jwt.verify(token, secret, { algorithms: ['RS256'] });";
        let findings = run_on("a.js", body);
        assert!(
            findings.is_empty(),
            "explicit RS256 algorithms list is the hardened form: {findings:?}"
        );
    }

    #[test]
    fn py_decode_with_algorithms_is_not_flagged() {
        let body = "claims = jwt.decode(token, key, algorithms=['RS256'])";
        let findings = run_on("a.py", body);
        assert!(
            findings.is_empty(),
            "explicit algorithms list should not flag: {findings:?}"
        );
    }

    #[test]
    fn js_sign_with_env_var_secret_is_not_flagged() {
        let body = "const t = jwt.sign(payload, process.env.JWT_SECRET);";
        let findings = run_on("a.js", body);
        assert!(
            findings.is_empty(),
            "env var secret should not flag: {findings:?}"
        );
    }

    #[test]
    fn non_js_extension_is_skipped_for_js_pattern() {
        let body = "jwt.verify(token, secret, { algorithms: ['none'] });";
        let findings = run_on("a.txt", body);
        assert!(findings.is_empty(), "txt should be ignored: {findings:?}");
    }

    #[test]
    fn messages_for_same_rule_differ_by_captured_call_site() {
        let body = "jwt.verify(t1, s1);\njwt.verify(t2, s2);";
        let findings = run_on("a.js", body);
        let msgs: Vec<&str> = findings.iter().map(|f| f.message.as_str()).collect();
        assert!(msgs.iter().any(|m| m.contains("jwt.verify(t1, s1)")));
        assert!(msgs.iter().any(|m| m.contains("jwt.verify(t2, s2)")));
    }

    #[test]
    fn help_text_includes_remediation_idiom() {
        let js_findings = run_on(
            "a.js",
            "jwt.verify(token, secret, { algorithms: ['none'] });",
        );
        let js_help = js_findings
            .iter()
            .find(|f| f.code == "RSTR-JWT-001")
            .and_then(|f| f.help.as_deref())
            .unwrap_or_default();
        assert!(js_help.contains("algorithms") && js_help.contains("RS256"));

        let py_findings = run_on(
            "a.py",
            "claims = jwt.decode(token, options={'verify_signature': False})",
        );
        let py_help = py_findings
            .iter()
            .find(|f| f.code == "RSTR-JWT-002")
            .and_then(|f| f.help.as_deref())
            .unwrap_or_default();
        assert!(py_help.contains("os.environ") || py_help.contains("algorithms"));

        let go_findings = run_on(
            "a.go",
            "token, err := jwt.Parse(s, func(t *jwt.Token) (interface{}, error) { return secret, nil })",
        );
        let go_help = go_findings
            .iter()
            .find(|f| f.code == "RSTR-JWT-005")
            .and_then(|f| f.help.as_deref())
            .unwrap_or_default();
        assert!(go_help.contains("SigningMethodHMAC") || go_help.contains("token.Method"));
    }

    #[test]
    fn trim_match_balances_parens() {
        let raw = "jwt.verify(token, secret),";
        let out = trim_match(raw);
        assert_eq!(out, "jwt.verify(token, secret)");
    }
}