File: README.md

package info (click to toggle)
scap-workbench 1.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 3,292 kB
  • sloc: cpp: 7,519; sh: 205; xml: 38; ansic: 15; makefile: 13
file content (120 lines) | stat: -rw-r--r-- 2,919 bytes parent folder | download
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
SCAP Workbench
==============

A GUI tool that provides scanning, tailoring and validation functionality for SCAP content

About
-----

SCAP Workbench is a GUI tool that provides scanning, tailoring
and validation functionality for SCAP content. It uses openscap library
to access SCAP functionalities.

Homepage of the project is https://www.open-scap.org/tools/scap-workbench/

How to run it out of the box
----------------------------

1) Make sure you have installed all prerequisites

required dependencies:
```console
# yum install cmake gcc-c++ openssh-clients util-linux openscap-devel qt5-devel openssh-askpass
```

required dependencies (only for the git repo, not required for released tarballs):
```console
# yum install asciidoc
```

optional dependencies:
```console
# yum install polkit
```

2) Build SCAP Workbench:
```console
$ mkdir build; cd build
$ cmake ../
$ make
```
To build against locally built OpenSCAP library export following variables:

```console
$ export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/PATH/TO/DIR/WITH/.pcFILE/"
$ export LIBRARY_PATH=/PATH/TO/DIR/WITH/openscap.soFILE/
```

Additionally it is possible to use custom CMake definitions instead of exporting environment variables:

```console
$ cmake -DOPENSCAP_LIBRARIES:PATH=/local/openscap.so/filepath/ \
    -DOPENSCAP_INCLUDE_DIRS:PATH=/local/openscap/include/path \
    -DOPENSCAP_VERSION:STRING="X.Y.Z" \
    ../
$ make
```

3) Install SCAP Workbench: (optional)

(inside the build folder):
```console
$ # may require superuser privileges if you didn't set different installation
$ # prefix (CMAKE_INSTALL_PREFIX)
$ make install
```

4a) Run SCAP Workbench: (if it was installed)

spawning open file dialog:
```console
$ scap-workbench
```

with an XCCDF file to load:
```console
$ scap-workbench /path/to/xccdf-file.xml
```

with a source datastream (SDS) to load:
```console
$ scap-workbench /path/to/sds-file
```

4b) Run SCAP Workbench: (straight from build dir, without installation)

Note: If you have built SCAP-Workbench against locally built OpenSCAP library, then run one of the following commands:

```console
$ ldconfig /PATH/TO/DIR/WITH/openscap.soFILE/
```
or
```console
$ export LD_LIBRARY_PATH=/PATH/TO/DIR/WITH/openscap.soFILE/
```

and then:

```console
$ cd build/
$ bash runwrapper.sh ./scap-workbench
```

What now?
---------

You should have a built SCAP Workbench executable by now. Please refer to the user manual for documentation on how to use it.

There are 3 ways to get the user manual:

 * Click `Help -> User Manual` in the application
 * Open `/usr/share/doc/scap-workbench/user_manual.html` (installed system-wide) or `doc/user_manual.html` (from the tarball) in your browser
 * Open or download [user manual from the website](https://static.open-scap.org/scap-workbench-1.1/)

How to make a tarball
---------------------
```console
$ mkdir build; cd build
$ cmake ../
$ make package_source
```