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 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
|
.TH OSCAP "8" "Dec 2012" "Red Hat" "System Administration Utilities"
.SH NAME
oscap \- OpenSCAP command line tool
.SH SYNOPSIS
\fBoscap\fR [\fIgeneral-options\fR] \fBmodule\fR operation [\fIoperation-options-and-arguments\fR]
.SH DESCRIPTION
\fBoscap\fP is Security Content Automation Protocol (SCAP) toolkit based on OpenSCAP library. It provides various functions for
different SCAP specifications (modules).
OpenSCAP tool claims to provide capabilities of Authenticated Configuration Scanner and Authenticated Vulnerability Scanner as defined by The National Institute of Standards and Technology.
.SH GENERAL OPTIONS
.TP
\fB\-V, -\-version\fR
Print supported SCAP specification, location of schema files, schematron files, CPE files, probes and supported OVAL objects.
Displays a list of inbuilt CPE names.
.TP
\fB\-h, \-\-help\fR
Help screen.
.SH MODULES
.TP
\fBinfo\fR
Determine type and print information about a file.
.TP
\fBxccdf\fR
The eXtensible Configuration Checklist Description Format.
.TP
\fBoval\fR
Open Vulnerability and Assessment Language.
.TP
\fBds\fR
SCAP Data Stream
.TP
\fBcpe\fR
Common Platform Enumeration.
.TP
\fBcvss\fR
Common Vulnerability Scoring System
.TP
\fBcve\fR
Common Vulnerabilities and Exposures
.SH INFO OPERATIONS
.TP
any-scap-file.xml
.RS
This module prints information about SCAP content in a file specified on a command line. It determines SCAP content type, specification version, date of creation, date of import and so on. Info module doesn't require any additional opperation switch.
For XCCDF or Datastream files, info module prints out IDs of incorporated profiles, components, and datastreams. These IDs can be used to specify the target for evaluation. Use options --profile, --xccdf-id (or --oval-id), and --datastream-id respectively.
.SH XCCDF OPERATIONS
.TP
.B \fBeval\fR [\fIoptions\fR] INPUT_FILE [\fIoval-definitions-files\fR]
.RS
Perform evaluation of XCCDF document file given as INPUT_FILE. Print result of each rule to standard output, including rule title, rule id and security identifier(CVE, CCE). Optionally you can give a source datastream as the INPUT_FILE instead of an XCCDF file (see --datastream-id).
.PP
oscap returns 0 if all rules pass. If there is an error during evaluation, the return code is 1. If there is at least one rule with either fail or unknown result, oscap-scan finishes with return code 2.
.PP
.PP
Unless --skip-valid is used, the INPUT_FILE is validated using XSD schemas (depending on document type of INPUT_FILE) and rejected if invalid.
.PP
You may specify OVAL Definition files as the last parameter, XCCDF evaluation will then proceed only with those specified files. Otherwise, when \fIoval-definitions-files\fR parameter is missing, oscap tool will try to load all OVAL Definition files referenced from XCCDF automatically (search in the same path as XCCDF).
.PP
.TP
\fB\-\-profile PROFILE\fR
.RS
Select a particular profile from XCCDF document.
.RE
.TP
\fB\-\-tailoring-file TAILORING_FILE\fR
.RS
Use given file for XCCDF tailoring. If both --tailoring-file and --tailoring-id are specified, --tailoring files takes priority!
.RE
.TP
\fB\-\-tailoring-id COMPONENT_ID\fR
.RS
Use component of given ID (in input source datastream) for XCCDF tailoring. If both --tailoring-file and --tailoring-id are specified, --tailoring files takes priority!
.RE
.TP
\fB\-\-cpe CPE_FILE\fR
.RS
Use given CPE dictionary or language (auto-detected) for applicability checks. (Some CPE names are provided by openscap, see oscap --version for Inbuilt CPE names)
.RE
.TP
\fB\-\-results FILE\fR
.RS
Write XCCDF results into FILE.
.RE
.TP
\fB\-\-results-arf FILE\fR
.RS
Writes results to a given FILE in Asset Reporting Format. It is recommended to use this option instead of --results when dealing with datastreams.
.RE
.TP
\fB\-\-report FILE\fR
.RS
Write HTML report into FILE. You also have to specify --results for this feature to work. Please see --oval-results to enable additional information in the report.
.RE
.TP
\fB\-\-oval-results\fR
.RS
Generate OVAL Result file for each OVAL session used for evaluation. File with name '\fIoriginal-oval-definitions-filename\fR.result.xml' will be generated for each referenced OVAL file in current working directory. This option (in conjunction with the \fB\-\-report\fR option) also enables inclusion of additional OVAL information in the XCCDF report. To change the directory where OVAL files are generated change the CWD using the `cd` command.
.RE
.TP
\fB\-\-check-engine-results\fR
.RS
After evaluation is finished, each loaded check engine plugin is asked to export its results. The export itself is plugin specific, please refer to documentation of the plugin for more details.
.RE
.TP
\fB\-\-export-variables\fR
.RS
Generate OVAL Variables documents which contain external variables' values that were provided to the OVAL checking engine during evaluation. The filename format is '\fIoriginal-oval-definitions-filename\fR-\fIsession-index\fR.variables-\fIvariables-index\fR.xml'.
.RE
.TP
\fB\-\-datastream-id ID\fR
.RS
Uses a datastream with that particular ID from the given datastream collection. If not given the first datastream is used. Only applies if you give source datastream in place of an XCCDF file.
.RE
.TP
\fB\-\-xccdf-id ID\fR
.RS
Takes component ref with given ID from checklists. This allows to select a particular XCCDF component even in cases where there are 2 XCCDFs in one datastream. If none is given, the first component from the checklists element is used.
.RE
.TP
\fB\-\-benchmark-id ID\fR
.RS
Selects a component ref from any datastream that references a component with XCCDF Benchmark such that its @id attribute matches given string exactly. Please note that this is not the recommended way of selecting a component-ref. You are advised to use --xccdf-id AND/OR --datastream-id for more precision. --benchmark-id is only used when both --xccdf-id and --datastream-id are not present on the command line!
.RE
.TP
\fB\-\-skip-valid\fR
.RS
Do not validate input/output files.
.RE
.TP
\fB\-\-fetch-remote-resources\fR
.RS
Allow download of remote OVAL content referenced from XCCDF by check-content-ref/@href.
.RE
.TP
\fB\-\-remediate\fR
.RS
Execute XCCDF remediatation in the process of XCCDF evaluation. This option automatically executes content of XCCDF fix elements for failed rules, and thus this shall be avoided unless for trusted content. Use of this option is always at your own risk.
.RE
.RE
.TP
.B remediate\fR [\fIoptions\fR] INPUT_FILE [\fIoval-definitions-files\fR]
.RS
This module provides post-scan remediation. It assumes that the INPUT_FILE is result of `oscap xccdf eval` operation. The input file must contain TestResult element. This module executes XCCDF fix elements for failed rule-result contained in the given TestResult. Use of this option is always at your own risk and it shall be avoided unless for trusted content.
.TP
\fB\-\-result-id ID
.RS
ID of the XCCDF TestResult element which shall be remediated. If this option is missing the last TestResult (in top-down processing) will be remediated.
.RE
.TP
\fB\-\-skip-valid\fR
.RS
Do not validate input/output files.
.RE
.TP
\fB\-\-fetch-remote-resources\fR
.RS
Allow download of remote OVAL content referenced from XCCDF by check-content-ref/@href.
.RE
.TP
\fB\-\-cpe CPE_FILE\fR
.RS
Use given CPE dictionary or language (auto-detected) for applicability checks.
.RE
.TP
\fB\-\-results FILE\fR
.RS
Write XCCDF results into FILE.
.RE
.TP
\fB\-\-results-arf FILE\fR
.RS
Writes results to a given FILE in Asset Reporting Format. It is recommended to use this option instead of --results when dealing with datastreams.
.RE
.TP
\fB\-\-report FILE\fR
.RS
Write HTML report into FILE. You also have to specify --results for this feature to work.
.RE
.TP
\fB\-\-oval-results\fR
.RS
Generate OVAL Result file for each OVAL session used for evaluation. File with name '\fIoriginal-oval-definitions-filename\fR.result.xml' will be generated for each referenced OVAL file. This option (with conjunction with the \fB\-\-report\fR option) also enables inclusion of additional OVAL information in the XCCDF report.
.RE
.TP
\fB\-\-check-engine-results\fR
.RS
After evaluation is finished, each loaded check engine plugin is asked to export its results. The export itself is plugin specific, please refer to documentation of the plugin for more details.
.RE
.TP
\fB\-\-export-variables\fR
.RS
Generate OVAL Variables documents which contain external variables' values that were provided to the OVAL checking engine during evaluation. The filename format is '\fIoriginal-oval-definitions-filename\fR-\fIsession-index\fR.variables-\fIvariables-index\fR.xml'.
.RE
.RE
.TP
.B resolve\fR -o output-file xccdf-file
.RS
Resolve an XCCDF file as described in the XCCDF specification. It will flatten inheritance hierarchy of XCCDF profiles, groups, rules, and values. Result is another XCCDF document, which will be written to \fIoutput-file\fR.
.TP
\fB\-\-force\fR
Force resolving XCCDF document even if it is already marked as resolved.
.RE
.TP
.B validate\fR [\fIoptions\fR] xccdf-file
.RS
Validate given XCCDF file against a XML schema. Every found error is printed to the standard error. Return code is 0 if validation succeeds, 1 if validation could not be performed due to some error, 2 if the XCCDF document is not valid.
.TP
\fB\-\-schematron\fR
Turn on Schematron-based validation. It is able to find more errors and inconsistencies but is much slower. Schematron is available only for XCCDF version 1.2.
.RE
.TP
.B export-oval-variables\fR [\fIoptions\fR] xccdf-file [\fIoval-definitions-files\fR]
.RS
Collect all the XCCDF values that would be used by OVAL during evaluation of a certain profile and export them as OVAL external-variables document(s). The filename format is '\fIoriginal-oval-definitions-filename\fR-\fIsession-index\fR.variables-\fIvariables-index\fR.xml'.
.PP
.TP
\fB\-\-profile PROFILE\fR
.RS
Select a particular profile from XCCDF document.
.RE
.TP
\fB\-\-fetch-remote-resources\fR
.RS
Allow download of remote OVAL content referenced from XCCDF by check-content-ref/@href.
.RE
.TP
\fB\-\-skip-valid\fR
.RS
Do not validate input/output files.
.RE
.TP
\fB\-\-datastream-id ID\fR
.RS
Uses a datastream with that particular ID from the given datastream collection. If not given the first datastream is used. Only applies if you give source datastream in place of an XCCDF file.
.RE
.TP
\fB\-\-xccdf-id ID\fR
.RS
Takes component ref with given ID from checklists. This allows to select a particular XCCDF component even in cases where there are 2 XCCDFs in one datastream.
.RE
.TP
\fB\-\-cpe CPE_FILE\fR
.RS
Use given CPE dictionary or language (auto-detected) for applicability checks. The variables documents are created only for xccdf:Rules which are applicable.
.RE
.RE
.TP
.B \fBgenerate\fR [\fIoptions\fR] <submodule> [submodule-specific-options]
.RS
Generate another document form an XCCDF file such as security guide or result report.
.TP
\fB\-\-profile ID\fR
Apply profile with given ID to the Benchmark before further processing takes place.
.TP
\fB\-\-format FMT\fR
Specify output format. This option applies only on document generators (i.e. guide, report). Available formats: \fIhtml\fR (default), \fIdocbook\fR.
.TP
Available submodules:
.TP
.B \fBguide\fR [\fIoptions\fR] xccdf-file
.RS
Generate a formatted document containing a security guide from a XCCDF Benchmark. Unless the --output option is specified it will be written to the standard output. Without profile being set only groups (not rules) will be included in the output.
.TP
\fB\-\-output FILE\fR
Write the guide to this file instead of standard output.
.TP
\fB\-\-hide-profile-info\fR
Information on chosen profile (e.g. rules selected by the profile) will be excluded from the document.
.RE
.TP
.B \fBreport\fR [\fIoptions\fR] xccdf-file
.RS
Generate a document containing results of a XCCDF Benchmark execution. Unless the --output option is specified it will be written to the standard output. ID of the TestResult element to visualise defaults to the most recent result (according to the end-time attribute).
.TP
\fB\-\-output FILE\fR
Write the report to this file instead of standard output.
.TP
\fB\-\-result-id ID\fR
ID of the XCCDF TestResult from which the report will be generated.
.TP
\fB\-\-show \fIwhat\fR
Specify what result types shall be displayed in the result report. The default is to show everything except for rules with results notselected and notapplicable. The \fIwhat\fR part is a comma-separated list of result types to display in addition to the default. If result type is prefixed by a dash '-', it will be excluded from the results. If \fIwhat\fR is prefixed by an equality sign '=', a following list specifies exactly what rule types to include in the report. Result types are: pass, fixed, notchecked, notapplicable, notselected, informational, unknown, error, fail.
.TP
\fB\-\-oval-template \fItemplate-string\fR
To use the ability to include additional information from OVAL in xccdf result file, a template which will be used to obtain OVAL result file names has to be specified. The template can be either a filename or a string containing wildcard character (percent sign '%'). Wildcard will be replaced by the original OVAL definition file name as referenced from the XCCDF file. This way it is possible to obtain OVAL information even from XCCDF documents referencing several OVAL files. To use this option with results from an XCCDF evaluation, specify \fI%.result.xml\fR as a OVAL file name template.
.RE
.TP
.B \fBfix\fR [\fIoptions\fR] xccdf-file
.RS
Generate a script that shall bring the system to a state of compliance with given XCCDF Benchmark.
.TP
\fB\-\-output FILE\fR
Write the report to this file instead of standard output.
.TP
\fB\-\-result-id \fIID\fR\fR
Fixes will be generated for failed rule-results of the specified TestResult.
.TP
\fB\-\-template \fIID|FILE\fR\fR
Template to be used to generate the script. If it contains a dot '.' it is interpreted as a location of a file with the template definition. Otherwise it identifies a template from standard set which currently includes: \fIbash\fR (default if no --template switch present). Brief explanation of the process of writing your own templates is in the XSL file \fIxsl/fix.xsl\fR in the openscap data directory. You can also take a look at the default template \fIxsl/fixtpl-bash.xml\fR.
.RE
.TP
.B \fBcustom\fR --stylesheet xslt-file [\fIoptions\fR] xccdf-file
.RS
Generate a custom output (depending on given XSLT file) from an XCCDF file.
.TP
\fB\-\-stylesheet \fIFILE\fR\fR
Specify an absolute path to a custom stylesheet to format the output.
.TP
\fB\-\-output FILE\fR
Write the document into file.
.RE
.SH OVAL OPERATIONS
.TP
.B eval\fR [\fIoptions\fR] INPUT_FILE
.RS
Probe the system and evaluate all definitions from OVAL Definition file. Print result of each definition to standard output. The return code is 0 after a successful evaluation. On error, value 1 is returned.
.PP
INPUT_FILE can be either OVAL Definition File or SCAP Source Datastream, it depends on used options.
.PP
Unless --skip-valid is used, the INPUT_FILE is validated using XSD schemas (depending on document type of INPUT_FILE) and rejected if invalid.
.TP
\fB\-\-id DEFINITION-ID\fR
Evaluate ONLY specified OVAL Definition from OVAL Definition File.
.TP
\fB\-\-variables FILE\fR
Provide external variables expected by OVAL Definition File.
.TP
\fB\-\-directives FILE\fR
Use OVAL Directives content to specify desired results content.
.TP
\fB\-\-results FILE\fR
Write OVAL Results into file.
.TP
\fB\-\-report FILE\fR
Create human readable (HTML) report from OVAL Results.
.TP
\fB\-\-datastream-id ID\fR
.RS
Uses a datastream with that particular ID from the given datastream collection. If not given the first datastream is used. Only applies if you give source datastream in place of an OVAL file.
.RE
.TP
\fB\-\-oval-id ID\fR
.RS
Takes component ref with given ID from checks. This allows to select a particular OVAL component even in cases where there are 2 OVALs in one datastream.
.RE
.TP
\fB\-\-skip-valid\fR
Do not validate input/output files.
.RE
.TP
.B collect\fR [\fIoptions\fR] definitions-file
.RS
Probe the system and gather system characteristics for all objects in OVAL Definition file.
.PP
.TP
\fB\-\-id OBJECT-ID\fR
Collect system characteristics ONLY for specified OVAL Object.
.TP
\fB\-\-variables FILE\fR
Provide external variables expected by OVAL Definitions.
.TP
\fB\-\-syschar FILE\fR
Write OVAL System Characteristic into file.
.TP
\fB\-\-skip-valid\fR
Do not validate input/output files.
.RE
.TP
.B analyse\fR [\fIoptions\fR] --results FILE definitions-file syschar-file
.RS
In this mode, the oscap tool does not perform data collection on the local system, but relies upon the input file, which may have been generated on another system. The output (OVAL Results) is printed to file specified by \fB--results\fR parameter.
.TP
\fB\-\-variables FILE\fR
Provide external variables expected by OVAL Definitions.
.TP
\fB\-\-directives FILE\fR
Use OVAL Directives content to specify desired results content.
.TP
\fB\-\-skip-valid\fR
Do not validate input/output files.
.RE
.TP
.B validate\fR [\fIoptions\fR] oval-file
.RS
Validate given OVAL file against a XML schema. Every found error is printed to the standard error. Return code is 0 if validation succeeds, 1 if validation could not be performed due to some error, 2 if the OVAL document is not valid.
.TP
\fB\-\-definitions\fR, \fB\-\-variables\fR, \fB\-\-syschar\fR, \fB\-\-results\fR \fB\-\-directives\fR
Type of the OVAL document is automatically detected by default. If you want enforce certain document type, you can use one of these options.
.TP
\fB\-\-schematron\fR
Turn on Schematron-based validation. It is able to find more errors and inconsistencies but is much slower.
.RE
.TP
.B \fBgenerate\fR <submodule> [submodule-specific-options]
.RS
Generate another document form an OVAL file.
.TP
Available submodules:
.TP
.B \fBreport\fR [\fIoptions\fR] oval-results-file
.RS
Generate a formatted HTML page containing visualisation of an OVAL results file. Unless the --output option is specified it will be written to the standard output.
.TP
\fB\-\-output FILE\fR
Write the report to this file instead of standard output.
.RE
.RE
.TP
.B \fBlist-probes\fR [\fIoptions\fR]
.RS
List supported object types (i.e. probes)
.TP
\fB\-\-static\fR
List all probes defined in the internal tables.
.TP
\fB\-\-dynamic\fR
List all probes supported on the current system (this is default behavior).
.TP
\fB\-\-verbose\fR
Be verbose.
.RE
.SH CPE OPERATIONS
.TP
.B \fBcheck\fR name
.RS
Check whether name is in correct CPE format.
.RE
.PP
.B \fBmatch\fR name dictionary.xml
.RS
Find an exact match of CPE name in the dictionary.
.RE
.PP
.B validate\fR cpe-dict-file
.RS
Validate given CPE dictionary file against a XML schema. Every found error is printed to the standard error. Return code is 0 if validation succeeds, 1 if validation could not be performed due to some error, 2 if the XCCDF document is not valid.
.SH CVSS OPERATIONS
.TP
.B \fBscore\fR \fIcvss_vector\fR
.RS
Calculate score from a CVSS vector. Prints base score for base CVSS vector, base and temporal score for temporal CVSS vector, base and temporal and environmental score for environmental CVSS vector.
.RE
.TP
.B \fBdescribe\fR \fIcvss_vector\fR
.RS
Describe individual components of a CVSS vector in a human-readable format and print partial scores.
.RE
.TP
.B \fICVSS vector\fR consists of several slash-separated components specified as key-value pairs. Each key can be specified at most once. Valid CVSS vector has to contain at least base CVSS metrics, i.e. AV, AC, AU, C, I, and A. Following table summarizes the components and possible values (second column is metric category: B for base, T for temporal, E for environmental):
.RS
.P
AV:[L|A|N] B Access vector: Local, Adjacent network, Network
.P
AC:[H|M|L] B Access complexity: High, Medium, Low
.P
AU:[M|S|N] B Required authentication: Multiple instances, Single instance, None
.P
C:[N|P|C] B Confidentiality impact: None, Partial, Complete
.P
I:[N|P|C] B Integrity impact: None, Partial, Complete
.P
A:[N|P|C] B Availability impact: None, Partial, Complete
.P
E:[ND|U|POC|F|H] T Exploitability: Not Defined, Unproven, Proof of Concept, Functional, High
.P
RL:[ND|OF|TF|W|U] T Remediation Level: Not Defined, Official Fix, Temporary Fix, Workaround, Unavailable
.P
RC:[ND|UC|UR|C] T Report Confidence: Not Defined, Unconfirmed, Uncorroborated, Confirmed
.P
CDP:[ND|N|L|LM|MH|H] E Collateral Damage Potential: Not Defined, None, Low, Low-Medium, Medium-High, High
.P
TD:[ND|N|L|M|H] E Target Distribution: Not Defined, None, Low, Medium, High
.P
CR:[ND|L|M|H] E Confidentiality requirement: Not Defined, Low, Medium, High
.P
IR:[ND|L|M|H] E Integrity requirement: Not Defined, Low, Medium, High
.P
AR:[ND|L|M|H] E Availability requirement: Not Defined, Low, Medium, High
.RE
.RE
.PP
.SH DS OPERATIONS
.TP
.B \fBsds-compose\fR SOURCE_XCCDF TARGET_SDS
.RS
Creates a source datastream from the XCCDF file given in SOURCE_XCCDF and stores the result in TARGET_SDS. Dependencies like OVAL files are automatically detected and bundled in target source datastream.
.RE
.TP
.B \fBsds-add\fR [\fIoptions\fR] NEW_COMPONENT EXISTING_SDS
.RS
Adds given NEW_COMPONENT file to the existing source datastream (EXISTING_SDS). Component file might be OVAL, XCCDF or CPE Dictionary file. Dependencies like OVAL files are automatically detected an bundled in target source datastream.
.TP
\fB\-\-datastream-id DATASTREAM_ID\fR
Uses a datastream with that particular ID from the given datastream collection. If not given the first datastream is used.
.RE
.TP
.B \fBsds-split\fR [\fIoptions\fR] SOURCE_DS TARGET_DIR
.RS
Splits given source datastream into multiple files and stores all the files in TARGET_DIR.
.TP
\fB\-\-datastream-id DATASTREAM_ID\fR
Uses a datastream with that particular ID from the given datastream collection. If not given the first datastream is used.
.TP
\fB\-\-xccdf-id XCCDF_ID\fR
Takes component ref with given ID from checklists. This allows to select a particular XCCDF component even in cases where there are 2 XCCDFs in one datastream.
.RE
.TP
.B \fBsds-validate\fR SOURCE_DS
.RS
Validate given source datastream file against a XML schema. Every found error is printed to the standard error. Return code is 0 if validation succeeds, 1 if validation could not be performed due to some error, 2 if the source datastream is not valid.
.RE
.TP
.B \fBrds-create\fR SDS TARGET_ARF XCCDF_RESULTS [OVAL_RESULTS [OVAL_RESULTS ..]]
.RS
Takes given source datastream, XCCDF and OVAL results and creates a result datastream (in Asset Reporting Format) and saves it to file given in TARGET_ARF.
.RE
.TP
.B \fBrds-split\fR [--report-id REPORT_ID] RDS TARGET_DIR
.RS
Takes given result datastream (also called ARF = asset reporting format) and splits given report and its respective report-request to given target directory. If no report-id is given, we assume user wants the first applicable report in top-down order in the file.
.RE
.TP
.B \fBrds-validate\fR SOURCE_RDS
.RS
Validate given result datastream file against a XML schema. Every found error is printed to the standard error. Return code is 0 if validation succeeds, 1 if validation could not be performed due to some error, 2 if the result datastream is not valid.
.RE
.SH CVE OPERATIONS
.TP
.B validate\fR cve-nvd-feed.xml
.RS
Validate given CVE data feed.
.RE
.TP
.B find\fR CVE cve-nvd-feed.xml
.RS
Find given CVE in data feed and report base score, vector string and vulnerable software list.
.RE
.SH EXIT STATUS
.TP
\fBNormally, the exit status is 0 when operation finished successfully and 1 otherwise. In cases when oscap performs evaluation of the system it may return 2 indicating success of the operation but incompliance of the assessed system.
.RE
.SH EXAMPLES
Evaluate XCCDF content using CPE dictionary and produce html report. In this case we use United States Government Configuration Baseline (USGCB) for Red Hat Enterprise Linux 5 Desktop.
.PP
.nf
.RS
\& oscap xccdf eval \-\-fetch-remote-resources \-\-oval-results \e
\& \-\-profile united_states_government_configuration_baseline \e
\& \-\-report usgcb-rhel5desktop.report.html \e
\& \-\-results usgcb-rhel5desktop-xccdf.xml.result.xml \e
\& \-\-cpe usgcb-rhel5desktop-cpe-dictionary.xml \e
\& usgcb-rhel5desktop-xccdf.xml
.RE
.fi
.PP
.SH CONTENT
.TP
\fB National Vulnerability Database\fR - \fIhttp://web.nvd.nist.gov/view/ncp/repository\fR
.TP
\fB Red Hat content repository\fR - \fIhttp://www.redhat.com/security/data/oval/\fR
.SH REPORTING BUGS
.nf
Please report bugs using https://fedorahosted.org/openscap/
Make sure you include the full output of `oscap --v` in the bug report.
.SH AUTHORS
.nf
Peter Vrabec <pvrabec@redhat.com>
Šimon Lukašík
Martin Preisler <mpreisle@redhat.com>
.fi
|