Skip to content

Commit 2b4cd40

Browse files
Update README.md
spelling
1 parent 9891b6d commit 2b4cd40

File tree

1 file changed

+17
-17
lines changed
  • security/security-design/shared-assets/kms-backup

1 file changed

+17
-17
lines changed

security/security-design/shared-assets/kms-backup/README.md

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

33
Owner: Inge Os
44

5-
OCI Vault supports several types of keys, two HSM based, and software based.
5+
OCI Vault supports several types of keys: HSM-based and software-based.
66

7-
Most services in Oracle OCI with encryption offers two types of encryption key management, Oracle Managed keys or Customer Managed keys.
7+
Most services in Oracle OCI with encryption offer two types of encryption key management, Oracle-managed keys or Customer-managed keys.
88

99
Some common main requirements most often seen in various cyber security frameworks typically are:
1010
- Separation of Duty, key administration is separated from service management. Typical for Oracle Databases with Transparent Data Encryption the DBA function does not have access to manage the keys, only to read and use them.
11-
- The Master key shall not be stored in any filesystem shared with the encrypted resource. Again, for using the Oracle Database with TDE as an example, the default key management with TDE is to use a Oracle Wallet stored in the same filesystem as the Oracle software installation.
12-
To meet these requirements and to have a robust operations model for key management, Oracle offers Oracle Key Vault.
11+
- The Master key shall not be stored in any filesystem shared with the encrypted resource. Again, for using the Oracle Database with TDE as an example, the default key management with TDE is to use an Oracle Wallet stored in the same filesystem as the Oracle software installation.
12+
- To meet these requirements and to have a robust operations model for key management, Oracle offers Oracle Key Vault.
1313

14-
Oracle key Vault offers two main categories of key management:
15-
HSM based, with a FIPS compliant Hardware Security Module
16-
Software Based, where the key is not stored in a HSM, but still protected with the strong tenant isolation and ops isolation that is the cornerstone of Oracle OCI.
14+
Oracle Key Vault offers two main categories of key management:
15+
- HSM-based, with a FIPS compliant Hardware Security Module
16+
- Software-based, where the key is not stored in an HSM, but still protected with the strong tenant isolation and ops isolation that is the cornerstone of Oracle OCI.
1717

18-
The main difference between HSM based Vaults and Software based is that the HSM based prohibits explicit export of the master key. HSM based key storage offers HA and DR, including cross region replication, slightly dependent of the type of HSM service deployed.
18+
The main difference between HSM-based Vaults and Software-based is that the HSM-based prohibits explicit export of the master key. HSM-based key storage offers HA and DR, including cross-region replication, slightly dependent on the type of HSM service deployed.
1919

20-
Software based Key Vault do not offer cross region replication.
21-
The main purpose of this asset is to provide an example python script that demonstrates usage of the Python KMS SDK, an example of OCI Vault software key backup/restore between two regions.
20+
Software-based Key Vault does not offer cross-region replication.
21+
The main purpose of this asset is to provide an example Python script that demonstrates the usage of the Python KMS SDK, an example of OCI Vault software key backup/restore between two regions.
2222

2323
## Prerequisites
2424

25-
- The script may be run from the Cloud Shell, or from a linux/Windows environment
25+
- The script may be run from the Cloud Shell, or from a Linux/Windows environment
2626
- Python 3.0
2727
- Create a virtual environment
2828

@@ -44,7 +44,7 @@ Please refer to the OCI install guide.
4444
```
4545

4646
- Configure OCI profiles and verify the OCI SDK
47-
Configure the OCI CLI with a API key (may be the same) for source and target. Please refer to the OCI CLI documentation for creating a OCI environment file.
47+
Configure the OCI CLI with an API key (may be the same) for source and target. Please refer to the OCI CLI documentation for creating an OCI environment file.
4848

4949

5050
[OCI File Configuration]( https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliconfigure.htm)
@@ -61,7 +61,7 @@ The OCI CLI configuration may be verified with the following command:
6161

6262
- A valid public key for export only
6363

64-
- Create and/or Check IAM Policies to permit key read, inspect and key creation.
64+
- Create and/or Check IAM Policies to permit key reading, inspection, and creation.
6565

6666
Permission to `manage` the following types of resources in your Oracle Cloud Infrastructure tenancy: `vaults`, `keys`, `secret-family`
6767
Example policies:
@@ -79,15 +79,15 @@ If you don't have the required permissions and quota, contact your tenancy admin
7979

8080
## Script execution
8181

82-
The script requires a number of arguments. The arguments vary dependent on modi of script execution. All or some arguments can be submitted as a configuration file in JSON format or at the command-line. Any command-line argument overwrites any arguments from the configuration file,
82+
The script requires a number of arguments. The arguments vary depending on the script execution. All or some arguments can be submitted as a configuration file in JSON format or at the command line. Any command-line argument overwrites any arguments from the configuration file,
8383

8484
The script has two modes of operation:
8585
1) Export a key, save it to a file, and print the fingerprint, used for verification of a key
86-
2) Copy the key between two locations where tenant OCID, region and API Key is required.
86+
2) Copy the key between two locations where tenant OCID, region, and API Key are required.
8787

88-
A key in vault may have several versions, and you may specify the OCID of a given version for both export and copy of the key. If no key version is specified, the most recent key is exported.
88+
A key in the vault may have several versions, and you may specify the OCID of a given version for both export and copy of the key. If no key version is specified, the most recent key is exported.
8989

90-
The script checks if the key is Enabled and is of type SOFTWARE, before any export is attempted.
90+
The script checks if the key is Enabled and is of type SOFTWARE before any export is attempted.
9191

9292
## Configuration parameters/arguments
9393

0 commit comments

Comments
 (0)