You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: security/security-design/shared-assets/kms-backup/README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,27 +2,27 @@
2
2
3
3
Owner: Inge Os
4
4
5
-
OCI Vault supports several types of keys, two HSMbased, and softwarebased.
5
+
OCI Vault supports several types of keys: HSM-based and software-based.
6
6
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.
8
8
9
9
Some common main requirements most often seen in various cyber security frameworks typically are:
10
10
- 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.
13
13
14
-
Oracle key Vault offers two main categories of key management:
15
-
HSMbased, 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.
17
17
18
-
The main difference between HSMbased Vaults and Softwarebased is that the HSMbased prohibits explicit export of the master key. HSMbased key storage offers HA and DR, including crossregion 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.
19
19
20
-
Softwarebased Key Vault do not offer crossregion 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.
22
22
23
23
## Prerequisites
24
24
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
26
26
- Python 3.0
27
27
- Create a virtual environment
28
28
@@ -44,7 +44,7 @@ Please refer to the OCI install guide.
44
44
```
45
45
46
46
- 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.
@@ -61,7 +61,7 @@ The OCI CLI configuration may be verified with the following command:
61
61
62
62
- A valid public key for export only
63
63
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.
65
65
66
66
Permission to `manage` the following types of resources in your Oracle Cloud Infrastructure tenancy: `vaults`, `keys`, `secret-family`
67
67
Example policies:
@@ -79,15 +79,15 @@ If you don't have the required permissions and quota, contact your tenancy admin
79
79
80
80
## Script execution
81
81
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 commandline. Any command-line argument overwrites any arguments from the configuration file,
83
83
84
84
The script has two modes of operation:
85
85
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.
87
87
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.
89
89
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.
0 commit comments