Skip to content

Commit 3b6f794

Browse files
Merge pull request #1111 from oracle-devrel/lvb_add_version_20240502_files
Added version 240502 to repo
2 parents 84a7829 + deee3ac commit 3b6f794

File tree

9 files changed

+794
-522
lines changed

9 files changed

+794
-522
lines changed

security/security-design/shared-assets/oci-security-health-check-standard/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Owner: Olaf Heimburger
44

5-
Version: 240315
5+
Version: 240502
66

7-
Reviewed: 01.02.2024
7+
Reviewed: 05.02.2024
88

99
# Introduction
1010
![Flyer](./files/resources/OCI_Security_Health_Check_Standard.png)
@@ -29,22 +29,22 @@ See the *OCI Security Health Check - Standard Edition* in action and watch the [
2929

3030
Before running the *OCI Security Health Check - Standard Edition* you should download and verify it.
3131

32-
- Download the latest distribution [oci-security-health-check-standard-240315.zip](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240315/oci-security-health-check-standard-240315.zip).
32+
- Download the latest distribution [oci-security-health-check-standard-240502.zip](./files/resources/oci-security-health-check-standard-240502.zip).
3333
- Download the respective checksum file:
34-
- [oci-security-health-check-standard-240315.sha512](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240315/oci-security-health-check-standard-240315.sha512).
35-
- [oci-security-health-check-standard-240315.sha512256](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240315/oci-security-health-check-standard-240315.sha512256).
34+
- [oci-security-health-check-standard-240502.sha512](./files/resources/oci-security-health-check-standard-240502.sha512).
35+
- [oci-security-health-check-standard-240502.sha512256](./files/resources/oci-security-health-check-standard-240502.sha512256).
3636
- Verify the integrity of the distribution. Both files must be in the same directory (for example, in your downloads directory).
3737

3838
On MacOS:
3939
```
4040
cd <your_downloads_directory>
41-
shasum -a 512256 -c oci-security-health-check-standard-240315.sha512256
41+
shasum -a 512256 -c oci-security-health-check-standard-240502.sha512256
4242
```
4343
4444
On Linux (including Cloud Shell):
4545
```
4646
cd <your_downloads_directory>
47-
sha512sum -c oci-security-health-check-standard-240315.sha512
47+
sha512sum -c oci-security-health-check-standard-240502.sha512
4848
```
4949
5050
**Reject the downloaded file if the check fails!**

security/security-design/shared-assets/oci-security-health-check-standard/files/oci-security-health-check-standard/README.md

Lines changed: 114 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Owner: Olaf Heimburger
44

5-
Version: 240315
5+
Version: 240502 (cis_report.py version 2.8.2+)
66

77
## When to use this asset?
88

@@ -12,26 +12,31 @@ The *OCI Security Health Check - Standard Edition* checks an OCI tenancy for CIS
1212

1313
This asset covers the OCI platform as specified in the *CIS Oracle Cloud Infrastructure Foundations Benchmark*, only. Any workload provisioned in Databases, Compute VMs (running any Operating System), the Container Engine for Kubernetes, or in the VMware Solution is *out of scope* of the *OCI Security Health Check*.
1414

15+
This is not an official Oracle application and it is not supported
16+
by Oracle Support.
17+
1518
## Usage
1619

1720
### Download and verify the release file
1821

1922
Before running the *OCI Security Health Check - Standard Edition* you should download and verify it.
2023

21-
- Download the latest distribution [oci-security-health-check-standard-240315.zip](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240315/oci-security-health-check-standard-240315.zip).
22-
- Download the respective checksum file [oci-security-health-check-standard-240315.sha512256](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240315/oci-security-health-check-standard-240315.sha512256).
24+
- Download the latest distribution [oci-security-health-check-standard-240502.zip](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240502/oci-security-health-check-standard-240502.zip).
25+
- Download the respective checksum file:
26+
- [oci-security-health-check-standard-240502.sha512256](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240502/oci-security-health-check-standard-240502.sha512256)
27+
- [oci-security-health-check-standard-240502.sha512](https://github.com/oracle-devrel/technology-engineering/releases/download/oci-security-health-check-std-240502/oci-security-health-check-standard-240502.sha512).
2328
- Verify the integrity of the distribution. Both files must be in the same directory (for example, in your downloads directory).
2429

2530
On MacOS:
2631
```
2732
cd <your_downloads_directory>
28-
shasum -a 512256 -c oci-security-health-check-standard-240315.sha512256
33+
shasum -a 512256 -c oci-security-health-check-standard-240502.sha512256
2934
```
3035
3136
On Linux (including Cloud Shell):
3237
```
3338
cd <your_downloads_directory>
34-
sha512sum -c oci-security-health-check-standard-240315.sha512
39+
sha512sum -c oci-security-health-check-standard-240502.sha512
3540
```
3641
3742
**Reject the downloaded file when the check fails!**
@@ -48,7 +53,7 @@ quickest way. If you decide to use this option, please continue reading in
4853
For recurring usage, setting up a group for auditing is recommended. The
4954
steps for setting this up are described in the next chapter.
5055
51-
#### Setting up an *Auditor* group and policy
56+
#### Setting up an *Auditor* group and related permissions
5257
5358
Using an auditor group is the recommended way to run the assessment script.
5459
To create a group for auditing do the following steps:
@@ -112,7 +117,7 @@ The recommended way is to run the *OCI Security Health Check - Standard* in the
112117
- Upload the distribution file.
113118
- Extract it
114119
```
115-
unzip -q oci-security-health-check-standard-240315.zip
120+
unzip -q oci-security-health-check-standard-240502.zip
116121
```
117122
118123
### Run the script
@@ -123,20 +128,113 @@ The recommended way is to run the *OCI Security Health Check - Standard* in the
123128
- In the `oci-security-health-check-standard` directory:
124129
- Enable execution of script `standard.sh`:
125130
```
126-
$ chmod +x standard.sh
131+
chmod +x standard.sh
127132
```
128133
- Run the script for all subscribed regions:
129134
```
130-
$ ./standard.sh
135+
./standard.sh
131136
```
132137
- Run the script for one subscribed region:
133138
```
134-
$ ./standard.sh -r <region_name>
139+
./standard.sh -r <region_name>
135140
```
136141
- Get command line options:
137142
```
138-
$ ./standard.sh -h
143+
./standard.sh -h
144+
```
145+
### Using an OCI Compute VM (Oracle Linux)
146+
147+
- Create a Dynamic Group
148+
`'Default'/'dgp-instance-principal'`
149+
150+
This dynamic group must specify the compartment OCID (`resource.compartment.id`) or the Compute VM OCID (`resource.instance.id`), respectively.
151+
- Create permissions for the Dynamic Group
152+
```
153+
allow dynamic-group 'Default'/'dgp-instance-principal' to inspect all-resources in tenancy
154+
allow dynamic-group 'Default'/'dgp-instance-principal' to read audit-events in tenancy
155+
allow dynamic-group 'Default'/'dgp-instance-principal' to read buckets in tenancy
156+
allow dynamic-group 'Default'/'dgp-instance-principal' to read cloudevents-rules in tenancy
157+
allow dynamic-group 'Default'/'dgp-instance-principal' to read dns in tenancy
158+
allow dynamic-group 'Default'/'dgp-instance-principal' to read domains in tenancy
159+
allow dynamic-group 'Default'/'dgp-instance-principal' to read file-family in tenancy
160+
allow dynamic-group 'Default'/'dgp-instance-principal' to read instances in tenancy
161+
allow dynamic-group 'Default'/'dgp-instance-principal' to read instance-configurations in tenancy
162+
allow dynamic-group 'Default'/'dgp-instance-principal' to read keys in tenancy
163+
allow dynamic-group 'Default'/'dgp-instance-principal' to read load-balancers in tenancy
164+
allow dynamic-group 'Default'/'dgp-instance-principal' to read nat-gateways in tenancy
165+
allow dynamic-group 'Default'/'dgp-instance-principal' to read network-security-groups in tenancy
166+
allow dynamic-group 'Default'/'dgp-instance-principal' to read osms-family in tenancy
167+
allow dynamic-group 'Default'/'dgp-instance-principal' to read public-ips in tenancy
168+
allow dynamic-group 'Default'/'dgp-instance-principal' to read resource-availability in tenancy
169+
allow dynamic-group 'Default'/'dgp-instance-principal' to read serviceconnectors in tenancy
170+
allow dynamic-group 'Default'/'dgp-instance-principal' to read stream-family in tenancy
171+
allow dynamic-group 'Default'/'dgp-instance-principal' to read users in tenancy
172+
allow dynamic-group 'Default'/'dgp-instance-principal' to read vault in tenancy
173+
allow dynamic-group 'Default'/'dgp-instance-principal' to read vlans in tenancy
174+
allow dynamic-group 'Default'/'dgp-instance-principal' to read vss-family in tenancy
175+
```
176+
- Preparing the Compute VM:
177+
- Log into the Compute VM
178+
- Make sure that Python 3 is installed:
179+
```
180+
sudo yum list python39
181+
```
182+
- If Python 3 is missing, install it:
183+
```
184+
sudo yum install python39 -y
185+
```
186+
- Update the link of python3 to /usr/bin/python3.9
139187
```
188+
sudo alternatives --config python3
189+
```
190+
Follow the instructions to select /usr/bin/python3.9
191+
- Log out
192+
193+
- From your desktop, upload the `oci-security-health-check-standard-240502.zip` file to the Compute VM using any SFTP client.
194+
- Log into the Compute VM
195+
- Extract the distribution
196+
```
197+
unzip -q oci-security-health-check-standard-240502.zip
198+
```
199+
- Change directory into `oci-security-health-check-standard`:
200+
```
201+
cd oci-security-health-check-standard
202+
```
203+
- Enable execution of script `standard.sh`:
204+
```
205+
chmod +x standard.sh
206+
```
207+
- In the `oci-security-health-check-standard` directory run the assess.sh
208+
script.
209+
- Start the `screen` program:
210+
```
211+
screen
212+
```
213+
214+
- Run the script for all subscribed regions:
215+
```
216+
./standard.sh -ip -t <tenancy_name>
217+
```
218+
- Run the script for one subscribed region, only:
219+
```
220+
./standard.sh -ip -t <tenancy_name> -r <region_name>
221+
```
222+
- Get command line options:
223+
```
224+
./standard.sh -h
225+
```
226+
- When your Compute VM session has been ended due to inactivity you can
227+
resume without starting the script again.
228+
229+
To resume the screen session, follow these steps
230+
(the output will be different in your *Compute VM*):
231+
- Connect to your *Compute VM* again.
232+
```
233+
screen -ls
234+
1234.text
235+
screen -d 1234
236+
screen -r 1234
237+
```
140238
141239
### Getting the results
142240
- In the directory `oci-security-health-check-standard` a directory will be created which
@@ -146,7 +244,7 @@ The recommended way is to run the *OCI Security Health Check - Standard* in the
146244
147245
### Checking the results
148246
149-
The report results are showing the compliance status of the related [CIS OCI Foundation Benchmark, version 1.2](https://www.cisecurity.org/benchmark/Oracle_Cloud) recommendations. Please download this benchmark before reading the report. (For license reasons, we cannot distribute the benchmark.)
247+
The report results are showing the compliance status of the related [CIS OCI Foundation Benchmark, version 2.0](https://www.cisecurity.org/benchmark/Oracle_Cloud) recommendations. Please download this benchmark before reading the report. (For license reasons, we cannot distribute the benchmark.)
150248
151249
The report results are summarized in two files:
152250
- *cis_html_summary_report.html* &ndash; The report in HTML that displays the all recommendations and their compliance status, respectively.
@@ -158,18 +256,19 @@ No known issues.
158256
159257
## Credits
160258
161-
The *OCI Security Health Check - Standard Edition* streamlines the usage of the bundled [Compliance Checking Script](https://github.com/oracle-quickstart/oci-cis-landingzone-quickstart/blob/main/compliance-script.md) provided by the [CIS OCI Landing Zone Quick Start Template](https://github.com/oracle-quickstart/oci-cis-landingzone-quickstart).
259+
The *OCI Security Health Check - Standard Edition* streamlines the usage of the [Compliance Checking Script](https://github.com/oracle-quickstart/oci-cis-landingzone-quickstart/blob/main/compliance-script.md) provided by the [CIS OCI Landing Zone Quick Start Template](https://github.com/oracle-quickstart/oci-cis-landingzone-quickstart).
162260
163261
The *OCI Security Health Check - Standard Edition* would not be possible without the great work of the [CIS OCI Landing Zone Quick Start Template Team](https://github.com/oracle-quickstart/oci-cis-landingzone-quickstart/graphs/contributors).
164262
165263
## Certification
166264
167-
The Compliance Checking Script is certified by the [CIS Center of Internet Security for the OCI Oracle Cloud Foundation Benchmark v1.2.O, Level 1 and 2](https://www.cisecurity.org/partner/oracle).
265+
The Compliance Checking Script is certified by the [CIS Center of Internet Security for the OCI Oracle Cloud Foundation Benchmark v1.2, Level 1 and 2](https://www.cisecurity.org/partner/oracle).
168266
169267
# License
170268
171269
Copyright (c) 2022-2024 Oracle and/or its affiliates.
172270
173271
Licensed under the Universal Permissive License (UPL), Version 1.0.
174272
175-
See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE) for more details.
273+
See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/folder-structure/LICENSE) for more details.
274+

0 commit comments

Comments
 (0)