gem-audit 2.8.0

Ultra-fast, standalone security auditor for Gemfile.lock
Documentation
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
use std::collections::HashSet;
use std::io::{self, IsTerminal, Write};
use std::path::{Path, PathBuf};
use std::process;

use clap::{Parser, Subcommand};

use gem_audit::advisory::{Criticality, Database};
use gem_audit::check;
use gem_audit::configuration::Configuration;
use gem_audit::fixer::{self, FixResult};
use gem_audit::format::{self, OutputFormat};
use gem_audit::scanner::{ScanOptions, Scanner};
use gem_audit::util::format_timestamp;

const VERSION: &str = env!("CARGO_PKG_VERSION");

const EXIT_SUCCESS: i32 = 0;
const EXIT_VULNERABLE: i32 = 1;
const EXIT_ERROR: i32 = 2;
const EXIT_STALE: i32 = 3;

#[derive(Parser)]
#[command(
    name = "gem-audit",
    about = "Patch-level verification for Ruby Bundler dependencies",
    version = VERSION,
)]
struct Cli {
    #[command(subcommand)]
    command: Option<Commands>,
}

#[derive(clap::Args)]
struct CheckOptions {
    /// Project directory to audit
    #[arg(default_value = ".")]
    dir: String,

    /// Suppress output
    #[arg(short, long)]
    quiet: bool,

    /// Show detailed descriptions
    #[arg(short, long)]
    verbose: bool,

    /// Advisory IDs to ignore
    #[arg(short, long, num_args = 1..)]
    ignore: Vec<String>,

    /// Update the advisory database before checking
    #[arg(short, long)]
    update: bool,

    /// Path to the advisory database
    #[arg(short = 'D', long)]
    database: Option<String>,

    /// Output format
    #[arg(short = 'F', long, value_enum, default_value = "text")]
    format: OutputFormat,

    /// Path to the Gemfile.lock file
    #[arg(short = 'G', long, default_value = "Gemfile.lock")]
    gemfile_lock: String,

    /// Path to the configuration file
    #[arg(short, long, default_value = ".gem-audit.yml")]
    config: String,

    /// Output file (default: stdout)
    #[arg(short, long)]
    output: Option<String>,

    /// Minimum severity level to report (none, low, medium, high, critical)
    #[arg(short = 'S', long, value_enum)]
    severity: Option<Criticality>,

    /// Maximum advisory database age in days before warning
    #[arg(long)]
    max_db_age: Option<u64>,

    /// Exit with code 3 if the advisory database is stale
    #[arg(long)]
    fail_on_stale: bool,

    /// Treat parse/load warnings as errors (exit code 2)
    #[arg(long)]
    strict: bool,

    /// Fix vulnerable gem versions in Gemfile.lock
    #[arg(long)]
    fix: bool,

    /// Preview fix changes without writing (use with --fix)
    #[arg(long)]
    dry_run: bool,

    /// Write all detected advisory IDs to the config file's ignore list
    #[arg(long)]
    write_ignore: bool,
}

#[derive(Subcommand)]
enum Commands {
    /// Check the Gemfile.lock for insecure dependencies (default)
    Check(CheckOptions),

    /// Update the ruby-advisory-db
    Update {
        /// Suppress output
        #[arg(short, long)]
        quiet: bool,

        /// Path to the advisory database
        #[arg(short = 'D', long)]
        database: Option<String>,
    },

    /// Download the ruby-advisory-db
    Download {
        /// Suppress output
        #[arg(short, long)]
        quiet: bool,

        /// Path to the advisory database
        #[arg(short = 'D', long)]
        database: Option<String>,
    },

    /// Print ruby-advisory-db statistics
    Stats {
        /// Path to the advisory database
        #[arg(short = 'D', long)]
        database: Option<String>,
    },

    /// Print the gem-audit version
    Version,
}

fn main() {
    let cli = Cli::parse();

    let code = match cli.command {
        Some(Commands::Check(opts)) => cmd_check(opts),
        Some(Commands::Update { quiet, database }) => cmd_update(quiet, database.as_deref()),
        Some(Commands::Download { quiet, database }) => cmd_download(quiet, database.as_deref()),
        Some(Commands::Stats { database }) => cmd_stats(database.as_deref()),
        Some(Commands::Version) => {
            println!("gem-audit {}", VERSION);
            EXIT_SUCCESS
        }
        None => cmd_check(CheckOptions::default()),
    };

    if code != EXIT_SUCCESS {
        process::exit(code);
    }
}

impl Default for CheckOptions {
    fn default() -> Self {
        Self {
            dir: ".".to_string(),
            quiet: false,
            verbose: false,
            ignore: Vec::new(),
            update: false,
            database: None,
            format: OutputFormat::Text,
            gemfile_lock: "Gemfile.lock".to_string(),
            config: Configuration::DEFAULT_FILE.to_string(),
            output: None,
            severity: None,
            max_db_age: None,
            fail_on_stale: false,
            strict: false,
            fix: false,
            dry_run: false,
            write_ignore: false,
        }
    }
}

fn resolve_db_path(database: Option<&str>) -> PathBuf {
    database
        .map(PathBuf::from)
        .unwrap_or_else(Database::default_path)
}

fn ensure_database(db_path: &Path, update: bool, quiet: bool) -> Result<Database, i32> {
    if !db_path.is_dir() || !db_path.join("gems").is_dir() {
        if !quiet {
            eprintln!("Downloading ruby-advisory-db ...");
        }
        match Database::download(db_path, quiet) {
            Ok(_) => {
                if !quiet {
                    eprintln!("Downloaded ruby-advisory-db");
                }
            }
            Err(e) => {
                eprintln!("Failed to download advisory database: {}", e);
                return Err(EXIT_ERROR);
            }
        }
    } else if update {
        if !quiet {
            eprintln!("Updating ruby-advisory-db ...");
        }
        let db = Database::open(db_path).map_err(|e| {
            eprintln!("Failed to open advisory database: {}", e);
            EXIT_ERROR
        })?;
        match db.update() {
            Ok(true) => {
                if !quiet {
                    eprintln!("Updated ruby-advisory-db");
                }
            }
            Ok(false) => {
                if !quiet {
                    eprintln!("Skipping update, ruby-advisory-db is not a git repository");
                }
            }
            Err(e) => {
                eprintln!("warning: Failed to update advisory database: {}", e);
            }
        }
    }

    Database::open(db_path).map_err(|e| {
        eprintln!("Failed to open advisory database: {}", e);
        EXIT_ERROR
    })
}

fn apply_fixes(lockfile_path: &Path, fix_results: &[FixResult]) {
    let fixes: Vec<fixer::FixSuggestion> = fix_results
        .iter()
        .filter_map(|r| match r {
            FixResult::Fixed(f) => Some(f.clone()),
            _ => None,
        })
        .collect();

    if fixes.is_empty() {
        return;
    }

    match std::fs::read_to_string(lockfile_path) {
        Ok(content) => {
            let (patched, patched_names) = fixer::patch_lockfile(&content, &fixes);
            if !patched_names.is_empty() {
                let tmp_path = lockfile_path.with_extension("lock.tmp");
                match std::fs::write(&tmp_path, &patched) {
                    Ok(()) => {
                        if let Err(e) = std::fs::rename(&tmp_path, lockfile_path) {
                            eprintln!("error: failed to write Gemfile.lock: {}", e);
                            let _ = std::fs::remove_file(&tmp_path);
                        } else {
                            eprintln!(
                                "\nFixed {} gem(s) in {}. Run `bundle install` to install the updated versions.",
                                patched_names.len(),
                                lockfile_path.display()
                            );
                        }
                    }
                    Err(e) => {
                        eprintln!("error: failed to write temporary file: {}", e);
                    }
                }
            }
        }
        Err(e) => {
            eprintln!("error: failed to read {}: {}", lockfile_path.display(), e);
        }
    }
}

fn write_ignore_list(
    report: &gem_audit::scanner::Report,
    config: &Configuration,
    config_path: &Path,
) -> i32 {
    let (new_ids, comments) = check::build_ignore_comments(report);
    let merged_ignore: HashSet<String> = config.ignore.union(&new_ids).cloned().collect();

    let updated_config = Configuration {
        ignore: merged_ignore,
        max_db_age_days: config.max_db_age_days,
    };

    match updated_config.save(config_path, Some(&comments)) {
        Ok(()) => {
            let count = updated_config.ignore.len() - config.ignore.len();
            eprintln!(
                "Added {} advisory ID(s) to {}",
                count,
                config_path.display()
            );
            EXIT_SUCCESS
        }
        Err(e) => {
            eprintln!("Failed to write config: {}", e);
            EXIT_ERROR
        }
    }
}

fn cmd_check(opts: CheckOptions) -> i32 {
    let dir = Path::new(&opts.dir);
    if !dir.is_dir() {
        eprintln!("No such file or directory: {}", dir.display());
        return EXIT_ERROR;
    }

    let config_path = if Path::new(&opts.config).is_absolute() {
        PathBuf::from(&opts.config)
    } else {
        dir.join(&opts.config)
    };
    let config = match Configuration::load_or_default(&config_path) {
        Ok(c) => c,
        Err(e) => {
            eprintln!("{}", e);
            return EXIT_ERROR;
        }
    };

    let db_path = resolve_db_path(opts.database.as_deref());

    let db = match ensure_database(&db_path, opts.update, opts.quiet) {
        Ok(db) => db,
        Err(code) => return code,
    };

    let stale = check::check_staleness(&db, opts.max_db_age, config.max_db_age_days);

    let lockfile_path = dir.join(&opts.gemfile_lock);
    let scanner = match Scanner::new(&lockfile_path, db) {
        Ok(s) => s,
        Err(e) => {
            eprintln!("{}", e);
            return EXIT_ERROR;
        }
    };

    let ignore_set = if !opts.ignore.is_empty() {
        opts.ignore.iter().cloned().collect::<HashSet<String>>()
    } else {
        config.ignore.clone()
    };

    let scan_options = ScanOptions {
        ignore: ignore_set,
        severity: opts.severity,
        strict: opts.strict,
    };

    let report = scanner.scan(&scan_options);

    // Output
    let stdout = io::stdout();
    let is_tty = stdout.is_terminal();
    let mut output_handle: Box<dyn Write> = if let Some(ref path) = opts.output {
        match std::fs::File::create(path) {
            Ok(f) => Box::new(f),
            Err(e) => {
                eprintln!("Failed to open output file {}: {}", path, e);
                return EXIT_ERROR;
            }
        }
    } else {
        Box::new(stdout.lock())
    };

    let fix_results = if opts.fix && !report.unpatched_gems.is_empty() {
        let remediations = report.remediations();
        Some(fixer::resolve_fixes(&remediations))
    } else {
        None
    };

    let print_result = match opts.format {
        OutputFormat::Text => {
            let use_color = opts.output.is_none() && is_tty;
            format::print_text(
                &report,
                &mut output_handle,
                opts.verbose,
                opts.quiet,
                use_color,
                opts.fix,
                fix_results.as_deref(),
            )
        }
        OutputFormat::Json => format::print_json(
            &report,
            &mut output_handle,
            is_tty && opts.output.is_none(),
            opts.fix,
            fix_results.as_deref(),
        ),
    };

    if let Err(e) = print_result
        && e.kind() != io::ErrorKind::BrokenPipe
    {
        eprintln!("error: write failed: {}", e);
        return EXIT_ERROR;
    }

    if opts.fix
        && !opts.dry_run
        && let Some(ref results) = fix_results
    {
        apply_fixes(&lockfile_path, results);
    }

    if opts.write_ignore && report.vulnerable() {
        return write_ignore_list(&report, &config, &config_path);
    }

    if report.vulnerable() {
        return EXIT_VULNERABLE;
    }

    if opts.strict && (report.version_parse_errors > 0 || report.advisory_load_errors > 0) {
        return EXIT_ERROR;
    }

    if stale && opts.fail_on_stale {
        return EXIT_STALE;
    }

    EXIT_SUCCESS
}

fn cmd_update(quiet: bool, database: Option<&str>) -> i32 {
    let db_path = resolve_db_path(database);

    if !db_path.is_dir() || !db_path.join("gems").is_dir() {
        return cmd_download(quiet, database);
    }

    if !quiet {
        eprintln!("Updating ruby-advisory-db ...");
    }

    let db = match Database::open(&db_path) {
        Ok(db) => db,
        Err(e) => {
            eprintln!("Failed to open advisory database: {}", e);
            return EXIT_ERROR;
        }
    };

    match db.update() {
        Ok(true) => {
            if !quiet {
                eprintln!("Updated ruby-advisory-db");
            }
        }
        Ok(false) => {
            if !quiet {
                eprintln!("Skipping update, ruby-advisory-db is not a git repository");
            }
        }
        Err(e) => {
            eprintln!("Failed to update: {}", e);
            return EXIT_ERROR;
        }
    }

    if !quiet {
        print_stats(&db);
    }

    EXIT_SUCCESS
}

fn cmd_download(quiet: bool, database: Option<&str>) -> i32 {
    let db_path = resolve_db_path(database);

    if db_path.is_dir() && db_path.join("gems").is_dir() {
        eprintln!("Database already exists");
        return EXIT_SUCCESS;
    }

    if !quiet {
        eprintln!("Downloading ruby-advisory-db ...");
    }

    match Database::download(&db_path, quiet) {
        Ok(db) => {
            if !quiet {
                print_stats(&db);
            }
            EXIT_SUCCESS
        }
        Err(e) => {
            eprintln!("Failed to download: {}", e);
            EXIT_ERROR
        }
    }
}

fn cmd_stats(database: Option<&str>) -> i32 {
    let db_path = resolve_db_path(database);

    let db = match Database::open(&db_path) {
        Ok(db) => db,
        Err(e) => {
            eprintln!("Failed to open advisory database: {}", e);
            return EXIT_ERROR;
        }
    };

    print_stats(&db);
    EXIT_SUCCESS
}

fn print_stats(db: &Database) {
    let gems = db.size();
    let rubies = db.rubies_size();

    println!("ruby-advisory-db:");
    println!("  advisories:\t{} advisories", gems + rubies);

    if rubies > 0 {
        println!("  gems:\t\t{}", gems);
        println!("  rubies:\t{}", rubies);
    }

    if let Some(ts) = db.last_updated_at() {
        println!("  last updated:\t{}", format_timestamp(ts));
    }

    if let Some(commit) = db.commit_id() {
        println!("  commit:\t{}", commit);
    }
}