diff --git a/docs/kms/umn/ALL_META.TXT.json b/docs/kms/umn/ALL_META.TXT.json index cace4f228..6640e0674 100644 --- a/docs/kms/umn/ALL_META.TXT.json +++ b/docs/kms/umn/ALL_META.TXT.json @@ -3,8 +3,8 @@ "dockw":"User Guide" }, { - "uri":"kms_01_0091.html", - "node_id":"kms_01_0091.xml", + "uri":"kms_01_0109.html", + "node_id":"kms_01_0109.xml", "product_code":"kms", "code":"1", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -13,9 +13,6 @@ "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -24,40 +21,52 @@ "githuburl":"" }, { - "uri":"kms_01_0299.html", - "node_id":"kms_01_0299.xml", + "uri":"kms_01_0045.html", + "node_id":"kms_01_0045.xml", "product_code":"kms", "code":"2", - "des":"Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).KMS uses har", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", - "kw":"Key Management Service,Service Overview,User Guide", + "kw":"Key Management", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Key Management Service", + "title":"Key Management", "githuburl":"" }, { - "uri":"kms_01_0121.html", - "node_id":"kms_01_0121.xml", + "uri":"kms_01_0003.html", + "node_id":"kms_01_0003.xml", "product_code":"kms", "code":"3", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", - "kw":"KMS", + "kw":"Concepts", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Concepts", + "githuburl":"" + }, + { + "uri":"kms_01_0004.html", + "node_id":"kms_01_0004.xml", + "product_code":"kms", + "code":"4", + "des":"Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).This service", + "doc_type":"usermanual", + "kw":"KMS,Concepts,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -66,19 +75,142 @@ "githuburl":"" }, { - "uri":"kms_01_0001.html", - "node_id":"kms_01_0001.xml", + "uri":"kms_01_0005.html", + "node_id":"kms_01_0005.xml", "product_code":"kms", - "code":"4", - "des":"KMS is a secure, reliable, and easy-to-use cloud service that helps users create, manage, and protect keys in a centralized manner.It uses Hardware Security Modules (HSMs", + "code":"5", + "des":"A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user using KMS. It is used to encrypt and protect Data Encryption Keys (DEKs). One CMK can be used ", "doc_type":"usermanual", - "kw":"Functions,KMS,User Guide", + "kw":"CMK,Concepts,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"CMK", + "githuburl":"" + }, + { + "uri":"kms_01_0006.html", + "node_id":"kms_01_0006.xml", + "product_code":"kms", + "code":"6", + "des":"A default key is automatically created by another cloud service using KMS, such as Object Storage Service (OBS). The name of a default key ends with /default.You can use ", + "doc_type":"usermanual", + "kw":"Default Key,Concepts,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Default Key", + "githuburl":"" + }, + { + "uri":"kms_01_0007.html", + "node_id":"kms_01_0007.xml", + "product_code":"kms", + "code":"7", + "des":"Data Encryption Keys (DEKs) are used by users to encrypt data.", + "doc_type":"usermanual", + "kw":"DEK,Concepts,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"DEK", + "githuburl":"" + }, + { + "uri":"kms_01_0008.html", + "node_id":"kms_01_0008.xml", + "product_code":"kms", + "code":"8", + "des":"A Hardware Security Module (HSM) securely produces, stores, manages, and uses keys and provides encryption services.", + "doc_type":"usermanual", + "kw":"HSM,Concepts,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"HSM", + "githuburl":"" + }, + { + "uri":"kms_01_0009.html", + "node_id":"kms_01_0009.xml", + "product_code":"kms", + "code":"9", + "des":"Envelope encryption is an encryption method that enables DEKs to be stored, transmitted, and used in \"envelopes.\" As a result, CMKs are not used to directly encrypt and d", + "doc_type":"usermanual", + "kw":"Envelope Encryption,Concepts,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Envelope Encryption", + "githuburl":"" + }, + { + "uri":"kms_01_0010.html", + "node_id":"kms_01_0010.xml", + "product_code":"kms", + "code":"10", + "des":"A true random number generator (TRNG) is a device that generates unpredictable random numbers by physical procedures instead of computer programs.", + "doc_type":"usermanual", + "kw":"TRNG,Concepts,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"TRNG", + "githuburl":"" + }, + { + "uri":"kms_01_0012.html", + "node_id":"kms_01_0012.xml", + "product_code":"kms", + "code":"11", + "des":"A project is used to group and isolate OpenStack resources, including computing, storage, and network resources. A project can be a department or a project team.Multiple ", + "doc_type":"usermanual", + "kw":"Project,Concepts,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Project", + "githuburl":"" + }, + { + "uri":"kms_01_0047.html", + "node_id":"kms_01_0047.xml", + "product_code":"kms", + "code":"12", + "des":"KMS provides the following functions:Manages custom keys.You can perform the following operations on custom keys on the KMS console or via APIs:Creating, querying, enabli", + "doc_type":"usermanual", + "kw":"Functions,Key Management,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -87,19 +219,16 @@ "githuburl":"" }, { - "uri":"kms_01_0115.html", - "node_id":"kms_01_0115.xml", + "uri":"kms_01_0100.html", + "node_id":"kms_01_0100.xml", "product_code":"kms", - "code":"5", + "code":"13", "des":"By integrating with OBS, EVS, and IMS, you can use KMS to manage the keys of the services or use KMS APIs to encrypt and decrypt local data.By integrating with Cloud Trac", "doc_type":"usermanual", - "kw":"Advantages,KMS,User Guide", + "kw":"Advantages,Key Management,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -108,19 +237,16 @@ "githuburl":"" }, { - "uri":"kms_01_0006.html", - "node_id":"kms_01_0006.xml", + "uri":"kms_01_0046.html", + "node_id":"kms_01_0046.xml", "product_code":"kms", - "code":"6", - "des":"You can use the online tool on the KMS console or call KMS APIs to directly encrypt or decrypt a small amount of data, such as passwords, certificates, or phone numbers. ", + "code":"14", + "des":"KMS can manage CMKs used for data encryption and decryption in Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File S", "doc_type":"usermanual", - "kw":"Application Scenarios,KMS,User Guide", + "kw":"Application Scenarios,Key Management,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -129,187 +255,70 @@ "githuburl":"" }, { - "uri":"kms_01_0016.html", - "node_id":"kms_01_0016.xml", - "product_code":"kms", - "code":"7", - "des":"Cloud services use the envelope encryption technology and call KMS APIs to encrypt service resources. Your CMKs are under your own management. With your grant, cloud serv", - "doc_type":"usermanual", - "kw":"Using KMS,KMS,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Using KMS", - "githuburl":"" - }, - { - "uri":"kms_01_0106.html", - "node_id":"kms_01_0106.xml", - "product_code":"kms", - "code":"8", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"usermanual", - "kw":"Cloud Services with KMS Integrated", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Cloud Services with KMS Integrated", - "githuburl":"" - }, - { - "uri":"kms_01_0007.html", - "node_id":"kms_01_0007.xml", - "product_code":"kms", - "code":"9", - "des":"When using Object Storage Service (OBS) to upload data with server-side encryption, you can select KMS encryption and use the key provided by KMS to encrypt the files to ", - "doc_type":"usermanual", - "kw":"Encrypting Data in OBS,Cloud Services with KMS Integrated,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Encrypting Data in OBS", - "githuburl":"" - }, - { - "uri":"kms_01_0008.html", - "node_id":"kms_01_0008.xml", - "product_code":"kms", - "code":"10", - "des":"When purchasing a disk, you can choose Advanced Settings > Encryption to encrypt the disk using the key provided by KMS. For details, see Figure 1. For more information a", - "doc_type":"usermanual", - "kw":"Encrypting Data in EVS,Cloud Services with KMS Integrated,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Encrypting Data in EVS", - "githuburl":"" - }, - { - "uri":"kms_01_0009.html", - "node_id":"kms_01_0009.xml", - "product_code":"kms", - "code":"11", - "des":"When uploading an image file to Image Management Service (IMS), you can choose to encrypt the image file using a key provided by KMS to protect the file. Figure 1 describ", - "doc_type":"usermanual", - "kw":"Encrypting Data in IMS,Cloud Services with KMS Integrated,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Encrypting Data in IMS", - "githuburl":"" - }, - { - "uri":"kms_01_0116.html", - "node_id":"kms_01_0116.xml", - "product_code":"kms", - "code":"12", - "des":"When creating a file system using the Scalable File Service (SFS), you can select KMS encryption and use the key provided by the KMS to encrypt the file system.For detail", - "doc_type":"usermanual", - "kw":"Encrypting Data in SFS,Cloud Services with KMS Integrated,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Encrypting Data in SFS", - "githuburl":"" - }, - { - "uri":"kms_01_0101.html", - "node_id":"kms_01_0101.xml", - "product_code":"kms", - "code":"13", - "des":"When a user creates a database instance from Relational Database Service (RDS), the user can select Disk encryption and use the key provided by KMS to encrypt the disk of", - "doc_type":"usermanual", - "kw":"Encrypting Data in RDS,Cloud Services with KMS Integrated,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Encrypting Data in RDS", - "githuburl":"" - }, - { - "uri":"kms_01_0199.html", - "node_id":"kms_01_0199.xml", - "product_code":"kms", - "code":"14", - "des":"When a user creates a database instance from DDS, the user can select Disk encryption and use the key provided by KMS to encrypt the disk of the database instance. For mo", - "doc_type":"usermanual", - "kw":"Encrypting Data in DDS,Cloud Services with KMS Integrated,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Encrypting Data in DDS", - "githuburl":"" - }, - { - "uri":"kms_01_0018.html", - "node_id":"kms_01_0018.xml", + "uri":"kms_01_0013.html", + "node_id":"kms_01_0013.xml", "product_code":"kms", "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Accessing and Using KMS", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Accessing and Using KMS", + "githuburl":"" + }, + { + "uri":"kms_01_0014.html", + "node_id":"kms_01_0014.xml", + "product_code":"kms", + "code":"16", + "des":"The cloud service provides a web-based service management platform. You can access KMS using HTTPS-compliant APIs or the management console.Management consoleIf you have ", + "doc_type":"usermanual", + "kw":"How to Access KMS,Accessing and Using KMS,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"How to Access KMS", + "githuburl":"" + }, + { + "uri":"kms_01_0015.html", + "node_id":"kms_01_0015.xml", + "product_code":"kms", + "code":"17", + "des":"Users can upload objects to and download them from Object Storage Service (OBS) in common mode or server-side encryption mode. When users upload objects in encryption mod", + "doc_type":"usermanual", + "kw":"How to Use KMS,Accessing and Using KMS,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"How to Use KMS", + "githuburl":"" + }, + { + "uri":"kms_01_9999.html", + "node_id":"kms_01_9999.xml", + "product_code":"kms", + "code":"18", "des":"If you want to assign different access permissions to employees in an enterprise for the KMS resources purchased on the cloud platform, you can use Identity and Access Ma", "doc_type":"usermanual", "kw":"KMS Permission Management,Service Overview,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -318,40 +327,142 @@ "githuburl":"" }, { - "uri":"kms_01_0015.html", - "node_id":"kms_01_0015.xml", + "uri":"dew_01_0106.html", + "node_id":"dew_01_0106.xml", "product_code":"kms", - "code":"16", - "des":"The cloud service provides a web-based service management platform. You can access KMS using HTTPS-compliant APIs or the management console.Management consoleLog in to th", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", - "kw":"How to Access,Service Overview,User Guide", + "kw":"Cloud Services with KMS Integrated", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"How to Access", + "title":"Cloud Services with KMS Integrated", "githuburl":"" }, { - "uri":"kms_01_0017.html", - "node_id":"kms_01_0017.xml", + "uri":"dew_01_0007.html", + "node_id":"dew_01_0007.xml", "product_code":"kms", - "code":"17", + "code":"20", + "des":"When using Object Storage Service (OBS) to upload data with server-side encryption, you can select SEE-KMS encryption and use the key provided by KMS to encrypt the files", + "doc_type":"usermanual", + "kw":"Encrypting Data in OBS,Cloud Services with KMS Integrated,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Encrypting Data in OBS", + "githuburl":"" + }, + { + "uri":"dew_01_0008.html", + "node_id":"dew_01_0008.xml", + "product_code":"kms", + "code":"21", + "des":"When purchasing a disk, you can choose Advanced Settings > Encryption to encrypt the disk using the key provided by KMS. For details, see Figure 1. For more information a", + "doc_type":"usermanual", + "kw":"Encrypting Data in EVS,Cloud Services with KMS Integrated,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Encrypting Data in EVS", + "githuburl":"" + }, + { + "uri":"dew_01_0009.html", + "node_id":"dew_01_0009.xml", + "product_code":"kms", + "code":"22", + "des":"When uploading an image file to Image Management Service (IMS), you can choose to encrypt the image file using a key provided by KMS to protect the file. Figure 1 describ", + "doc_type":"usermanual", + "kw":"Encrypting Data in IMS,Cloud Services with KMS Integrated,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Encrypting Data in IMS", + "githuburl":"" + }, + { + "uri":"dew_01_0116.html", + "node_id":"dew_01_0116.xml", + "product_code":"kms", + "code":"23", + "des":"When creating a file system using the Scalable File Service (SFS), you can select KMS encryption and use the key provided by the KMS to encrypt the file system. For detai", + "doc_type":"usermanual", + "kw":"Encrypting Data in SFS,Cloud Services with KMS Integrated,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Encrypting Data in SFS", + "githuburl":"" + }, + { + "uri":"dew_01_0101.html", + "node_id":"dew_01_0101.xml", + "product_code":"kms", + "code":"24", + "des":"When a user creates a database instance from Relational Database Service (RDS), the user can select Disk encryption and use the key provided by KMS to encrypt the disk of", + "doc_type":"usermanual", + "kw":"Encrypting Data in RDS,Cloud Services with KMS Integrated,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Encrypting Data in RDS", + "githuburl":"" + }, + { + "uri":"dew_01_0199.html", + "node_id":"dew_01_0199.xml", + "product_code":"kms", + "code":"25", + "des":"When a user creates a database instance from DDS, the user can select Disk encryption and use the key provided by KMS to encrypt the disk of the database instance. For mo", + "doc_type":"usermanual", + "kw":"Encrypting Data in DDS,Cloud Services with KMS Integrated,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Encrypting Data in DDS", + "githuburl":"" + }, + { + "uri":"kms_01_0016.html", + "node_id":"kms_01_0016.xml", + "product_code":"kms", + "code":"26", "des":"Object Storage Service (OBS) is a scalable service that provides secure, reliable, and cost-effective cloud storage for massive amounts of data. KMS provides central mana", "doc_type":"usermanual", "kw":"Related Services,Service Overview,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -360,103 +471,34 @@ "githuburl":"" }, { - "uri":"kms_01_0222.html", - "node_id":"kms_01_0222.xml", + "uri":"kms_01_0018.html", + "node_id":"kms_01_0018.xml", "product_code":"kms", - "code":"18", - "des":"To ensure that your personal data, such as the username, password, and mobile phone number, will not be leaked or obtained by unauthorized or unauthenticated entities or ", - "doc_type":"usermanual", - "kw":"Personal Data Protection Mechanism,Service Overview,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Personal Data Protection Mechanism", - "githuburl":"" - }, - { - "uri":"kms_01_0105.html", - "node_id":"kms_01_0105.xml", - "product_code":"kms", - "code":"19", + "code":"27", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", - "kw":"User Guide", + "kw":"Key Management", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"User Guide", + "title":"Key Management", "githuburl":"" }, { - "uri":"kms_01_0177.html", - "node_id":"kms_01_0177.xml", + "uri":"kms_01_0194.html", + "node_id":"kms_01_0194.xml", "product_code":"kms", - "code":"20", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"28", + "des":"This section describes how to create a custom key on the KMS management console. You can create up to 100 custom keys, excluding default keys.CMKs can be used for:Server-", "doc_type":"usermanual", - "kw":"Key Management Service", + "kw":"Creating a Key,Key Management,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Key Management Service", - "githuburl":"" - }, - { - "uri":"kms_01_7775.html", - "node_id":"kms_01_7775.xml", - "product_code":"kms", - "code":"21", - "des":"CMKs include custom keys and default keys. This section describes how to create, view, enable, disable, schedule the deletion, and cancel the deletion of custom keys.Cust", - "doc_type":"usermanual", - "kw":"Key Types,Key Management Service,User Guide", - "search_title":"", - "metedata":[ - { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Key Types", - "githuburl":"" - }, - { - "uri":"kms_01_0178.html", - "node_id":"kms_01_0178.xml", - "product_code":"kms", - "code":"22", - "des":"This section describes how to create a custom key on the KMS console.Custom keys can be categorized into symmetric keys and asymmetric keys.You can create up to 100 custo", - "doc_type":"usermanual", - "kw":"Creating a Key,Key Management Service,User Guide", - "search_title":"", - "metedata":[ - { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -465,40 +507,34 @@ "githuburl":"" }, { - "uri":"kms_01_0142.html", - "node_id":"kms_01_0142.xml", + "uri":"kms_01_0019.html", + "node_id":"kms_01_0019.xml", "product_code":"kms", - "code":"23", + "code":"29", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", - "kw":"Creating CMKs Using Imported Key Materials", + "kw":"Creating CMKs Using Imported Key Material", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Creating CMKs Using Imported Key Materials", + "title":"Creating CMKs Using Imported Key Material", "githuburl":"" }, { - "uri":"kms_01_0088.html", - "node_id":"kms_01_0088.xml", + "uri":"kms_01_0054.html", + "node_id":"kms_01_0054.xml", "product_code":"kms", - "code":"24", - "des":"A custom key contains key metadata (key ID, key alias, description, key status, and creation date) and key materials used for encrypting and decrypting data.When a user u", + "code":"30", + "des":"The custom key contains key metadata (key ID, key name, description, key status, and creation date) and key materials used for encrypting and decrypting data.When a user ", "doc_type":"usermanual", - "kw":"Overview,Creating CMKs Using Imported Key Materials,User Guide", + "kw":"Overview,Creating CMKs Using Imported Key Material,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -507,61 +543,52 @@ "githuburl":"" }, { - "uri":"kms_01_0089.html", - "node_id":"kms_01_0089.xml", + "uri":"kms_01_0055.html", + "node_id":"kms_01_0055.xml", "product_code":"kms", - "code":"25", - "des":"If you want to use your own key materials instead of the KMS-generated materials, you can use the console to import your key materials to KMS. CMKs created using imported", + "code":"31", + "des":"If you want to use your own key material instead of the KMS-generated material, you can use the console to import your key material to KMS. The keys created using importe", "doc_type":"usermanual", - "kw":"Importing Key Materials,Creating CMKs Using Imported Key Materials,User Guide", + "kw":"Importing a Key Material,Creating CMKs Using Imported Key Material,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Importing Key Materials", + "title":"Importing a Key Material", "githuburl":"" }, { - "uri":"kms_01_0090.html", - "node_id":"kms_01_0090.xml", + "uri":"kms_01_0020.html", + "node_id":"kms_01_0020.xml", "product_code":"kms", - "code":"26", - "des":"When importing key materials, you can specify their expiration time. After the key material expires, KMS deletes it, and the status of the custom key changes to Pending i", + "code":"32", + "des":"When importing key material, you can specify the expiration time. After the key material expires, KMS deletes it, and the status of the custom key changes to Pending impo", "doc_type":"usermanual", - "kw":"Deleting Key Materials,Creating CMKs Using Imported Key Materials,User Guide", + "kw":"Deleting a Key Material,Creating CMKs Using Imported Key Material,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Deleting Key Materials", + "title":"Deleting a Key Material", "githuburl":"" }, { - "uri":"kms_01_0028.html", - "node_id":"kms_01_0028.xml", + "uri":"kms_01_0032.html", + "node_id":"kms_01_0032.xml", "product_code":"kms", - "code":"27", + "code":"33", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", "kw":"Managing CMKs", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -570,124 +597,124 @@ "githuburl":"" }, { - "uri":"kms_01_0179.html", - "node_id":"kms_01_0179.xml", + "uri":"kms_01_0096.html", + "node_id":"kms_01_0096.xml", "product_code":"kms", - "code":"28", - "des":"This section describes how to view the information about the custom key on the KMS console, including the key alias, status, ID, and creation time. The status of a key ca", + "code":"34", + "des":"This section describes how to use the management console to view the information about a custom key, such as its name, status, ID, and creation time. The status of a key ", "doc_type":"usermanual", - "kw":"Viewing a CMK,Managing CMKs,User Guide", + "kw":"Querying a Key,Managing CMKs,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Viewing a CMK", + "title":"Querying a Key", "githuburl":"" }, { - "uri":"kms_01_0029.html", - "node_id":"kms_01_0029.xml", + "uri":"kms_01_0033.html", + "node_id":"kms_01_0033.xml", "product_code":"kms", - "code":"29", - "des":"This section describes how to use the KMS console to enable one or more custom keys. Only enabled custom keys can be used to encrypt or decrypt data. A new custom key is ", + "code":"35", + "des":"Key names help you find custom keys more easily.This section describes how to change the name and description of a custom key on the KMS management console.The name and d", "doc_type":"usermanual", - "kw":"Enabling One or More CMKs,Managing CMKs,User Guide", + "kw":"Changing the Name and Description of a Key,Managing CMKs,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Enabling One or More CMKs", + "title":"Changing the Name and Description of a Key", "githuburl":"" }, { - "uri":"kms_01_0030.html", - "node_id":"kms_01_0030.xml", + "uri":"kms_01_0034.html", + "node_id":"kms_01_0034.xml", "product_code":"kms", - "code":"30", - "des":"This section describes how to use the KMS console to disable one or more custom keys, thereby protecting data in urgent cases.After being disabled, a custom key cannot be", + "code":"36", + "des":"This section describes how to use the management console to enable one or multiple custom keys. Only enabled keys can be used to encrypt/decrypt data. A new custom key is", "doc_type":"usermanual", - "kw":"Disabling One or More CMKs,Managing CMKs,User Guide", + "kw":"Enabling a Key,Managing CMKs,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Disabling One or More CMKs", + "title":"Enabling a Key", "githuburl":"" }, { - "uri":"kms_01_0031.html", - "node_id":"kms_01_0031.xml", + "uri":"kms_01_0035.html", + "node_id":"kms_01_0035.xml", "product_code":"kms", - "code":"31", - "des":"Before deleting the CMK, confirm that it is not in use and will not be used.The key to be deleted is in Enabled, Disabled, or Pending import status.A key will not be dele", + "code":"37", + "des":"This section describes how to use the management console to disable one or multiple custom keys, thereby protecting data in urgent cases.After being disabled, a custom ke", "doc_type":"usermanual", - "kw":"Deleting One or More CMKs,Managing CMKs,User Guide", + "kw":"Disabling a Key,Managing CMKs,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Deleting One or More CMKs", + "title":"Disabling a Key", "githuburl":"" }, { - "uri":"kms_01_0032.html", - "node_id":"kms_01_0032.xml", + "uri":"kms_01_0072.html", + "node_id":"kms_01_0072.xml", "product_code":"kms", - "code":"32", - "des":"This section describes how to use the KMS console to cancel the scheduled deletion of one or more custom keys prior to deletion execution. After the cancellation, the key", + "code":"38", + "des":"This section describes how to use the management console to schedule the deletion of one or multiple unwanted custom keys.If deletion is scheduled for a key, the deletion", "doc_type":"usermanual", - "kw":"Canceling the Scheduled Deletion of One or More CMKs,Managing CMKs,User Guide", + "kw":"Deleting a Key,Managing CMKs,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Canceling the Scheduled Deletion of One or More CMKs", + "title":"Deleting a Key", + "githuburl":"" + }, + { + "uri":"kms_01_0036.html", + "node_id":"kms_01_0036.xml", + "product_code":"kms", + "code":"39", + "des":"This section describes how to use the management console to cancel the scheduled deletion of a custom key prior to deletion execution.The key for which you want to cancel", + "doc_type":"usermanual", + "kw":"Canceling the Scheduled Deletion of a Key,Managing CMKs,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Canceling the Scheduled Deletion of a Key", "githuburl":"" }, { "uri":"kms_01_0021.html", "node_id":"kms_01_0021.xml", "product_code":"kms", - "code":"33", + "code":"40", "des":"This section describes how to configure the Simple Message Notification (SMN) function on the Cloud Trace Service (CTS) console.Decryption will fail if the key used for e", "doc_type":"usermanual", - "kw":"Configuring SMN,Key Management Service,User Guide", + "kw":"Configuring SMN,Key Management,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -699,37 +726,49 @@ "uri":"kms_01_0022.html", "node_id":"kms_01_0022.xml", "product_code":"kms", - "code":"34", - "des":"This section describes how to use the online tool to encrypt or decrypt small-size data (4 KB or smaller) on the KMS console.The custom key is in Enabled status.Default k", + "code":"41", + "des":"This section describes how to use an online tool to encrypt and decrypt data less than or equal to 4 KB on the KMS console.The desired custom key is in Enabled status.Def", "doc_type":"usermanual", - "kw":"Using the Online Tool to Encrypt and Decrypt Small-Size Data,Key Management Service,User Guide", + "kw":"Encrypting and Decrypting Small-Size Data Online,Key Management,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "opensource":"true", - "IsBot":"Yes", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Using the Online Tool to Encrypt and Decrypt Small-Size Data", + "title":"Encrypting and Decrypting Small-Size Data Online", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002203211100.html", + "node_id":"en-us_topic_0000002203211100.xml", + "product_code":"kms", + "code":"42", + "des":"An alias is an identifier of a key. You can use the alias as the key ID during API calling. The original key alias is not used as the key name.This section describes how ", + "doc_type":"usermanual", + "kw":"Key Alias,Key Management,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Key Alias", "githuburl":"" }, { "uri":"kms_01_0023.html", "node_id":"kms_01_0023.xml", "product_code":"kms", - "code":"35", + "code":"43", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", "kw":"Managing Tags", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -741,16 +780,13 @@ "uri":"kms_01_0024.html", "node_id":"kms_01_0024.xml", "product_code":"kms", - "code":"36", - "des":"Tags are used to identify keys. You can add tags to custom keys so that you can classify custom keys, trace them, and collect their usage status according to the tags.Tag", + "code":"44", + "des":"Tags are used to identify custom keys. You can add tags to custom keys so that you can classify custom keys, trace them, and collect their usage status according to the t", "doc_type":"usermanual", "kw":"Adding a Tag,Managing Tags,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -758,20 +794,35 @@ "title":"Adding a Tag", "githuburl":"" }, + { + "uri":"kms_01_0025.html", + "node_id":"kms_01_0025.xml", + "product_code":"kms", + "code":"45", + "des":"This section describes how to search for tags through KMS. You can search for tags of all custom keys that meet the search criteria in the current project.Tags have been ", + "doc_type":"usermanual", + "kw":"Searching for a Custom Key by Tag,Managing Tags,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Searching for a Custom Key by Tag", + "githuburl":"" + }, { "uri":"kms_01_0026.html", "node_id":"kms_01_0026.xml", "product_code":"kms", - "code":"37", - "des":"This section describes how to modify tag values on the KMS console.", + "code":"46", + "des":"This section describes how to modify tag values on the KMS management console.", "doc_type":"usermanual", "kw":"Modifying Tag Values,Managing Tags,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -783,16 +834,13 @@ "uri":"kms_01_0027.html", "node_id":"kms_01_0027.xml", "product_code":"kms", - "code":"38", - "des":"This section describes how to delete tags on the KMS console.", + "code":"47", + "des":"This section describes how to delete tags on the KMS management console.", "doc_type":"usermanual", "kw":"Deleting Tags,Managing Tags,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -804,58 +852,49 @@ "uri":"kms_01_0138.html", "node_id":"kms_01_0138.xml", "product_code":"kms", - "code":"39", + "code":"48", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", - "kw":"Rotating CMKs", + "kw":"Rotating Keys", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Rotating CMKs", + "title":"Rotating Keys", "githuburl":"" }, { "uri":"kms_01_0094.html", "node_id":"kms_01_0094.xml", "product_code":"kms", - "code":"40", + "code":"49", "des":"Keys that are widely or repeatedly used are insecure. To enhance the security of encryption keys, you are advised to periodically rotate keys and change their key materia", "doc_type":"usermanual", - "kw":"About Key Rotation,Rotating CMKs,User Guide", + "kw":"Key Rotation Overview,Rotating Keys,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"About Key Rotation", + "title":"Key Rotation Overview", "githuburl":"" }, { "uri":"kms_01_0139.html", "node_id":"kms_01_0139.xml", "product_code":"kms", - "code":"41", - "des":"This section describes how to enable rotation for a key on the KMS console.By default, automatic key rotation is disabled for a custom key. Every time you enable key rota", + "code":"50", + "des":"This section describes how to enable rotation for a key on the KMS console.By default, automatic key rotation is disabled for a CMK. Every time you enable key rotation, K", "doc_type":"usermanual", - "kw":"Enabling Key Rotation,Rotating CMKs,User Guide", + "kw":"Enabling Key Rotation,Rotating Keys,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -864,19 +903,16 @@ "githuburl":"" }, { - "uri":"kms_01_7774.html", - "node_id":"kms_01_7774.xml", + "uri":"kms_01_0095.html", + "node_id":"kms_01_0095.xml", "product_code":"kms", - "code":"42", - "des":"This section describes how to disable rotation for a key on the KMS console.The key is enabled.The Origin of the key is KMS.Key rotation has been enabled.", + "code":"51", + "des":"This section describes how to disable rotation for a key on the KMS console.The key is in Enabled status.The Origin of the key is KMS.Key rotation has been enabled.", "doc_type":"usermanual", - "kw":"Disabling Key Rotation,Rotating CMKs,User Guide", + "kw":"Disabling Key Rotation,Rotating Keys,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -885,19 +921,16 @@ "githuburl":"" }, { - "uri":"kms_01_0095.html", - "node_id":"kms_01_0095.xml", + "uri":"kms_01_0028.html", + "node_id":"kms_01_0028.xml", "product_code":"kms", - "code":"43", + "code":"52", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", "kw":"Managing a Grant", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -906,19 +939,16 @@ "githuburl":"" }, { - "uri":"kms_01_0096.html", - "node_id":"kms_01_0096.xml", + "uri":"kms_01_0029.html", + "node_id":"kms_01_0029.xml", "product_code":"kms", - "code":"44", - "des":"You can create grants for other users or accounts to use the custom key. You can create a maximum of 100 grants on a custom key.You have obtained the ID of the grantee (u", + "code":"53", + "des":"You can create grants for other users to use the custom key. You can create a maximum of 100 grants for a custom key.The owner of a custom key can create a grant for the ", "doc_type":"usermanual", "kw":"Creating a Grant,Managing a Grant,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -927,19 +957,16 @@ "githuburl":"" }, { - "uri":"kms_01_0097.html", - "node_id":"kms_01_0097.xml", + "uri":"kms_01_0030.html", + "node_id":"kms_01_0030.xml", "product_code":"kms", - "code":"45", - "des":"You can view the details about a custom key grant on the KMS console, such as the grant ID, grantee user ID, granted operation, and creation time.You have created a grant", + "code":"54", + "des":"This section describes how to view the details about a grant, such as the grant ID, grantee user ID, granted operation, and creation time.You have created a grant.Table 1", "doc_type":"usermanual", "kw":"Querying a Grant,Managing a Grant,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -948,19 +975,16 @@ "githuburl":"" }, { - "uri":"kms_01_0098.html", - "node_id":"kms_01_0098.xml", + "uri":"kms_01_0031.html", + "node_id":"kms_01_0031.xml", "product_code":"kms", - "code":"46", - "des":"You can revoke a grant on the KMS console in either of the following scenarios:A grantee does not need the custom key grant. (The grantee can either tell the user who has", + "code":"55", + "des":"You can revoke a grant in either of the following scenarios:A grantee does not need the custom key grant. (The grantee can either tell the user who has created the grant ", "doc_type":"usermanual", "kw":"Revoking a Grant,Managing a Grant,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -969,40 +993,34 @@ "githuburl":"" }, { - "uri":"kms_01_0133.html", - "node_id":"kms_01_0133.xml", + "uri":"kms_01_9998.html", + "node_id":"kms_01_9998.xml", "product_code":"kms", - "code":"47", + "code":"56", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", - "kw":"Permission Control", + "kw":"Permissions Management", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"Permission Control", + "title":"Permissions Management", "githuburl":"" }, { - "uri":"kms_01_0135.html", - "node_id":"kms_01_0135.xml", + "uri":"kms_01_9997.html", + "node_id":"kms_01_9997.xml", "product_code":"kms", - "code":"48", + "code":"57", "des":"This section describes IAM's fine-grained permissions management for your KMS resources. With IAM, you can:Create IAM users for employees based on the organizational stru", "doc_type":"usermanual", - "kw":"Creating a User and Authorizing the User the Permission to Access KMS,Permission Control,User Guide", + "kw":"Creating a User and Authorizing the User the Permission to Access KMS,Permissions Management,User Gu", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -1011,19 +1029,16 @@ "githuburl":"" }, { - "uri":"kms_01_0161.html", - "node_id":"kms_01_0161.xml", + "uri":"kms_01_9996.html", + "node_id":"kms_01_9996.xml", "product_code":"kms", - "code":"49", - "des":"Custom policies can be created as a supplement to the system policies of KMS. For details about the actions supported by custom policies, see \"Permissions Policies and Su", + "code":"58", + "des":"Custom policies can be created as a supplement to the system policies of KMSfilter. For details about the actions supported by custom policies, see \"Permissions Policies ", "doc_type":"usermanual", - "kw":"Creating a Custom KMS Policy,Permission Control,User Guide", + "kw":"Creating a Custom KMS Policy,Permissions Management,User Guide", "search_title":"", "metedata":[ { - "IsMulti":"No", - "IsBot":"Yes", - "opensource":"true", "prodname":"kms", "documenttype":"usermanual" } @@ -1032,19 +1047,16 @@ "githuburl":"" }, { - "uri":"kms_01_0092.html", - "node_id":"kms_01_0092.xml", + "uri":"kms_01_0037.html", + "node_id":"kms_01_0037.xml", "product_code":"kms", - "code":"50", + "code":"59", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", "kw":"FAQs", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -1053,40 +1065,16 @@ "githuburl":"" }, { - "uri":"kms_01_0048.html", - "node_id":"kms_01_0048.xml", + "uri":"kms_01_0073.html", + "node_id":"kms_01_0073.xml", "product_code":"kms", - "code":"51", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"60", + "des":"Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).This service", "doc_type":"usermanual", - "kw":"KMS Related", + "kw":"What Is Key Management Service?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"KMS Related", - "githuburl":"" - }, - { - "uri":"kms_01_0047.html", - "node_id":"kms_01_0047.xml", - "product_code":"kms", - "code":"52", - "des":"KMS is a secure, reliable, and easy-to-use cloud service that helps users create, manage, and protect keys in a centralized manner.It uses Hardware Security Modules (HSMs", - "doc_type":"usermanual", - "kw":"What Is Key Management Service?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -1095,19 +1083,16 @@ "githuburl":"" }, { - "uri":"kms_01_0044.html", - "node_id":"kms_01_0044.xml", + "uri":"kms_01_0074.html", + "node_id":"kms_01_0074.xml", "product_code":"kms", - "code":"53", - "des":"A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user on KMS. It is used to encrypt and protect DEKs. One CMK can be used to encrypt one or more DEK", + "code":"61", + "des":"A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user using KMS. It is used to encrypt and protect Data Encryption Keys (DEKs). One CMK can be used ", "doc_type":"usermanual", - "kw":"What Is a Customer Master Key?,KMS Related,User Guide", + "kw":"What Is a Customer Master Key?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", "prodname":"kms", "documenttype":"usermanual" } @@ -1116,40 +1101,16 @@ "githuburl":"" }, { - "uri":"kms_01_0045.html", - "node_id":"kms_01_0045.xml", + "uri":"kms_01_0101.html", + "node_id":"kms_01_0101.xml", "product_code":"kms", - "code":"54", - "des":"A default key is automatically created by another cloud service using KMS, such as Object Storage Service (OBS). The alias of a default key ends with /default.You can use", - "doc_type":"usermanual", - "kw":"What Is a Default Key?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"What Is a Default Key?", - "githuburl":"" - }, - { - "uri":"kms_01_0055.html", - "node_id":"kms_01_0055.xml", - "product_code":"kms", - "code":"55", + "code":"62", "des":"The following table describes the differences between a custom key and a default key.", "doc_type":"usermanual", - "kw":"What Are the Differences Between a Custom Key and a Default Key?,KMS Related,User Guide", + "kw":"What Are the Differences Between a Custom Key and a Default Key?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -1158,19 +1119,16 @@ "githuburl":"" }, { - "uri":"kms_01_0046.html", - "node_id":"kms_01_0046.xml", + "uri":"kms_01_0038.html", + "node_id":"kms_01_0038.xml", "product_code":"kms", - "code":"56", + "code":"63", "des":"A data encryption key (DEK) is used to encrypt data.", "doc_type":"usermanual", - "kw":"What Is a Data Encryption Key?,KMS Related,User Guide", + "kw":"What Is a Data Encryption Key?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -1179,40 +1137,16 @@ "githuburl":"" }, { - "uri":"kms_01_0049.html", - "node_id":"kms_01_0049.xml", + "uri":"kms_01_0040.html", + "node_id":"kms_01_0040.xml", "product_code":"kms", - "code":"57", - "des":"The decision to delete a CMK should be considered with great caution. Before deletion, confirm that the CMK's encrypted data has all been migrated. As soon as the CMK is ", + "code":"64", + "des":"Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File Service (SFS), and Relational Database Service (RDS) can use KMS", "doc_type":"usermanual", - "kw":"Why Cannot I Delete a CMK Immediately?,KMS Related,User Guide", + "kw":"Which Cloud Services Can Use KMS for Encryption?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Why Cannot I Delete a CMK Immediately?", - "githuburl":"" - }, - { - "uri":"kms_01_0050.html", - "node_id":"kms_01_0050.xml", - "product_code":"kms", - "code":"58", - "des":"Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File Service (SFS), Document Database Service (DDS), and Relational D", - "doc_type":"usermanual", - "kw":"Which Cloud Services Can Use KMS for Encryption?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", "prodname":"kms", "documenttype":"usermanual" } @@ -1221,61 +1155,52 @@ "githuburl":"" }, { - "uri":"kms_01_0053.html", - "node_id":"kms_01_0053.xml", + "uri":"kms_01_0093.html", + "node_id":"kms_01_0093.xml", "product_code":"kms", - "code":"59", - "des":"Services (such as OBS, IMS, EVS, SFS, DDS, and RDS) use the envelope encryption method provided by KMS to protect data.Envelope encryption is an encryption method that en", + "code":"65", + "des":"No.The pending period of a key from its scheduling till its deletion is not charged.However, if you cancel the scheduled deletion, the charging resumes from the time when", "doc_type":"usermanual", - "kw":"How Do Cloud Services Use KMS to Encrypt Data?,KMS Related,User Guide", + "kw":"Will a Key Be Charged After It Is Scheduled to Delete?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"How Do Cloud Services Use KMS to Encrypt Data?", + "title":"Will a Key Be Charged After It Is Scheduled to Delete?", "githuburl":"" }, { - "uri":"kms_01_0054.html", - "node_id":"kms_01_0054.xml", + "uri":"kms_01_0039.html", + "node_id":"kms_01_0039.xml", "product_code":"kms", - "code":"60", - "des":"Envelope encryption is the practice of encrypting data with a DEK and then encrypting the DEK with a root key that you can fully manage. In this case, CMKs are not requir", + "code":"66", + "des":"The decision to delete a CMK should be taken with caution. Before deletion, confirm that the CMK's encrypted data has all been migrated. Once the CMK is deleted, you will", "doc_type":"usermanual", - "kw":"What Are the Benefits of Envelope Encryption?,KMS Related,User Guide", + "kw":"Why Can't I Delete a CMK Immediately?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } ], - "title":"What Are the Benefits of Envelope Encryption?", + "title":"Why Can't I Delete a CMK Immediately?", "githuburl":"" }, { - "uri":"kms_01_0056.html", - "node_id":"kms_01_0056.xml", + "uri":"kms_01_0198.html", + "node_id":"kms_01_0198.xml", "product_code":"kms", - "code":"61", - "des":"Yes.You can create a maximum of 100 custom keys, including those in enabled, disabled, and pending deletion states. Default keys are not included.", + "code":"67", + "des":"There is a limit on the number of custom keys that can be created on KMS.You can create a maximum of 100 custom keys, including those in enabled, disabled, and pending de", "doc_type":"usermanual", - "kw":"Is There a Limit on the Number of Custom Keys That I Can Create on KMS?,KMS Related,User Guide", + "kw":"Is There a Limit on the Number of Custom Keys That I Can Create on KMS?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", "prodname":"kms", "documenttype":"usermanual" } @@ -1284,19 +1209,34 @@ "githuburl":"" }, { - "uri":"kms_01_0058.html", - "node_id":"kms_01_0058.xml", + "uri":"kms_01_0106.html", + "node_id":"kms_01_0106.xml", "product_code":"kms", - "code":"62", - "des":"No.To ensure CMK security, users can only create and use CMKs in KMS.", + "code":"68", + "des":"Envelope encryption is the practice of encrypting data with a DEK and then encrypting the DEK with a root key that you can fully manage. In this case, CMKs are not requir", "doc_type":"usermanual", - "kw":"Can I Export a CMK from KMS?,KMS Related,User Guide", + "kw":"What Are the Benefits of Envelope Encryption?,FAQs,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"What Are the Benefits of Envelope Encryption?", + "githuburl":"" + }, + { + "uri":"kms_01_0102.html", + "node_id":"kms_01_0102.xml", + "product_code":"kms", + "code":"69", + "des":"No.To ensure CMK security, users can only create and use CMKs in KMS.", + "doc_type":"usermanual", + "kw":"Can I Export a CMK from KMS?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -1305,40 +1245,16 @@ "githuburl":"" }, { - "uri":"kms_01_0059.html", - "node_id":"kms_01_0059.xml", + "uri":"kms_01_0107.html", + "node_id":"kms_01_0107.xml", "product_code":"kms", - "code":"63", - "des":"No.If you have permanently deleted your custom key, the data encrypted using it cannot be decrypted. Before the scheduled deletion date of the custom key, you can cancel ", + "code":"70", + "des":"You can use the online tool to encrypt or decrypt data in the following procedures:The key you clicked is used for encryption.To clear your input, click Clear.To copy the", "doc_type":"usermanual", - "kw":"Can I Decrypt My Data if I Permanently Delete My Custom Key?,KMS Related,User Guide", + "kw":"How Do I Use the Online Tool to Encrypt or Decrypt Small Volumes of Data?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Can I Decrypt My Data if I Permanently Delete My Custom Key?", - "githuburl":"" - }, - { - "uri":"kms_01_0060.html", - "node_id":"kms_01_0060.xml", - "product_code":"kms", - "code":"64", - "des":"You can use the online tool to encrypt or decrypt data in the following procedures:Use the current CMK to encrypt the data.You can click Clear to clear the entered data.Y", - "doc_type":"usermanual", - "kw":"How Do I Use the Online Tool to Encrypt or Decrypt Small Volumes of Data?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", "prodname":"kms", "documenttype":"usermanual" } @@ -1347,19 +1263,16 @@ "githuburl":"" }, { - "uri":"kms_01_0062.html", - "node_id":"kms_01_0062.xml", + "uri":"kms_01_0114.html", + "node_id":"kms_01_0114.xml", "product_code":"kms", - "code":"65", + "code":"71", "des":"No.Keys created using KMS-generated materials cannot be updated. You can only use KMS to create new CMKs to encrypt and decrypt data.", "doc_type":"usermanual", - "kw":"Can I Update CMKs Created by KMS-Generated Key Materials?,KMS Related,User Guide", + "kw":"Can I Update CMKs Created by KMS-Generated Key Materials?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -1368,166 +1281,16 @@ "githuburl":"" }, { - "uri":"kms_01_0102.html", - "node_id":"kms_01_0102.xml", - "product_code":"kms", - "code":"66", - "des":"If you do not want to use KMS-generated key materials, you can import your own key materials to create a CMK. Such a CMK allows deletion of only the key materials when yo", - "doc_type":"usermanual", - "kw":"When Should I Use a CMK Created with Imported Key Materials?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"When Should I Use a CMK Created with Imported Key Materials?", - "githuburl":"" - }, - { - "uri":"kms_01_0103.html", - "node_id":"kms_01_0103.xml", - "product_code":"kms", - "code":"67", - "des":"You can import 256-bit symmetric keys.", - "doc_type":"usermanual", - "kw":"What Types of Keys Can I Import?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"What Types of Keys Can I Import?", - "githuburl":"" - }, - { - "uri":"kms_01_0104.html", - "node_id":"kms_01_0104.xml", - "product_code":"kms", - "code":"68", - "des":"You can import the backup key materials from your local device again.Before importing key materials, you are advised to back up the materials. The materials to be re-impo", - "doc_type":"usermanual", - "kw":"What Should I Do When I Accidentally Delete Key Materials?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"What Should I Do When I Accidentally Delete Key Materials?", - "githuburl":"" - }, - { - "uri":"kms_01_0182.html", - "node_id":"kms_01_0182.xml", - "product_code":"kms", - "code":"69", - "des":"A message indicating lack of permissions is displayed when you attempt to perform operations on keys, such as view, create, or import keys.Your account is not associated ", - "doc_type":"usermanual", - "kw":"What Should I Do If I Do Not Have the Permissions to Perform Operations on KMS?,KMS Related,User Gui", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"What Should I Do If I Do Not Have the Permissions to Perform Operations on KMS?", - "githuburl":"" - }, - { - "uri":"kms_01_0186.html", - "node_id":"kms_01_0186.xml", - "product_code":"kms", - "code":"70", - "des":"By default, the -id-aes256-wrap-pad algorithm is not enabled in OpenSSL. To wrap a key, upgrade OpenSSL to the latest version and patch it first.Use bash commands to crea", - "doc_type":"usermanual", - "kw":"Why Can't I Wrap Asymmetric Keys by Using -id-aes256-wrap-pad in OpenSSL?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Why Can't I Wrap Asymmetric Keys by Using -id-aes256-wrap-pad in OpenSSL?", - "githuburl":"" - }, - { - "uri":"kms_01_0189.html", - "node_id":"kms_01_0189.xml", - "product_code":"kms", - "code":"71", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"usermanual", - "kw":"Key Algorithms Supported by KMS,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsMulti":"No", - "IsBot":"Yes", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Key Algorithms Supported by KMS", - "githuburl":"" - }, - { - "uri":"kms_01_0215.html", - "node_id":"kms_01_0215.xml", + "uri":"kms_01_0193.html", + "node_id":"kms_01_0193.xml", "product_code":"kms", "code":"72", - "des":"The basic length of the ciphertext returned by the encrypt-data API is 124 bytes. The ciphertext consists of multiple fields, including the key ID, encryption algorithm, ", - "doc_type":"usermanual", - "kw":"What Is the Relationship Between the Ciphertext and Plaintext Returned by the encrypt-data API?,KMS ", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"What Is the Relationship Between the Ciphertext and Plaintext Returned by the encrypt-data API?", - "githuburl":"" - }, - { - "uri":"kms_01_0227.html", - "node_id":"kms_01_0227.xml", - "product_code":"kms", - "code":"73", "des":"The mechanism of KMS prevents anyone from accessing your keys in plaintext. KMS relies on hardware security modules (HSMs) that safeguard the confidentiality and integrit", "doc_type":"usermanual", - "kw":"How Does KMS Protect My Keys?,KMS Related,User Guide", + "kw":"How Does KMS Protect My Keys?,FAQs,User Guide", "search_title":"", "metedata":[ { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", "prodname":"kms", "documenttype":"usermanual" } @@ -1536,31 +1299,10 @@ "githuburl":"" }, { - "uri":"kms_01_0330.html", - "node_id":"kms_01_0330.xml", + "uri":"kms_01_0043.html", + "node_id":"kms_01_0043.xml", "product_code":"kms", - "code":"74", - "des":"Imported keys do not support rotation. After the imported key materials are deleted, ensure that the same key materials are imported.", - "doc_type":"usermanual", - "kw":"Does an Imported Key Support Rotation?,KMS Related,User Guide", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "IsBot":"Yes", - "IsMulti":"No", - "prodname":"kms", - "documenttype":"usermanual" - } - ], - "title":"Does an Imported Key Support Rotation?", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000001682248672.html", - "node_id":"en-us_topic_0000001682248672.xml", - "product_code":"kms", - "code":"75", + "code":"73", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"usermanual", "kw":"Change History,User Guide", @@ -1573,5 +1315,23 @@ ], "title":"Change History", "githuburl":"" + }, + { + "uri":"kms_01_0044.html", + "node_id":"kms_01_0044.xml", + "product_code":"kms", + "code":"74", + "des":"For details about the glossaries in this document, see Glossary.", + "doc_type":"usermanual", + "kw":"Glossary,User Guide", + "search_title":"", + "metedata":[ + { + "prodname":"kms", + "documenttype":"usermanual" + } + ], + "title":"Glossary", + "githuburl":"" } ] \ No newline at end of file diff --git a/docs/kms/umn/CLASS.TXT.json b/docs/kms/umn/CLASS.TXT.json index 744f8464b..5939d2747 100644 --- a/docs/kms/umn/CLASS.TXT.json +++ b/docs/kms/umn/CLASS.TXT.json @@ -3,16 +3,16 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", "title":"Service Overview", - "uri":"kms_01_0091.html", + "uri":"kms_01_0109.html", "doc_type":"usermanual", "p_code":"", "code":"1" }, { - "desc":"Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).KMS uses har", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", - "title":"Key Management Service", - "uri":"kms_01_0299.html", + "title":"Key Management", + "uri":"kms_01_0045.html", "doc_type":"usermanual", "p_code":"1", "code":"2" @@ -20,143 +20,143 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", - "title":"KMS", - "uri":"kms_01_0121.html", + "title":"Concepts", + "uri":"kms_01_0003.html", "doc_type":"usermanual", - "p_code":"1", + "p_code":"2", "code":"3" }, { - "desc":"KMS is a secure, reliable, and easy-to-use cloud service that helps users create, manage, and protect keys in a centralized manner.It uses Hardware Security Modules (HSMs", + "desc":"Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).This service", "product_code":"kms", - "title":"Functions", - "uri":"kms_01_0001.html", + "title":"KMS", + "uri":"kms_01_0004.html", "doc_type":"usermanual", "p_code":"3", "code":"4" }, { - "desc":"By integrating with OBS, EVS, and IMS, you can use KMS to manage the keys of the services or use KMS APIs to encrypt and decrypt local data.By integrating with Cloud Trac", + "desc":"A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user using KMS. It is used to encrypt and protect Data Encryption Keys (DEKs). One CMK can be used ", "product_code":"kms", - "title":"Advantages", - "uri":"kms_01_0115.html", + "title":"CMK", + "uri":"kms_01_0005.html", "doc_type":"usermanual", "p_code":"3", "code":"5" }, { - "desc":"You can use the online tool on the KMS console or call KMS APIs to directly encrypt or decrypt a small amount of data, such as passwords, certificates, or phone numbers. ", + "desc":"A default key is automatically created by another cloud service using KMS, such as Object Storage Service (OBS). The name of a default key ends with /default.You can use ", "product_code":"kms", - "title":"Application Scenarios", + "title":"Default Key", "uri":"kms_01_0006.html", "doc_type":"usermanual", "p_code":"3", "code":"6" }, { - "desc":"Cloud services use the envelope encryption technology and call KMS APIs to encrypt service resources. Your CMKs are under your own management. With your grant, cloud serv", + "desc":"Data Encryption Keys (DEKs) are used by users to encrypt data.", "product_code":"kms", - "title":"Using KMS", - "uri":"kms_01_0016.html", + "title":"DEK", + "uri":"kms_01_0007.html", "doc_type":"usermanual", "p_code":"3", "code":"7" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"A Hardware Security Module (HSM) securely produces, stores, manages, and uses keys and provides encryption services.", "product_code":"kms", - "title":"Cloud Services with KMS Integrated", - "uri":"kms_01_0106.html", + "title":"HSM", + "uri":"kms_01_0008.html", "doc_type":"usermanual", "p_code":"3", "code":"8" }, { - "desc":"When using Object Storage Service (OBS) to upload data with server-side encryption, you can select KMS encryption and use the key provided by KMS to encrypt the files to ", + "desc":"Envelope encryption is an encryption method that enables DEKs to be stored, transmitted, and used in \"envelopes.\" As a result, CMKs are not used to directly encrypt and d", "product_code":"kms", - "title":"Encrypting Data in OBS", - "uri":"kms_01_0007.html", + "title":"Envelope Encryption", + "uri":"kms_01_0009.html", "doc_type":"usermanual", - "p_code":"8", + "p_code":"3", "code":"9" }, { - "desc":"When purchasing a disk, you can choose Advanced Settings > Encryption to encrypt the disk using the key provided by KMS. For details, see Figure 1. For more information a", + "desc":"A true random number generator (TRNG) is a device that generates unpredictable random numbers by physical procedures instead of computer programs.", "product_code":"kms", - "title":"Encrypting Data in EVS", - "uri":"kms_01_0008.html", + "title":"TRNG", + "uri":"kms_01_0010.html", "doc_type":"usermanual", - "p_code":"8", + "p_code":"3", "code":"10" }, { - "desc":"When uploading an image file to Image Management Service (IMS), you can choose to encrypt the image file using a key provided by KMS to protect the file. Figure 1 describ", + "desc":"A project is used to group and isolate OpenStack resources, including computing, storage, and network resources. A project can be a department or a project team.Multiple ", "product_code":"kms", - "title":"Encrypting Data in IMS", - "uri":"kms_01_0009.html", + "title":"Project", + "uri":"kms_01_0012.html", "doc_type":"usermanual", - "p_code":"8", + "p_code":"3", "code":"11" }, { - "desc":"When creating a file system using the Scalable File Service (SFS), you can select KMS encryption and use the key provided by the KMS to encrypt the file system.For detail", + "desc":"KMS provides the following functions:Manages custom keys.You can perform the following operations on custom keys on the KMS console or via APIs:Creating, querying, enabli", "product_code":"kms", - "title":"Encrypting Data in SFS", - "uri":"kms_01_0116.html", + "title":"Functions", + "uri":"kms_01_0047.html", "doc_type":"usermanual", - "p_code":"8", + "p_code":"2", "code":"12" }, { - "desc":"When a user creates a database instance from Relational Database Service (RDS), the user can select Disk encryption and use the key provided by KMS to encrypt the disk of", + "desc":"By integrating with OBS, EVS, and IMS, you can use KMS to manage the keys of the services or use KMS APIs to encrypt and decrypt local data.By integrating with Cloud Trac", "product_code":"kms", - "title":"Encrypting Data in RDS", - "uri":"kms_01_0101.html", + "title":"Advantages", + "uri":"kms_01_0100.html", "doc_type":"usermanual", - "p_code":"8", + "p_code":"2", "code":"13" }, { - "desc":"When a user creates a database instance from DDS, the user can select Disk encryption and use the key provided by KMS to encrypt the disk of the database instance. For mo", + "desc":"KMS can manage CMKs used for data encryption and decryption in Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File S", "product_code":"kms", - "title":"Encrypting Data in DDS", - "uri":"kms_01_0199.html", + "title":"Application Scenarios", + "uri":"kms_01_0046.html", "doc_type":"usermanual", - "p_code":"8", + "p_code":"2", "code":"14" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"kms", + "title":"Accessing and Using KMS", + "uri":"kms_01_0013.html", + "doc_type":"usermanual", + "p_code":"2", + "code":"15" + }, + { + "desc":"The cloud service provides a web-based service management platform. You can access KMS using HTTPS-compliant APIs or the management console.Management consoleIf you have ", + "product_code":"kms", + "title":"How to Access KMS", + "uri":"kms_01_0014.html", + "doc_type":"usermanual", + "p_code":"15", + "code":"16" + }, + { + "desc":"Users can upload objects to and download them from Object Storage Service (OBS) in common mode or server-side encryption mode. When users upload objects in encryption mod", + "product_code":"kms", + "title":"How to Use KMS", + "uri":"kms_01_0015.html", + "doc_type":"usermanual", + "p_code":"15", + "code":"17" + }, { "desc":"If you want to assign different access permissions to employees in an enterprise for the KMS resources purchased on the cloud platform, you can use Identity and Access Ma", "product_code":"kms", "title":"KMS Permission Management", - "uri":"kms_01_0018.html", - "doc_type":"usermanual", - "p_code":"1", - "code":"15" - }, - { - "desc":"The cloud service provides a web-based service management platform. You can access KMS using HTTPS-compliant APIs or the management console.Management consoleLog in to th", - "product_code":"kms", - "title":"How to Access", - "uri":"kms_01_0015.html", - "doc_type":"usermanual", - "p_code":"1", - "code":"16" - }, - { - "desc":"Object Storage Service (OBS) is a scalable service that provides secure, reliable, and cost-effective cloud storage for massive amounts of data. KMS provides central mana", - "product_code":"kms", - "title":"Related Services", - "uri":"kms_01_0017.html", - "doc_type":"usermanual", - "p_code":"1", - "code":"17" - }, - { - "desc":"To ensure that your personal data, such as the username, password, and mobile phone number, will not be leaked or obtained by unauthorized or unauthenticated entities or ", - "product_code":"kms", - "title":"Personal Data Protection Mechanism", - "uri":"kms_01_0222.html", + "uri":"kms_01_9999.html", "doc_type":"usermanual", "p_code":"1", "code":"18" @@ -164,128 +164,191 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", - "title":"User Guide", - "uri":"kms_01_0105.html", + "title":"Cloud Services with KMS Integrated", + "uri":"dew_01_0106.html", "doc_type":"usermanual", - "p_code":"", + "p_code":"1", "code":"19" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"When using Object Storage Service (OBS) to upload data with server-side encryption, you can select SEE-KMS encryption and use the key provided by KMS to encrypt the files", "product_code":"kms", - "title":"Key Management Service", - "uri":"kms_01_0177.html", + "title":"Encrypting Data in OBS", + "uri":"dew_01_0007.html", "doc_type":"usermanual", "p_code":"19", "code":"20" }, { - "desc":"CMKs include custom keys and default keys. This section describes how to create, view, enable, disable, schedule the deletion, and cancel the deletion of custom keys.Cust", + "desc":"When purchasing a disk, you can choose Advanced Settings > Encryption to encrypt the disk using the key provided by KMS. For details, see Figure 1. For more information a", "product_code":"kms", - "title":"Key Types", - "uri":"kms_01_7775.html", + "title":"Encrypting Data in EVS", + "uri":"dew_01_0008.html", "doc_type":"usermanual", - "p_code":"20", + "p_code":"19", "code":"21" }, { - "desc":"This section describes how to create a custom key on the KMS console.Custom keys can be categorized into symmetric keys and asymmetric keys.You can create up to 100 custo", + "desc":"When uploading an image file to Image Management Service (IMS), you can choose to encrypt the image file using a key provided by KMS to protect the file. Figure 1 describ", "product_code":"kms", - "title":"Creating a Key", - "uri":"kms_01_0178.html", + "title":"Encrypting Data in IMS", + "uri":"dew_01_0009.html", "doc_type":"usermanual", - "p_code":"20", + "p_code":"19", "code":"22" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"When creating a file system using the Scalable File Service (SFS), you can select KMS encryption and use the key provided by the KMS to encrypt the file system. For detai", "product_code":"kms", - "title":"Creating CMKs Using Imported Key Materials", - "uri":"kms_01_0142.html", + "title":"Encrypting Data in SFS", + "uri":"dew_01_0116.html", "doc_type":"usermanual", - "p_code":"20", + "p_code":"19", "code":"23" }, { - "desc":"A custom key contains key metadata (key ID, key alias, description, key status, and creation date) and key materials used for encrypting and decrypting data.When a user u", + "desc":"When a user creates a database instance from Relational Database Service (RDS), the user can select Disk encryption and use the key provided by KMS to encrypt the disk of", "product_code":"kms", - "title":"Overview", - "uri":"kms_01_0088.html", + "title":"Encrypting Data in RDS", + "uri":"dew_01_0101.html", "doc_type":"usermanual", - "p_code":"23", + "p_code":"19", "code":"24" }, { - "desc":"If you want to use your own key materials instead of the KMS-generated materials, you can use the console to import your key materials to KMS. CMKs created using imported", + "desc":"When a user creates a database instance from DDS, the user can select Disk encryption and use the key provided by KMS to encrypt the disk of the database instance. For mo", "product_code":"kms", - "title":"Importing Key Materials", - "uri":"kms_01_0089.html", + "title":"Encrypting Data in DDS", + "uri":"dew_01_0199.html", "doc_type":"usermanual", - "p_code":"23", + "p_code":"19", "code":"25" }, { - "desc":"When importing key materials, you can specify their expiration time. After the key material expires, KMS deletes it, and the status of the custom key changes to Pending i", + "desc":"Object Storage Service (OBS) is a scalable service that provides secure, reliable, and cost-effective cloud storage for massive amounts of data. KMS provides central mana", "product_code":"kms", - "title":"Deleting Key Materials", - "uri":"kms_01_0090.html", + "title":"Related Services", + "uri":"kms_01_0016.html", "doc_type":"usermanual", - "p_code":"23", + "p_code":"1", "code":"26" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", - "title":"Managing CMKs", - "uri":"kms_01_0028.html", + "title":"Key Management", + "uri":"kms_01_0018.html", "doc_type":"usermanual", - "p_code":"20", + "p_code":"", "code":"27" }, { - "desc":"This section describes how to view the information about the custom key on the KMS console, including the key alias, status, ID, and creation time. The status of a key ca", + "desc":"This section describes how to create a custom key on the KMS management console. You can create up to 100 custom keys, excluding default keys.CMKs can be used for:Server-", "product_code":"kms", - "title":"Viewing a CMK", - "uri":"kms_01_0179.html", + "title":"Creating a Key", + "uri":"kms_01_0194.html", "doc_type":"usermanual", "p_code":"27", "code":"28" }, { - "desc":"This section describes how to use the KMS console to enable one or more custom keys. Only enabled custom keys can be used to encrypt or decrypt data. A new custom key is ", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", - "title":"Enabling One or More CMKs", - "uri":"kms_01_0029.html", + "title":"Creating CMKs Using Imported Key Material", + "uri":"kms_01_0019.html", "doc_type":"usermanual", "p_code":"27", "code":"29" }, { - "desc":"This section describes how to use the KMS console to disable one or more custom keys, thereby protecting data in urgent cases.After being disabled, a custom key cannot be", + "desc":"The custom key contains key metadata (key ID, key name, description, key status, and creation date) and key materials used for encrypting and decrypting data.When a user ", "product_code":"kms", - "title":"Disabling One or More CMKs", - "uri":"kms_01_0030.html", + "title":"Overview", + "uri":"kms_01_0054.html", "doc_type":"usermanual", - "p_code":"27", + "p_code":"29", "code":"30" }, { - "desc":"Before deleting the CMK, confirm that it is not in use and will not be used.The key to be deleted is in Enabled, Disabled, or Pending import status.A key will not be dele", + "desc":"If you want to use your own key material instead of the KMS-generated material, you can use the console to import your key material to KMS. The keys created using importe", "product_code":"kms", - "title":"Deleting One or More CMKs", - "uri":"kms_01_0031.html", + "title":"Importing a Key Material", + "uri":"kms_01_0055.html", "doc_type":"usermanual", - "p_code":"27", + "p_code":"29", "code":"31" }, { - "desc":"This section describes how to use the KMS console to cancel the scheduled deletion of one or more custom keys prior to deletion execution. After the cancellation, the key", + "desc":"When importing key material, you can specify the expiration time. After the key material expires, KMS deletes it, and the status of the custom key changes to Pending impo", "product_code":"kms", - "title":"Canceling the Scheduled Deletion of One or More CMKs", + "title":"Deleting a Key Material", + "uri":"kms_01_0020.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"32" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"kms", + "title":"Managing CMKs", "uri":"kms_01_0032.html", "doc_type":"usermanual", "p_code":"27", - "code":"32" + "code":"33" + }, + { + "desc":"This section describes how to use the management console to view the information about a custom key, such as its name, status, ID, and creation time. The status of a key ", + "product_code":"kms", + "title":"Querying a Key", + "uri":"kms_01_0096.html", + "doc_type":"usermanual", + "p_code":"33", + "code":"34" + }, + { + "desc":"Key names help you find custom keys more easily.This section describes how to change the name and description of a custom key on the KMS management console.The name and d", + "product_code":"kms", + "title":"Changing the Name and Description of a Key", + "uri":"kms_01_0033.html", + "doc_type":"usermanual", + "p_code":"33", + "code":"35" + }, + { + "desc":"This section describes how to use the management console to enable one or multiple custom keys. Only enabled keys can be used to encrypt/decrypt data. A new custom key is", + "product_code":"kms", + "title":"Enabling a Key", + "uri":"kms_01_0034.html", + "doc_type":"usermanual", + "p_code":"33", + "code":"36" + }, + { + "desc":"This section describes how to use the management console to disable one or multiple custom keys, thereby protecting data in urgent cases.After being disabled, a custom ke", + "product_code":"kms", + "title":"Disabling a Key", + "uri":"kms_01_0035.html", + "doc_type":"usermanual", + "p_code":"33", + "code":"37" + }, + { + "desc":"This section describes how to use the management console to schedule the deletion of one or multiple unwanted custom keys.If deletion is scheduled for a key, the deletion", + "product_code":"kms", + "title":"Deleting a Key", + "uri":"kms_01_0072.html", + "doc_type":"usermanual", + "p_code":"33", + "code":"38" + }, + { + "desc":"This section describes how to use the management console to cancel the scheduled deletion of a custom key prior to deletion execution.The key for which you want to cancel", + "product_code":"kms", + "title":"Canceling the Scheduled Deletion of a Key", + "uri":"kms_01_0036.html", + "doc_type":"usermanual", + "p_code":"33", + "code":"39" }, { "desc":"This section describes how to configure the Simple Message Notification (SMN) function on the Cloud Trace Service (CTS) console.Decryption will fail if the key used for e", @@ -293,17 +356,26 @@ "title":"Configuring SMN", "uri":"kms_01_0021.html", "doc_type":"usermanual", - "p_code":"20", - "code":"33" + "p_code":"27", + "code":"40" }, { - "desc":"This section describes how to use the online tool to encrypt or decrypt small-size data (4 KB or smaller) on the KMS console.The custom key is in Enabled status.Default k", + "desc":"This section describes how to use an online tool to encrypt and decrypt data less than or equal to 4 KB on the KMS console.The desired custom key is in Enabled status.Def", "product_code":"kms", - "title":"Using the Online Tool to Encrypt and Decrypt Small-Size Data", + "title":"Encrypting and Decrypting Small-Size Data Online", "uri":"kms_01_0022.html", "doc_type":"usermanual", - "p_code":"20", - "code":"34" + "p_code":"27", + "code":"41" + }, + { + "desc":"An alias is an identifier of a key. You can use the alias as the key ID during API calling. The original key alias is not used as the key name.This section describes how ", + "product_code":"kms", + "title":"Key Alias", + "uri":"en-us_topic_0000002203211100.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"42" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -311,367 +383,286 @@ "title":"Managing Tags", "uri":"kms_01_0023.html", "doc_type":"usermanual", - "p_code":"20", - "code":"35" - }, - { - "desc":"Tags are used to identify keys. You can add tags to custom keys so that you can classify custom keys, trace them, and collect their usage status according to the tags.Tag", - "product_code":"kms", - "title":"Adding a Tag", - "uri":"kms_01_0024.html", - "doc_type":"usermanual", - "p_code":"35", - "code":"36" - }, - { - "desc":"This section describes how to modify tag values on the KMS console.", - "product_code":"kms", - "title":"Modifying Tag Values", - "uri":"kms_01_0026.html", - "doc_type":"usermanual", - "p_code":"35", - "code":"37" - }, - { - "desc":"This section describes how to delete tags on the KMS console.", - "product_code":"kms", - "title":"Deleting Tags", - "uri":"kms_01_0027.html", - "doc_type":"usermanual", - "p_code":"35", - "code":"38" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"kms", - "title":"Rotating CMKs", - "uri":"kms_01_0138.html", - "doc_type":"usermanual", - "p_code":"20", - "code":"39" - }, - { - "desc":"Keys that are widely or repeatedly used are insecure. To enhance the security of encryption keys, you are advised to periodically rotate keys and change their key materia", - "product_code":"kms", - "title":"About Key Rotation", - "uri":"kms_01_0094.html", - "doc_type":"usermanual", - "p_code":"39", - "code":"40" - }, - { - "desc":"This section describes how to enable rotation for a key on the KMS console.By default, automatic key rotation is disabled for a custom key. Every time you enable key rota", - "product_code":"kms", - "title":"Enabling Key Rotation", - "uri":"kms_01_0139.html", - "doc_type":"usermanual", - "p_code":"39", - "code":"41" - }, - { - "desc":"This section describes how to disable rotation for a key on the KMS console.The key is enabled.The Origin of the key is KMS.Key rotation has been enabled.", - "product_code":"kms", - "title":"Disabling Key Rotation", - "uri":"kms_01_7774.html", - "doc_type":"usermanual", - "p_code":"39", - "code":"42" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"kms", - "title":"Managing a Grant", - "uri":"kms_01_0095.html", - "doc_type":"usermanual", - "p_code":"20", + "p_code":"27", "code":"43" }, { - "desc":"You can create grants for other users or accounts to use the custom key. You can create a maximum of 100 grants on a custom key.You have obtained the ID of the grantee (u", + "desc":"Tags are used to identify custom keys. You can add tags to custom keys so that you can classify custom keys, trace them, and collect their usage status according to the t", "product_code":"kms", - "title":"Creating a Grant", - "uri":"kms_01_0096.html", + "title":"Adding a Tag", + "uri":"kms_01_0024.html", "doc_type":"usermanual", "p_code":"43", "code":"44" }, { - "desc":"You can view the details about a custom key grant on the KMS console, such as the grant ID, grantee user ID, granted operation, and creation time.You have created a grant", + "desc":"This section describes how to search for tags through KMS. You can search for tags of all custom keys that meet the search criteria in the current project.Tags have been ", "product_code":"kms", - "title":"Querying a Grant", - "uri":"kms_01_0097.html", + "title":"Searching for a Custom Key by Tag", + "uri":"kms_01_0025.html", "doc_type":"usermanual", "p_code":"43", "code":"45" }, { - "desc":"You can revoke a grant on the KMS console in either of the following scenarios:A grantee does not need the custom key grant. (The grantee can either tell the user who has", + "desc":"This section describes how to modify tag values on the KMS management console.", "product_code":"kms", - "title":"Revoking a Grant", - "uri":"kms_01_0098.html", + "title":"Modifying Tag Values", + "uri":"kms_01_0026.html", "doc_type":"usermanual", "p_code":"43", "code":"46" }, + { + "desc":"This section describes how to delete tags on the KMS management console.", + "product_code":"kms", + "title":"Deleting Tags", + "uri":"kms_01_0027.html", + "doc_type":"usermanual", + "p_code":"43", + "code":"47" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", - "title":"Permission Control", - "uri":"kms_01_0133.html", + "title":"Rotating Keys", + "uri":"kms_01_0138.html", "doc_type":"usermanual", - "p_code":"19", - "code":"47" + "p_code":"27", + "code":"48" + }, + { + "desc":"Keys that are widely or repeatedly used are insecure. To enhance the security of encryption keys, you are advised to periodically rotate keys and change their key materia", + "product_code":"kms", + "title":"Key Rotation Overview", + "uri":"kms_01_0094.html", + "doc_type":"usermanual", + "p_code":"48", + "code":"49" + }, + { + "desc":"This section describes how to enable rotation for a key on the KMS console.By default, automatic key rotation is disabled for a CMK. Every time you enable key rotation, K", + "product_code":"kms", + "title":"Enabling Key Rotation", + "uri":"kms_01_0139.html", + "doc_type":"usermanual", + "p_code":"48", + "code":"50" + }, + { + "desc":"This section describes how to disable rotation for a key on the KMS console.The key is in Enabled status.The Origin of the key is KMS.Key rotation has been enabled.", + "product_code":"kms", + "title":"Disabling Key Rotation", + "uri":"kms_01_0095.html", + "doc_type":"usermanual", + "p_code":"48", + "code":"51" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"kms", + "title":"Managing a Grant", + "uri":"kms_01_0028.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"52" + }, + { + "desc":"You can create grants for other users to use the custom key. You can create a maximum of 100 grants for a custom key.The owner of a custom key can create a grant for the ", + "product_code":"kms", + "title":"Creating a Grant", + "uri":"kms_01_0029.html", + "doc_type":"usermanual", + "p_code":"52", + "code":"53" + }, + { + "desc":"This section describes how to view the details about a grant, such as the grant ID, grantee user ID, granted operation, and creation time.You have created a grant.Table 1", + "product_code":"kms", + "title":"Querying a Grant", + "uri":"kms_01_0030.html", + "doc_type":"usermanual", + "p_code":"52", + "code":"54" + }, + { + "desc":"You can revoke a grant in either of the following scenarios:A grantee does not need the custom key grant. (The grantee can either tell the user who has created the grant ", + "product_code":"kms", + "title":"Revoking a Grant", + "uri":"kms_01_0031.html", + "doc_type":"usermanual", + "p_code":"52", + "code":"55" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"kms", + "title":"Permissions Management", + "uri":"kms_01_9998.html", + "doc_type":"usermanual", + "p_code":"", + "code":"56" }, { "desc":"This section describes IAM's fine-grained permissions management for your KMS resources. With IAM, you can:Create IAM users for employees based on the organizational stru", "product_code":"kms", "title":"Creating a User and Authorizing the User the Permission to Access KMS", - "uri":"kms_01_0135.html", + "uri":"kms_01_9997.html", "doc_type":"usermanual", - "p_code":"47", - "code":"48" + "p_code":"56", + "code":"57" }, { - "desc":"Custom policies can be created as a supplement to the system policies of KMS. For details about the actions supported by custom policies, see \"Permissions Policies and Su", + "desc":"Custom policies can be created as a supplement to the system policies of KMSfilter. For details about the actions supported by custom policies, see \"Permissions Policies ", "product_code":"kms", "title":"Creating a Custom KMS Policy", - "uri":"kms_01_0161.html", + "uri":"kms_01_9996.html", "doc_type":"usermanual", - "p_code":"47", - "code":"49" + "p_code":"56", + "code":"58" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", "title":"FAQs", - "uri":"kms_01_0092.html", + "uri":"kms_01_0037.html", "doc_type":"usermanual", "p_code":"", - "code":"50" + "code":"59" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"kms", - "title":"KMS Related", - "uri":"kms_01_0048.html", - "doc_type":"usermanual", - "p_code":"50", - "code":"51" - }, - { - "desc":"KMS is a secure, reliable, and easy-to-use cloud service that helps users create, manage, and protect keys in a centralized manner.It uses Hardware Security Modules (HSMs", + "desc":"Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).This service", "product_code":"kms", "title":"What Is Key Management Service?", - "uri":"kms_01_0047.html", + "uri":"kms_01_0073.html", "doc_type":"usermanual", - "p_code":"51", - "code":"52" + "p_code":"59", + "code":"60" }, { - "desc":"A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user on KMS. It is used to encrypt and protect DEKs. One CMK can be used to encrypt one or more DEK", + "desc":"A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user using KMS. It is used to encrypt and protect Data Encryption Keys (DEKs). One CMK can be used ", "product_code":"kms", "title":"What Is a Customer Master Key?", - "uri":"kms_01_0044.html", + "uri":"kms_01_0074.html", "doc_type":"usermanual", - "p_code":"51", - "code":"53" - }, - { - "desc":"A default key is automatically created by another cloud service using KMS, such as Object Storage Service (OBS). The alias of a default key ends with /default.You can use", - "product_code":"kms", - "title":"What Is a Default Key?", - "uri":"kms_01_0045.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"54" + "p_code":"59", + "code":"61" }, { "desc":"The following table describes the differences between a custom key and a default key.", "product_code":"kms", "title":"What Are the Differences Between a Custom Key and a Default Key?", - "uri":"kms_01_0055.html", + "uri":"kms_01_0101.html", "doc_type":"usermanual", - "p_code":"51", - "code":"55" + "p_code":"59", + "code":"62" }, { "desc":"A data encryption key (DEK) is used to encrypt data.", "product_code":"kms", "title":"What Is a Data Encryption Key?", - "uri":"kms_01_0046.html", + "uri":"kms_01_0038.html", "doc_type":"usermanual", - "p_code":"51", - "code":"56" + "p_code":"59", + "code":"63" }, { - "desc":"The decision to delete a CMK should be considered with great caution. Before deletion, confirm that the CMK's encrypted data has all been migrated. As soon as the CMK is ", - "product_code":"kms", - "title":"Why Cannot I Delete a CMK Immediately?", - "uri":"kms_01_0049.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"57" - }, - { - "desc":"Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File Service (SFS), Document Database Service (DDS), and Relational D", + "desc":"Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File Service (SFS), and Relational Database Service (RDS) can use KMS", "product_code":"kms", "title":"Which Cloud Services Can Use KMS for Encryption?", - "uri":"kms_01_0050.html", + "uri":"kms_01_0040.html", "doc_type":"usermanual", - "p_code":"51", - "code":"58" + "p_code":"59", + "code":"64" }, { - "desc":"Services (such as OBS, IMS, EVS, SFS, DDS, and RDS) use the envelope encryption method provided by KMS to protect data.Envelope encryption is an encryption method that en", + "desc":"No.The pending period of a key from its scheduling till its deletion is not charged.However, if you cancel the scheduled deletion, the charging resumes from the time when", "product_code":"kms", - "title":"How Do Cloud Services Use KMS to Encrypt Data?", - "uri":"kms_01_0053.html", + "title":"Will a Key Be Charged After It Is Scheduled to Delete?", + "uri":"kms_01_0093.html", "doc_type":"usermanual", - "p_code":"51", - "code":"59" + "p_code":"59", + "code":"65" + }, + { + "desc":"The decision to delete a CMK should be taken with caution. Before deletion, confirm that the CMK's encrypted data has all been migrated. Once the CMK is deleted, you will", + "product_code":"kms", + "title":"Why Can't I Delete a CMK Immediately?", + "uri":"kms_01_0039.html", + "doc_type":"usermanual", + "p_code":"59", + "code":"66" + }, + { + "desc":"There is a limit on the number of custom keys that can be created on KMS.You can create a maximum of 100 custom keys, including those in enabled, disabled, and pending de", + "product_code":"kms", + "title":"Is There a Limit on the Number of Custom Keys That I Can Create on KMS?", + "uri":"kms_01_0198.html", + "doc_type":"usermanual", + "p_code":"59", + "code":"67" }, { "desc":"Envelope encryption is the practice of encrypting data with a DEK and then encrypting the DEK with a root key that you can fully manage. In this case, CMKs are not requir", "product_code":"kms", "title":"What Are the Benefits of Envelope Encryption?", - "uri":"kms_01_0054.html", + "uri":"kms_01_0106.html", "doc_type":"usermanual", - "p_code":"51", - "code":"60" - }, - { - "desc":"Yes.You can create a maximum of 100 custom keys, including those in enabled, disabled, and pending deletion states. Default keys are not included.", - "product_code":"kms", - "title":"Is There a Limit on the Number of Custom Keys That I Can Create on KMS?", - "uri":"kms_01_0056.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"61" + "p_code":"59", + "code":"68" }, { "desc":"No.To ensure CMK security, users can only create and use CMKs in KMS.", "product_code":"kms", "title":"Can I Export a CMK from KMS?", - "uri":"kms_01_0058.html", + "uri":"kms_01_0102.html", "doc_type":"usermanual", - "p_code":"51", - "code":"62" + "p_code":"59", + "code":"69" }, { - "desc":"No.If you have permanently deleted your custom key, the data encrypted using it cannot be decrypted. Before the scheduled deletion date of the custom key, you can cancel ", - "product_code":"kms", - "title":"Can I Decrypt My Data if I Permanently Delete My Custom Key?", - "uri":"kms_01_0059.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"63" - }, - { - "desc":"You can use the online tool to encrypt or decrypt data in the following procedures:Use the current CMK to encrypt the data.You can click Clear to clear the entered data.Y", + "desc":"You can use the online tool to encrypt or decrypt data in the following procedures:The key you clicked is used for encryption.To clear your input, click Clear.To copy the", "product_code":"kms", "title":"How Do I Use the Online Tool to Encrypt or Decrypt Small Volumes of Data?", - "uri":"kms_01_0060.html", + "uri":"kms_01_0107.html", "doc_type":"usermanual", - "p_code":"51", - "code":"64" + "p_code":"59", + "code":"70" }, { "desc":"No.Keys created using KMS-generated materials cannot be updated. You can only use KMS to create new CMKs to encrypt and decrypt data.", "product_code":"kms", "title":"Can I Update CMKs Created by KMS-Generated Key Materials?", - "uri":"kms_01_0062.html", + "uri":"kms_01_0114.html", "doc_type":"usermanual", - "p_code":"51", - "code":"65" - }, - { - "desc":"If you do not want to use KMS-generated key materials, you can import your own key materials to create a CMK. Such a CMK allows deletion of only the key materials when yo", - "product_code":"kms", - "title":"When Should I Use a CMK Created with Imported Key Materials?", - "uri":"kms_01_0102.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"66" - }, - { - "desc":"You can import 256-bit symmetric keys.", - "product_code":"kms", - "title":"What Types of Keys Can I Import?", - "uri":"kms_01_0103.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"67" - }, - { - "desc":"You can import the backup key materials from your local device again.Before importing key materials, you are advised to back up the materials. The materials to be re-impo", - "product_code":"kms", - "title":"What Should I Do When I Accidentally Delete Key Materials?", - "uri":"kms_01_0104.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"68" - }, - { - "desc":"A message indicating lack of permissions is displayed when you attempt to perform operations on keys, such as view, create, or import keys.Your account is not associated ", - "product_code":"kms", - "title":"What Should I Do If I Do Not Have the Permissions to Perform Operations on KMS?", - "uri":"kms_01_0182.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"69" - }, - { - "desc":"By default, the -id-aes256-wrap-pad algorithm is not enabled in OpenSSL. To wrap a key, upgrade OpenSSL to the latest version and patch it first.Use bash commands to crea", - "product_code":"kms", - "title":"Why Can't I Wrap Asymmetric Keys by Using -id-aes256-wrap-pad in OpenSSL?", - "uri":"kms_01_0186.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"70" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"kms", - "title":"Key Algorithms Supported by KMS", - "uri":"kms_01_0189.html", - "doc_type":"usermanual", - "p_code":"51", + "p_code":"59", "code":"71" }, - { - "desc":"The basic length of the ciphertext returned by the encrypt-data API is 124 bytes. The ciphertext consists of multiple fields, including the key ID, encryption algorithm, ", - "product_code":"kms", - "title":"What Is the Relationship Between the Ciphertext and Plaintext Returned by the encrypt-data API?", - "uri":"kms_01_0215.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"72" - }, { "desc":"The mechanism of KMS prevents anyone from accessing your keys in plaintext. KMS relies on hardware security modules (HSMs) that safeguard the confidentiality and integrit", "product_code":"kms", "title":"How Does KMS Protect My Keys?", - "uri":"kms_01_0227.html", + "uri":"kms_01_0193.html", "doc_type":"usermanual", - "p_code":"51", - "code":"73" - }, - { - "desc":"Imported keys do not support rotation. After the imported key materials are deleted, ensure that the same key materials are imported.", - "product_code":"kms", - "title":"Does an Imported Key Support Rotation?", - "uri":"kms_01_0330.html", - "doc_type":"usermanual", - "p_code":"51", - "code":"74" + "p_code":"59", + "code":"72" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"kms", "title":"Change History", - "uri":"en-us_topic_0000001682248672.html", + "uri":"kms_01_0043.html", "doc_type":"usermanual", "p_code":"", - "code":"75" + "code":"73" + }, + { + "desc":"For details about the glossaries in this document, see Glossary.", + "product_code":"kms", + "title":"Glossary", + "uri":"kms_01_0044.html", + "doc_type":"usermanual", + "p_code":"", + "code":"74" } ] \ No newline at end of file diff --git a/docs/kms/umn/dew_01_0007.html b/docs/kms/umn/dew_01_0007.html new file mode 100644 index 000000000..ead6e8df2 --- /dev/null +++ b/docs/kms/umn/dew_01_0007.html @@ -0,0 +1,21 @@ + + +

Encrypting Data in OBS

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/kms/umn/dew_01_0008.html b/docs/kms/umn/dew_01_0008.html new file mode 100644 index 000000000..5fc089a97 --- /dev/null +++ b/docs/kms/umn/dew_01_0008.html @@ -0,0 +1,23 @@ + + +

Encrypting Data in EVS

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/kms/umn/dew_01_0009.html b/docs/kms/umn/dew_01_0009.html new file mode 100644 index 000000000..8cdfbdbdc --- /dev/null +++ b/docs/kms/umn/dew_01_0009.html @@ -0,0 +1,21 @@ + + +

Encrypting Data in IMS

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/kms/umn/dew_01_0101.html b/docs/kms/umn/dew_01_0101.html new file mode 100644 index 000000000..7982199c9 --- /dev/null +++ b/docs/kms/umn/dew_01_0101.html @@ -0,0 +1,20 @@ + + +

Encrypting Data in RDS

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/kms/umn/dew_01_0106.html b/docs/kms/umn/dew_01_0106.html new file mode 100644 index 000000000..a185429cf --- /dev/null +++ b/docs/kms/umn/dew_01_0106.html @@ -0,0 +1,25 @@ + + +

Cloud Services with KMS Integrated

+
+
+ + + +
+ diff --git a/docs/kms/umn/dew_01_0116.html b/docs/kms/umn/dew_01_0116.html new file mode 100644 index 000000000..07b0d78c3 --- /dev/null +++ b/docs/kms/umn/dew_01_0116.html @@ -0,0 +1,20 @@ + + +

Encrypting Data in SFS

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/kms/umn/dew_01_0199.html b/docs/kms/umn/dew_01_0199.html new file mode 100644 index 000000000..fa288c872 --- /dev/null +++ b/docs/kms/umn/dew_01_0199.html @@ -0,0 +1,21 @@ + + +

Encrypting Data in DDS

+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/kms/umn/en-us_image_0000001285528060.png b/docs/kms/umn/en-us_image_0000001285528060.png deleted file mode 100644 index 9ff91b23e..000000000 Binary files a/docs/kms/umn/en-us_image_0000001285528060.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001295227514.png b/docs/kms/umn/en-us_image_0000001295227514.png deleted file mode 100644 index 9ff91b23e..000000000 Binary files a/docs/kms/umn/en-us_image_0000001295227514.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001295496116.png b/docs/kms/umn/en-us_image_0000001295496116.png deleted file mode 100644 index fa5270336..000000000 Binary files a/docs/kms/umn/en-us_image_0000001295496116.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001348333869.png b/docs/kms/umn/en-us_image_0000001348333869.png deleted file mode 100644 index 89a4c459c..000000000 Binary files a/docs/kms/umn/en-us_image_0000001348333869.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001542027770.png b/docs/kms/umn/en-us_image_0000001542027770.png deleted file mode 100644 index b56106999..000000000 Binary files a/docs/kms/umn/en-us_image_0000001542027770.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001628743570.png b/docs/kms/umn/en-us_image_0000001628743570.png deleted file mode 100644 index 96497353d..000000000 Binary files a/docs/kms/umn/en-us_image_0000001628743570.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001629072682.png b/docs/kms/umn/en-us_image_0000001629072682.png deleted file mode 100644 index 4367bf40d..000000000 Binary files a/docs/kms/umn/en-us_image_0000001629072682.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001629122164.png b/docs/kms/umn/en-us_image_0000001629122164.png deleted file mode 100644 index af0d7d9fb..000000000 Binary files a/docs/kms/umn/en-us_image_0000001629122164.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001629601212.png b/docs/kms/umn/en-us_image_0000001629601212.png deleted file mode 100644 index 1cacc9026..000000000 Binary files a/docs/kms/umn/en-us_image_0000001629601212.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001677425385.png b/docs/kms/umn/en-us_image_0000001677425385.png deleted file mode 100644 index 1f2dc3851..000000000 Binary files a/docs/kms/umn/en-us_image_0000001677425385.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001677561857.png b/docs/kms/umn/en-us_image_0000001677561857.png deleted file mode 100644 index 262ba8362..000000000 Binary files a/docs/kms/umn/en-us_image_0000001677561857.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001677751557.png b/docs/kms/umn/en-us_image_0000001677751557.png deleted file mode 100644 index ee937b4dd..000000000 Binary files a/docs/kms/umn/en-us_image_0000001677751557.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001677882901.png b/docs/kms/umn/en-us_image_0000001677882901.png deleted file mode 100644 index c72e623b9..000000000 Binary files a/docs/kms/umn/en-us_image_0000001677882901.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001678663053.png b/docs/kms/umn/en-us_image_0000001678663053.png deleted file mode 100644 index bf3e1e935..000000000 Binary files a/docs/kms/umn/en-us_image_0000001678663053.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000001830825206.png b/docs/kms/umn/en-us_image_0000001830825206.png deleted file mode 100644 index c1cde5749..000000000 Binary files a/docs/kms/umn/en-us_image_0000001830825206.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0000002171452720.png b/docs/kms/umn/en-us_image_0000002171452720.png new file mode 100644 index 000000000..67272a86b Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002171452720.png differ diff --git a/docs/kms/umn/en-us_image_0000002172246184.png b/docs/kms/umn/en-us_image_0000002172246184.png new file mode 100644 index 000000000..245e5a1da Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172246184.png differ diff --git a/docs/kms/umn/en-us_image_0000002172643144.png b/docs/kms/umn/en-us_image_0000002172643144.png new file mode 100644 index 000000000..a425a3de5 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172643144.png differ diff --git a/docs/kms/umn/en-us_image_0000002172644408.png b/docs/kms/umn/en-us_image_0000002172644408.png new file mode 100644 index 000000000..8802c01b2 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172644408.png differ diff --git a/docs/kms/umn/en-us_image_0000002172654270.png b/docs/kms/umn/en-us_image_0000002172654270.png new file mode 100644 index 000000000..85179f2e3 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172654270.png differ diff --git a/docs/kms/umn/en-us_image_0000002172662606.png b/docs/kms/umn/en-us_image_0000002172662606.png new file mode 100644 index 000000000..1c4c17871 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172662606.png differ diff --git a/docs/kms/umn/en-us_image_0000002172663278.png b/docs/kms/umn/en-us_image_0000002172663278.png new file mode 100644 index 000000000..5beb29c5e Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172663278.png differ diff --git a/docs/kms/umn/en-us_image_0000002172703332.png b/docs/kms/umn/en-us_image_0000002172703332.png new file mode 100644 index 000000000..5299fe7b1 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172703332.png differ diff --git a/docs/kms/umn/en-us_image_0000002172766950.png b/docs/kms/umn/en-us_image_0000002172766950.png new file mode 100644 index 000000000..ff7f71fa5 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172766950.png differ diff --git a/docs/kms/umn/en-us_image_0000002172771934.png b/docs/kms/umn/en-us_image_0000002172771934.png new file mode 100644 index 000000000..386b8fe16 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172771934.png differ diff --git a/docs/kms/umn/en-us_image_0000002172783520.png b/docs/kms/umn/en-us_image_0000002172783520.png new file mode 100644 index 000000000..8ee6b5a9b Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172783520.png differ diff --git a/docs/kms/umn/en-us_image_0000002172804952.png b/docs/kms/umn/en-us_image_0000002172804952.png new file mode 100644 index 000000000..88612ce3d Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172804952.png differ diff --git a/docs/kms/umn/en-us_image_0000002172809156.png b/docs/kms/umn/en-us_image_0000002172809156.png new file mode 100644 index 000000000..521f7456c Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172809156.png differ diff --git a/docs/kms/umn/en-us_image_0000002172817710.png b/docs/kms/umn/en-us_image_0000002172817710.png new file mode 100644 index 000000000..f32327d61 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172817710.png differ diff --git a/docs/kms/umn/en-us_image_0000002172846818.png b/docs/kms/umn/en-us_image_0000002172846818.png new file mode 100644 index 000000000..446060a9f Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172846818.png differ diff --git a/docs/kms/umn/en-us_image_0000002172859956.png b/docs/kms/umn/en-us_image_0000002172859956.png new file mode 100644 index 000000000..364bf545d Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002172859956.png differ diff --git a/docs/kms/umn/en-us_image_0000001677425609.png b/docs/kms/umn/en-us_image_0000002203676060.png similarity index 100% rename from docs/kms/umn/en-us_image_0000001677425609.png rename to docs/kms/umn/en-us_image_0000002203676060.png diff --git a/docs/kms/umn/en-us_image_0000002207465277.png b/docs/kms/umn/en-us_image_0000002207465277.png new file mode 100644 index 000000000..0d2c95e1e Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002207465277.png differ diff --git a/docs/kms/umn/en-us_image_0000002207563973.png b/docs/kms/umn/en-us_image_0000002207563973.png new file mode 100644 index 000000000..64e0a9e9d Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002207563973.png differ diff --git a/docs/kms/umn/en-us_image_0000002207903449.png b/docs/kms/umn/en-us_image_0000002207903449.png new file mode 100644 index 000000000..8b3822a21 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002207903449.png differ diff --git a/docs/kms/umn/en-us_image_0000002208027189.png b/docs/kms/umn/en-us_image_0000002208027189.png new file mode 100644 index 000000000..1acf43fa4 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208027189.png differ diff --git a/docs/kms/umn/en-us_image_0000002208041185.png b/docs/kms/umn/en-us_image_0000002208041185.png new file mode 100644 index 000000000..170147543 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208041185.png differ diff --git a/docs/kms/umn/en-us_image_0000002208065393.png b/docs/kms/umn/en-us_image_0000002208065393.png new file mode 100644 index 000000000..16d8d2a31 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208065393.png differ diff --git a/docs/kms/umn/en-us_image_0000002208066957.png b/docs/kms/umn/en-us_image_0000002208066957.png new file mode 100644 index 000000000..1c2a70af9 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208066957.png differ diff --git a/docs/kms/umn/en-us_image_0000002208068029.png b/docs/kms/umn/en-us_image_0000002208068029.png new file mode 100644 index 000000000..938702c74 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208068029.png differ diff --git a/docs/kms/umn/en-us_image_0000002208083193.png b/docs/kms/umn/en-us_image_0000002208083193.png new file mode 100644 index 000000000..791d933a2 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208083193.png differ diff --git a/docs/kms/umn/en-us_image_0000002208103933.png b/docs/kms/umn/en-us_image_0000002208103933.png new file mode 100644 index 000000000..0812d6531 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208103933.png differ diff --git a/docs/kms/umn/en-us_image_0000002208150489.png b/docs/kms/umn/en-us_image_0000002208150489.png new file mode 100644 index 000000000..78af9cbbe Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208150489.png differ diff --git a/docs/kms/umn/en-us_image_0000002208162289.png b/docs/kms/umn/en-us_image_0000002208162289.png new file mode 100644 index 000000000..d7dab5101 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208162289.png differ diff --git a/docs/kms/umn/en-us_image_0000002208172261.png b/docs/kms/umn/en-us_image_0000002208172261.png new file mode 100644 index 000000000..93d520bee Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208172261.png differ diff --git a/docs/kms/umn/en-us_image_0000002208177921.png b/docs/kms/umn/en-us_image_0000002208177921.png new file mode 100644 index 000000000..f8bbbd255 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208177921.png differ diff --git a/docs/kms/umn/en-us_image_0000002208180117.png b/docs/kms/umn/en-us_image_0000002208180117.png new file mode 100644 index 000000000..82c6d7814 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208180117.png differ diff --git a/docs/kms/umn/en-us_image_0000002208187325.png b/docs/kms/umn/en-us_image_0000002208187325.png new file mode 100644 index 000000000..eeb7ca2ef Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208187325.png differ diff --git a/docs/kms/umn/en-us_image_0000002208253509.png b/docs/kms/umn/en-us_image_0000002208253509.png new file mode 100644 index 000000000..d3d27b139 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208253509.png differ diff --git a/docs/kms/umn/en-us_image_0000002208255689.png b/docs/kms/umn/en-us_image_0000002208255689.png new file mode 100644 index 000000000..9594416ac Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208255689.png differ diff --git a/docs/kms/umn/en-us_image_0000002208263345.png b/docs/kms/umn/en-us_image_0000002208263345.png new file mode 100644 index 000000000..c31509a36 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002208263345.png differ diff --git a/docs/kms/umn/en-us_image_0000002220522126.png b/docs/kms/umn/en-us_image_0000002220522126.png new file mode 100644 index 000000000..b17595b48 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002220522126.png differ diff --git a/docs/kms/umn/en-us_image_0000001828683422.png b/docs/kms/umn/en-us_image_0000002220532122.png similarity index 100% rename from docs/kms/umn/en-us_image_0000001828683422.png rename to docs/kms/umn/en-us_image_0000002220532122.png diff --git a/docs/kms/umn/en-us_image_0000002238636017.png b/docs/kms/umn/en-us_image_0000002238636017.png new file mode 100644 index 000000000..a1ea77d9d Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002238636017.png differ diff --git a/docs/kms/umn/en-us_image_0000002255480681.png b/docs/kms/umn/en-us_image_0000002255480681.png new file mode 100644 index 000000000..1a67ac262 Binary files /dev/null and b/docs/kms/umn/en-us_image_0000002255480681.png differ diff --git a/docs/kms/umn/en-us_image_0112946996.png b/docs/kms/umn/en-us_image_0112946996.png new file mode 100644 index 000000000..e0028eb2e Binary files /dev/null and b/docs/kms/umn/en-us_image_0112946996.png differ diff --git a/docs/kms/umn/en-us_image_0129547803.png b/docs/kms/umn/en-us_image_0129547803.png deleted file mode 100644 index b56d78879..000000000 Binary files a/docs/kms/umn/en-us_image_0129547803.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0129550097.png b/docs/kms/umn/en-us_image_0129550097.png deleted file mode 100644 index 0a980dfc1..000000000 Binary files a/docs/kms/umn/en-us_image_0129550097.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0129551027.png b/docs/kms/umn/en-us_image_0129551027.png deleted file mode 100644 index 82e4f7ffd..000000000 Binary files a/docs/kms/umn/en-us_image_0129551027.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0231665754.png b/docs/kms/umn/en-us_image_0231665754.png deleted file mode 100644 index b207192f5..000000000 Binary files a/docs/kms/umn/en-us_image_0231665754.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0232856156.png b/docs/kms/umn/en-us_image_0232856156.png deleted file mode 100644 index dc4eb5f83..000000000 Binary files a/docs/kms/umn/en-us_image_0232856156.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0232858228.png b/docs/kms/umn/en-us_image_0232858228.png deleted file mode 100644 index d1618ee6f..000000000 Binary files a/docs/kms/umn/en-us_image_0232858228.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0232858842.png b/docs/kms/umn/en-us_image_0232858842.png deleted file mode 100644 index 29e5f3e00..000000000 Binary files a/docs/kms/umn/en-us_image_0232858842.png and /dev/null differ diff --git a/docs/kms/umn/en-us_image_0237800345.png b/docs/kms/umn/en-us_image_0237800345.png index 256ee8aca..a1ea77d9d 100644 Binary files a/docs/kms/umn/en-us_image_0237800345.png and b/docs/kms/umn/en-us_image_0237800345.png differ diff --git a/docs/kms/umn/en-us_image_0237809856.png b/docs/kms/umn/en-us_image_0237809856.png new file mode 100644 index 000000000..ef602d7f4 Binary files /dev/null and b/docs/kms/umn/en-us_image_0237809856.png differ diff --git a/docs/kms/umn/en-us_image_0237809858.png b/docs/kms/umn/en-us_image_0237809858.png new file mode 100644 index 000000000..b200b43be Binary files /dev/null and b/docs/kms/umn/en-us_image_0237809858.png differ diff --git a/docs/kms/umn/en-us_image_0237812311.png b/docs/kms/umn/en-us_image_0237812311.png new file mode 100644 index 000000000..29cdb922a Binary files /dev/null and b/docs/kms/umn/en-us_image_0237812311.png differ diff --git a/docs/kms/umn/en-us_image_0249630192.png b/docs/kms/umn/en-us_image_0249630192.png new file mode 100644 index 000000000..b200b43be Binary files /dev/null and b/docs/kms/umn/en-us_image_0249630192.png differ diff --git a/docs/kms/umn/en-us_topic_0000001682248672.html b/docs/kms/umn/en-us_topic_0000001682248672.html deleted file mode 100644 index 65a5861ca..000000000 --- a/docs/kms/umn/en-us_topic_0000001682248672.html +++ /dev/null @@ -1,150 +0,0 @@ - - -

Change History

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Released On

-

Description

-

2024-05-14

-

This is the twenty-second official release.

-

Modified the names of tag-related events in section "Related Services".

-

Added "Does an Imported Key Support Rotation?" in section "FAQs".

-

2024-03-25

-

This is the twenty-first official release.

-

Added screenshots of the console in section "Configuring SMN".

-

Added the sfs/default key in section "What Is a Default Key?".

-

Added description about grant ID in section "Querying a Grant".

-

Added description about the verification operations after a grant is revoked in section "Revoking a Grant".

-

2023-10-20

-

This is the twentieth official release.

-

Updated the images of the service console.

-

2023-06-15

-

This is the nineteenth official release.

-

Added section "How Does KMS Protect My Keys?"

-

2022-09-30

-

This issue is the eighteenth official release.

-

Optimized the content in section "Creating a Custom KMS Policy".

-

2021-11-30

-

This issue is the seventeenth official release.

-
  • Deleted description about DSS in "Application Scenarios" and "Accessing and Using KMS".
  • Added examples for creating a key and using a custom key policy in "Creating a Custom KMS Policy".
-

2021-10-20

-

This issue is the sixteenth official release.

-
  • Added description about DSS in "Application Scenarios" and "Accessing and Using KMS".
  • Added description about fine-grained authorization in "Permissions Management".
-

2021-09-22

-

This is the fifteenth official release.

-
  • Updated screenshots in "Managing Tags".
  • Updated screenshots in "Managing a Grant".
-

2020-08-18

-

This is the fourteenth official release.

-
  • Modified the operation name of batchCreateKeyTags in section "Related Services".
  • Updated the description in section "Creating a Key".
-

2020-06-29

-

This is the thirteenth official release.

-
  • Modified operations and information displayed on the rotation setting page in section "Enabling Key Rotation".
  • Added the section "Disabling Key Rotation".
-

2019-12-10

-

This is the twelfth official release.

-
  • Added section "Enabling Key Rotation".
  • Added the description about enabling key rotation to section "Functions".
  • Added the description of enabling key rotation, changing the key rotation period, and disabling key rotation to section "Related Services".
  • Updated screenshots.
-

2018-09-05

-

This is the eleventh official release.

-

Updated screenshots.

-

2018-07-30

-

This is the tenth official release.

-
  • Added section "Adding a Tag".
  • Added section "Searching for Tags".
  • Added section "Modifying Tag Values".
  • Added section "Deleting Tags".
  • Modified contents in section "Functions": added description about adding, editing, and deleting tags.
  • Modified section "Related Services": added descriptions about the operations of adding tags, deleting tags, adding tags in batches, and deleting tags in batches.
  • Modified section "Creating a Key": added the procedure for adding a tag.
  • Modified section "Importing Key Material": added the procedure for adding a tag.
  • Accepted in OTC 3.1.
  • Added description about RSAES_OAEP_SHA_256 and RSAES_OAEP_SHA_1 algorithms.
  • Added the description about using KMS encryption for RDS.
  • Added description about the relationship between KMS and RDS, as well as how to use RDS together with KMS.
-

2018-06-15

-

This is the ninth official release.

-
  • Added the description about using KMS encryption for SFS.
  • Added description about relationships between KMS and SFS, as well as how to use these services together with KMS.
  • Updated screenshots.
  • Modified section "Importing Key material": updated the screenshots.
  • Modified section "Deleting Key material": added related descriptions.
  • Modified section "Configuring SMN-Enabled Event Notification": updated screenshots.
  • Modified section "Importing Key Material": added the description about how to obtain the wrapping key and import token calling the API.
  • Updated screenshots.
-

2018-03-30

-

This is the eighth official release.

-
  • Updated screenshots.
  • Added section "Importing a CMK".
  • Added section "Overview".
  • Added section "Importing Key Material".
  • Added section "Deleting Key Material".
  • Added the description of importing and deleting keys to section "Related Services".
  • Updated screenshots.
-

2017-11-30

-

This is the seventh official release.

-

Updated a screenshot in section "Scheduling the Deletion of One or Multiple CMKs".

-

2017-10-30

-

This is the sixth official release.

-
  • Added operations creating a grant, retiring a grant, and revoking a grant to the table of supported KMS operations in section "Related Services".
  • Added section "Configuring SMN".
  • Added section "Creating a Grant".
  • Added section "Querying a Grant".
  • Added section "Revoking a Grant".
-

2017-08-30

-

This is the fifth official release.

-
  • Added section "Project".
  • Added the step of selecting a project.
  • Updated some screenshots.
-

2017-06-30

-

This is the fourth official release.

-
  • Added operations changing the alias of a CMK, changing the description of a CMK, and prompting risks about CMK deletion to table "KMS operations that CTS supports" in section "Related Services".
  • Added section "Changing the Alias and Description of a CMK".
-

2017-03-31

-

This is the third official release.

-
  • Added section "Glossary".
  • Added section "User Permissions".
-

2017-01-20

-

This is the second official release.

-
  • Added definitions of OBS, EVS, and IMS and optimized description about application scenarios.
  • Optimized description about SSE-KMS and description about KMS operations that CTS supports.
  • Added description about how to create a DEK and a plaintext-free DEK.
  • Added description about relationships between KMS, EVS and IMS as well as how to use these services together with KMS.
  • Added description about how to encrypt data on EVS disks.
  • Added description about how to encrypt private images.
-

2016-12-30

-

This is the first official release.

-
-
-
- diff --git a/docs/kms/umn/en-us_topic_0000002203211100.html b/docs/kms/umn/en-us_topic_0000002203211100.html new file mode 100644 index 000000000..97309c7a5 --- /dev/null +++ b/docs/kms/umn/en-us_topic_0000002203211100.html @@ -0,0 +1,20 @@ + + +

Key Alias

+

An alias is an identifier of a key. You can use the alias as the key ID during API calling. The original key alias is not used as the key name.

+

This section describes how to add and delete an alias for a key.

+

Constraints

+
+

Creating an Alias

  1. Log in to the management console.
  2. Click in the upper left corner and select a region or project.
  3. Choose Security > Key Management Service .
  4. Click the target key name. On the key details page, click the Alias tab.
  5. Click Create Alias. Enter the alias in the displayed dialog box and click OK.

    Only digits, letters, underscores (_), hyphens (-), colons (:), and slashes (/) are allowed.

    +
    +

+
+

Deleting an Alias

  1. Log in to the management console.
  2. Click in the upper left corner and select a region or project.
  3. Choose Security > Key Management Service .
  4. Click the target key name. On the key details page, click the Alias tab.
  5. Enter DELETE in the confirmation dialog box and click OK.
+
+
+
+ +
+ diff --git a/docs/kms/umn/kms_01_0001.html b/docs/kms/umn/kms_01_0001.html deleted file mode 100644 index a2a7899f5..000000000 --- a/docs/kms/umn/kms_01_0001.html +++ /dev/null @@ -1,94 +0,0 @@ - - -

Functions

-

KMS is a secure, reliable, and easy-to-use cloud service that helps users create, manage, and protect keys in a centralized manner.

-

It uses Hardware Security Modules (HSMs) to protect keys. All keys are protected by root keys in HSMs to avoid key leakage. The HSM module meets the FIPS 140-2 Level 3 security requirements.

-

It also controls access to keys and records all operations on keys with traceable logs. In addition, it provides use records of all keys, meeting your audit and regulatory compliance requirements.

-

Functions

-
-

Key Algorithms Supported by KMS

Symmetric keys created on the KMS console use the AES algorithm. Asymmetric keys created by KMS support the RSAand ECC algorithms.

- -
- - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Key algorithms supported by KMS

Key Type

-

Algorithm Type

-

Key Specifications

-

Description

-

Application Scenario

-

Symmetric key

-

AES

-

AES_256

-

AES symmetric key

-
  • Data encryption and decryption
  • DEKs encryption and decryption
    NOTE:

    You can encrypt and decrypt a small amount of data using the the online tool on the console.

    -

    You need to call APIs to encrypt and decrypt a large amount of data.

    -
    -
-

Asymmetric key

-

RSA

-
  • RSA_2048
  • RSA_3072
  • RSA_4096
-

RSA asymmetric password

-
  • Digital signature and signature verification
  • Data encryption and decryption
    NOTE:

    Asymmetric keys are applicable to signature and signature verification scenarios. Asymmetric keys are not efficient enough for data encryption. Symmetric keys are suitable for encrypting and decrypting data.

    -
    -
-

ECC

-
  • EC_P256
  • EC_P384
-

Elliptic curve recommended by NIST

-

Digital signature and signature verification

-
-
-

Table 2 describes the encryption and decryption algorithms supported for user-imported keys.

- -
- - - - - - - - - -
Table 2 Key wrapping algorithms

Algorithm

-

Description

-

Configuration

-

RSAES_OAEP_SHA_256

-

RSA algorithm that uses OAEP and has the SHA-256 hash function

-

Select an algorithm based on your HSM functions.

-

If your HSM supports the RSAES_OAEP_SHA_256 algorithm, use RSAES_OAEP_SHA_256 to encrypt key materials.

-
-
-
-
-
- -
- diff --git a/docs/kms/umn/kms_01_0003.html b/docs/kms/umn/kms_01_0003.html new file mode 100644 index 000000000..e19c80739 --- /dev/null +++ b/docs/kms/umn/kms_01_0003.html @@ -0,0 +1,29 @@ + + +

Concepts

+
+
+ + + +
+ diff --git a/docs/kms/umn/kms_01_0004.html b/docs/kms/umn/kms_01_0004.html new file mode 100644 index 000000000..3b6eedc18 --- /dev/null +++ b/docs/kms/umn/kms_01_0004.html @@ -0,0 +1,13 @@ + + +

KMS

+

Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).

+

This service uses hardware security modules (HSMs) to protect CMKs. HSMs help you create and control CMKs with ease. All CMKs are protected by root keys in HSMs to avoid leakage caused by human error.

+

KMS implements access control and log-based tracking on all operations involving CMKs. Additionally, it provides use records of all CMKs, meeting your audit and regulatory compliance requirements.

+
+
+ +
+ diff --git a/docs/kms/umn/kms_01_0005.html b/docs/kms/umn/kms_01_0005.html new file mode 100644 index 000000000..5448ae427 --- /dev/null +++ b/docs/kms/umn/kms_01_0005.html @@ -0,0 +1,12 @@ + + +

CMK

+

A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user using KMS. It is used to encrypt and protect Data Encryption Keys (DEKs). One CMK can be used to encrypt one or multiple DEKs.

+

CMKs are categorized into custom keys and default keys.

+
+
+ +
+ diff --git a/docs/kms/umn/kms_01_0006.html b/docs/kms/umn/kms_01_0006.html index 7ab4e388c..c615c3268 100644 --- a/docs/kms/umn/kms_01_0006.html +++ b/docs/kms/umn/kms_01_0006.html @@ -1,26 +1,54 @@ -

Application Scenarios

-

Small Data Encryption and Decryption

You can use the online tool on the KMS console or call KMS APIs to directly encrypt or decrypt a small amount of data, such as passwords, certificates, or phone numbers. Currently, a maximum of 4 KB of data can be encrypted or decrypted in this way.

-

Figure 1 shows an example about how to call the APIs to encrypt and decrypt an HTTPS certificate.

-
Figure 1 Encrypting and decrypting an HTTPS certificate
-
The procedure is as follows:
  1. Create a CMK on KMS.
  2. Call the encrypt-data API of KMS and use the CMK to encrypt the plaintext certificate.
  3. Deploy the certificate onto a server.
  4. The server calls the decrypt-data API of KMS to decrypt the ciphertext certificate.
-
-
-

Large Data Encryption and Decryption

If you want to encrypt or decrypt large volumes of data, such as pictures, videos, and database files, you can use the envelope encryption method, where the data does not need to be transferred over the network.

- +

Default Key

+

A default key is automatically created by another cloud service using KMS, such as Object Storage Service (OBS). The name of a default key ends with /default.

+

You can use the management console to query the status of Default Master Keys, but cannot disable or schedule the deletion of default keys.

+ +
+ + + + + + + + + + + + + + + + + + + + + + +
Table 1 Default keys

Key Name

+

Cloud Service

+

obs/default

+

Object Storage Service (OBS)

+

evs/default

+

Elastic Volume Service (EVS)

+

ims/default

+

Image Management Service (IMS)

+

sfs/default

+

Scalable File Service (SFS)

+

rds/default

+

Relational Database Service (RDS)

+

kps/default

+

Key Pair Service (KPS)

+
+

A Default Master Key is automatically created when a user employs the KMS encryption function for the first time in another cloud service.

+
diff --git a/docs/kms/umn/kms_01_0007.html b/docs/kms/umn/kms_01_0007.html index 5159032a4..90a697ae8 100644 --- a/docs/kms/umn/kms_01_0007.html +++ b/docs/kms/umn/kms_01_0007.html @@ -1,14 +1,11 @@ -

Encrypting Data in OBS

-
  • When using Object Storage Service (OBS) to upload data with server-side encryption, you can select KMS encryption and use the key provided by KMS to encrypt the files to be uploaded. For details, see Figure 1. For more information, see Object Storage Service User Guide.
    Figure 1 OBS server-side encryption
    -

    There are two types of CMKs that can be used:

    -
    • The default key obs/default created by KMS
    • Custom keys that you created on the KMS console
    -
  • Alternatively, you can call OBS APIs to upload a file with server-side encryption using KMS-managed keys (SSE-KMS). For details, see the .
+

DEK

+

Data Encryption Keys (DEKs) are used by users to encrypt data.

diff --git a/docs/kms/umn/kms_01_0008.html b/docs/kms/umn/kms_01_0008.html index c6a37ac11..833c416d0 100644 --- a/docs/kms/umn/kms_01_0008.html +++ b/docs/kms/umn/kms_01_0008.html @@ -1,16 +1,11 @@ -

Encrypting Data in EVS

-
  • When purchasing a disk, you can choose Advanced Settings > Encryption to encrypt the disk using the key provided by KMS. For details, see Figure 1. For more information about EVS, see the Elastic Volume Service User Guide.

    Before you use the encryption function, EVS must be granted the permission to access KMS. If you have the right to grant the permission, you can grant the permission directly. If you do not have the permission, contact a user with the security administrator permissions to add the security administrator permission for you. Then, you can grant the permission. For more information about EVS, see the Elastic Volume Service User Guide.

    -
    -
    Figure 1 Encrypting data in EVS
    -

    There are two types of CMKs that can be used:

    -
    • The default key evs/default created by KMS
    • Custom keys that you create on the KMS console using KMS-generated key materials
    -
  • You can also call EVS APIs to create encrypted EVS disks. For details, see the Elastic Volume Service API Reference.
+

HSM

+

A Hardware Security Module (HSM) securely produces, stores, manages, and uses keys and provides encryption services.

diff --git a/docs/kms/umn/kms_01_0009.html b/docs/kms/umn/kms_01_0009.html index ae083cdd5..cf5af500d 100644 --- a/docs/kms/umn/kms_01_0009.html +++ b/docs/kms/umn/kms_01_0009.html @@ -1,14 +1,11 @@ -

Encrypting Data in IMS

-
  • When uploading an image file to Image Management Service (IMS), you can choose to encrypt the image file using a key provided by KMS to protect the file. Figure 1 describes details. For details, see the Image Management Service User Guide.
    Figure 1 Encrypting data in IMS
    -

    There are two types of CMKs that can be used:

    -
    • The default key ims/default created by KMS
    • Custom keys that you create on the KMS console using KMS-generated key materials
    -
  • You can also call IMS APIs to create encrypted image files. For details, see Image Management Service API Reference.
+

Envelope Encryption

+

Envelope encryption is an encryption method that enables DEKs to be stored, transmitted, and used in "envelopes." As a result, CMKs are not used to directly encrypt and decrypt data.

diff --git a/docs/kms/umn/kms_01_0010.html b/docs/kms/umn/kms_01_0010.html new file mode 100644 index 000000000..968b05fae --- /dev/null +++ b/docs/kms/umn/kms_01_0010.html @@ -0,0 +1,11 @@ + + +

TRNG

+

A true random number generator (TRNG) is a device that generates unpredictable random numbers by physical procedures instead of computer programs.

+
+
+ +
+ diff --git a/docs/kms/umn/kms_01_0012.html b/docs/kms/umn/kms_01_0012.html new file mode 100644 index 000000000..23023619a --- /dev/null +++ b/docs/kms/umn/kms_01_0012.html @@ -0,0 +1,12 @@ + + +

Project

+

A project is used to group and isolate OpenStack resources, including computing, storage, and network resources. A project can be a department or a project team.

+

Multiple projects can be created for one account.

+
+
+ +
+ diff --git a/docs/kms/umn/kms_01_0013.html b/docs/kms/umn/kms_01_0013.html new file mode 100644 index 000000000..9a066da29 --- /dev/null +++ b/docs/kms/umn/kms_01_0013.html @@ -0,0 +1,17 @@ + + +

Accessing and Using KMS

+
+
+ + + +
+ diff --git a/docs/kms/umn/kms_01_0014.html b/docs/kms/umn/kms_01_0014.html new file mode 100644 index 000000000..0e098aebb --- /dev/null +++ b/docs/kms/umn/kms_01_0014.html @@ -0,0 +1,14 @@ + + +

How to Access KMS

+

The cloud service provides a web-based service management platform. You can access KMS using HTTPS-compliant APIs or the management console.

+
  • Management console

    If you have registered with the cloud service, you can log in to the management console directly. In the upper left corner of the console, click . Select a region or project. Choose Security > Key Management Service.

    +
  • API

    You can access KMS using APIs. For details, see Key Management Service (KMS) API Reference.

    +
+
+
+ +
+ diff --git a/docs/kms/umn/kms_01_0015.html b/docs/kms/umn/kms_01_0015.html index 740d3fb2b..69a1fba72 100644 --- a/docs/kms/umn/kms_01_0015.html +++ b/docs/kms/umn/kms_01_0015.html @@ -1,15 +1,27 @@ -

How to Access

-

The cloud service provides a web-based service management platform. You can access KMS using HTTPS-compliant APIs or the management console.

-
  • Management console

    Log in to the management console. In the upper left corner, click . Select a region or project. Click and choose Security > Key Management Service.

    -

    -
  • API

    You can access KMS using the API. For details, see the Key Management Service API Reference.

    -
+

How to Use KMS

+

Working with OBS

Users can upload objects to and download them from Object Storage Service (OBS) in common mode or server-side encryption mode. When users upload objects in encryption mode, data is encrypted at the server side and then securely stored on OBS in ciphertext. When users download encrypted objects, the data in ciphertext is decrypted at the server side and then provided to users in plaintext. OBS supports the server-side encryption with KMS-managed keys (SSE-KMS) mode. In SSE-KMS mode, OBS uses the keys provided by KMS for server-side encryption.

+

For details about how to upload objects to OBS in SSE-KMS mode, see the Object Storage Service User Guide.

+
+

Working with EVS

If you enable the encryption function when creating an EVS disk and select a CMK provided by KMS to encrypt the EVS disk, data stored to the EVS disk is automatically encrypted.

+

For details about how to use the encryption function of EVS, see the Elastic Volume Service User Guide.

+
+

Working with IMS

When creating a private image using an external image file, you can enable the private image encryption function and select a CMK provided by KMS to encrypt the image.

+

For details about how to use the private image encryption function of Image Management Service (IMS), see the Image Management Service User Guide.

+
+

Working with SFS

When creating a file system on SFS, the CMK provided by KMS can be selected to encrypt the file system, so that files stored in the file system are automatically encrypted.

+

For details about how to use the encryption function of SFS, see the Scalable File Service User Guide.

+
+

Working with RDS

When creating a database instance, you can enable the disk encryption function of the database instance and select a CMK created on KMS to encrypt the disk of the database instance. The enablement of disk encryption will enhance data security.

+

For details about how to use the disk encryption function of RDS, see the Relational Database Service User Guide.

+
+

Working with User Applications

To encrypt plaintext data, a user application can call the necessary KMS APIs to generate a DEK. The DEK can then be used to encrypt the plaintext data. Then the application can store the encrypted data. In addition, the user application can call the necessary KMS APIs to create CMKs. DEKs can be stored in ciphertext after being encrypted with the CMKs. For details, see the Key Management Service API Reference.

+
diff --git a/docs/kms/umn/kms_01_0016.html b/docs/kms/umn/kms_01_0016.html index f26229daa..366491e23 100644 --- a/docs/kms/umn/kms_01_0016.html +++ b/docs/kms/umn/kms_01_0016.html @@ -1,72 +1,229 @@ -

Using KMS

-

Interacting with Cloud Services

Cloud services use the envelope encryption technology and call KMS APIs to encrypt service resources. Your CMKs are under your own management. With your grant, cloud services use a specific custom key of yours to encrypt data.

-
The encryption process is as follows:
  1. Create a custom key on KMS.
  2. Cloud services call the create-datakey API of the KMS to create a DEK. Then you get a plaintext DEK and a ciphertext DEK.

    Ciphertext DEKs are generated when you use a CMK to encrypt the plaintext DEKs.

    -
    -
  3. Cloud services use the plaintext DEK to encrypt a plaintext file, generating a ciphertext file.
  4. Cloud services store the ciphertext DEK and ciphertext file in a persistent storage device or a storage service.
+

Related Services

+

OBS

Object Storage Service (OBS) is a scalable service that provides secure, reliable, and cost-effective cloud storage for massive amounts of data. KMS provides central management and control capabilities of CMKs for OBS. It is used for server-side encryption with KMS-managed keys (SSE-KMS) on OBS.

-

When users download the data from a cloud service, the service uses the custom key specified by KMS to decrypt the ciphertext DEK, uses the decrypted DEK to decrypt data, and then provides the decrypted data for users to download.

-
+

EVS

Elastic Volume Service (EVS) offers scalable block storage for cloud servers. With high reliability, high performance, and rich specifications, EVS disks can be used for distributed file systems, development and test environments, data warehouse applications, and high-performance computing (HPC) scenarios to meet diverse service requirements. KMS provides central management and control capabilities of CMKs for EVS. It is used for encryption in EVS.

+
+

IMS

Image Management Service (IMS) allows you to manage the entire lifecycle of your images. KMS provides central management and control capabilities of CMKs for Image Management Service (IMS). It is used for private image encryption in IMS.

+
+

SFS

Scalable File Service (SFS) provides high-performance file storage (NAS) that can be expanded on demand. KMS provides central management and control capabilities of CMKs for SFS. It is used for file system encryption in SFS.

+
+

RDS

Relational Database Service (RDS) is a cloud relational database that is reliable, scalable, easy to manage, and immediately ready for use. KMS provides central management and control capabilities of CMKs for RDS. It is used for disk encryption in RDS.

+
+

DDS

Document Database Service (DDS) is a MongoDB-compatible database service that is secure, highly available, reliable, scalable, and easy to use. It provides DB instance creation, scaling, redundancy, backup, restoration, monitoring, and alarm reporting functions with just a few clicks on the DDS console. KMS provides central management and control capabilities of CMKs for DDS. It is used for disk encryption in DDS.

+
+

CTS

Cloud Trace Service (CTS) provides you with a history of KMS operations. After the CTS service is enabled, you can view all generated traces to review and audit performed KMS operations. For details, see the Cloud Trace Service User Guide.

-
Table 1 List of cloud services that use KMS encryption

Service Name

+
- + - - + - - + - - + - - + - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 KMS operations supported by CTS

Operation

Description

+

Resource Type

+

Trace Name

Object Storage Service (OBS)

+

Create a key

You can upload objects to and download them from Object Storage Service (OBS) in common mode or server-side encryption mode. When you upload objects in encryption mode, data is encrypted at the server side and then securely stored on OBS in ciphertext. When you download encrypted objects, the data in ciphertext is decrypted at the server side and then provided to you in plaintext. OBS supports the server-side encryption with KMS-managed keys (SSE-KMS) mode. In SSE-KMS mode, OBS uses the keys provided by KMS for server-side encryption.

-

For details about how to upload objects to OBS in SSE-KMS mode, see the Object Storage Service Console Operation Guide.

+

CMK

+

createKey

Elastic Volume Service (EVS)

+

Create a DEK

If you enable the encryption function when creating an EVS disk, the disk will be encrypted with the DEK generated by using your CMK. Data stored in the EVS disk will be automatically encrypted.

-

For details about how to use the encryption function of EVS, see Elastic Volume Service User Guide.

+

CMK

+

createDataKey

Image Management Service (IMS)

+

Create a plaintext-free DEK

When creating a private image using an external image file, you can enable the private image encryption function and select a CMK provided by KMS to encrypt the image.

-

For details about how to use the private image encryption function of Image Management Service (IMS), see Image Management Service User Guide.

+

CMK

+

createDataKeyWithoutPlaintext

Scalable File Service (SFS)

+

Enable a key

When creating a file system on SFS, the CMK provided by KMS can be selected to encrypt the file system, so that files stored in the file system are automatically encrypted.

-

For details about how to use the file system encryption function of SFS, see Scalable File Service User Guide.

+

CMK

+

enableKey

Relational Database Service (RDS)

+

Disable a key

When purchasing a database instance, you can enable the disk encryption function of the database instance and select a CMK created on KMS to encrypt the disk of the database instance. Enabling the disk encryption function will enhance data security.

-

For details about how to use the disk encryption function of RDS, see Relational Database Service User Guide.

+

CMK

+

disableKey

Document Database Service (DDS)

+

Encrypt a DEK

When purchasing a DDS instance, you can enable the disk encryption function of the instance and select a CMK created on KMS to encrypt the disk of the instance. Enabling the disk encryption function will enhance data security.

-

For details about how to use the disk encryption function of DDS, see Document Database Service User Guide.

+

CMK

+

encryptDatakey

+

Decrypt a DEK

+

CMK

+

decryptDatakey

+

Schedule key deletion

+

CMK

+

scheduleKeyDeletion

+

Cancel scheduled key deletion

+

CMK

+

cancelKeyDeletion

+

Generate random numbers

+

RNG

+

genRandom

+

Modify a key alias

+

CMK

+

updateKeyAlias

+

Modify key description

+

CMK

+

updateKeyDescription

+

Prompt risks about CMK deletion

+

CMK

+

deleteKeyRiskTips

+

Import key materials

+

CMK

+

importKeyMaterial

+

Delete key materials

+

CMK

+

deleteImportedKeyMaterial

+

Create a grant

+

CMK

+

createGrant

+

Retire a grant

+

CMK

+

retireGrant

+

Revoke a grant

+

CMK

+

revokeGrant

+

Encrypt data

+

CMK

+

encryptData

+

Decrypt data

+

CMK

+

decryptData

+

Add a tag

+

CMK

+

dealUnifiedTags

+

Delete a tag

+

CMK

+

dealUnifiedTags

+

Add tags in batches

+

CMK

+

dealUnifiedTags

+

Delete tags in batches

+

CMK

+

dealUnifiedTags

+

Enable key rotation

+

CMK

+

enableKeyRotation

+

Modify key rotation interval

+

CMK

+

updateKeyRotationInterval

+

Disable key rotation

+

CMK

+

disableKeyRotation

-

Working with User Applications

To encrypt plaintext data, a user application can call the necessary KMS API to create a DEK. The DEK can then be used to encrypt the plaintext data. Then the application can store the encrypted data. In addition, the user application can call the KMS API to create CMKs. DEKs can be stored in ciphertext after being encrypted with the CMKs.

-

Envelope encryption is implemented, with CMKs stored in KMS and ciphertext DEKs in user applications. KMS is called to decrypt a ciphertext DEK only when necessary.

-
The encryption process is as follows:
  1. The application calls the create-key API of KMS to create a custom key.
  2. The application calls the create-datakey API of KMS to create a DEK. A plaintext DEK and a ciphertext DEK are generated.

    Ciphertext DEKs are generated when you use a CMK to encrypt the plaintext DEKs in 1.

    -
    -
  3. The application uses the plaintext DEK to encrypt a plaintext file. A ciphertext file is generated.
  4. The application saves the ciphertext DEK and the ciphertext file together in a persistent storage device or a storage service.
-
-

For details, see the Key Management Service API Reference.

+

IAM

Identity and Access Management (IAM) provides the permission management function for KMS.

+

Only users who have KMS Administrator permissions can use KMS.

+

To apply for permissions, contact a user with Security Administrator permissions. For details, see the Identity and Access Management User Guide.

diff --git a/docs/kms/umn/kms_01_0017.html b/docs/kms/umn/kms_01_0017.html deleted file mode 100644 index ee9c3a02a..000000000 --- a/docs/kms/umn/kms_01_0017.html +++ /dev/null @@ -1,227 +0,0 @@ - - -

Related Services

-

OBS

Object Storage Service (OBS) is a scalable service that provides secure, reliable, and cost-effective cloud storage for massive amounts of data. KMS provides central management and control capabilities of CMKs for OBS. It is used for server-side encryption with KMS-managed keys (SSE-KMS) on OBS.

-
-

EVS

Elastic Volume Service (EVS) offers scalable block storage for cloud servers. With high reliability, high performance, and rich specifications, EVS disks can be used for distributed file systems, development and test environments, data warehouse applications, and high-performance computing (HPC) scenarios to meet diverse service requirements. KMS provides central management and control capabilities of CMKs for EVS. It is used for encryption in EVS.

-
-

IMS

Image Management Service (IMS) allows you to manage the entire lifecycle of your images. KMS provides central management and control capabilities of CMKs for Image Management Service (IMS). It is used for private image encryption in IMS.

-
-

SFS

Scalable File Service (SFS) provides high-performance file storage (NAS) that can be expanded on demand. KMS provides central management and control capabilities of CMKs for SFS. It is used for file system encryption in SFS.

-
-

RDS

Relational Database Service (RDS) is a relational database that is reliable, scalable, easy to manage, and immediately ready for use. KMS provides central management and control capabilities of CMKs for RDS. It is used for disk encryption in relational databases.

-
-

CTS

Cloud Trace Service (CTS) provides you with a history of KMS operations. After the CTS service is enabled, you can view all generated traces to review and audit performed KMS operations. For details, see the Cloud Trace Service User Guide.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 KMS operations supported by CTS

Operation

-

Resource Type

-

Trace Name

-

Create a key

-

cmk

-

createKey

-

Create a DEK

-

cmk

-

createDataKey

-

Create a plaintext-free DEK

-

cmk

-

createDataKeyWithoutPlaintext

-

Enable a key

-

cmk

-

enableKey

-

Disable a key

-

cmk

-

disableKey

-

Encrypt a DEK

-

cmk

-

encryptDatakey

-

Decrypt a DEK

-

cmk

-

decryptDatakey

-

Schedule key deletion

-

cmk

-

scheduleKeyDeletion

-

Cancel scheduled key deletion

-

cmk

-

cancelKeyDeletion

-

Generate random numbers

-

rng

-

genRandom

-

Modify a key alias

-

cmk

-

updateKeyAlias

-

Modify key description

-

cmk

-

updateKeyDescription

-

Prompt risks about CMK deletion

-

cmk

-

deleteKeyRiskTips

-

Import key materials

-

cmk

-

importKeyMaterial

-

Delete key materials

-

cmk

-

deleteImportedKeyMaterial

-

Create a grant

-

cmk

-

createGrant

-

Retire a grant

-

cmk

-

retireGrant

-

Revoke a grant

-

cmk

-

revokeGrant

-

Encrypt data

-

cmk

-

encryptData

-

Decrypt data

-

cmk

-

decryptData

-

Add a tag

-

cmk

-

dealUnifiedTags

-

Delete a tag

-

cmk

-

dealUnifiedTags

-

Add tags in batches

-

cmk

-

dealUnifiedTags

-

Delete tags in batches

-

cmk

-

dealUnifiedTags

-

Enable key rotation

-

cmk

-

enableKeyRotation

-

Modify key rotation interval

-

cmk

-

updateKeyRotationInterval

-

Disable key rotation

-

cmk

-

disableKeyRotation

-
-
-
-

IAM

Identity and Access Management (IAM) provides the permission management function for KMS.

-

Only users who have KMS Administrator permissions can use KMS.

-

To apply for permissions, contact a user with Security Administrator permissions. For details, see the Identity and Access Management User Guide.

-
-
-
- -
- diff --git a/docs/kms/umn/kms_01_0018.html b/docs/kms/umn/kms_01_0018.html index 8d00ccdbd..88d7d1ce8 100644 --- a/docs/kms/umn/kms_01_0018.html +++ b/docs/kms/umn/kms_01_0018.html @@ -1,326 +1,27 @@ -

KMS Permission Management

-

If you want to assign different access permissions to employees in an enterprise for the KMS resources purchased on the cloud platform, you can use Identity and Access Management (IAM) to perform refined permission management. IAM provides identity authentication, permissions management, and access control, helping you secure access to your resources.

-

With IAM, you can use your account to create IAM users for your employees, and grant permissions to control their access to specific resource types. For example, if you have software developers and you want to assign them the permission to access KMS but not to delete KMS or its resources, then you can create an IAM policy to assign the developers the permission to access KMS but prevent them from deleting KMS related data.

-

If the system account has met your requirements and you do not need to create an independent IAM user for permission control, then you can skip this section. This will not affect other functions of KMS.

-

KMS Permissions

By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from their groups and can perform specified operations on cloud services based on the permissions.

-

KMS is a project-level service deployed and accessed in specific physical regions. To assign permissions to a user group, specify the scope as region-specific projects and select projects for the permissions to take effect. If All projects is selected, the permissions will take effect for the user group in all region-specific projects. Users need to switch to the authorized region when accessing KMS.

-

You can grant users permissions by using roles and policies.

-
  • Roles: A type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. This mechanism provides only a limited number of service-level roles for authorization. When using roles to grant permissions, you must also assign other roles that the permissions depend on to take effect. However, roles are not an ideal choice for fine-grained authorization and secure access control.
  • Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization, meeting requirements for secure access control. For example, you can grant KMS users only the permissions for managing a certain type of cloud servers. Most policies contain permissions for specific APIs, and permissions are defined using API actions.
-

For more information, see Table 1.

- -
- - - - - - - - - - - - - - - - - - - - - -
Table 1 KMS permissions

Role/Policy

-

Description

-

Type

-

KMS Administrator

-

Administrator permissions for the encryption key

-

Role

-

KMS CMKFullAccess

-

All permissions for the encryption keys

-

Policy

-

KMS CMK Admin

-

All permissions for the encryption keys

-

Policy

-

KMS CMKReadOnlyAccess

-

Read-only permission for encryption keys

-

Policy

-
-
-

Table 2 lists the common operations supported by each system-defined permission of KMS. Select the permissions as needed.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Common operations supported by each system-defined policy or role

Operation

-

KMS Administrator

-

KMS CMKFullAccess

-

Create a key

-

-

-

Enable a key

-

-

-

Disable a key

-

-

-

Schedule key deletion

-

-

-

Cancel scheduled key deletion

-

-

-

Modify a key alias

-

-

-

Modify key description

-

-

-

Generate a random number

-

-

-

Create a DEK

-

-

-

Create a plaintext-free DEK

-

-

-

Encrypt a DEK

-

-

-

Decrypt a DEK

-

-

-

Obtain parameters for importing a key

-

-

-

Import key materials

-

-

-

Delete key materials

-

-

-

Create a grant

-

-

-

Revoke a grant

-

-

-

Retire a grant

-

-

-

Query the grant list

-

-

-

Query retirable grants

-

-

-

Encrypt data

-

-

-

Decrypt data

-

-

-

Enable key rotation

-

-

-

Modify key rotation interval

-

-

-

Disable key rotation

-

-

-

Query key rotation status

-

-

-

Query CMK instances

-

-

-

Query key tags

-

-

-

Query project tags

-

-

-

Batch add or delete key tags

-

-

-

Add tags to a key

-

-

-

Delete key tags

-

-

-

Query the key list

-

-

-

Query key details

-

-

-

Query instance quantity

-

-

-

Query quotas

-

-

-
-
-
-

Related Links

  • Two types of permission policies are provided by default: default policies and custom policies. Default policies are pre-defined by IAM and cannot be modified. If default policies do not meet your requirements, you can create custom policies for fine-grained permission control.
  • Configure permission policies for a user group and add users to the group so that these users can obtain operation permissions defined in the policies.
-
-
+

Key Management

+
diff --git a/docs/kms/umn/kms_01_0019.html b/docs/kms/umn/kms_01_0019.html new file mode 100644 index 000000000..26b0cdebd --- /dev/null +++ b/docs/kms/umn/kms_01_0019.html @@ -0,0 +1,19 @@ + + +

Creating CMKs Using Imported Key Material

+
+ + diff --git a/docs/kms/umn/kms_01_0020.html b/docs/kms/umn/kms_01_0020.html new file mode 100644 index 000000000..196162036 --- /dev/null +++ b/docs/kms/umn/kms_01_0020.html @@ -0,0 +1,20 @@ + + +

Deleting a Key Material

+

Scenario

When importing key material, you can specify the expiration time. After the key material expires, KMS deletes it, and the status of the custom key changes to Pending import. You can manually delete the key material as needed. The effect of expiration of the key material is the same as that of manual deletion of the key material.

+

This section describes how to delete imported key material on the management console.

+
+

Constraints

  • To re-import a deleted key material, ensure the imported material is the same as the deleted one.
  • Data encrypted using a custom key cannot be decrypted if the key material of the custom key was deleted. To decrypt the data, re-import the key material.
  • After the deletion, the key will become unavailable and its status will change to Pending import.
+
+

Prerequisites

  • You have imported the key material for a key.
  • The material source of the key is External.
  • The key status is Enabled or Disabled.
+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner of the management console and select a region or project.
  3. Choose Security > Key Management Service . The key management page is displayed.
  4. Locate the target key material and choose More > Delete Key Material in the Operation column.
  5. In the displayed dialog box, click Yes.

    After the deletion, the key will become unavailable and its status changes to Pending import.

    +

+
+
+ + diff --git a/docs/kms/umn/kms_01_0021.html b/docs/kms/umn/kms_01_0021.html index 6b3f039a3..576a11d01 100644 --- a/docs/kms/umn/kms_01_0021.html +++ b/docs/kms/umn/kms_01_0021.html @@ -1,71 +1,77 @@

Configuring SMN

-

Scenario

This section describes how to configure the Simple Message Notification (SMN) function on the Cloud Trace Service (CTS) console.

-

Decryption will fail if the key used for encryption has been scheduled for deletion. You will receive messages about the decryption failure on terminals (SMS, email, HTTP, or HTTPS) if the SMN function has been configured in CTS.

+

Scenario

This section describes how to configure the Simple Message Notification (SMN) function on the Cloud Trace Service (CTS) console.

+

Decryption will fail if the key used for encryption has been scheduled for deletion. You will receive messages about the decryption failure on terminals (SMS, email, HTTP, or HTTPS) if the SMN function has been configured in CTS.

-

Prerequisites

  • CTS has been enabled.
  • You have subscribed to SMN.
+

Prerequisites

  • CTS has been enabled.
  • You have subscribed to SMN.
-

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner of the management console and select a region or project.
  3. Choose Management & Deployment > Cloud Trace Service to go to the CTS console.
  4. In the navigation pane on the left, click Tracker List.
  5. If the desired tracker is not enabled, click Enable. In the dialog box that is displayed, click OK to enable the tracker. If the tracker is already enabled, skip this step.
  6. In the navigation pane on the left, click Key Event Notifications.
  7. Click Create Key Event Notification at the upper right corner of the page. The creation page is displayed.
  8. In the Basic Information area, enter a notification name. See Figure 1 for details.

    Figure 1 Configuring basic information
    -

  9. Select operation types in the Operation area. See Figure 2 for details.

    Figure 2 Selecting operation types
    -

    +

    Procedure

    1. Log in to the management console.
    2. Click in the upper left corner of the management console and select a region or project.
    3. Choose Management & Deployment > Cloud Trace Service to go to the CTS console.
    4. In the navigation pane on the left, click Tracker List.
    5. If the desired tracker is not enabled, click Enable. In the dialog box that is displayed, click OK to enable the tracker. If the tracker is already enabled, skip this step.
    6. In the navigation pane on the left, click Key Event Notifications.
    7. Click Create Key Event Notification at the upper right corner of the page. The creation page is displayed.
    8. In the Basic Information area, enter a notification name. See Figure 1 for details.

      Figure 1 Configuring basic information
      +

    9. Select operation types in the Operation area. See Figure 2 for details.

      Figure 2 Selecting operation types
      -
      Table 1 Parameters for operation types

      Parameter

      +
      - - - - -
      Table 1 Parameters for operation types

      Parameter

      Description

      +

      Description

      Example Value

      +

      Example Value

      Operation Type

      +

      Operation Type

      SMN sends messages to users when deletion, creation, or login operations are performed on keys.

      +

      SMN sends messages to users when deletion, creation, or login operations are performed on keys.

      Delete

      +

      Delete

      -

    10. In the User area, specify the user who performs the specified operations. See Figure 3 for details.

      • You can select All users so that SMN notifications are sent when specified operations are performed by any user.
      • You can also select Specified users and add users to the User List. Then SMN notifications are sent when the specified operations are performed by specified users.
      +

    11. In the User area, specify the user who performs the specified operations. See Figure 3 for details.

      • You can select All users so that SMN notifications are sent when specified operations are performed by any user.
      • You can also select Specified users and add users to the User List. Then SMN notifications are sent when the specified operations are performed by specified users.
      -
      Figure 3 Specifying users
      -

    12. In the Topic area, configure whether to send notifications. See Figure 4 for details.

      Figure 4 Configuring SMN topic
      +
      Figure 3 Specifying users
      +

    13. In the Topic area, configure whether to send notifications. See Figure 4 for details.

      Figure 4 Configuring SMN
      -
      Table 2 Parameters for configuring the SMN notification

      Parameter

      +
      - - - - - - - -
      Table 2 Parameters for configuring the SMN notification

      Parameter

      Description

      +

      Description

      Configuration

      +

      Configuration

      Send Notification

      +

      Send Notification

      Specifies whether notifications will be sent.

      -
      • Select Yes to activate notification.
      • Select No to deactivate notification.
      +

      Specifies whether notifications will be sent.

      +
      • Select Yes to activate notification.
      • Select No to deactivate notification.

      Yes

      +

      Yes

      SMN Topic

      +

      SMN Topic

      You can select an existing topic or click Topic to create a topic.

      -

      For details about topics, see the Simple Message Notification User Guide.

      +

      You can select an existing topic or click Topic to create a topic.

      +

      For details about topics, see the Simple Message Notification User Guide.

      KMS

      +

      KMS

      -

    14. Click OK. The SMN notification is configured.
    15. +

    16. Click OK. The SMN notification is configured.
    17. + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0022.html b/docs/kms/umn/kms_01_0022.html index 54e1ce6cf..1be1c3275 100644 --- a/docs/kms/umn/kms_01_0022.html +++ b/docs/kms/umn/kms_01_0022.html @@ -1,28 +1,36 @@ -

      Using the Online Tool to Encrypt and Decrypt Small-Size Data

      -

      This section describes how to use the online tool to encrypt or decrypt small-size data (4 KB or smaller) on the KMS console.

      -

      Prerequisites

      The custom key is in Enabled status.

      +

      Encrypting and Decrypting Small-Size Data Online

      +

      This section describes how to use an online tool to encrypt and decrypt data less than or equal to 4 KB on the KMS console.

      +

      Prerequisites

      The desired custom key is in Enabled status.

      -

      Constraints

      • Default keys cannot be used to encrypt or decrypt such data with the tool.
      • Asymmetric keys cannot be used to encrypt or decrypt such data with the tool.
      • You can call an API to use a default key to encrypt or decrypt small volumes of data. For details, see the Key Management Service API Reference.
      • Use the current CMK to encrypt the data.
      • Exercise caution when you delete a CMK. The online tool cannot decrypt data if the CMK used for encryption has been deleted.
      +

      Constraints

      • Default keys cannot be used to encrypt or decrypt such data with the tool.
      • Asymmetric keys cannot be used to encrypt or decrypt such data with the tool.
      • You can call an API to use a default key to encrypt or decrypt small volumes of data. For details, see the Key Management Service API Reference.
      • Use the current CMK to encrypt the data.
      • Exercise caution when you delete a CMK. The online tool cannot decrypt data if the CMK used for encryption has been deleted.
      • After an API is called to encrypt data, the online tool cannot be used to decrypt the data.
      -

      Encrypting Data

      1. Log in to the management console.
      2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
      1. Click Encrypt. In the text box on the left, enter the data to be encrypted, as shown in Figure 1.

        Figure 1 Encrypting data
        -

      2. Click Execute. Ciphertext of the data is displayed in the text box on the right.

        • Use the current CMK to encrypt the data.
        • You can click Clear to clear the entered data.
        • You can click Copy to Clipboard to copy the ciphertext and save it in a local file.
        +

        Encrypting Data

        1. Log in to the management console.
        2. Click in the upper left corner of the management console and select a region or project.
        3. Choose Security > Key Management Service . The key management page is displayed.
        4. Click the name of the target custom key to access the key details page. Click the Tool tab.
        5. Click Encrypt. In the text box on the left, enter the data to be encrypted.

          Figure 1 Encrypting data

          +
          +

        6. Click Execute. The data encryption result is displayed in the text box on the right.

          • The key you clicked is used for encryption.
          • To clear your input, click Clear.
          • To copy the encrypted data, click Copy to Clipboard. You can then paste and save it to a local file.

        -

        Decrypting Data

        1. Log in to the management console.
        1. You can click any non-default key in Enabled status to go to the encryption and decryption page of the online tool.
        2. Click Decrypt. In the text box on the left, enter the data to be decrypted. For details, see Figure 2.

          • The tool will identify the original encryption CMK and use it to decrypt the data.
          • If the key has been deleted, the decryption will fail.
          +

          Decrypting Data

          1. Log in to the management console.
          2. Click in the upper left corner of the management console and select a region or project.
          3. Choose Security > Key Management Service . The key management page is displayed.
          4. Click the alias of an enabled key (excepting Default Master Keys) to access its details page.
          5. Click the Tool tab.
          6. Click Decrypt. In the text box on the left, enter the data to be decrypted.

            • The online tool automatically identifies the key used for data encryption, and uses it to decrypt data.
            • If the key has been deleted, the decryption will fail.
            -
            Figure 2 Decrypting data
            -

          7. Click Execute. Plaintext of the data is displayed in the text box on the right.

            • You can click Copy to Clipboard to copy the plaintext and save it in a local file.
            • Enter the plaintext on the console, the text will be encoded to Base64 format before encryption.

              The decryption result returned via API will be in Base64 format. Perform Base64 decoding to obtain the plaintext entered on the console.

              -
            +
            Figure 2 Decrypting data

            +
            +

          8. Click Execute. The data decryption result is displayed in plaintext in the text box on the right.

            To copy the decrypted data, click Copy to Clipboard. You can then paste and save it to a local file.

          + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0023.html b/docs/kms/umn/kms_01_0023.html index ff38bb45b..9931014d3 100644 --- a/docs/kms/umn/kms_01_0023.html +++ b/docs/kms/umn/kms_01_0023.html @@ -1,11 +1,13 @@

          Managing Tags

          -
          +
          diff --git a/docs/kms/umn/kms_01_0024.html b/docs/kms/umn/kms_01_0024.html index 95f62c841..a8dbc8ff6 100644 --- a/docs/kms/umn/kms_01_0024.html +++ b/docs/kms/umn/kms_01_0024.html @@ -1,49 +1,49 @@

          Adding a Tag

          -

          Tags are used to identify keys. You can add tags to custom keys so that you can classify custom keys, trace them, and collect their usage status according to the tags.

          -

          Constraints

          Tags cannot be added to default keys.

          +

          Scenario

          Tags are used to identify custom keys. You can add tags to custom keys so that you can classify custom keys, trace them, and collect their usage status according to the tags.

          -

          Procedure

          1. Log in to the management console.
          2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
          3. Click the alias of the target custom key to view its details.
          4. Click Tags to go to the tag management page.
          5. Click Add Tag. In the Add Tag dialog box, enter the tag key and tag value. Table 1 describes the parameters.

            Figure 1 Adding a tag
            +

            Constraints

            Tags cannot be added to default keys.

            +
            +

            Procedure

            1. Log in to the management console.
            2. Click in the upper left corner of the management console and select a region or project.
            3. Choose Security > Key Management Service . The key management page is displayed.
            4. Click the name of the target custom key to view its details.
            5. Click Tags to go to the tag management page.

              Figure 1 Managing tags
              +

            6. Click Add Tag. In the Add Tag dialog box, enter the tag key and tag value. Table 1 describes the parameters.

              Figure 2 Adding a Tag

              If you want to delete a tag to be added when adding multiple tags, you can click Delete in the row where the tag to be added is located to delete the tag.

              -
              Table 1 Tag parameters

              Parameter

              +
              - - - - - - - - - - -
              Table 1 Tag parameters

              Parameter

              Description

              +

              Description

              Value

              +

              Value

              Example Value

              +

              Example Value

              Tag key

              +

              Tag key

              Name of a tag.

              -

              The same tag (including tag key and tag value) can be used for different custom keys. However, under the same custom key, one tag key can have only one tag value.

              -

              A maximum of 20 tags can be added for one custom key.

              +

              Name of a tag.

              +

              The same tag (including tag key and tag value) can be used for different keys. However, under the same custom key, one tag key can have only one tag value.

              +

              A maximum of 20 tags can be added for one custom key.

              • Mandatory.
              • The tag key must be unique for the same custom key.
              • 128 characters limit.
              • The value cannot start or end with a space.
              • The following character types are allowed:
                • English
                • Numbers
                • Special characters: _-@
                -
              +
              • Mandatory.
              • Each tag key must be unique under the same custom key.
              • Contains a maximum of 36 characters.
              • Only digits, letters, underscores (_), and hyphens (-) are allowed.

              cost

              +

              cost

              Tag value

              +

              Tag value

              Value of the tag

              +

              Value of the tag

              • This parameter can be empty.
              • 255 characters limit.
              • The following character types are allowed:
                • English
                • Numbers
                • Special characters: _-@
                -
              +
              • This parameter can be empty.
              • Can contain a maximum of 43 characters.
              • Only digits, letters, underscores (_), and hyphens (-) are allowed.

              100

              +

              100

              -

            7. Click OK to complete.
            8. +

            9. Click OK to complete.
            10. @@ -52,3 +52,10 @@
              + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0025.html b/docs/kms/umn/kms_01_0025.html new file mode 100644 index 000000000..709a26afa --- /dev/null +++ b/docs/kms/umn/kms_01_0025.html @@ -0,0 +1,28 @@ + + +

              Searching for a Custom Key by Tag

              +

              Scenario

              This section describes how to search for tags through KMS. You can search for tags of all custom keys that meet the search criteria in the current project.

              +
              +

              Prerequisites

              Tags have been added.

              +
              +

              Procedure

              1. Log in to the management console.
              2. Click in the upper left corner of the management console and select a region or project.
              3. Choose Security > Key Management Service . The key management page is displayed.
              4. In the search box, enter the tag key and tag value.

                Figure 1 Searching for tags
                +

              5. The list displays the custom keys that meet the search criteria.

                Figure 2 Search results
                +
                • Multiple tags can be added for one search, 20 at most. If multiple tags are added, only custom keys that meet the combined search criteria are displayed.
                • If you want to delete an added tag from the search criteria, click next to the tag.
                • You can click Reset to reset the search criteria.
                +
                +
                +

              +
              +
              +
              + +
              + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0026.html b/docs/kms/umn/kms_01_0026.html index b1bb94de0..f57e8f983 100644 --- a/docs/kms/umn/kms_01_0026.html +++ b/docs/kms/umn/kms_01_0026.html @@ -1,8 +1,11 @@

              Modifying Tag Values

              -

              This section describes how to modify tag values on the KMS console.

              -

              Procedure

              1. Log in to the management console.
              2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
              1. Click the alias of the target custom key to view its details.
              2. Click Tags to go to the tag management page.
              3. Click Edit of the target tag, and the Edit Tag dialog box is displayed.
              4. In the Edit Tag dialog box, enter a tag value, and click OK to complete the editing.
              +

              Scenario

              This section describes how to modify tag values on the KMS management console.

              +
              +

              Procedure

              1. Log in to the management console.
              2. Click in the upper left corner of the management console and select a region or project.
              3. Choose Security > Key Management Service . The key management page is displayed.
              4. Click the name of the target custom key to view its details.
              5. Click Tags to go to the tag management page.

                Figure 1 Managing tags
                +

              6. Click Edit of the target tag, and the Edit Tag dialog box is displayed.

                Figure 2 Editing a tag
                +

              7. In the Edit Tag dialog box, enter a tag value, and click OK to complete the editing.
              @@ -11,3 +14,10 @@
              + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0027.html b/docs/kms/umn/kms_01_0027.html index 6c772feea..dc0e3a850 100644 --- a/docs/kms/umn/kms_01_0027.html +++ b/docs/kms/umn/kms_01_0027.html @@ -1,8 +1,10 @@

              Deleting Tags

              -

              This section describes how to delete tags on the KMS console.

              -

              Procedure

              1. Log in to the management console.
              2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
              1. Click the alias of the target custom key to view its details.
              2. Click Tags to go to the tag management page.
              3. Click Delete of the target tag, and the Delete Tag dialog box is displayed.
              4. In the Delete Tag dialog box, click Confirm.
              +

              Scenario

              This section describes how to delete tags on the KMS management console.

              +
              +

              Procedure

              1. Log in to the management console.
              2. Click in the upper left corner of the management console and select a region or project.
              3. Choose Security > Key Management Service . The key management page is displayed.
              4. Click the name of the target custom key to view its details.
              5. Click Tags to go to the tag management page.

                Figure 1 Managing tags
                +

              6. Click Delete of the target tag, and the Delete Tag dialog box is displayed.
              7. In the Delete Tag dialog box, click Yes to complete the deletion.
              @@ -11,3 +13,10 @@
              + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0028.html b/docs/kms/umn/kms_01_0028.html index c27e14777..76851bbe3 100644 --- a/docs/kms/umn/kms_01_0028.html +++ b/docs/kms/umn/kms_01_0028.html @@ -1,23 +1,19 @@ -

              Managing CMKs

              -
              +

              Managing a Grant

              +
              diff --git a/docs/kms/umn/kms_01_0029.html b/docs/kms/umn/kms_01_0029.html index b590aa93b..3b61c3c5c 100644 --- a/docs/kms/umn/kms_01_0029.html +++ b/docs/kms/umn/kms_01_0029.html @@ -1,17 +1,70 @@ -

              Enabling One or More CMKs

              -

              This section describes how to use the KMS console to enable one or more custom keys. Only enabled custom keys can be used to encrypt or decrypt data. A new custom key is in the Enabled state by default.

              -

              Prerequisites

              The custom key you want to enable is in Disabled status.

              +

              Creating a Grant

              +

              Scenario

              You can create grants for other users to use the custom key. You can create a maximum of 100 grants for a custom key.

              +

              The owner of a custom key can create a grant for the custom key on the KMS management console or by making the API calls. A user, who has been granted with the grant creation permission by the owner of the custom key, can create grants for the custom key only by making the API calls.

              -

              Procedure

              1. Log in to the management console.
              2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
              1. In the row containing the target custom key, click Enable.
              2. In the displayed dialog box, click OK to enable the key.

                To enable multiple CMKs at a time, select them and click Enable in the upper left corner of the list.

                +

                Prerequisites

                • You have obtained the user ID of the grantee (user to whom permissions are to be authorized).
                • The desired custom key is in Enabled status.
                +
                +

                Constraints

                The owner of a custom key can create a grant for the custom key on the KMS console or by calling APIs. The users or accounts who have the grant creation permission assigned by the owner of the custom key can create grants for the custom key only by calling APIs.

                +
                +

                Procedure

                1. Log in to the management console.
                2. Click in the upper left corner of the management console and select a region or project.
                3. Choose Security > Key Management Service . The key management page is displayed.
                4. Click the name of the target custom key to view its grant details.

                  Figure 1 Grants tab
                  +

                5. Click Create Grant. The Create Grant dialog box is displayed.

                  Figure 2 Creating a grant
                  +

                6. In the dialog box that is displayed, enter the ID of the user to be authorized and select permissions to be granted.

                  A grantee can perform the authorized operations only by calling the necessary API. For details, see the Key Management Service API Reference.

                  + +
                  + + + + + + + + + + + + + + + + + +
                  Table 1 Parameter description

                  Parameter

                  +

                  Description

                  +

                  Example Value

                  +

                  Key ID

                  +

                  ID of a custom key (automatically read by the system)

                  +

                  -

                  +

                  Grantee

                  +

                  The user ID of the grantee is required.

                  +
                  NOTE:

                  The user IDs are provided by grantees who can obtain their IDs by clicking their portraits and choosing My Credential > User ID.

                  +
                  +

                  d9a6b2bdaedd4ba586cabe6372d1b312

                  +

                  Granted Operations

                  +

                  The following permissions can be authorized:

                  +
                  NOTE:
                  • You can create multiple grants on a custom key to provide different permissions to the same user. The user's permissions on the custom key are the combination of all the grants.
                  • This parameter cannot be left blank.
                  • Create Grant cannot be selected exclusively.
                  +
                  +
                  • Create Data Key Without Plaintext
                  • Create Data Key
                  • Encrypt Data Key
                  • Decrypt Data Key
                  • Query Key Information
                  • Create Grant
                  • Retire Grant
                    • A grantee can retire a grant if the grantee does not need that permission.
                    • If, before retiring a grant, the grantee has granted the permission to another user, that user's permission will not be affected by the grant retirement.
                    +
                  +

                  -

                  +
                  +
                  +

                7. Click OK. When message Grant of key alias created successfully is displayed in the upper right corner, the grant has been created.

                  In the list of grants, you can view the grant ID, grantee ID, granted operation, and creation time of the grant.

                + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0030.html b/docs/kms/umn/kms_01_0030.html index ca0a79615..7f688c9cd 100644 --- a/docs/kms/umn/kms_01_0030.html +++ b/docs/kms/umn/kms_01_0030.html @@ -1,20 +1,52 @@ -

                Disabling One or More CMKs

                -

                This section describes how to use the KMS console to disable one or more custom keys, thereby protecting data in urgent cases.

                -

                After being disabled, a custom key cannot be used to encrypt or decrypt any data. Before using a disabled CMK to encrypt or decrypt data, you must enable it by following instructions in Enabling One or More CMKs.

                -

                Prerequisites

                The CMK you want to disable is in Enabled status.

                +

                Querying a Grant

                +

                Scenario

                This section describes how to view the details about a grant, such as the grant ID, grantee user ID, granted operation, and creation time.

                -

                Constraints

                • Default keys created by KMS cannot be disabled.
                • A disabled CMK is still billable. It will stop incurring charges if it is deleted.
                +

                Prerequisites

                You have created a grant.

                -

                Procedure

                1. Log in to the management console.
                2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                3. In the row containing the target CMK, click Disable.
                4. In the displayed dialog box, select I understand the impact of disabling keys, and click OK.

                  To disable multiple CMKs at a time, select them and click Disable in the upper left corner of the list.

                  -
                  -

                +

                Procedure

                1. Log in to the management console.
                2. Click in the upper left corner of the management console and select a region or project.
                3. Choose Security > Key Management Service . The key management page is displayed.
                4. Click the name of the target custom key to view its details.
                5. Information about the custom key and grants created on it are displayed, as shown in .

                  Table 1 provides more details.

                  + +
                  + + + + + + + + + + + + + + + + + + + +
                  Table 1 Parameter description

                  Parameter

                  +

                  Description

                  +

                  Grant ID

                  +

                  Randomly generated unique identification of a grant

                  +

                  Grantee

                  +

                  ID of an authorized user.

                  +

                  Granted Operations

                  +

                  Authorized operations (such as Create Data Key) on the custom key

                  +

                  Creation Time

                  +

                  Creation time of the grant

                  +

                  Operation

                  +

                  Operations that can be performed on a grant. For example, you can revoke a grant.

                  +
                  +
                  +

                6. Click a grant ID to view the grant details. shows an example.
                diff --git a/docs/kms/umn/kms_01_0031.html b/docs/kms/umn/kms_01_0031.html index 8bac77579..f4323fab6 100644 --- a/docs/kms/umn/kms_01_0031.html +++ b/docs/kms/umn/kms_01_0031.html @@ -1,22 +1,19 @@ -

                Deleting One or More CMKs

                -

                Before deleting the CMK, confirm that it is not in use and will not be used.

                -

                Prerequisites

                • The key to be deleted is in Enabled, Disabled, or Pending import status.
                +

                Revoking a Grant

                +

                Scenario

                You can revoke a grant in either of the following scenarios:

                +
                • A grantee does not need the custom key grant. (The grantee can either tell the user who has created the grant to revoke the grant or call the necessary API to revoke the grant directly.)
                • You do not want the grantee to have the grant.
                +

                When a grant is revoked, the grantee does not have the corresponding permission anymore. However, if the grantee has created the same grant to another user, permission of that user will not be affected.

                +

                This section describes how to revoke a grant.

                -

                Constraints

                • A key will not be deleted until its scheduled deletion period expires. You can set the period to a value within the range 7 to 1096 days.

                  Before the specified deletion date, you can cancel the deletion if you want to use the CMK. Once the scheduled deletion has taken effect, the CMK will be deleted permanently and you will not be able to decrypt data encrypted by the CMK. Exercise caution when performing this operation.

                  -
                • Default keys created by KMS cannot be scheduled for deletion.
                +

                Prerequisites

                You have created a grant.

                -

                Procedure

                1. Log in to the management console.
                2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                3. In the row containing the target CMK, click Delete in the Operation column.
                4. On the key deletion dialog box, enter the deletion delay time.

                  • A key will not be deleted until its scheduled deletion period expires. You can set the period to a value within the range 7 to 1096 days. Before the specified deletion date, you can cancel the deletion if you want to use the CMK.
                  -
                  -

                -

                To schedule the deletion of multiple CMKs at a time, select them and click Delete in the upper left corner of the list.

                -
                +

                Procedure

                1. Log in to the management console.
                2. Click in the upper left corner of the management console and select a region or project.
                3. Choose Security > Key Management Service . The key management page is displayed.
                4. Click the name of the target custom key to view its details.
                5. In the row containing the desired grantee, click Revoke Grant in the Operation column.
                6. In the dialog box that is displayed, click Yes. When Grant grant_ID revoked successfully is displayed in the upper right corner, the grant has been revoked.
                diff --git a/docs/kms/umn/kms_01_0032.html b/docs/kms/umn/kms_01_0032.html index 06a1ac70d..1974d92f4 100644 --- a/docs/kms/umn/kms_01_0032.html +++ b/docs/kms/umn/kms_01_0032.html @@ -1,18 +1,25 @@ -

                Canceling the Scheduled Deletion of One or More CMKs

                -

                This section describes how to use the KMS console to cancel the scheduled deletion of one or more custom keys prior to deletion execution. After the cancellation, the key is in Disabled status.

                -

                Prerequisites

                The CMK for which you want to cancel the scheduled deletion is in Pending deletion status.

                -
                -

                Procedure

                1. Log in to the management console.
                2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                3. In the row containing the target CMK, click Cancel Deletion.
                4. In the displayed dialog box, click OK to cancel the scheduled deletion.

                  • If a key is created on the KMS console, the status of the key changes to Disabled after its scheduled deletion is canceled. For details about how to enable the key, see Enabling One or More CMKs.
                  • If the CMK is created using imported materials, its status becomes Disabled after the cancellation. To enable the CMK, see Enabling One or More CMKs.
                  • If the CMK is created using imported materials and no key materials have been imported for it, its status becomes Pending import after the cancellation. To use the CMK, perform Creating CMKs Using Imported Key Materials.
                  -

                  To cancel the deletion of multiple CMKs at a time, select them and click Cancel Deletion in the upper left corner of the list.

                  -
                  -

                -
                -
                +

                Managing CMKs

                +
                diff --git a/docs/kms/umn/kms_01_0033.html b/docs/kms/umn/kms_01_0033.html new file mode 100644 index 000000000..e8e80ca11 --- /dev/null +++ b/docs/kms/umn/kms_01_0033.html @@ -0,0 +1,29 @@ + + +

                Changing the Name and Description of a Key

                +

                Scenario

                Key names help you find custom keys more easily.

                +

                This section describes how to change the name and description of a custom key on the KMS management console.

                +
                • The name and description of the default master key cannot be modified. The name of the default master key ends with /default.
                • The name and description of a key cannot be changed if the key is in Pending deletion status.
                +
                +
                +

                Prerequisites

                • The custom key is in Enabled, Disabled, or Pending import status.
                +
                +

                Procedure

                1. Log in to the management console.
                2. Click in the upper left corner of the management console and select a region or project.
                3. Choose Security > Key Management Service . The key management page is displayed.
                4. Click the name or description of the target key to access its details page.
                5. To change the alias or description of a key, click next to Name or Description.

                  Figure 1 Key details
                  +
                  • The name can contain 1 to 255 characters. Only digits, letters, underscores (_), hyphens (-), colons (:), and forward slashes (/) are allowed.
                  • Length of the description cannot exceed 255 characters.
                  +
                  +

                6. Click to save the changes.
                +
                +
                +
                + +
                + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0034.html b/docs/kms/umn/kms_01_0034.html new file mode 100644 index 000000000..133668339 --- /dev/null +++ b/docs/kms/umn/kms_01_0034.html @@ -0,0 +1,26 @@ + + +

                Enabling a Key

                +

                Scenario

                This section describes how to use the management console to enable one or multiple custom keys. Only enabled keys can be used to encrypt/decrypt data. A new custom key is in the Enabled state by default.

                +
                +

                Prerequisites

                The key you want to enable is in Disabled status.

                +
                +

                Procedure

                1. Log in to the management console.
                2. Click in the upper left corner of the management console and select a region or project.
                3. Choose Security > Key Management Service . The key management page is displayed.
                4. In the row containing the desired key, click Enable.

                  Figure 1 Enabling a single key
                  +

                5. In the dialog box that is displayed, click Yes to enable the key.

                  To enable multiple keys at a time, select them and click Enable in the upper left corner of the list.

                  +
                  +

                +
                +
                +
                + +
                + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0035.html b/docs/kms/umn/kms_01_0035.html new file mode 100644 index 000000000..73c699a91 --- /dev/null +++ b/docs/kms/umn/kms_01_0035.html @@ -0,0 +1,29 @@ + + +

                Disabling a Key

                +

                Scenario

                This section describes how to use the management console to disable one or multiple custom keys, thereby protecting data in urgent cases.

                +

                After being disabled, a custom key cannot be used to encrypt or decrypt any data. Before using a disabled key to encrypt or decrypt data, you must enable it by following instructions in Enabling a Key.

                +

                Default keys created by KMS cannot be disabled.

                +
                +
                +

                Prerequisites

                The key you want to disable is in Enabled status.

                +
                +

                Procedure

                1. Log in to the management console.
                2. Click in the upper left corner of the management console and select a region or project.
                3. Choose Security > Key Management Service . The key management page is displayed.
                4. In the row containing the desired key, click Disable.

                  Figure 1 Disabling a single key
                  +

                5. In the dialog box that is displayed, select I understand the impact of disabling keys and click OK.

                  To disable multiple keys at a time, select them and click Disable in the upper left corner of the list.

                  +
                  +

                +
                +
                +
                + +
                + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0036.html b/docs/kms/umn/kms_01_0036.html new file mode 100644 index 000000000..1a488a6c1 --- /dev/null +++ b/docs/kms/umn/kms_01_0036.html @@ -0,0 +1,28 @@ + + +

                Canceling the Scheduled Deletion of a Key

                +

                Scenario

                This section describes how to use the management console to cancel the scheduled deletion of a custom key prior to deletion execution.

                +
                +

                Prerequisites

                The key for which you want to cancel the scheduled deletion is in Pending deletion status.

                +
                +

                Procedure

                1. Log in to the management console.
                2. Click in the upper left corner of the management console and select a region or project.
                3. Choose Security > Key Management Service . The key management page is displayed.
                4. In the row containing the desired key, click Cancel Deletion.

                  Figure 1 Canceling the scheduled deletion of a single key
                  +

                5. In the displayed dialog box, click Yes to cancel the scheduled deletion for the key.

                  • If the key is created using KMS generated material, its status becomes Disabled after the cancelation. To enable the key, see Enabling a Key.
                  • If the key is created using imported material, its status becomes Disabled after the cancelation. To enable the key, see Enabling a Key.
                  • If the key is created using imported material and no key material has been imported for it, its status becomes Pending import after the cancelation. To use the key, perform Creating CMKs Using Imported Key Material.
                  +

                  To cancel the deletion of multiple keys at a time, select them and click Cancel Deletion in the upper left corner of the list.

                  +
                  +
                  +

                +
                +
                +
                + +
                + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0037.html b/docs/kms/umn/kms_01_0037.html new file mode 100644 index 000000000..32f08c2d8 --- /dev/null +++ b/docs/kms/umn/kms_01_0037.html @@ -0,0 +1,35 @@ + + +

                FAQs

                +
                + + diff --git a/docs/kms/umn/kms_01_0038.html b/docs/kms/umn/kms_01_0038.html new file mode 100644 index 000000000..060e978a8 --- /dev/null +++ b/docs/kms/umn/kms_01_0038.html @@ -0,0 +1,11 @@ + + +

                What Is a Data Encryption Key?

                +

                A data encryption key (DEK) is used to encrypt data.

                +
                +
                + +
                + diff --git a/docs/kms/umn/kms_01_0039.html b/docs/kms/umn/kms_01_0039.html new file mode 100644 index 000000000..9c0082cf9 --- /dev/null +++ b/docs/kms/umn/kms_01_0039.html @@ -0,0 +1,11 @@ + + +

                Why Can't I Delete a CMK Immediately?

                +

                The decision to delete a CMK should be taken with caution. Before deletion, confirm that the CMK's encrypted data has all been migrated. Once the CMK is deleted, you will not be able to decrypt data with it. Therefore, KMS offers a waiting period of 7 to 1096 days for the deletion to finally take effect. On the scheduled day of deletion, the CMK will be permanently deleted. However, prior to the scheduled day, you can still cancel the deletion.

                +
                +
                + +
                + diff --git a/docs/kms/umn/kms_01_0040.html b/docs/kms/umn/kms_01_0040.html new file mode 100644 index 000000000..53c48e161 --- /dev/null +++ b/docs/kms/umn/kms_01_0040.html @@ -0,0 +1,11 @@ + + +

                Which Cloud Services Can Use KMS for Encryption?

                +

                Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File Service (SFS), and Relational Database Service (RDS) can use KMS for encryption.

                +
                +
                + +
                + diff --git a/docs/kms/umn/kms_01_0043.html b/docs/kms/umn/kms_01_0043.html new file mode 100644 index 000000000..942e89ace --- /dev/null +++ b/docs/kms/umn/kms_01_0043.html @@ -0,0 +1,146 @@ + + +

                Change History

                +
                +
                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

                Released On

                +

                Description

                +

                2025-03-26

                +

                This is the twenty-second official release.

                +
                • Modified section "How to Access KMS".
                • Added section "Encrypting and Decrypting Small-Size Data Online".
                • Modified section "How Do I Use the Online Tool to Encrypt or Decrypt Small Volumes of Data?".
                +

                2025-03-21

                +

                This is the twenty-first official release.

                +

                Updated section "Importing a Key Material".

                +

                2025-02-18

                +

                This is the twentieth official release.

                +
                • Updated some screenshots.
                • Modified section "User Permissions".
                • Modified section "Importing a Key Material".
                • Added section "Key Alias".
                +

                2023-06-15

                +

                This is the nineteenth official release.

                +

                Added section "How Does KMS Protect My Keys?"

                +

                2022-09-30

                +

                This issue is the eighteenth official release.

                +

                Optimized the content in section "Creating a Custom KMS Policy".

                +

                2021-11-30

                +

                This issue is the seventeenth official release.

                +
                • Deleted description about DSS in "Application Scenarios" and "Accessing and Using KMS".
                • Added examples for creating a key and using a custom key policy in "Creating a Custom KMS Policy".
                +

                2021-10-20

                +

                This issue is the sixteenth official release.

                +
                • Added description about DSS in "Application Scenarios" and "Accessing and Using KMS".
                • Added description about fine-grained authorization in "Permissions Management".
                +

                2021-09-22

                +

                This is the fifteenth official release.

                +
                • Updated screenshots in "Managing Tags".
                • Updated screenshots in "Managing a Grant".
                +

                2020-08-18

                +

                This is the fourteenth official release.

                +
                • Modified the operation name of batchCreateKeyTags in section "Related Services".
                • Updated the description in section "Creating a Key".
                +

                2020-06-29

                +

                This is the thirteenth official release.

                +
                • Modified operations and information displayed on the rotation setting page in section "Enabling Key Rotation".
                • Added the section "Disabling Key Rotation".
                +

                2019-12-10

                +

                This is the twelfth official release.

                +
                • Added section "Enabling Key Rotation".
                • Added the description about enabling key rotation to section "Functions".
                • Added the description of enabling key rotation, changing the key rotation period, and disabling key rotation to section "Related Services".
                • Updated screenshots.
                +

                2018-09-05

                +

                This is the eleventh official release.

                +

                Updated screenshots.

                +

                2018-07-30

                +

                This is the tenth official release.

                +
                • Added section "Adding a Tag".
                • Added section "Searching for Tags".
                • Added section "Modifying Tag Values".
                • Added section "Deleting Tags".
                • Modified contents in section "Functions": added description about adding, editing, and deleting tags.
                • Modified section "Related Services": added descriptions about the operations of adding tags, deleting tags, adding tags in batches, and deleting tags in batches.
                • Modified section "Creating a Key": added the procedure for adding a tag.
                • Modified section "Importing Key Material": added the procedure for adding a tag.
                • Accepted in OTC 3.1.
                • Added description about RSAES_OAEP_SHA_256 and RSAES_OAEP_SHA_1 algorithms.
                • Added the description about using KMS encryption for RDS.
                • Added description about the relationship between KMS and RDS, as well as how to use RDS together with KMS.
                +

                2018-06-15

                +

                This is the ninth official release.

                +
                • Added the description about using KMS encryption for SFS.
                • Added description about relationships between KMS and SFS, as well as how to use these services together with KMS.
                • Updated screenshots.
                • Modified section "Importing Key material": updated the screenshots.
                • Modified section "Deleting Key material": added related descriptions.
                • Modified section "Configuring SMN-Enabled Event Notification": updated screenshots.
                • Modified section "Importing Key Material": added the description about how to obtain the wrapping key and import token calling the API.
                • Updated screenshots.
                +

                2018-03-30

                +

                This is the eighth official release.

                +
                • Updated screenshots.
                • Added section "Importing a CMK".
                • Added section "Overview".
                • Added section "Importing Key Material".
                • Added section "Deleting Key Material".
                • Added the description of importing and deleting keys to section "Related Services".
                • Updated screenshots.
                +

                2017-11-30

                +

                This is the seventh official release.

                +

                Updated a screenshot in section "Scheduling the Deletion of One or Multiple CMKs."

                +

                2017-10-30

                +

                This is the sixth official release.

                +
                • Added operations creating a grant, retiring a grant, and revoking a grant to the table of supported KMS operations in section "Related Services."
                • Added section "Configuring SMN."
                • Added section "Creating a Grant."
                • Added section "Querying a Grant."
                • Added section "Revoking a Grant."
                +

                2017-08-30

                +

                This is the fifth official release.

                +
                • Added section "Project."
                • Added the step of selecting a project.
                • Updated some screenshots.
                +

                2017-06-30

                +

                This is the fourth official release.

                +
                • Added operations changing the alias of a CMK, changing the description of a CMK, and prompting risks about CMK deletion to table "KMS operations that CTS supports" in section "Related Services."
                • Added section "Changing the Alias and Description of a CMK."
                +

                2017-03-31

                +

                This is the third official release.

                +
                • Added section "Glossary".
                • Added section "User Permissions."
                +

                2017-01-20

                +

                This is the second official release.

                +
                • Added definitions of OBS, EVS, and IMS and optimized description about application scenarios.
                • Optimized description about SSE-KMS and description about KMS operations that CTS supports.
                • Added description about how to create a DEK and a plaintext-free DEK.
                • Added description about relationships between KMS, EVS and IMS as well as how to use these services together with KMS.
                • Added description about how to encrypt data on EVS disks.
                • Added description about how to encrypt private images.
                +

                2016-12-30

                +

                This is the first official release.

                +
                +
                +
                + diff --git a/docs/kms/umn/kms_01_0044.html b/docs/kms/umn/kms_01_0044.html index f32c8a4f7..0622546d1 100644 --- a/docs/kms/umn/kms_01_0044.html +++ b/docs/kms/umn/kms_01_0044.html @@ -1,46 +1,7 @@ -

                What Is a Customer Master Key?

                -

                A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user on KMS. It is used to encrypt and protect DEKs. One CMK can be used to encrypt one or more DEKs.

                -
                CMKs are categorized into custom keys and default keys.
                • Custom keys

                  Keys created or imported by users on the KMS console.

                  -
                • Default keys

                  When a user uses KMS for encryption in a cloud service for the first time, the cloud service automatically creates a key with the alias suffix /default.

                  -

                  You can use the management console to query but cannot disable or schedule the deletion of Default Master Keys.

                  - -
                  - - - - - - - - - - - - - - - - -
                  Table 1 Default Master Keys

                  Alias

                  -

                  Cloud Service

                  -

                  obs/default

                  -

                  Object Storage Service (OBS)

                  -

                  evs/default

                  -

                  Elastic Volume Service (EVS)

                  -

                  ims/default

                  -

                  Image Management Service (IMS)

                  -

                  sfs/default

                  -

                  Scalable File Service (SFS)

                  -
                  -
                  -
                -
                -
                -
                - -
                +

                Glossary

                +

                For details about the glossaries in this document, see Glossary.

                +
                +
                diff --git a/docs/kms/umn/kms_01_0045.html b/docs/kms/umn/kms_01_0045.html index 2e14a5a7a..739e28462 100644 --- a/docs/kms/umn/kms_01_0045.html +++ b/docs/kms/umn/kms_01_0045.html @@ -1,45 +1,23 @@ -

                What Is a Default Key?

                -

                A default key is automatically created by another cloud service using KMS, such as Object Storage Service (OBS). The alias of a default key ends with /default.

                -

                You can use the management console to query but cannot disable or schedule the deletion of default keys.

                -

                Default keys are hosted for free, and are charged based on the number of the API requests for them. If API requests exceed the free limit, the excess part will be charged.

                - -
                - - - - - - - - - - - - - - - - -
                Table 1 Default Master Keys

                Alias

                -

                Cloud Service

                -

                obs/default

                -

                Object Storage Service (OBS)

                -

                evs/default

                -

                Elastic Volume Service (EVS)

                -

                ims/default

                -

                Image Management Service (IMS)

                -

                sfs/default

                -

                Scalable File Service (SFS)

                -
                -
                -

                A default key is automatically created when a user employs the KMS encryption function for the first time in another cloud service.

                -
                -
                +

                Key Management

                +
                diff --git a/docs/kms/umn/kms_01_0046.html b/docs/kms/umn/kms_01_0046.html index f507a0b8b..e0b4f6a84 100644 --- a/docs/kms/umn/kms_01_0046.html +++ b/docs/kms/umn/kms_01_0046.html @@ -1,11 +1,32 @@ -

                What Is a Data Encryption Key?

                -

                A data encryption key (DEK) is used to encrypt data.

                +

                Application Scenarios

                +

                KMS can manage CMKs used for data encryption and decryption in Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File Service (SFS), Relational Database Service (RDS), and user applications.

                +
                • For OBS, KMS applies to object encryption on OBS.

                  OBS is an object-based storage service that provides customers with massive, secure, reliable, and cost-effective data storage capabilities, including but not limited to bucket creation, modification, deletion, and management, as well as object upload, download, deletion, and general management. OBS can store all file types, and is suitable for individual subscribers, websites, enterprises, and developers. For details about OBS, see Object Storage Service (OBS) User Guide.

                  +
                  +
                • For EVS, KMS applies to data encryption in EVS disks.

                  Based on a distributed architecture, an EVS disk is a virtual block storage device that can be elastically scaled up and down. EVS disks can be operated online. Using them is the same as using common server hard disks. Compared with traditional hard disks, EVS disks have higher data reliability and I/O throughput and are easier to use. EVS disks can be used in file systems, databases, and system software applications that require block storage devices. For more information about EVS, see the Elastic Volume Service User Guide.

                  +
                  +
                • For IMS, KMS applies to the creation of encrypted private images.

                  IMS provides easy-to-use self-service image management functions. You can apply for a cloud server using either a private image or a public image. You can also create a private image using an existing ECS or an external image file. For more information about IMS, see the Image Management Service User Guide.

                  +
                  +
                • For SFS, KMS applies to data encryption for files in SFS.

                  SFS provides high-performance file storage that is scalable on demand. It can be shared with multiple cloud servers. For more information, see the Scalable File Service User Guide.

                  +
                  +
                • For RDS, KMS applies to disk encryption in RDS database instances.

                  RDS is an online relational database service based on the cloud computing platform. RDS is out-of-box, reliable, scalable, and easy to manage. For more information about RDS, see the Relational Database Service User Guide.

                  +
                  +
                • For user applications

                  To encrypt plaintext data, a user application can call the necessary KMS API to generate a DEK, which can then be used to encrypt the plaintext data. Then the application can store the encrypted data. In addition, the user application can call the necessary KMS APIs to create custom keys. DEKs can be stored in ciphertext after being encrypted with the custom keys. Figure 1 shows envelope encryption working principles.

                  +

                  To ensure the security of the user's encrypted data, KMS does not save DEKs in plaintext or ciphertext. Instead, it manages users' custom keys so that users can obtain and use DEKs securely.

                  +
                  Figure 1 Envelope encryption working principles
                  +
                + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0047.html b/docs/kms/umn/kms_01_0047.html index 3a2c64414..81672f3c0 100644 --- a/docs/kms/umn/kms_01_0047.html +++ b/docs/kms/umn/kms_01_0047.html @@ -1,13 +1,102 @@ -

                What Is Key Management Service?

                -

                KMS is a secure, reliable, and easy-to-use cloud service that helps users create, manage, and protect keys in a centralized manner.

                -

                It uses Hardware Security Modules (HSMs) to protect keys. All keys are protected by root keys in HSMs to avoid key leakage. The HSM module meets the FIPS 140-2 Level 3 security requirements.

                -

                It also controls access to keys and records all operations on keys with traceable logs. In addition, it provides use records of all keys, meeting your audit and regulatory compliance requirements.

                +

                Functions

                +

                KMS provides the following functions:

                +
                • Manages custom keys.
                  You can perform the following operations on custom keys on the KMS console or via APIs:
                  • Creating, querying, enabling, disabling, scheduling the deletion of, and canceling the deletion of custom keys
                  • Importing keys and deleting key material
                  • Modifying the name and description of a custom key
                  • Using the online tool to encrypt and decrypt small-size data
                  • Creating, querying, and revoking a grant
                  • Adding, searching for, editing, and deleting tags
                  • Enabling key rotation
                  +
                  +
                +
                • Creates, encrypts, and decrypts DEKs, and retires a grant on a key.

                  By calling APIs, you can create, encrypt, and decrypt DEKs, and retire a grant on a key. For details, see the Key Management Service API Reference.

                  +
                • Generates hardware true random numbers.

                  You can generate 512-bit hardware true random numbers using a KMS API. The 512-bit hardware true random numbers can be used as or serve as basis for keys and encryption parameters. For details, see .

                  +
                +

                Key Algorithms Supported by KMS

                Symmetric keys created on the KMS console use the AES-256 algorithm. Asymmetric keys created by KMS support the RSA and ECC algorithms.

                + +
                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                Table 1 Key algorithms supported by KMS

                Key Type

                +

                Algorithm Type

                +

                Key Specifications

                +

                Description

                +

                Application Scenario

                +

                Symmetric key

                +

                AES

                +

                AES_256

                +

                AES symmetric key

                +
                • Data encryption and decryption
                • DEKs encryption and decryption
                  NOTE:

                  You can encrypt and decrypt a small amount of data using the the online tool on the console.

                  +

                  You need to call APIs to encrypt and decrypt a large amount of data.

                  +
                  +
                +

                Digest key

                +

                SHA

                +
                • HMAC_256
                • HMAC_384
                • HMAC_512
                +

                Digest key

                +
                • Data tampering prevention
                • Data integrity verification
                +

                Asymmetric key

                +

                RSA

                +
                • RSA_2048
                • RSA_3072
                • RSA_4096
                +

                RSA asymmetric password

                +
                • Digital signature and signature verification
                • Data encryption and decryption
                  NOTE:

                  Asymmetric keys are applicable to signature and signature verification scenarios. Asymmetric keys are not efficient enough for data encryption. Symmetric keys are suitable for encrypting and decrypting data.

                  +
                  +
                +

                ECC

                +
                • EC_P256
                • EC_P384
                +

                Elliptic curve recommended by NIST

                +

                Digital signature and signature verification

                +
                +
                +

                Key wrapping algorithms describes the cryptographic key wrapping algorithms supported by imported keys.

                + +
                + + + + + + + + + +
                Table 2 Key wrapping algorithms

                Algorithm

                +

                Description

                +

                Example Value

                +

                RSAES_OAEP_SHA_256

                +

                RSA cryptographic algorithm that uses OAEP and has the SHA-256 hash function

                +

                The RSAES_OAEP_SHA_256 encryption key is recommended.

                +
                +
                +
                diff --git a/docs/kms/umn/kms_01_0048.html b/docs/kms/umn/kms_01_0048.html deleted file mode 100644 index c76ae83d7..000000000 --- a/docs/kms/umn/kms_01_0048.html +++ /dev/null @@ -1,59 +0,0 @@ - - -

                KMS Related

                -
                -
                - - - -
                - diff --git a/docs/kms/umn/kms_01_0049.html b/docs/kms/umn/kms_01_0049.html deleted file mode 100644 index 039eb7658..000000000 --- a/docs/kms/umn/kms_01_0049.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

                Why Cannot I Delete a CMK Immediately?

                -

                The decision to delete a CMK should be considered with great caution. Before deletion, confirm that the CMK's encrypted data has all been migrated. As soon as the CMK is deleted, you will not be able to decrypt data with it. Therefore, KMS offers a user-specified period of 7 to 1096 days for the deletion to finally take effect. On the scheduled day of deletion, the CMK will be permanently deleted. However, prior to the scheduled day, you can still cancel the pending deletion. This is a means of precaution within KMS.

                -
                -
                - -
                - diff --git a/docs/kms/umn/kms_01_0050.html b/docs/kms/umn/kms_01_0050.html deleted file mode 100644 index 99d1f21d3..000000000 --- a/docs/kms/umn/kms_01_0050.html +++ /dev/null @@ -1,57 +0,0 @@ - - -

                Which Cloud Services Can Use KMS for Encryption?

                -

                Object Storage Service (OBS), Elastic Volume Service (EVS), Image Management Service (IMS), Scalable File Service (SFS), Document Database Service (DDS), and Relational Database Service (RDS) can use KMS for encryption.

                - -
                - - - - - - - - - - - - - - - - - - - - - - -
                Table 1 List of cloud services that use KMS encryption

                Service Name

                -

                Description

                -

                Object Storage Service (OBS)

                -

                You can upload objects to and download them from Object Storage Service (OBS) in common mode or server-side encryption mode. When you upload objects in encryption mode, data is encrypted at the server side and then securely stored on OBS in ciphertext. When you download encrypted objects, the data in ciphertext is decrypted at the server side and then provided to you in plaintext. OBS supports the server-side encryption with KMS-managed keys (SSE-KMS) mode. In SSE-KMS mode, OBS uses the keys provided by KMS for server-side encryption.

                -

                For details about how to upload objects to OBS in SSE-KMS mode, see the Object Storage Service Console Operation Guide.

                -

                Elastic Volume Service (EVS)

                -

                If you enable the encryption function when creating an EVS disk, the disk will be encrypted with the DEK generated by using your CMK. Data stored in the EVS disk will be automatically encrypted.

                -

                For details about how to use the encryption function of EVS, see Elastic Volume Service User Guide.

                -

                Image Management Service (IMS)

                -

                When creating a private image using an external image file, you can enable the private image encryption function and select a CMK provided by KMS to encrypt the image.

                -

                For details about how to use the private image encryption function of Image Management Service (IMS), see Image Management Service User Guide.

                -

                Scalable File Service (SFS)

                -

                When creating a file system on SFS, the CMK provided by KMS can be selected to encrypt the file system, so that files stored in the file system are automatically encrypted.

                -

                For details about how to use the file system encryption function of SFS, see Scalable File Service User Guide.

                -

                Relational Database Service (RDS)

                -

                When purchasing a database instance, you can enable the disk encryption function of the database instance and select a CMK created on KMS to encrypt the disk of the database instance. Enabling the disk encryption function will enhance data security.

                -

                For details about how to use the disk encryption function of RDS, see Relational Database Service User Guide.

                -

                Document Database Service (DDS)

                -

                When purchasing a DDS instance, you can enable the disk encryption function of the instance and select a CMK created on KMS to encrypt the disk of the instance. Enabling the disk encryption function will enhance data security.

                -

                For details about how to use the disk encryption function of DDS, see Document Database Service User Guide.

                -
                -
                -
                -
                - -
                - diff --git a/docs/kms/umn/kms_01_0053.html b/docs/kms/umn/kms_01_0053.html deleted file mode 100644 index 025e61583..000000000 --- a/docs/kms/umn/kms_01_0053.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

                How Do Cloud Services Use KMS to Encrypt Data?

                -

                Services (such as OBS, IMS, EVS, SFS, DDS, and RDS) use the envelope encryption method provided by KMS to protect data.

                -

                Envelope encryption is an encryption method that enables DEKs to be stored, transmitted, and used in "envelopes" of CMKs. As a result, CMKs do not directly encrypt and decrypt data.

                -
                - -

                When users download the data from the cloud, the cloud service uses the CMK specified by KMS to decrypt the ciphertext DEK, use the decrypted DEK to decrypt data, and then provide the decrypted data for users to download.

                -
                -
                - -
                - diff --git a/docs/kms/umn/kms_01_0054.html b/docs/kms/umn/kms_01_0054.html index f3f681b3d..d46065375 100644 --- a/docs/kms/umn/kms_01_0054.html +++ b/docs/kms/umn/kms_01_0054.html @@ -1,23 +1,42 @@ -

                What Are the Benefits of Envelope Encryption?

                -

                Envelope encryption is the practice of encrypting data with a DEK and then encrypting the DEK with a root key that you can fully manage. In this case, CMKs are not required for encryption or decryption.

                -

                Benefits:

                -
                • Advantages over CMK encryption in KMS

                  Users can use CMKs to encrypt and decrypt data on the KMS console or by calling KMS APIs.

                  -

                  A CMK can encrypt and decrypt data no more than 4 KB. An envelope can encrypt and decrypt larger volumes of data.

                  -

                  Data encrypted using envelopes does not need to be transferred. Only the DEKs need to be transferred to the KMS server.

                  -
                • Advantages over encryption by using cloud services
                  • Security

                    Data transferred to the cloud for encryption is exposed to risks such as interception and phishing.

                    -

                    During envelope encryption, KMS uses Hardware Security Modules (HSMs) to protect keys. All CMKs are protected by root keys in HSMs to avoid key leakage.

                    -
                  • Trustworthiness

                    You will worry about data security on the cloud. It is also difficult for cloud services to prove that they never misuse or disclose such data.

                    -

                    If you choose envelope encryption, KMS will control access to keys and record all usages of and operations on keys with traceable logs, meeting your audit and regulatory compliance requirements.

                    -
                  • Performance and cost

                    To encrypt or decrypt data using a cloud service, you have to send the data to the encryption server and receive the processed data. This process seriously affects your service performance and incurs high costs.

                    -

                    Envelope encryption allows you to generate DEKs online by calling KMS cryptographic algorithm APIs, and to encrypt a large amount of local data with the DEKs.

                    +

                    Overview

                    +
                    The custom key contains key metadata (key ID, key name, description, key status, and creation date) and key materials used for encrypting and decrypting data.
                    • When a user uses the KMS console to create a custom key, the KMS automatically generates a key material for the custom key.
                    • If you want to use your own key material, you can use the KMS console to create a custom key whose key material source is external, and import the key material to the custom key.
                    +
                    +

                    Important Notes

                    • Security

                      You need to ensure that random sources meet your security requirements when using them to generate key materials. When using the import key function, you need to be responsible for the security of your key materials. Save the original backup of the key material so that the backup key material can be imported to the KMS in time when the key material is deleted accidentally.

                      +
                    • Availability and Durability

                      Before importing the key material into KMS, you need to ensure the availability and durability of the key material.

                      +

                      Differences between the imported key material and the key material generated by KMS are shown in Table 1.

                      + +
                      + + + + + + + + + + +
                      Table 1 Differences between the imported key material and the key material generated by KMS

                      Key Material Source

                      +

                      Difference

                      +

                      Imported keys

                      +
                      • You can delete the key material, but cannot delete the custom key and its metadata.
                      • Such keys cannot be rotated.
                      • When importing the key material, you can set the expiration time of the key material. After the key material expires, the KMS automatically deletes the key material within 24 hours, but does not delete the custom key and its metadata.

                        It is recommended that you save a copy of the material on your local device because it may be used for re-import in cases of invalid key materials or key material mis-deletion.

                        +
                        NOTE:

                        Keys using RSA_2048, RSA_3072, RSA_4096, EC_P256, and EC_P384 algorithms are permanently valid. Their key materials cannot be manually deleted, and their expiration time cannot be configured.

                        +
                      +

                      Keys created in KMS

                      +
                      • The key material cannot be manually deleted.
                      • Symmetric keys can be rotated.
                      • You cannot set the expiration time for key material.
                      +
                      +
                      +
                    • Association

                      When a key material is imported to a custom key, the custom key is permanently associated with the key material. Other key materials cannot be imported into the custom key.

                      +
                    • Uniqueness

                      If you use the custom key created using the imported key material to encrypt data, the encrypted data can be decrypted only by the custom key that has been used to encrypt the data, because the metadata and key material of the custom key must be consistent.

                    +
                    diff --git a/docs/kms/umn/kms_01_0055.html b/docs/kms/umn/kms_01_0055.html index db03d04ee..a7dc6a531 100644 --- a/docs/kms/umn/kms_01_0055.html +++ b/docs/kms/umn/kms_01_0055.html @@ -1,39 +1,176 @@ -

                    What Are the Differences Between a Custom Key and a Default Key?

                    -

                    The following table describes the differences between a custom key and a default key.

                    +

                    Importing a Key Material

                    +

                    Scenario

                    If you want to use your own key material instead of the KMS-generated material, you can use the console to import your key material to KMS. The keys created using imported material and KMS-generated material are managed together by KMS.

                    +

                    This section describes how to import key material through KMS Console.

                    +
                    • A key using imported material works in the same way as one using KMS-generated material, that is, you enable and disable them as well as schedule their deletion and cancel their scheduled deletion in the same way.
                    • You can only import 256-bit symmetric keys.
                    +
                    +
                    +

                    Prerequisites

                    • You have prepared the key material to be imported.
                    +
                    +

                    Procedure

                    1. Log in to the management console.
                    2. Click in the upper left corner of the management console and select a region or project.
                    3. Choose Security > Key Management Service . The key management page is displayed.
                    4. Locate the target key in the list and click Import Key Material in the Operation column.

                      Figure 1 Importing a Key Material
                      -
                      Table 1 Differences between a custom key and a default key

                      Item

                      +
                      - - - - - - - - + +
                      Table 1 Key wrapping algorithms

                      Algorithm

                      Definition

                      +

                      Description

                      Difference

                      +

                      Example Value

                      Custom key

                      +

                      RSAES_OAEP_SHA_256

                      A Key Encryption Key (KEK) created using KMS. The key is used to encrypt and protect DEKs.

                      -

                      A custom key can be used to encrypt multiple DEKs.

                      +

                      RSA cryptographic algorithm that uses OAEP and has the SHA-256 hash function

                      • It can be disabled and scheduled for deletion.
                      • It is billed per use after the being created or imported.
                      +

                      Choose an algorithm from the drop-down list box.

                      +
                      1. If the HSMs support the RSAES_OAEP_SHA_256 algorithm, use RSAES_OAEP_SHA_256 to encrypt the key material.
                      2. If the HSMs do not support OAEP, use RSAES_PKCS1_V1_5 to encrypt the key material.
                      3. The RSAES_OAEP_SHA_1 cryptographic algorithm is no longer secure. Exercise caution when performing this operation.

                      Default key

                      +

                      RSAES_PKCS1_V1_5

                      Automatically generated by the system when you use KMS to encrypt data in another cloud service for the first time. The suffix of the key is /default.

                      -

                      Example: evs/default

                      +

                      RSA cryptographic algorithm (v1.5) of Public-Key Cryptography Standards number 1 (PKCS #1)

                      • It cannot be disabled or scheduled for deletion.
                      +

                      RSAES_OAEP_SHA_1

                      +

                      RSA cryptographic algorithm that uses Optimal Asymmetric Encryption Padding (OAEP) and has the SHA-1 hash function

                      +

                      If you stop a key material import process and want to try again, click Import Key Material in the row of the required custom key, and import key material in the dialog box that is displayed.

                      +
                      +

                    5. Click Download and Continue, download the wrapping key, as shown in Figure 2.

                      Figure 2 Downloaded files
                      +
                      • wrappingKey_Key ID: wrapping key used to encrypt the key material

                        The wrapping key expires in 24 hours. If the wrapping key is invalid, download it again.

                        +
                        +
                      +
                      Alternatively, you can obtain the wrapping key and import token by calling the API.
                      1. Call the get-parameters-for-import API to obtain the wrapping key and import token.
                        • public_key: content of the wrapping key (Base-64 encoding) returned after the API call
                        • import_token: content of the import token (Base-64 encoding) returned after the API call
                        +

                        The following example describes how to obtain the wrapping key and import token of a CMK (ID: 43f1ffd7-18fb-4568-9575-602e009b7ee8; algorithm: RSAES_OAEP_SHA_256).

                        +
                        • Request example
                          {      
                          +    "key_id": "43f1ffd7-18fb-4568-9575-602e009b7ee8",
                          +    "wrapping_algorithm":"RSAES_OAEP_SHA_256"
                          +}
                          +
                        • Response example:
                          {
                          +    "key_id": "43f1ffd7-18fb-4568-9575-602e009b7ee8",    
                          +    "public_key":"public key base64 encoded data",
                          +    "import_token":"import token base64 encoded data",
                          +    "expiration_time":1501578672
                          +}
                          +
                        +
                      2. Save the wrapping key, and convert its format according to the following procedure. Only the key material that is encrypted using the converted wrapping key can be imported to the management console.
                        1. Copy the content of the wrapping key public_key, save it to the .txt file as PublicKey.b64.
                        2. Run the following command to convert the Base-64 coding of the PublicKey.b64 file to binary data, and save the converted file as PublicKey.bin:

                          openssl enc -d -base64 -A -in PublicKey.b64 -out PublicKey.bin

                          +
                        +
                      3. Save the import token, copy the content of the import_token token, paste it to a .txt file, and save the file as ImportToken.b64.
                      +
                      +

                    6. You use the downloaded wrappingKey file to encrypt the key material to be imported.

                      • Method 1: Use the downloaded wrapping key to encrypt the key material on your HSM. For details, see the operation guide of your HSM.
                      • Method 2: Use OpenSSL to encrypt a key material and use the downloaded wrapping key to encrypt the key material.

                        If you need to run the openssl pkeyutl command, the OpenSSL version must be 1.0.2 or later.

                        +
                        +
                        Generate a key material (256-bit symmetric key) and save it as PlaintextKeyMaterial.bin.
                        1. If the AES256 symmetric key algorithm is used, run the following command on the client where the OpenSSL tool has been installed:

                          openssl rand -out PlaintextKeyMaterial.bin 32

                          +
                        2. Use the downloaded wrapping key to encrypt the key material and save the encrypted key material as EncryptedKeyMaterial.bin.

                          Replace PublicKey.bin in the command with the name of the wrapping key wrappingKey_key ID_download time downloaded in 5.

                          + +
                          + + + + + + + + + + + + + +
                          Table 2 Encrypting the generated key material using the downloaded wrapping key

                          Wrapping Key Algorithm

                          +

                          Key Materials Encryption

                          +

                          RSAES_OAEP_SHA_256

                          +

                          openssl pkeyutl

                          +

                          -in PlaintextKeyMaterial.bin

                          +

                          -inkey PublicKey.bin

                          +

                          -out EncryptedKeyMaterial.bin

                          +

                          -keyform der

                          +

                          -pubin -encrypt

                          +

                          -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha256

                          +

                          RSAES_PKCS1_V1_5

                          +

                          openssl rsautl -encrypt

                          +

                          -in PlaintextKeyMaterial.bin

                          +

                          -pkcs

                          +

                          -inkey PublicKey.bin

                          +

                          -keyform der

                          +

                          -pubin

                          +

                          -out EncryptedKeyMaterial.bin

                          +

                          RSAES_OAEP_SHA_1

                          +

                          openssl pkeyutl

                          +

                          -in PlaintextKeyMaterial.bin

                          +

                          -inkey PublicKey.bin

                          +

                          -out EncryptedKeyMaterial.bin

                          +

                          -keyform der

                          +

                          -pubin -encrypt

                          +

                          -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha1

                          +
                          +
                          +
                        +
                        +
                      +

                    7. Go to the Import Key Material page. Configure the parameters as described in Table 3.

                      Figure 3 Importing a Key Material
                      + +
                      + + + + + + + + + + +
                      Table 3 Parameters for importing key material

                      Parameter

                      +

                      Description

                      +

                      Key ID

                      +

                      Random ID of a key generated during key creation

                      +

                      Key material

                      +
                      1. Use the key material encrypted by the wrappingKey file downloaded in 5.
                      +
                      +
                      +

                    8. Click Next to go to the Import Key Token step. Configure the parameters as described in Table 4.

                      Figure 4 Importing a key token
                      + +
                      + + + + + + + + + + +
                      Table 4 Parameters for importing a key token

                      Parameter

                      +

                      Description

                      +

                      Key ID

                      +

                      Random ID of a key generated during key creation

                      +

                      Key material expiration mode

                      +
                      • Key material will never expire: This option specifies that key material will not expire after import.
                      • Key material expires on: This option specifies the expiration time of the key material. By default, the key material expires in 24 hours after import.

                        When the key material expires, KMS will delete them in 24 hours, making the key unusable and the custom key status Pending import.

                        +
                      +
                      +
                      +

                    9. Click OK.

                      Key material can be successfully imported when it matches the corresponding key ID and token.

                      +
                      +

                      Your imported material is displayed in the list of custom keys. The default status of an imported key is Enabled.

                      +

                    10. + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0056.html b/docs/kms/umn/kms_01_0056.html deleted file mode 100644 index c910a1e3c..000000000 --- a/docs/kms/umn/kms_01_0056.html +++ /dev/null @@ -1,12 +0,0 @@ - - -

                      Is There a Limit on the Number of Custom Keys That I Can Create on KMS?

                      -

                      Yes.

                      -

                      You can create a maximum of 100 custom keys, including those in enabled, disabled, and pending deletion states. Default keys are not included.

                      -
                      -
                      - -
                      - diff --git a/docs/kms/umn/kms_01_0058.html b/docs/kms/umn/kms_01_0058.html deleted file mode 100644 index f8c98255e..000000000 --- a/docs/kms/umn/kms_01_0058.html +++ /dev/null @@ -1,12 +0,0 @@ - - -

                      Can I Export a CMK from KMS?

                      -

                      No.

                      -

                      To ensure CMK security, users can only create and use CMKs in KMS.

                      -
                      -
                      - -
                      - diff --git a/docs/kms/umn/kms_01_0059.html b/docs/kms/umn/kms_01_0059.html deleted file mode 100644 index fb7255c65..000000000 --- a/docs/kms/umn/kms_01_0059.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

                      Can I Decrypt My Data if I Permanently Delete My Custom Key?

                      -

                      No.

                      -

                      If you have permanently deleted your custom key, the data encrypted using it cannot be decrypted. Before the scheduled deletion date of the custom key, you can cancel the scheduled deletion.

                      -

                      If the custom key is created using imported key material and only the key material is deleted, you can import the local backup of the key material to the custom key and reclaim the user data. If the key material is not backed up locally, user data cannot be reclaimed.

                      -
                      -
                      - -
                      - diff --git a/docs/kms/umn/kms_01_0060.html b/docs/kms/umn/kms_01_0060.html deleted file mode 100644 index 0cafd98e3..000000000 --- a/docs/kms/umn/kms_01_0060.html +++ /dev/null @@ -1,27 +0,0 @@ - - -

                      How Do I Use the Online Tool to Encrypt or Decrypt Small Volumes of Data?

                      -

                      You can use the online tool to encrypt or decrypt data in the following procedures:

                      -

                      Encrypting Data

                      1. Log in to the management console.
                      2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                      1. Click Encrypt. In the text box on the left, enter the data to be encrypted, as shown in Figure 1.

                        Figure 1 Encrypting data
                        -

                      2. Click Execute. Ciphertext of the data is displayed in the text box on the right.

                        • Use the current CMK to encrypt the data.
                        • You can click Clear to clear the entered data.
                        • You can click Copy to Clipboard to copy the ciphertext and save it in a local file.
                        -
                        -

                      -
                      -

                      Enter the plaintext on the console, the text will be encoded to Base64 format before encryption.

                      -

                      The decryption result returned via API will be in Base64 format. Perform Base64 decoding to obtain the plaintext entered on the console.

                      -
                      -

                      Decrypting Data

                      1. Log in to the management console.
                      1. You can click any non-default key in Enabled status to go to the encryption and decryption page of the online tool.
                      2. Click Decrypt. In the text box on the left, enter the data to be decrypted. For details, see Figure 2.

                        • The tool will identify the original encryption CMK and use it to decrypt the data.
                        • If the key has been deleted, the decryption will fail.
                        -
                        -
                        Figure 2 Decrypting data
                        -

                      3. Click Execute. Plaintext of the data is displayed in the text box on the right.

                        • You can click Copy to Clipboard to copy the plaintext and save it in a local file.
                        • Enter the plaintext on the console, the text will be encoded to Base64 format before encryption.

                          The decryption result returned via API will be in Base64 format. Perform Base64 decoding to obtain the plaintext entered on the console.

                          -
                        -
                        -

                      -
                      -
                      -
                      - -
                      - diff --git a/docs/kms/umn/kms_01_0062.html b/docs/kms/umn/kms_01_0062.html deleted file mode 100644 index 2a09d66fb..000000000 --- a/docs/kms/umn/kms_01_0062.html +++ /dev/null @@ -1,12 +0,0 @@ - - -

                      Can I Update CMKs Created by KMS-Generated Key Materials?

                      -

                      No.

                      -

                      Keys created using KMS-generated materials cannot be updated. You can only use KMS to create new CMKs to encrypt and decrypt data.

                      -
                      -
                      - -
                      - diff --git a/docs/kms/umn/kms_01_0072.html b/docs/kms/umn/kms_01_0072.html new file mode 100644 index 000000000..c354b7962 --- /dev/null +++ b/docs/kms/umn/kms_01_0072.html @@ -0,0 +1,32 @@ + + +

                      Deleting a Key

                      +

                      Scenario

                      This section describes how to use the management console to schedule the deletion of one or multiple unwanted custom keys.

                      +

                      If deletion is scheduled for a key, the deletion will not take effect immediately. Instead, it will take effect after a waiting period of 7 to 1096 days. Before the specified deletion date, you can cancel the deletion if you want to use the key. Once the scheduled deletion has taken effect, the key will be deleted permanently and you will not be able to decrypt data encrypted by it. Therefore, you are advised to exercise caution when performing this operation.

                      +

                      Before deleting the key, confirm that it is not in use and will not be used.

                      +
                      • You can configure the SMN notification function to receive notifications when OBS fails to use the key to decrypt data before the deletion date. If you want to use the key again, cancel its deletion on the console. For SMN configuration instructions, see Configuring SMN.
                      • You can choose Storage > Elastic Volume Service to go to the EVS page. In the search bar, select KMS key ID and enter the key ID to check whether the key is being used by EVS.
                      • You can choose Computing > Image Management Service to go to the IMS page. Select the Private Image tab. In the search bar, select KMS key ID and enter the key ID to check whether the key is being used by IMS.
                      • You can choose Storage > Scalable File Service to go to the SFS page. In the search bar, select KMS key ID and enter the key ID to check whether the key is being used by SFS.
                      • You can choose Database > Relational Database Service to view the database instance list, and click the name of the target database instance. On the details page of the database instance, check whether the key to be deleted is in use.
                      +

                      Default Master Keys created by KMS cannot be scheduled for deletion.

                      +
                      +
                      +

                      Prerequisites

                      • The key to be deleted is in Enabled, Disabled, or Pending Import status.
                      +
                      +

                      Procedure

                      1. Log in to the management console.
                      2. Click in the upper left corner of the management console and select a region or project.
                      3. Choose Security > Key Management Service . The key management page is displayed.
                      4. In the row containing the desired key, click Delete.

                        Figure 1 Scheduling the deletion for a single key
                        +

                      5. On the key deletion dialog box, enter the deletion delay time.

                        Figure 2 Scheduling a deletion time
                        +

                      6. Click Yes to schedule the deletion.

                        To delete multiple keys at a time, select them and click Delete in the upper left corner of the list.

                        +
                        +

                      +
                      +
                      +
                      + +
                      + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0073.html b/docs/kms/umn/kms_01_0073.html new file mode 100644 index 000000000..495274c9a --- /dev/null +++ b/docs/kms/umn/kms_01_0073.html @@ -0,0 +1,12 @@ + + +

                      What Is Key Management Service?

                      +

                      Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).

                      +

                      This service uses hardware security modules (HSMs) to protect CMKs. HSMs help you create and control CMKs with ease. All CMKs are protected by root keys in HSMs to avoid leakage caused by human error. KMS implements access control and log-based tracking on all operations involving CMKs. Additionally, it provides CMK operation records, meeting your audit and regulatory compliance requirements.

                      +
                      +
                      + +
                      + diff --git a/docs/kms/umn/kms_01_0074.html b/docs/kms/umn/kms_01_0074.html new file mode 100644 index 000000000..6580b0808 --- /dev/null +++ b/docs/kms/umn/kms_01_0074.html @@ -0,0 +1,46 @@ + + +

                      What Is a Customer Master Key?

                      +

                      A Customer Master Key (CMK) is a Key Encryption Key (KEK) created by a user using KMS. It is used to encrypt and protect Data Encryption Keys (DEKs). One CMK can be used to encrypt one or multiple DEKs.

                      +
                      CMKs are categorized into custom keys and default keys.
                      • Custom keys

                        Keys created or imported by users on the KMS console.

                        +
                      • Default keys

                        When a user uses KMS for encryption in a cloud service for the first time, the cloud service automatically creates a key whose name ends with /default.

                        +

                        On the KMS console, you can query Default Master Keys, but can neither disable them nor schedule their deletion.

                        + +
                        + + + + + + + + + + + + + + + + +
                        Table 1 Default Master Keys

                        Key Name

                        +

                        Cloud Service

                        +

                        obs/default

                        +

                        Object Storage Service (OBS)

                        +

                        evs/default

                        +

                        Elastic Volume Service (EVS)

                        +

                        ims/default

                        +

                        Image Management Service (IMS)

                        +

                        sfs/default

                        +

                        Scalable File Service (SFS)

                        +
                        +
                        +
                      +
                      +
                      +
                      + +
                      + diff --git a/docs/kms/umn/kms_01_0088.html b/docs/kms/umn/kms_01_0088.html deleted file mode 100644 index 7ead0de43..000000000 --- a/docs/kms/umn/kms_01_0088.html +++ /dev/null @@ -1,40 +0,0 @@ - - -

                      Overview

                      -
                      A custom key contains key metadata (key ID, key alias, description, key status, and creation date) and key materials used for encrypting and decrypting data.
                      • When a user uses the KMS console to create a custom key, the KMS automatically generates a key material for the custom key.
                      • If you want to use your own key material, you can use the key import function on the KMS console to create a custom key whose key material is empty, and import the key material to the custom key.
                      -
                      -

                      Important Notes

                      • Security

                        You need to ensure that random sources meet your security requirements when using them to generate key materials. When using the import key function, you need to be responsible for the security of your key materials. Save the original backup of the key material so that the backup key material can be imported to the KMS in time when the key material is deleted accidentally.

                        -
                      • Availability and Durability

                        Before importing the key material into KMS, you need to ensure the availability and durability of the key material.

                        -

                        Differences between the imported key material and the key material generated by KMS are shown in Table 1.

                        - -
                        - - - - - - - - - - -
                        Table 1 Differences between the imported key material and the key material generated by KMS

                        Key Material Source

                        -

                        Difference

                        -

                        Imported keys

                        -
                        • You can delete the key material, but cannot delete the custom key and its metadata.
                        • Such keys cannot be rotated.
                        • When importing the key material, you can set the expiration time of the key material. After the key material expires, the KMS automatically deletes the key material within 24 hours, but does not delete the custom key and its metadata.

                          It is recommended that you save a copy of the material on your local device because it may be used for re-import in cases of invalid key materials or key material mis-deletion.

                          -
                        -

                        Keys created in KMS

                        -
                        • The key material cannot be manually deleted.
                        • Symmetric keys can be rotated.
                        • You cannot set the expiration time for key material.
                        -
                        -
                        -
                      • Association

                        When a key material is imported to a custom key, the custom key is permanently associated with the key material. Other key materials cannot be imported into the custom key.

                        -
                      • Uniqueness

                        If you use the custom key created using the imported key material to encrypt data, the encrypted data can be decrypted only by the custom key that has been used to encrypt the data, because the metadata and key material of the custom key must be consistent.

                        -
                      -
                      -
                      - - diff --git a/docs/kms/umn/kms_01_0089.html b/docs/kms/umn/kms_01_0089.html deleted file mode 100644 index 63b6dafa3..000000000 --- a/docs/kms/umn/kms_01_0089.html +++ /dev/null @@ -1,191 +0,0 @@ - - -

                      Importing Key Materials

                      -

                      If you want to use your own key materials instead of the KMS-generated materials, you can use the console to import your key materials to KMS. CMKs created using imported materials and KMS-generated materials are managed together by KMS.

                      -

                      This section describes how to import key materials on the KMS console.

                      -

                      Procedure

                      1. Log in to the management console.
                      2. Click in the upper left corner of the management console and select a region or project.
                      3. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                      4. Click Import Key. The Import Key dialog box is displayed.
                      5. Configure key parameters.

                        Figure 1 Creating an empty key
                        -
                        • Alias is the alias of the key to be created.
                          • You can enter digits, letters, underscores (_), hyphens (-), colons (:), and slashes (/).
                          • You can enter up to 255 characters.
                          -
                          -
                        • (Optional) Description is the description of the custom key.

                          You can enter up to 255 characters.

                          -
                          -
                        -

                      6. (Optional) Add tags to the custom key as needed, and enter the tag key and tag value.

                        • If a custom key has been created without any tag, you can add a tag to the custom key later if needed. Click the alias of the custom key, choose the Tags tab, and click Add Tag.
                        • The same tag (including tag key and tag value) can be used for different custom keys. However, under the same custom key, one tag key can have only one tag value.
                        • A maximum of 20 tags can be added for one custom key.
                        • If you want to delete a tag from the tag list when adding multiple tags, you can click Delete in the row where the tag to be added is located to delete the tag.
                        -
                        -

                      7. Click security and durability to understand the security and durability of the imported key.
                      8. Select I understand the security and durability of using an imported key, and create a custom key whose key material is empty.
                      9. Click Next to go to the Download the Import Items step. Select a key wrapping algorithm based on Table 1.

                        Figure 2 Obtaining the wrapping key and import token
                        - -
                        - - - - - - - - - -
                        Table 1 Key wrapping algorithms

                        Algorithm

                        -

                        Description

                        -

                        Configuration

                        -

                        RSAES_OAEP_SHA_256

                        -

                        RSA algorithm that uses OAEP and has the SHA-256 hash function

                        -

                        Select an algorithm based on your HSM functions.

                        -

                        If the HSMs support the RSAES_OAEP_SHA_256 algorithm, use RSAES_OAEP_SHA_256 to encrypt key materials.

                        -
                        -
                        -

                        If you stop a key material import process and want to try again, click Import Key Material in the row of the required custom key, and import key material in the displayed dialog box.

                        -
                        -

                      10. Obtain the wrapping key and import token. If you already have a key material, skip this step.

                        1. Obtain the wrapping key and import token.
                          • Method 1: Click Download and Continue to download the wrapping key file, as shown in Figure 3.
                            Figure 3 Downloaded file
                            -
                            • wrappingKey_KeyID is the wrapping key. It is encoded in binary format and used to encrypt the wrapping key of the key material.
                            • Import token: You do not need to download it. The import wizard automatically transfers the import token. If you close the wizard before completing the import, the token will automatically become invalid.
                            -

                            The wrapping key expires in 24 hours. If the wrapping key is invalid, download it again.

                            -

                            The import wizard automatically transfers the import token. If you close the wizard before completing the import, the token will automatically become invalid. To retry import, open the import wizard again.

                            -
                            -
                          -
                          • Method 2: Obtain the wrapping key and import token by calling APIs.
                            1. Call the get-parameters-for-import API to obtain the wrapping key and import token.
                              • public_key: content of the wrapping key (Base-64 encoding) returned after the API call
                              • import_token: content of the import token (Base-64 encoding) returned after the API call
                              -
                              The following example describes how to obtain the wrapping key and import token of a CMK (ID: 43f1ffd7-18fb-4568-9575-602e009b7ee8; algorithm: RSAES_OAEP_SHA_256).
                              • Example request
                                {      
                                -    "key_id": "43f1ffd7-18fb-4568-9575-602e009b7ee8",
                                -    "wrapping_algorithm":"RSAES_OAEP_SHA_256"
                                -}
                                -
                              • Example response
                                {
                                -    "key_id": "43f1ffd7-18fb-4568-9575-602e009b7ee8",    
                                -    "public_key":"public key base64 encoded data",
                                -    "import_token":"import token base64 encoded data",
                                -    "expiration_time":1501578672
                                -}
                                -
                              -
                              -
                            2. Save the wrapping key and convert its format. Only the key material encrypted using the converted wrapping key can be imported to the management console.
                              1. Copy the content of the wrapping key public_key, paste it to a .txt file, and save the file as PublicKey.b64.
                              2. Use OpenSSL to run the following command to perform Base-64 coding on the content of the PublicKey.b64 file to generate binary data, and save the converted file as PublicKey.bin:

                                openssl enc -d -base64 -A -in PublicKey.b64 -out PublicKey.bin

                                -
                              -
                            3. Save the import token, copy the content of the import_token token, paste it to a .txt file, and save the file as ImportToken.b64.
                            -
                          -
                        2. Use the wrapping key to encrypt the key material.

                          After performing this step, you will obtain either of the following files:

                          -

                          Symmetric key scenario: EncryptedKeyMaterial.bin (key material)

                          -

                          Asymmetric key scenario: EncryptedKeyMaterial.bin (temporary key material) and out_rsa_private_key.der (private key ciphertext)

                          -
                          -

                          Method 1: Use the downloaded wrapping key to encrypt key materials on your HSM. For details, see the operation guide of your HSM.

                          -
                          Method 2: Use OpenSSL to generate a key material and use the downloaded wrapping key to encrypt the key material.

                          If you need to run the openssl pkeyutl command, ensure your OpenSSL version is 1.0.2 or later.

                          -
                          -
                          1. Generate a key material (256-bit symmetric key) and save it as PlaintextKeyMaterial.bin.
                            • If the AES256 symmetric key algorithm is used, run the following command on the client where the OpenSSL tool has been installed:

                              openssl rand -out PlaintextKeyMaterial.bin 32

                              -
                            -
                            • If the RSA and ECC asymmetric key algorithms are used, run the following command on the client where the OpenSSL tool has been installed:
                              1. Generate a hexadecimal AES256 key.

                                openssl rand -out 0xPlaintextKeyMaterial.bin -hex 32

                                -
                              2. Convert the hexadecimal AES256 key to the binary format.

                                cat 0xPlaintextKeyMaterial.bin | xxd -r -ps > PlaintextKeyMaterial.bin

                                -
                              -
                            -
                          2. Use the downloaded wrapping key to encrypt the key material and save the encrypted key material as EncryptedKeyMaterial.bin.

                            If the wrapping key was downloaded from the console, replace PublicKey.bin in the following command with the wrapping key name wrappingKey_keyID.

                            - -
                            - - - - - - - -
                            Table 2 Encrypting the generated key material using the downloaded wrapping key

                            Wrapping Key Algorithm

                            -

                            Key Material Encryption

                            -

                            RSAES_OAEP_SHA_256

                            -

                            openssl pkeyutl

                            -

                            -in PlaintextKeyMaterial.bin

                            -

                            -inkey PublicKey.bin

                            -

                            -out EncryptedKeyMaterial.bin

                            -

                            -keyform der

                            -

                            -pubin -encrypt

                            -

                            -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha256

                            -
                            -
                            -
                          3. (Optional) To import an asymmetric key, generate an asymmetric private key, use the temporary key material (EncryptedKeyMaterial.bin) to encrypt the private key, and import the encrypted file as the private key ciphertext.
                            • Take the RSA4096 algorithm as an example. Perform the following operations:
                              1. Generate a private key.

                                openssl genrsa -out pkcs1_rsa_private_key.pem 4096

                                -
                              2. Convert the format to PKCS8.

                                openssl pkcs8 -topk8 -inform PEM -in pkcs1_rsa_private_key.pem -outform pem -nocrypt -out rsa_private_key.pem

                                -
                              3. Convert the PKCS8 format to the DER format.

                                openssl pkcs8 -topk8 -inform PEM -outform DER -in rsa_private_key.pem -out rsa_private_key.der -nocrypt

                                -
                              4. Use a temporary key material to encrypt the private key.

                                openssl enc -id-aes256-wrap-pad -K $(cat 0xPlaintextKeyMaterial.bin) -iv A65959A6 -in rsa_private_key.der -out out_rsa_private_key.der

                                -

                                By default, the -id-aes256-wrap-pad algorithm is not enabled in OpenSSL. To wrap a key, upgrade OpenSSL to the latest version and patch it first. For details, see FAQs.

                                -
                                -
                              -
                            -
                          -
                          -
                        -

                      11. The Import Key Material page is displayed.

                        -

                        - - - - - - - - - - -
                        Table 3 Parameters for importing key materials (for symmetric keys)

                        Parameter

                        -

                        Description

                        -

                        Key ID

                        -

                        Random ID of a CMK generated during the CMK creation

                        -

                        Key material

                        -

                        Import a key material.

                        -

                        For example, use the EncryptedKeyMaterial.bin file in 10.b.ii.

                        -
                        -
                        - -
                        - - - - - - - - - - - - - -
                        Table 4 Parameters for importing key materials (for asymmetric keys)

                        Parameter

                        -

                        Description

                        -

                        Key ID

                        -

                        Random ID of a CMK generated during the CMK creation

                        -

                        Temporary key material

                        -

                        Import a temporary key material.

                        -

                        For example, select the EncryptedKeyMaterial.bin file in 10.b.ii.

                        -

                        Private key ciphertext

                        -

                        Select private key ciphertext.

                        -

                        For example, select the out_rsa_private_key.der file in 10.b.iii.

                        -
                        -
                        -

                      12. Click Next to go to the Import Key Token step. Configure the parameters as described in Table 5.

                        -

                        - - - - - - - - - - - - - -
                        Table 5 Parameters for importing a key token

                        Parameter

                        -

                        Description

                        -

                        Key ID

                        -

                        Random ID of a CMK generated during the CMK creation

                        -

                        Key import token

                        -

                        Select the import token obtained via API in 12.b.

                        -

                        Key material expiration mode

                        -
                        • Key material will never expire: You use this option to specify that key materials will not expire after import.
                        • Key material will expire: You use this option to specify the expiration time of the key materials. By default, key materials expire in 24 hours after import.

                          After the key material expires, the system automatically deletes the key material within 24 hours. Once the key material is deleted, the key cannot be used and its status changes to Pending import.

                          -
                        -
                        -
                        -

                      13. Click OK. When the Key imported successfully message is displayed in the upper right corner, the materials are imported.

                        Key materials can be successfully imported when they match the corresponding CMK ID and token.

                        -
                        -

                        Your imported materials are displayed in the list of CMKs. The default status of an imported CMK is Enabled.

                        -

                      -
                      -
                      - - diff --git a/docs/kms/umn/kms_01_0090.html b/docs/kms/umn/kms_01_0090.html deleted file mode 100644 index 144a9c145..000000000 --- a/docs/kms/umn/kms_01_0090.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

                      Deleting Key Materials

                      -

                      When importing key materials, you can specify their expiration time. After the key material expires, KMS deletes it, and the status of the custom key changes to Pending import. You can manually delete the key materials as needed. The effect of expiration of the key material is the same as that of manual deletion of the key material.

                      -

                      This section describes how to delete imported key materials on the KMS console.

                      -
                      • To re-import a deleted key material, ensure the imported material is the same as the deleted one.
                      • Data encrypted using a CMK cannot be decrypted if the key material of the custom key was deleted. To decrypt the data, re-import the key material.
                      -
                      -

                      Prerequisites

                      • You have imported key materials for a CMK.
                      • The material source of the CMK is External.
                      • The CMK status is Enabled or Disabled.
                      -
                      -

                      Constraints

                      • To re-import a deleted key material, ensure the imported material is the same as the deleted one.
                      • Data encrypted using a CMK cannot be decrypted if the key material of the custom key was deleted. To decrypt the data, re-import the key material.
                      • After the deletion, the CMK will become unavailable and its status will change to Pending import.
                      • The key materials of asymmetric keys cannot be directly deleted. To delete them, perform the instructions in Deleting One or More CMKs.
                      -
                      -

                      Procedure

                      1. Log in to the management console.
                      2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                      3. In the row containing the target CMK, click Delete Key Material.
                      4. In the displayed dialog box, click OK. When Key material deleted successfully is displayed in the upper right corner, the key materials are successfully deleted.

                        After the deletion, the CMK will become unavailable and its status changes to Pending import.

                        -

                      -
                      -
                      - - diff --git a/docs/kms/umn/kms_01_0091.html b/docs/kms/umn/kms_01_0091.html deleted file mode 100644 index 0eea13f48..000000000 --- a/docs/kms/umn/kms_01_0091.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

                      Service Overview

                      -
                      - - diff --git a/docs/kms/umn/kms_01_0092.html b/docs/kms/umn/kms_01_0092.html deleted file mode 100644 index e82368c0e..000000000 --- a/docs/kms/umn/kms_01_0092.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

                      FAQs

                      -
                      -
                      - -
                      - diff --git a/docs/kms/umn/kms_01_0093.html b/docs/kms/umn/kms_01_0093.html new file mode 100644 index 000000000..36bb0d6c5 --- /dev/null +++ b/docs/kms/umn/kms_01_0093.html @@ -0,0 +1,13 @@ + + +

                      Will a Key Be Charged After It Is Scheduled to Delete?

                      +

                      No.

                      +

                      The pending period of a key from its scheduling till its deletion is not charged.

                      +

                      However, if you cancel the scheduled deletion, the charging resumes from the time when the key is scheduled to be deleted.

                      +
                      +
                      + +
                      + diff --git a/docs/kms/umn/kms_01_0094.html b/docs/kms/umn/kms_01_0094.html index 6bdcd9c3a..6433ca333 100644 --- a/docs/kms/umn/kms_01_0094.html +++ b/docs/kms/umn/kms_01_0094.html @@ -1,68 +1,85 @@ -

                      About Key Rotation

                      -

                      Purpose of Key Rotation

                      Keys that are widely or repeatedly used are insecure. To enhance the security of encryption keys, you are advised to periodically rotate keys and change their key materials.

                      -

                      The purposes of key rotation are:

                      -
                      • To reduce the amount of data encrypted by each key.

                        A key will be insecure if it is used to encrypt a huge number of data. The amount of data encrypted a key refers to the total number of bytes or messages encrypted using the key.

                        -
                      • To enhance the capability of responding to security events.

                        In your initial system security design, you shall design the key rotation function and use it for routine O&M, so that it will be at hand when an emergency occurs.

                        -
                      • To enhance the data isolation capability.

                        The ciphertext data generated before and after key rotation will be isolated. You can identify the impact scope of a security event based on the key involved and take actions accordingly.

                        +

                        Key Rotation Overview

                        +

                        Purpose of Key Rotation

                        Keys that are widely or repeatedly used are insecure. To enhance the security of encryption keys, you are advised to periodically rotate keys and change their key materials.

                        +

                        The purposes of key rotation are:

                        +
                        • To reduce the amount of data encrypted by each key.

                          A key will be insecure if it is used to encrypt a huge number of data. The amount of data encrypted a key refers to the total number of bytes or messages encrypted using the key.

                          +
                        • To enhance the capability of responding to security events.

                          In your initial system security design, you shall design the key rotation function and use it for routine O&M, so that it will be at hand when an emergency occurs.

                          +
                        • To enhance the data isolation capability.

                          The ciphertext data generated before and after key rotation will be isolated. You can identify the impact scope of a security event based on the key involved and take actions accordingly.

                        -

                        Key Rotation Methods

                        You can use either of the following key rotation methods:

                        -
                        • Manual key rotation

                          Method 1: Create a key B to replace the currently used key A.

                          -

                          Method 2: Modify the key A and use it.

                          -

                          -

                          Take OBS as an example. To manually rotate a key, create a new custom key on the KMS console. Replace the old custom key with the new one on the OBS console.

                          -
                          Figure 1 Manual key rotation
                          -
                        • Automatic key rotation

                          KMS automatically rotates keys based on the configured rotation period (365 days by default). The system automatically generates a new key to replace the key in use. Automatic key rotation only changes the key material of a CMK. The logical attributes of the key will not change, including its key ID, alias, description, and permissions.

                          -

                          Automatic key rotation has the following characteristics:

                          -
                          1. Enable rotation for an existing custom key. KMS will automatically generate new key materials for the custom key.
                          2. Data is not re-encrypted in an automatic key rotation. The DEK generated using the CMK is not automatically rotated, and data that has been encrypted using the CMK will not be encrypted again. If a DEK has been leaked, automatic rotation cannot contain the impact of the leakage.
                          -
                          Figure 2 Key rotation
                          +

                          Key Rotation Methods

                          You can use either of the following key rotation methods:

                          +
                          • Manual key rotation

                            Method 1: Create a key B to replace the currently used key A.

                            +

                            Method 2: Modify the key A and use it.

                            +

                            Example:

                            +

                            Take OBS as an example. To manually rotate a key, create a custom key on the KMS console. Replace the old custom key with the new one on the OBS console.

                            +
                            Figure 1 Manual key rotation
                            +
                          • Automatic key rotation

                            KMS automatically rotates keys based on the configured rotation period (365 days by default). The system automatically generates a new key to replace the key in use. Automatic key rotation only changes the key material of a CMK. The logical attributes of the key will not change, including its key ID, alias, description, and permissions.

                            +

                            Automatic key rotation has the following characteristics:

                            +
                            1. Enable rotation for an existing custom key. KMS will automatically generate new key materials for the custom key.
                            2. Data is not re-encrypted in an automatic key rotation. The DEK generated using the CMK is not automatically rotated, and data that has been encrypted using the CMK will not be encrypted again. If a DEK has been leaked, automatic rotation cannot contain the impact of the leakage.
                            +
                            Figure 2 Key rotation
                          -
                          KMS retains all versions of a custom key, so that you can decrypt any ciphertext encrypted using the custom key.
                          • KMS uses the latest version of the custom key to encrypt data.
                          • When decrypting data, KMS uses the custom key version that was used to encrypt the data.
                          +
                          KMS retains all versions of a custom key, so that you can decrypt any ciphertext encrypted using the custom key.
                          • KMS uses the latest version of the custom key to encrypt data.
                          • When decrypting data, KMS uses the custom key version that was used to encrypt the data.

                          Rotation Modes

                          -
                          Table 1 Key rotation modes

                          Key Type

                          +
                          - - - - - - - - - + + + + + +
                          Table 1 Key rotation modes

                          Key Type

                          Rotation Mode

                          +

                          Rotation Mode

                          Default key

                          +

                          Default master key

                          Cannot be rotated.

                          +

                          Cannot be rotated.

                          Custom key

                          +

                          User-defined key (imported CMK)

                          Keys can be rotated automatically or manually, depending on the key algorithm type.

                          -
                          • Symmetric key: Can be automatically or manually rotated.
                          • Asymmetric key: Can only be manually rotated.
                          +

                          Can only be manually rotated.

                          +

                          For more information about user-defined keys, see Custom Key Overview.

                          Disabled CMK

                          +

                          Symmetric key

                          Disabled CMKs are not rotated. KMS keeps their rotation status unchanged. After a custom key is enabled, if it has been used for longer than the rotation period, KMS will immediately rotate keys. If the custom key has been used for shorter than the rotation period, KMS will implement the original rotation plan.

                          -

                          For more information, see Disabling One or More CMKs.

                          +

                          Can be automatically or manually rotated.

                          CMKs in pending deletion state

                          +

                          Asymmetric key

                          KMS does not rotate CMKs in pending deletion status. After you cancel the deletion of a CMK, the previous key rotation status will be restored. If the custom key has been used for longer than the rotation period, KMS will immediately rotate keys. If the CMK has been used for shorter than the rotation period, KMS will implement the original rotation plan.

                          -

                          For more information, see Scheduling the Deletion of One or More Keys.

                          +

                          Can only be manually rotated.

                          +

                          Disabled CMK

                          +

                          Disabled CMKs are not rotated. KMS keeps their rotation status unchanged. After a master key is enabled, if it has been used for longer than the rotation period, KMS will immediately rotate keys. If the CMK has been used for shorter than the rotation period, KMS will implement the original rotation plan.

                          +

                          For more information, see Disabling a Key.

                          +

                          CMK in pending deletion state

                          +

                          Disabled CMKs are not rotated. KMS keeps their rotation status unchanged. After a CMK is enabled, if it has been used for longer than the rotation period, KMS will immediately rotate keys. If the CMK has been used for shorter than the rotation period, KMS will implement the original rotation plan.

                          +

                          For more information, see Scheduling the Deletion of One or More Keys.

                          -

                          You can check the rotation details on the Rotation Policy page, including the last rotation time and number of rotations.

                          +

                          You can check the rotation details on the Rotation Policy page, including the last rotation time and number of rotations.

                          + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0095.html b/docs/kms/umn/kms_01_0095.html index f1502bf27..28717fda4 100644 --- a/docs/kms/umn/kms_01_0095.html +++ b/docs/kms/umn/kms_01_0095.html @@ -1,19 +1,25 @@ -

                          Managing a Grant

                          -
                          +

                          Disabling Key Rotation

                          +

                          Scenario

                          This section describes how to disable rotation for a key on the KMS console.

                          +
                          +

                          Prerequisites

                          • The key is in Enabled status.
                          • The Origin of the key is KMS.
                          • Key rotation has been enabled.
                          +
                          +

                          Procedure

                          1. Log in to the management console.
                          2. Click in the upper left corner of the management console and select a region or project.
                          3. Choose Security > Key Management Service . The key management page is displayed.
                          4. Click the name of the target custom key to view its details.
                          5. Click to disable key rotation.
                          6. In the displayed Disable Rotation Policy dialog box, click Yes.

                            Figure 1 Disabling Key Rotation
                            +

                          7. Check the rotation status, as shown in Figure 2.

                            Figure 2 Key rotation
                            +

                          +
                          +
                          + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0096.html b/docs/kms/umn/kms_01_0096.html index f55a2b18e..735e9ddfb 100644 --- a/docs/kms/umn/kms_01_0096.html +++ b/docs/kms/umn/kms_01_0096.html @@ -1,55 +1,82 @@ -

                          Creating a Grant

                          -

                          You can create grants for other users or accounts to use the custom key. You can create a maximum of 100 grants on a custom key.

                          -

                          Prerequisites

                          • You have obtained the ID of the grantee (user to whom permissions are to be authorized).
                          • The target custom key is in Enabled status.
                          +

                          Querying a Key

                          +

                          Scenario

                          This section describes how to use the management console to view the information about a custom key, such as its name, status, ID, and creation time. The status of a key can be Enabled, Disabled, Pending deletion, or Pending import.

                          -

                          Constraints

                          • The owner of a custom key can create a grant for the custom key on the KMS console or by calling APIs. The users or accounts who have the grant creation permission assigned by the owner of the custom key can create grants for the custom key only by calling APIs.
                          • A maximum of 100 grants can be created for a custom key.
                          • Only users and accounts can be authorized. Agency authorization is not supported.
                          -
                          -

                          Procedure

                          1. Log in to the management console.
                          2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                          3. Click the alias of the target custom key to go to its details page and create a grant on it.
                          4. Click the Grants tab.
                          5. Click Create Grant. The Create Grant dialog box is displayed.
                          6. In the dialog box that is displayed, enter the ID of the user to be authorized and select permissions to be granted. For more information, see Table 1.

                            A grantee can perform the authorized operations only by calling the necessary APIs. For details, see the .

                            +

                            Procedure

                            1. Log in to the management console.
                            2. Click in the upper left corner of the management console and select a region or project.
                            3. Choose Security > Key Management Service . The key management page is displayed.
                            4. View key details in the key list.

                              Figure 1 Key list
                              +
                              • Enter the key name in the search box above the key list. Press Enter.
                              • You can click at the upper right corner on top of the key list to show or hide columns of the list.
                              +

                              Table 1 describes the parameters of a key list.

                              -
                              Table 1 Parameter description

                              Parameter

                              +
                              - - - - - - - - + + + + + + + + + + + + + +
                              Table 1 Key list parameters

                              Parameter

                              Description

                              -

                              Example Value

                              +

                              Description

                              User or Tenant

                              +

                              Name/ID

                              Whether a user or an account is authorized.

                              -
                              • User

                                User ID: Enter the IAM user ID. To obtain the ID, click the username in the upper right corner of the page, choose My Credentials. Choose API Credentials from the navigation pane, and copy the value of IAM User ID.

                                -

                                After the authorization is complete, the IAM user can use the specified keys.

                                -
                              • Account

                                Account ID: Enter the IAM user ID. To obtain the ID, click the username in the upper right corner of the page, choose My Credentials. Choose API Credentials from the navigation pane and copy the value of Account ID.

                                -

                                After the authorization is complete, all IAM users under the account can use the specified keys.

                                -
                              -

                              d9a6b2bdaedd4ba586cabe6372d1b312

                              +

                              Name of a key and the random ID of a key generated during its creation

                              Operations

                              +

                              Status

                              The following permissions can be authorized:

                              -
                              NOTE:
                              • You can create multiple grants on a custom key to provide different permissions to the same user. The user's permissions on the custom key are the combination of all the grants.
                              • This parameter cannot be left blank.
                              • Selecting only Create Grant is not allowed.
                              -
                              -
                              • Create Data Key Without Plaintext
                              • Create Data Key
                              • Encrypt Data Key
                              • Decrypt Data Key
                              • Query Key Information
                              • Create Grant
                              • Retire Grant
                                • A grantee can retire a grant if the grantee does not need that permission.
                                • If, before retiring a grant, the grantee has granted the permission to another user, that user's permission will not be affected by the grant retirement.
                                -
                              • Encrypt Data
                              • Decrypt Data
                              +

                              Status of a key, which can be one of the following:

                              +
                              • Enabled

                                The key is enabled.

                                +
                              • Disabled

                                The key is disabled.

                                +
                              • Pending deletion

                                The key is scheduled for deletion.

                                +
                              • Pending import

                                If a key does not have any key material, its status is Pending import.

                                +

                              -

                              +

                              Creation Time

                              +

                              Creation time of the key

                              +

                              Key Algorithm and Usage

                              +

                              Key algorithm selected during key creation and its usage

                              +

                              Expiration Time

                              +

                              Expiration time of the key material. When the material expires, the custom key becomes an empty key.

                              +

                              Origin

                              +

                              Source of key material, which can be one of the following:

                              +
                              • External

                                The key uses an imported key material.

                                +
                              • Key Management Service

                                The key uses KMS-generated material.

                                +
                              +

                              Operation

                              +

                              Operations you can perform on the CMK, such as disable, delete, import key material, or cancel deletion. You can also assign keys to projects.

                              -

                            5. Click OK. When message Grant created successfully is displayed in the upper right corner, the grant has been created.

                              In the list of grants, you can view the grant name, grant type, grantee ID, granted operation, and creation time of the grant.

                              +

                            6. Click the key name to view its details.

                              Figure 2 Viewing key details
                              +

                              To change the alias or description of the CMK, click next to Name or Description.

                              +
                              • The name and description of the default key cannot be modified. The name of the default key ends with /default.
                              • The name and description of a key cannot be changed if the key is in Pending deletion status.
                              +

                            7. + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0097.html b/docs/kms/umn/kms_01_0097.html deleted file mode 100644 index 0da522852..000000000 --- a/docs/kms/umn/kms_01_0097.html +++ /dev/null @@ -1,55 +0,0 @@ - - -

                              Querying a Grant

                              -

                              You can view the details about a custom key grant on the KMS console, such as the grant ID, grantee user ID, granted operation, and creation time.

                              -

                              Prerequisites

                              You have created a grant.

                              -
                              -

                              Procedure

                              1. Log in to the management console.
                              2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                              3. Click the alias of the target custom key to view its details.
                              4. Click Grant to view the grant information of the current custom key. Table 1 describes the parameters.

                                -

                                - - - - - - - - - - - - - - - - - - - - - - -
                                Table 1 Parameter description

                                Parameter

                                -

                                Description

                                -

                                Grant ID

                                -

                                Randomly generated unique identification of a grant

                                -

                                Granted To

                                -

                                Whether permissions are granted to a user or account.

                                -

                                Grantee ID

                                -

                                ID of the authorized user or account.

                                -

                                Granted Operations

                                -

                                Authorized operations (such as Create Data Key) on the custom key

                                -

                                Created

                                -

                                Time when the grant is created

                                -

                                Operation

                                -

                                Operations that can be performed on a grant. For example, you can revoke a grant.

                                -
                                -
                                -

                              -
                              -
                              -
                              - -
                              - diff --git a/docs/kms/umn/kms_01_0098.html b/docs/kms/umn/kms_01_0098.html deleted file mode 100644 index 922cce6cd..000000000 --- a/docs/kms/umn/kms_01_0098.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

                              Revoking a Grant

                              -

                              You can revoke a grant on the KMS console in either of the following scenarios:

                              -
                              • A grantee does not need the custom key grant. (The grantee can either tell the user who has created the grant to revoke the grant or call the necessary API to revoke the grant directly.)
                              • You do not want the grantee to have the grant.
                              -

                              When a grant is revoked, the grantee does not have the corresponding permission anymore. However, if the grantee has created the same grant to another user, permission of that user will not be affected.

                              -

                              This section describes how to revoke a grant on the KMS console.

                              -

                              Prerequisites

                              You have created a grant.

                              -
                              -

                              Procedure

                              1. Log in to the management console.
                              2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                              3. Click the alias of the target custom key to view its details.
                              4. In the row of a grantee, click Revoke Grant.
                              5. In the dialog box that is displayed, click OK. If Grant grant ID revoked successfully is displayed in the upper right corner, the grant has been revoked.

                                You can call the API to verify that the key grant has been revoked. For details about how to use APIs, see Key Management Service API Reference.

                                -

                                For example, if the grant to create a data key is revoked for a user, an error will be reported when the user calls the API to create a data key.

                                -
                                -

                              -
                              -
                              -
                              - -
                              - diff --git a/docs/kms/umn/kms_01_0100.html b/docs/kms/umn/kms_01_0100.html new file mode 100644 index 000000000..cbf362332 --- /dev/null +++ b/docs/kms/umn/kms_01_0100.html @@ -0,0 +1,16 @@ + + +

                              Advantages

                              +

                              Extensive Service Integration

                              • By integrating with OBS, EVS, and IMS, you can use KMS to manage the keys of the services or use KMS APIs to encrypt and decrypt local data.
                              • By integrating with Cloud Trace Service (CTS), you can use CTS to view recent KMS operation records.
                              +
                              +

                              Regulatory Compliance

                              Keys are generated by third-party validated HSMs. Access to keys is controlled and key operations involving keys are traceable by logs, compliant with international laws and regulations.

                              +
                              +

                              Easy to Use

                              You can use and manage keys easily using the console or APIs, needless to purchase hardware encryption devices.

                              +
                              +
                              +
                              + +
                              + diff --git a/docs/kms/umn/kms_01_0101.html b/docs/kms/umn/kms_01_0101.html index 3aef2dc41..129a9ea15 100644 --- a/docs/kms/umn/kms_01_0101.html +++ b/docs/kms/umn/kms_01_0101.html @@ -1,13 +1,39 @@ -

                              Encrypting Data in RDS

                              -
                              • When a user creates a database instance from Relational Database Service (RDS), the user can select Disk encryption and use the key provided by KMS to encrypt the disk of the database instance. For more information, see the Relational Database Service User Guide.
                                Figure 1 Encrypting data in RDS
                                -

                                You can use a custom key created on the KMS console for encryption.

                                -
                              • You can also call the RDS APIs to purchase encrypted database instances. For details, see the Relational Database Service User Guide.
                              +

                              What Are the Differences Between a Custom Key and a Default Key?

                              +

                              The following table describes the differences between a custom key and a default key.

                              + +
                              + + + + + + + + + + + + + +
                              Table 1 Differences between a custom key and a default key

                              Item

                              +

                              Definition

                              +

                              Difference

                              +

                              Custom key

                              +

                              A Key Encryption Key (KEK) created using KMS. The key is used to encrypt and protect DEKs.

                              +

                              A custom key can be used to encrypt multiple DEKs.

                              +
                              • It can be disabled and scheduled for deletion.
                              • It is billed per use after the being created or imported.
                              +

                              Default key

                              +

                              Automatically generated by the system when you use KMS to encrypt data in another cloud service for the first time. The suffix of the key is /default.

                              +

                              Example: evs/default

                              +
                              • It cannot be disabled or scheduled for deletion.
                              +
                              +
                              diff --git a/docs/kms/umn/kms_01_0102.html b/docs/kms/umn/kms_01_0102.html index bd7b8315c..8727239a2 100644 --- a/docs/kms/umn/kms_01_0102.html +++ b/docs/kms/umn/kms_01_0102.html @@ -1,11 +1,12 @@ -

                              When Should I Use a CMK Created with Imported Key Materials?

                              -
                              • If you do not want to use KMS-generated key materials, you can import your own key materials to create a CMK. Such a CMK allows deletion of only the key materials when you do not need it. In addition, when you find that the key materials are mis-deleted, you can import the same materials to the CMK.
                              • You can also import off-cloud key materials to KMS when you want to use the same keys on and off the cloud. This practice has proved useful when users migrate local encrypted data onto cloud.
                              +

                              Can I Export a CMK from KMS?

                              +

                              No.

                              +

                              To ensure CMK security, users can only create and use CMKs in KMS.

                              diff --git a/docs/kms/umn/kms_01_0103.html b/docs/kms/umn/kms_01_0103.html deleted file mode 100644 index 588fd6635..000000000 --- a/docs/kms/umn/kms_01_0103.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

                              What Types of Keys Can I Import?

                              -

                              You can import 256-bit symmetric keys.

                              -
                              -
                              - -
                              - diff --git a/docs/kms/umn/kms_01_0104.html b/docs/kms/umn/kms_01_0104.html deleted file mode 100644 index 313dad6a6..000000000 --- a/docs/kms/umn/kms_01_0104.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

                              What Should I Do When I Accidentally Delete Key Materials?

                              -

                              You can import the backup key materials from your local device again.

                              -

                              Before importing key materials, you are advised to back up the materials. The materials to be re-imported must be consistent with the mis-deleted materials.

                              -
                              -
                              -
                              - -
                              - diff --git a/docs/kms/umn/kms_01_0105.html b/docs/kms/umn/kms_01_0105.html deleted file mode 100644 index e12de5d4f..000000000 --- a/docs/kms/umn/kms_01_0105.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

                              User Guide

                              -
                              - - diff --git a/docs/kms/umn/kms_01_0106.html b/docs/kms/umn/kms_01_0106.html index aee4e2dc2..32a955004 100644 --- a/docs/kms/umn/kms_01_0106.html +++ b/docs/kms/umn/kms_01_0106.html @@ -1,25 +1,23 @@ -

                              Cloud Services with KMS Integrated

                              -
                              +

                              What Are the Benefits of Envelope Encryption?

                              +

                              Envelope encryption is the practice of encrypting data with a DEK and then encrypting the DEK with a root key that you can fully manage. In this case, CMKs are not required for encryption or decryption.

                              +

                              Benefits:

                              +
                              • Advantages over CMK encryption in KMS

                                Users can use CMKs to encrypt and decrypt data on the KMS console or by calling KMS APIs.

                                +

                                A CMK can encrypt and decrypt data no more than 4 KB. An envelope can encrypt and decrypt larger volumes of data.

                                +

                                Data encrypted using envelopes does not need to be transferred. Only the DEKs need to be transferred to the KMS server.

                                +
                              • Advantages over encryption by using cloud services
                                • Security

                                  Data transferred to the cloud for encryption is exposed to risks such as interception and phishing.

                                  +

                                  During envelope encryption, KMS uses Hardware Security Modules (HSMs) to protect keys. All CMKs are protected by root keys in HSMs to avoid key leakage.

                                  +
                                • Trustworthiness

                                  You will worry about data security on the cloud. It is also difficult for cloud services to prove that they never misuse or disclose such data.

                                  +

                                  If you choose envelope encryption, KMS will control access to keys and record all usages of and operations on keys with traceable logs, meeting your audit and regulatory compliance requirements.

                                  +
                                • Performance and cost

                                  To encrypt or decrypt data using a cloud service, you have to send the data to the encryption server and receive the processed data. This process seriously affects your service performance and incurs high costs.

                                  +

                                  Envelope encryption allows you to generate DEKs online by calling KMS cryptographic algorithm APIs, and to encrypt a large amount of local data with the DEKs.

                                  +
                                +
                              +
                              diff --git a/docs/kms/umn/kms_01_0107.html b/docs/kms/umn/kms_01_0107.html new file mode 100644 index 000000000..d6851d0c9 --- /dev/null +++ b/docs/kms/umn/kms_01_0107.html @@ -0,0 +1,32 @@ + + +

                              How Do I Use the Online Tool to Encrypt or Decrypt Small Volumes of Data?

                              +

                              You can use the online tool to encrypt or decrypt data in the following procedures:

                              +

                              Encrypting Data

                              1. Log in to the management console.
                              2. Click in the upper left corner of the management console and select a region or project.
                              3. Choose Security > Key Management Service . The key management page is displayed.
                              4. Click the name of the target custom key to access the key details page. Click the Tool tab.
                              5. Click Encrypt. In the text box on the left, enter the data to be encrypted.

                                Figure 1 Encrypting data

                                +
                                +

                              6. Click Execute. The data encryption result is displayed in the text box on the right.

                                • The key you clicked is used for encryption.
                                • To clear your input, click Clear.
                                • To copy the encrypted data, click Copy to Clipboard. You can then paste and save it to a local file.
                                +
                                +

                              +
                              +

                              Decrypting Data

                              1. Log in to the management console.
                              2. Click in the upper left corner of the management console and select a region or project.
                              3. Choose Security > Key Management Service . The key management page is displayed.
                              4. Click the alias of an enabled key (excepting Default Master Keys) to access its details page.
                              5. Click the Tool tab.
                              6. Click Decrypt. In the text box on the left, enter the data to be decrypted.

                                • The online tool automatically identifies the key used for data encryption, and uses it to decrypt data.
                                • If the key has been deleted, the decryption will fail.
                                +
                                +
                                Figure 2 Decrypting data

                                +
                                +

                              7. Click Execute. The data decryption result is displayed in plaintext in the text box on the right.

                                To copy the decrypted data, click Copy to Clipboard. You can then paste and save it to a local file.

                                +
                                +

                              +
                              +
                              +
                              + +
                              + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0109.html b/docs/kms/umn/kms_01_0109.html new file mode 100644 index 000000000..b01d02cf6 --- /dev/null +++ b/docs/kms/umn/kms_01_0109.html @@ -0,0 +1,17 @@ + + +

                              Service Overview

                              +
                              + + diff --git a/docs/kms/umn/kms_01_0114.html b/docs/kms/umn/kms_01_0114.html new file mode 100644 index 000000000..6a2206351 --- /dev/null +++ b/docs/kms/umn/kms_01_0114.html @@ -0,0 +1,12 @@ + + +

                              Can I Update CMKs Created by KMS-Generated Key Materials?

                              +

                              No.

                              +

                              Keys created using KMS-generated materials cannot be updated. You can only use KMS to create new CMKs to encrypt and decrypt data.

                              +
                              +
                              + +
                              + diff --git a/docs/kms/umn/kms_01_0115.html b/docs/kms/umn/kms_01_0115.html deleted file mode 100644 index c9113439a..000000000 --- a/docs/kms/umn/kms_01_0115.html +++ /dev/null @@ -1,16 +0,0 @@ - - -

                              Advantages

                              -

                              Extensive Service Integration

                              • By integrating with OBS, EVS, and IMS, you can use KMS to manage the keys of the services or use KMS APIs to encrypt and decrypt local data.
                              • By integrating with Cloud Trace Service (CTS), you can use CTS to view recent KMS operation records.
                              -
                              -

                              Regulatory Compliance

                              Keys are generated by third-party validated HSMs. Access to keys is controlled and all operations involving keys are traceable by logs, compliant with international laws and regulations.

                              -
                              -

                              Easy to Use

                              You can use and manage keys easily using the console or APIs, needless to purchase hardware encryption devices.

                              -
                              -
                              -
                              - -
                              - diff --git a/docs/kms/umn/kms_01_0116.html b/docs/kms/umn/kms_01_0116.html deleted file mode 100644 index 840cbaa56..000000000 --- a/docs/kms/umn/kms_01_0116.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

                              Encrypting Data in SFS

                              -
                              • When creating a file system using the Scalable File Service (SFS), you can select KMS encryption and use the key provided by the KMS to encrypt the file system.For details, see Figure 1. For more information, see the Scalable File Service User Guide.
                                Figure 1 Encrypting Data in SFS
                                -

                                You can use a custom key created on the KMS console for encryption.

                                -
                              • You can use the SFS API to create an encrypted file system. For details, see the Scalable File Service API Reference.
                              -
                              - - diff --git a/docs/kms/umn/kms_01_0121.html b/docs/kms/umn/kms_01_0121.html deleted file mode 100644 index f67c45aa6..000000000 --- a/docs/kms/umn/kms_01_0121.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

                              KMS

                              -
                              - - diff --git a/docs/kms/umn/kms_01_0133.html b/docs/kms/umn/kms_01_0133.html deleted file mode 100644 index 68da44fdb..000000000 --- a/docs/kms/umn/kms_01_0133.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

                              Permission Control

                              -
                              - - diff --git a/docs/kms/umn/kms_01_0135.html b/docs/kms/umn/kms_01_0135.html deleted file mode 100644 index 3966d0ec7..000000000 --- a/docs/kms/umn/kms_01_0135.html +++ /dev/null @@ -1,62 +0,0 @@ - - -

                              Creating a User and Authorizing the User the Permission to Access KMS

                              -

                              This section describes IAM's fine-grained permissions management for your KMS resources. With IAM, you can:

                              -
                              • Create IAM users for employees based on the organizational structure of your enterprise. Each IAM user has its own security credentials to access KMS resources.
                              • Grant users only the permissions required to perform a task.
                              • Entrust an account or cloud service to perform efficient O&M on your KMS resources.
                              -

                              If your account does not need individual IAM users, skip this chapter.

                              -

                              This section describes the procedure for granting permissions (see Figure 1).

                              -

                              Prerequisites

                              Before granting permissions to a user group, you need to understand the available KMS permissions, and grant permissions based on the real-life scenario. The following tables describe the permissions supported in KMS.

                              - -
                              - - - - - - - - - - - - - - - - - - - - - -
                              Table 1 KMS permissions

                              Role/Policy

                              -

                              Description

                              -

                              Type

                              -

                              KMS Administrator

                              -

                              Administrator permissions for the encryption key

                              -

                              Role

                              -

                              KMS CMKFullAccess

                              -

                              All permissions for the encryption keys

                              -

                              Policy

                              -

                              KMS CMK Admin

                              -

                              All permissions for the encryption keys

                              -

                              Policy

                              -

                              KMS CMKReadOnlyAccess

                              -

                              Read-only permission for encryption keys

                              -

                              Policy

                              -
                              -
                              -
                              -

                              Authorization Process

                              Figure 1 Authorizing the KMS access permission to a user
                              -
                              1. Create a user group on the IAM console and grant the user group the permission (indicating full permissions for keys).

                                -
                              2. Create a user on the IAM console and add the user to the user group created in 1.

                                -
                              3. Log in to the console as newly created user, and verify that the user only has the assigned permissions.

                                -
                              -
                              -
                              -
                              - -
                              - diff --git a/docs/kms/umn/kms_01_0138.html b/docs/kms/umn/kms_01_0138.html index 21f8ab066..f8ad7266f 100644 --- a/docs/kms/umn/kms_01_0138.html +++ b/docs/kms/umn/kms_01_0138.html @@ -1,19 +1,19 @@ -

                              Rotating CMKs

                              -
                              +

                              Rotating Keys

                              +
                              diff --git a/docs/kms/umn/kms_01_0139.html b/docs/kms/umn/kms_01_0139.html index 46e173958..192ab0e90 100644 --- a/docs/kms/umn/kms_01_0139.html +++ b/docs/kms/umn/kms_01_0139.html @@ -1,25 +1,33 @@

                              Enabling Key Rotation

                              -

                              This section describes how to enable rotation for a key on the KMS console.

                              -

                              By default, automatic key rotation is disabled for a custom key. Every time you enable key rotation, KMS automatically rotates custom keys based on the rotation period you set.

                              -

                              Prerequisites

                              • The key is enabled.
                              • The Origin of the key is KMS.
                              • Only symmetric keys can be rotated.
                              +

                              Scenario

                              This section describes how to enable rotation for a key on the KMS console.

                              +

                              By default, automatic key rotation is disabled for a CMK. Every time you enable key rotation, KMS automatically rotates CMKs based on the rotation period you set.

                              -

                              Constraints

                              • A disabled custom key is never rotated, even if rotation is enabled for it.

                                KMS resumes rotation when this custom key is enabled. If you enable this custom key after one rotation period has passed, KMS will rotate it within 24 hours.

                                -
                              • Only CMKs can be rotated.
                              +

                              Prerequisites

                              • The key is enabled.
                              • The Origin of the key is KMS.
                              -

                              Procedure

                              1. Log in to the management console.
                              2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                              1. Click the alias of the target custom key to view its details.
                              2. Click the Rotation Policy tab. The rotation switch is displayed.
                              3. Click to enable key rotation.
                              4. In the Enable Rotation Policy dialog box, set the rotation period and click OK.

                                • Set the rotation period (unit: day) to an integer in the range 30 to 365. The default value is 365.
                                • After the setting takes effect, the new rotation period starts.
                                • Configure the period based on how often a custom key is used. If it is frequently used, configure a short period. Otherwise, set a long one.
                                  • A disabled custom key is never rotated, even if rotation is enabled for it.
                                  • KMS resumes rotation when this custom key is enabled. If you enable this custom key after one rotation period has passed, KMS will rotate it within 24 hours.
                                  • You can click to change the rotation period. After the period is changed, KMS rotates the key by the new period.
                                  -
                                  -
                                -

                              5. Check rotation details, as shown in the following figure.

                                Figure 1 Key rotation details
                                -

                                You can click to change the rotation period. After the period is changed, KMS rotates the key by the new period.

                                +

                                Procedure

                                1. Log in to the management console.
                                2. Click in the upper left corner of the management console and select a region or project.
                                3. Choose Security > Key Management Service . The key management page is displayed.
                                4. Click the name of the target custom key to view its details.
                                5. Click Rotation Policy. The dialog box is displayed, as shown in Figure 1.

                                  Figure 1 Key rotation
                                  +

                                6. Click to enable key rotation.
                                7. In the Enable Rotation Policy dialog box, set the rotation period and click OK.

                                  Figure 2 Setting the rotation period
                                  +

                                  Set the rotation period (unit: day) to an integer in the range 30 to 365. The default value is 365.

                                  +

                                  After the setting takes effect, the new rotation period starts.

                                  +

                                  Configure the period based on how often a custom key is used. If it is frequently used, configure a short period; otherwise, set a long one.

                                  +

                                8. After rotation is enabled, the rotation details will be displayed, as shown in Figure 3.

                                  Figure 3 Key rotation details
                                  +

                                  After rotation is enabled, the key will be rotated based on your set period.

                                  +
                                  • A disabled custom key is never rotated, even if rotation is enabled for it.
                                  • KMS resumes rotation when this custom key is enabled. If you enable this custom key after one rotation period has passed, KMS will rotate it within 24 hours.
                                  • You can click to change the rotation period. After the period is changed, KMS rotates the key by the new period.

                                + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0142.html b/docs/kms/umn/kms_01_0142.html deleted file mode 100644 index 2bc8e7503..000000000 --- a/docs/kms/umn/kms_01_0142.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

                                Creating CMKs Using Imported Key Materials

                                -
                                - - diff --git a/docs/kms/umn/kms_01_0161.html b/docs/kms/umn/kms_01_0161.html deleted file mode 100644 index 2fcd633cd..000000000 --- a/docs/kms/umn/kms_01_0161.html +++ /dev/null @@ -1,68 +0,0 @@ - - -

                                Creating a Custom KMS Policy

                                -

                                Custom policies can be created as a supplement to the system policies of KMS. For details about the actions supported by custom policies, see "Permissions Policies and Supported Actions" in Key Management Service API Reference.

                                -

                                You can create custom policies in either of the following ways:

                                -
                                • Visual editor: You can select policy configurations without the need to know policy syntax.
                                • JSON: Edit JSON policies from scratch or based on an existing policy. This section describes typical KMS custom policies.
                                -

                                Example Custom Policies of KMS

                                • Example: authorizing users to create and import keys
                                  {
                                  -    "Version": "1.1",
                                  -    "Statement": [
                                  -        {
                                  -            "Effect": "Allow",
                                  -            "Action": [
                                  -                "kms:cmk:create",
                                  -                "kms:cmk:getMaterial",
                                  -                "kms:cmkTag:create",
                                  -                "kms:cmkTag:batch",
                                  -                "kms:cmk:importMaterial"
                                  -            ]
                                  -        }
                                  -    ]
                                  -}
                                  -
                                -
                                -
                                • Example: authorizing users to use keys
                                  {
                                  -    "Version": "1.1",
                                  -    "Statement": [
                                  -        {
                                  -            "Effect": "Allow",
                                  -            "Action": [
                                  -                "kms:dek:crypto",
                                  -                "kms:cmk:get",
                                  -                "kms:cmk:crypto",
                                  -                "kms:cmk:generate",
                                  -                "kms:cmk:list"
                                  -            ]
                                  -        }
                                  -    ]
                                  -}
                                  -
                                • Example: multi-action policy

                                  A custom policy can contain actions of multiple services that are all of the global or project-level type. The following is a policy with multiple statements:

                                  -
                                  {
                                  -    "Version": "1.1",
                                  -    "Statement": [
                                  -        {
                                  -            "Effect": "Allow",
                                  -            "Action": [
                                  -                "rds:task:list"
                                  -            ]
                                  -        },
                                  -        {
                                  -            "Effect": "Allow",
                                  -            "Action": [
                                  -                "kms:dek:crypto",
                                  -                "kms:cmk:get",
                                  -                "kms:cmk:crypto",
                                  -                "kms:cmk:generate",
                                  -                "kms:cmk:list"
                                  -            ]
                                  -        }
                                  -    ]
                                  -}
                                  -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0177.html b/docs/kms/umn/kms_01_0177.html deleted file mode 100644 index 2efbce5c2..000000000 --- a/docs/kms/umn/kms_01_0177.html +++ /dev/null @@ -1,31 +0,0 @@ - - -

                                Key Management Service

                                -
                                - - diff --git a/docs/kms/umn/kms_01_0178.html b/docs/kms/umn/kms_01_0178.html deleted file mode 100644 index ccbe470ef..000000000 --- a/docs/kms/umn/kms_01_0178.html +++ /dev/null @@ -1,79 +0,0 @@ - - -

                                Creating a Key

                                -

                                This section describes how to create a custom key on the KMS console.

                                -

                                Custom keys can be categorized into symmetric keys and asymmetric keys.

                                -

                                Constraints

                                • You can create up to 100 custom keys, excluding default keys.
                                • A custom key is created using the AES-256 algorithm and is 256 bit long.
                                • Asymmetric keys are created using RSA or ECC algorithms. RSA keys can be used for encryption, decryption, digital signature, and signature verification. ECC keys can be used only for digital signature and signature verification.
                                • Aliases of default keys end with /default. When choosing aliases for your custom keys, do not use aliases ending with /default.
                                • KMS does not limit the number of times that a key can be called.
                                -
                                -

                                Scenarios

                                • Encrypt data in OBS
                                • Encrypt data in EVS
                                • Encrypt data in IMS
                                • Use custom keys to directly encrypt and decrypt small volumes of data.
                                • DEK encryption and decryption for user applications
                                -
                                -

                                Creating a Key

                                1. Log in to the management console.
                                2. Click in the upper left corner of the management console and select a region or project.
                                3. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                                4. Click Create Bucket in the upper right corner.
                                5. Configure parameters in the Create Key dialog box.

                                  Figure 1 Creating a key
                                  -
                                  • Alias is the alias of the key to be created.
                                    • You can enter digits, letters, underscores (_), hyphens (-), colons (:), and slashes (/).
                                    • You can enter up to 255 characters.
                                    -
                                    -
                                  • Key Algorithm: Select a key algorithm. For more information, see Table 1. -
                                    - - - - - - - - - - - - - - - - - - - - - - - - -
                                    Table 1 Key algorithms supported by KMS

                                    Key Type

                                    -

                                    Algorithm Type

                                    -

                                    Key Specifications

                                    -

                                    Description

                                    -

                                    Usage

                                    -

                                    Symmetric key

                                    -

                                    AES

                                    -
                                    • AES_256
                                    -

                                    AES symmetric key

                                    -

                                    Encrypts and decrypts a small amount of data or data keys.

                                    -

                                    Asymmetric key

                                    -

                                    RSA

                                    -
                                    • RSA_2048
                                    • RSA_3072
                                    • RSA_4096
                                    -

                                    RSA asymmetric password

                                    -

                                    Encrypts and decrypts a small amount of data or creates digital signatures.

                                    -

                                    ECC

                                    -
                                    • EC_P256
                                    • EC_P384
                                    -

                                    Elliptic curve recommended by NIST

                                    -

                                    Digital signature

                                    -
                                    -
                                    -
                                  • Usage: Select SIGN_VERIFY or ENCRYPT_DECRYPT.
                                    • For an AES_256 symmetric key, the default value is ENCRYPT_DECRYPT.
                                    • For RSA asymmetric keys, select ENCRYPT_DECRYPT or SIGN_VERIFY. The default value is SIGN_VERIFY.
                                    • For an ECC asymmetric key, the default value is SIGN_VERIFY.
                                    -

                                    The key usage can only be configured during key creation and cannot be modified afterwards.

                                    -
                                    -
                                  • (Optional) Description is the description of the custom key.

                                    You can enter up to 255 characters.

                                    -
                                    -
                                  -

                                6. (Optional) Add tags to the custom key as needed, and enter the tag key and tag value.

                                  • After creating a CMK, you can click the alias of the CMK to go to the CMK details page and add a tag to the CMK.
                                  • The same tag (including tag key and tag value) can be used for different custom keys. However, under the same custom key, one tag key can have only one tag value.
                                  • A maximum of 20 tags can be added for one custom key.
                                  • To delete a tag, click Delete next to it.
                                  -
                                  -

                                7. Click OK. A message is displayed in the upper right corner of the page, indicating that the key is created successfully.

                                  In the key list, you can view the created keys. The default status of a key is Enabled.

                                  -

                                -
                                -

                                Related Operations

                                • For details about how to upload objects with server-side encryption, see section "Uploading a File with Server-Side Encryption" in Object Storage Service User Guide.
                                • For details about how to encrypt data on EVS disks, see section "Creating an EVS Disk" in Elastic Volume Service User Guide.
                                • For details about how to encrypt private images, see section "Encrypting an Image" in Image Management Service User Guide.
                                • For details about how to encrypt disks for a database instance in RDS, see section "Purchasing an Instance" in the Relational Database Service User Guide.
                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0179.html b/docs/kms/umn/kms_01_0179.html deleted file mode 100644 index 9f56720d8..000000000 --- a/docs/kms/umn/kms_01_0179.html +++ /dev/null @@ -1,59 +0,0 @@ - - -

                                Viewing a CMK

                                -

                                This section describes how to view the information about the custom key on the KMS console, including the key alias, status, ID, and creation time. The status of a key can be Enabled, Disabled, Scheduled deletion, or Pending import.

                                -

                                Procedure

                                1. Log in to the management console.
                                2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                                1. Check the key list.

                                  -

                                  - - - - - - - - - - - - - - - - - - - -
                                  Table 1 Key list parameters

                                  Parameter

                                  -

                                  Description

                                  -

                                  Alias/ID

                                  -

                                  Alias of a key and the random ID of a key generated during its creation.

                                  -

                                  Status

                                  -

                                  Status of a CMK, which can be one of the following:

                                  -
                                  • Enabled

                                    The CMK is enabled.

                                    -
                                  • Disabled

                                    The CMK is disabled.

                                    -
                                  • Pending deletion

                                    The CMK is scheduled for deletion.

                                    -
                                  • Pending import

                                    If your CMK does not have materials, its status is Pending import.

                                    -
                                  -

                                  Key Algorithm and Usage

                                  -

                                  Key algorithm selected during key creation and its usage

                                  -

                                  Origin

                                  -

                                  Source of key material, which can be one of the following:

                                  -
                                  • External

                                    The key is imported to the KMS from an external system.

                                    -
                                  • Key Management Service

                                    The key is a default key or created in KMS.

                                    -
                                  -

                                  Operation

                                  -

                                  Operations you can perform on the key, such as disable, delete, import key material, or cancel deletion. You can also assign keys to projects.

                                  -
                                  -
                                  -

                                2. You can click the alias of a key to view its details.

                                  To change the alias or description of the CMK, click next to the value of Alias or Description.

                                  -
                                  • A default key (the alias suffix of which is /default) does not allow alias and description changes.
                                  • The alias and description of a CMK cannot be changed if the CMK is in Pending deletion status.
                                  -
                                  -

                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0182.html b/docs/kms/umn/kms_01_0182.html deleted file mode 100644 index 08667bada..000000000 --- a/docs/kms/umn/kms_01_0182.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

                                What Should I Do If I Do Not Have the Permissions to Perform Operations on KMS?

                                -

                                Symptom

                                A message indicating lack of permissions is displayed when you attempt to perform operations on keys, such as view, create, or import keys.

                                -
                                -

                                Possible Causes

                                Your account is not associated with the required KMS system policies.

                                -
                                -

                                Solution

                                1. Check whether your account has been associated with KMS Administrator and KMS CMKFullAccess policies.

                                  For details about how to check your user groups and permissions, see the "User Groups and Authorization" section.

                                  -

                                  If your account has been associated with required KMS system policies, go to 2.

                                  -

                                2. Associate your account with required system policies.

                                  • For details about how to add administrator permissions, see the "User Groups and Authorization" section.
                                  • For details about how to add a custom policy, see the "Creating a Custom KMS Policy" section.
                                  -

                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0186.html b/docs/kms/umn/kms_01_0186.html deleted file mode 100644 index 07f9d81af..000000000 --- a/docs/kms/umn/kms_01_0186.html +++ /dev/null @@ -1,34 +0,0 @@ - - -

                                Why Can't I Wrap Asymmetric Keys by Using -id-aes256-wrap-pad in OpenSSL?

                                -

                                Symptom

                                By default, the -id-aes256-wrap-pad algorithm is not enabled in OpenSSL. To wrap a key, upgrade OpenSSL to the latest version and patch it first.

                                -
                                -

                                Solution

                                Use bash commands to create a local copy of the existing OpenSSL. You do not need to delete or modify the default OpenSSL client installation configurations.

                                -
                                1. Switch to the root user.

                                  sudo su -

                                  -

                                2. Run the following command and record the OpenSSL version:

                                  openssl version

                                  -

                                3. Run the following commands to create the /root/build directory. This directory will be used to store the latest OpenSSL binary file.

                                  mkdir $HOME/build

                                  -

                                  mkdir -p $HOME/local/ssl

                                  -

                                  cd $HOME/build

                                  -

                                4. Download the latest OpenSSL version from https://www.openssl.org/source/.
                                5. Download and decompress the binary file.
                                6. Replace openssl-1.1.1d.tar.gz with the latest OpenSSL version downloaded in step 4.

                                  curl -O https://www.openssl.org/source/openssl-1.1.1d.tar.gz

                                  -

                                  tar -zxf openssl-1.1.1d.tar.gz

                                  -

                                7. Use the gcc tool to patch the version, and compile the downloaded binary file.

                                  yum install patch make gcc -y

                                  If you are using a version other than OpenSSL-1.1.1d, you may need to change the directory and commands used, or this patch may not work properly.

                                  -
                                  -
                                  -

                                8. Run the following commands:

                                  sed -i "/BIO_get_cipher_ctx(benc, &ctx);/a\ EVP_CIPHER_CTX_set_flags(ctx, EVP_CIPHER_CTX_FLAG_WRAP_ALLOW);" $HOME/build/openssl-1.1.1d/apps/enc.c
                                  -

                                9. Run the following commands to compile the OpenSSL enc.c file:

                                  cd $HOME/build/openssl-1.1.1d/

                                  -

                                  ./config --prefix=$HOME/local --openssldir=$HOME/local/ssl

                                  -

                                  make -j$(grep -c ^processor /proc/cpuinfo)

                                  -

                                  make install

                                  -

                                10. Configure the environment variable LD_LIBRARY_PATH to ensure that required libraries are available for OpenSSL. The latest version of OpenSSL has been dynamically linked to the binary file in the $HOME/local/ssl/lib/ directory, and cannot be directly executed in shell.
                                11. Create a script named openssl.sh to load the $HOME/local/ssl/lib/ path before running the binary file.

                                  cd $HOME/local/bin/

                                  -

                                  echo -e '#!/bin/bash \nenv LD_LIBRARY_PATH=$HOME/local/lib/ $HOME/local/bin/openssl "$@"' > ./openssl.sh

                                  -

                                12. Run the following command to configure an execute bit on the script:

                                  chmod 755 ./openssl.sh

                                  -

                                13. Run the following command to start the patched OpenSSL version:

                                  $HOME/local/bin/openssl.sh

                                  -

                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0189.html b/docs/kms/umn/kms_01_0189.html deleted file mode 100644 index c277abb4c..000000000 --- a/docs/kms/umn/kms_01_0189.html +++ /dev/null @@ -1,57 +0,0 @@ - - -

                                Key Algorithms Supported by KMS

                                -
                                -
                                - - - - - - - - - - - - - - - - - - - - - - - - -
                                Table 1 Key algorithms supported by KMS

                                Key Type

                                -

                                Algorithm Type

                                -

                                Key Specifications

                                -

                                Description

                                -

                                Usage

                                -

                                Symmetric key

                                -

                                AES

                                -
                                • AES_256
                                -

                                AES symmetric key

                                -

                                Encrypts and decrypts a small amount of data or data keys.

                                -

                                Asymmetric key

                                -

                                RSA

                                -
                                • RSA_2048
                                • RSA_3072
                                • RSA_4096
                                -

                                RSA asymmetric password

                                -

                                Encrypts and decrypts a small amount of data or creates digital signatures.

                                -

                                ECC

                                -
                                • EC_P256
                                • EC_P384
                                -

                                Elliptic curve recommended by NIST

                                -

                                Digital signature

                                -
                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0193.html b/docs/kms/umn/kms_01_0193.html new file mode 100644 index 000000000..f20ab6ccb --- /dev/null +++ b/docs/kms/umn/kms_01_0193.html @@ -0,0 +1,11 @@ + + +

                                How Does KMS Protect My Keys?

                                +

                                The mechanism of KMS prevents anyone from accessing your keys in plaintext. KMS relies on hardware security modules (HSMs) that safeguard the confidentiality and integrity of your keys. Plaintext KMS keys are always encrypted by HSMs and are never stored on any disk. These keys are only utilized within the volatile memory of the HSMs for as long as necessary to perform the cryptographic operation you have requested.

                                +
                                +
                                + +
                                + diff --git a/docs/kms/umn/kms_01_0194.html b/docs/kms/umn/kms_01_0194.html new file mode 100644 index 000000000..75c0a25b9 --- /dev/null +++ b/docs/kms/umn/kms_01_0194.html @@ -0,0 +1,98 @@ + + +

                                Creating a Key

                                +

                                Scenario

                                This section describes how to create a custom key on the KMS management console. You can create up to 100 custom keys, excluding default keys.

                                +
                                CMKs can be used for:
                                • Server-side encryption on OBS
                                • Encryption of data on EVS disks
                                • Encryption of private images on IMS
                                • File system encryption on SFS
                                • Disk encryption for database instances in RDS
                                • DEK encryption and decryption for user applications
                                +
                                +
                                +

                                Constraints

                                • You can create up to 100 custom keys, excluding default keys.
                                • Names of default keys end with /default. When configuring names for your custom keys, the value cannot end with /default.
                                +
                                +

                                Procedure

                                1. Log in to the management console.
                                2. Click in the upper left corner of the management console and select a region or project.
                                3. Choose Security > Key Management Service . The key management page is displayed.
                                4. Click Create Key in the upper right corner. In the displayed dialog box, enter the alias, names, tags, and description of the key.

                                  Figure 1 Creating a Key
                                  +
                                  • Name: Name of the key to be created
                                  • Key Algorithm: Key algorithm supported by KMS. See the following table for details. +
                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                    Table 1 Key algorithms supported by KMS

                                    Key Type

                                    +

                                    Algorithm Type

                                    +

                                    Key Specifications

                                    +

                                    Description

                                    +

                                    Application Scenario

                                    +

                                    Symmetric key

                                    +

                                    AES

                                    +

                                    AES_256

                                    +

                                    AES symmetric key

                                    +
                                    • Data encryption and decryption
                                    • DEKs encryption and decryption
                                      NOTE:

                                      You can encrypt and decrypt a small amount of data using the the online tool on the console.

                                      +

                                      You need to call APIs to encrypt and decrypt a large amount of data.

                                      +
                                      +
                                    +

                                    Digest key

                                    +

                                    SHA

                                    +
                                    • HMAC_256
                                    • HMAC_384
                                    • HMAC_512
                                    +

                                    Digest key

                                    +
                                    • Data tampering prevention
                                    • Data integrity verification
                                    +

                                    Asymmetric key

                                    +

                                    RSA

                                    +
                                    • RSA_2048
                                    • RSA_3072
                                    • RSA_4096
                                    +

                                    RSA asymmetric password

                                    +
                                    • Digital signature and signature verification
                                    • Data encryption and decryption
                                      NOTE:

                                      Asymmetric keys are applicable to signature and signature verification scenarios. Asymmetric keys are not efficient enough for data encryption. Symmetric keys are suitable for encrypting and decrypting data.

                                      +
                                      +
                                    +

                                    ECC

                                    +
                                    • EC_P256
                                    • EC_P384
                                    +

                                    Elliptic curve recommended by NIST

                                    +

                                    Digital signature and signature verification

                                    +
                                    +
                                    +
                                  • Usage: Select SIGN_VERIFY, GENERATE_VERIFY_MAC, or ENCRYPT_DECRYPT.
                                    • For an AES_256 symmetric key, the default value is ENCRYPT_DECRYPT.
                                    • For an HMAC symmetric key, the default value is GENERATE_VERIFY_MAC.
                                    • For RSA asymmetric keys, select ENCRYPT_DECRYPT or SIGN_VERIFY. The default value is SIGN_VERIFY.
                                    • For an ECC asymmetric key, the default value is SIGN_VERIFY.
                                    +

                                    The key usage can only be configured during key creation and cannot be modified afterwards.

                                    +
                                    +
                                  • (Optional) Description is the description of the custom key.
                                  • (Optional) Tags: Add tags to the custom key as needed, and enter the tag key and tag value.
                                    • If a custom key has been created without any tag, you can add a tag to the custom key later as necessary. Click the name of the custom key. The page with key details is displayed. Then you can add tags to the custom key.
                                    • The same tag (including tag key and tag value) can be used for different custom keys. However, under the same custom key, one tag key can have only one tag value.
                                    • A maximum of 20 tags can be added for one custom key.
                                    • If you want to delete a tag to be added when adding multiple tags, you can click Delete in the row where the tag to be added is located to delete the tag.
                                    +
                                    +
                                  +

                                5. Click OK.

                                  In the custom key list, you can view created custom keys. The default status of a custom key is Enabled.

                                  +

                                +
                                +

                                Related Operations

                                • For details about how to upload objects with server-side encryption, see section Uploading a File with Server-Side Encryption in the Object Storage Service User Guide.
                                • For details about how to encrypt data on EVS disks, see section Creating an EVS Disk in the Elastic Volume Service User Guide.
                                • For details about how to encrypt private images, see section Encrypting an Image in the Image Management Service User Guide.
                                • For details about how to encrypt the file system on SFS, see section Creating a File System in the Scalable File Service User Guide.
                                • For details about how to encrypt disks for a database instance in RDS, see section Creating an RDS MySQL DB Instance in the Relational Database Service User Guide.
                                • For details about how to create a DEK and a plaintext-free DEK, see sections "Creating a DEK" and "Creating a Plaintext-Free DEK" in .
                                • For details about how to encrypt and decrypt a DEK for a user application, see sections "Encrypting a DEK" and "Decrypting a DEK" in .
                                +
                                +
                                +
                                + +
                                + + + \ No newline at end of file diff --git a/docs/kms/umn/kms_01_0198.html b/docs/kms/umn/kms_01_0198.html new file mode 100644 index 000000000..dee44c410 --- /dev/null +++ b/docs/kms/umn/kms_01_0198.html @@ -0,0 +1,12 @@ + + +

                                Is There a Limit on the Number of Custom Keys That I Can Create on KMS?

                                +

                                There is a limit on the number of custom keys that can be created on KMS.

                                +

                                You can create a maximum of 100 custom keys, including those in enabled, disabled, and pending deletion states. Default keys are not included.

                                +
                                +
                                + +
                                + diff --git a/docs/kms/umn/kms_01_0199.html b/docs/kms/umn/kms_01_0199.html deleted file mode 100644 index 4b36849ee..000000000 --- a/docs/kms/umn/kms_01_0199.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

                                Encrypting Data in DDS

                                -
                                • When a user creates a database instance from DDS, the user can select Disk encryption and use the key provided by KMS to encrypt the disk of the database instance. For more information, see the Document Database Service User Guide.
                                  Figure 1 Encrypting data in DDS
                                  -

                                  You can use a custom key created on the KMS console for encryption.

                                  -
                                -
                                • You can also call the required API of DDS to purchase encrypted DB instances. For details, see Document Database Service API Reference.
                                -
                                - - diff --git a/docs/kms/umn/kms_01_0215.html b/docs/kms/umn/kms_01_0215.html deleted file mode 100644 index d54d86db6..000000000 --- a/docs/kms/umn/kms_01_0215.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

                                What Is the Relationship Between the Ciphertext and Plaintext Returned by the encrypt-data API?

                                -

                                The basic length of the ciphertext returned by the encrypt-data API is 124 bytes. The ciphertext consists of multiple fields, including the key ID, encryption algorithm, key version, and ciphertext digest.

                                -

                                The plaintext has 16 bytes in each block. A block with fewer than 16 bytes will be padded. Ciphertext length = 124 + Ceil(plaintext length/16) x 16. The conversion result is encoded using Base64.

                                -

                                Take 4-byte plaintext input as an example. The calculation result is 124 + Ceil(4/16) x 16 = 140. The 140 bytes are converted into 188 bytes after Base64 encoding.

                                -

                                Ceil is a round-up function. Ceil(a) = 1. The value range of a is (0,1].

                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0222.html b/docs/kms/umn/kms_01_0222.html deleted file mode 100644 index a78d9f973..000000000 --- a/docs/kms/umn/kms_01_0222.html +++ /dev/null @@ -1,42 +0,0 @@ - - -

                                Personal Data Protection Mechanism

                                -

                                To ensure that your personal data, such as the username, password, and mobile phone number, will not be leaked or obtained by unauthorized or unauthenticated entities or people, KMS controls access to the data and records logs for operations performed on the data.

                                -

                                Personal Data to Be Collected

                                Table 1 lists the personal data generated or collected by KMS.

                                - -
                                - - - - - - - - - - - -
                                Table 1 Personal data

                                Type

                                -

                                Source

                                -

                                Can Be Modified

                                -

                                Mandatory

                                -

                                Tenant ID

                                -
                                • Tenant ID in the token when an operation is performed on the console.
                                • Tenant ID in the token when an API is invoked.
                                -

                                No

                                -

                                Yes

                                -
                                -
                                -
                                -

                                Storage Mode

                                Tenant IDs are not sensitive data and are stored in plaintext.

                                -
                                -

                                Access Permission Control

                                Users can view only logs related to their own services.

                                -
                                -

                                Log Records

                                KMS records logs for all operations, such as editing, querying, and deleting, performed on personal data. The logs are uploaded to Cloud Trace Service (CTS). You can view only the logs generated for operations you performed.

                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0227.html b/docs/kms/umn/kms_01_0227.html deleted file mode 100644 index b09a30600..000000000 --- a/docs/kms/umn/kms_01_0227.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

                                How Does KMS Protect My Keys?

                                -

                                The mechanism of KMS prevents anyone from accessing your keys in plaintext. KMS relies on hardware security modules (HSMs) that safeguard the confidentiality and integrity of your keys. Plaintext KMS keys are always encrypted by HSMs and are never stored on any disk. These keys are only utilized within the volatile memory of the HSMs for as long as necessary to perform the cryptographic operation you have requested.

                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0299.html b/docs/kms/umn/kms_01_0299.html deleted file mode 100644 index 00ee5b6e3..000000000 --- a/docs/kms/umn/kms_01_0299.html +++ /dev/null @@ -1,85 +0,0 @@ - - -

                                Key Management Service

                                -

                                Key Management Service (KMS) is a secure, reliable, and easy-to-use service that helps users centrally manage and safeguard their Customer Master Keys (CMKs).

                                -

                                KMS uses hardware security modules (HSMs) to protect CMKs. HSMs help you create and control CMKs with ease. All CMKs are protected by root keys in HSMs to avoid leakage.

                                -

                                It also controls access to keys and records all operations on keys with traceable logs. In addition, it provides use records of all keys, meeting your audit and regulatory compliance requirements.

                                - -
                                - - - - - - - - - - - - - - - - - - - - - - -
                                Table 1 Basic concepts

                                Item

                                -

                                Definition

                                -

                                Customer Master Key

                                -

                                (CMK)

                                -

                                A CMK is a main encryption key created by a user using KMS. It is used to encrypt and protect data encryption keys (DEKs). One CMK can be used to encrypt one or more DEKs.

                                -

                                Default Key

                                -

                                -

                                A default key is automatically created by another cloud service using KMS, such as Object Storage Service (OBS). The alias of a default key ends with /default. For details about the corresponding cloud services, see Default Master Keys.

                                -

                                You can use the management console to query the status of Default Master Keys, but cannot disable or schedule the deletion of default keys.

                                -

                                Data Encryption Key

                                -

                                (DEK)

                                -

                                A data encryption key (DEK) is a key used for encrypting data.

                                -

                                Hardware Security Module (HSM)

                                -

                                A hardware device that securely produces, stores, manages, and uses keys and provides encryption services.

                                -

                                True Random Number Generator (TRNG)

                                -

                                A device that generates random numbers through physical processes instead of computer programs.

                                -

                                Project

                                -

                                A project is used to group and isolate OpenStack resources, including computing, storage, and network resources. A project can be a department or a project team.

                                -

                                Multiple projects can be created for one account.

                                -
                                -
                                - -
                                - - - - - - - - - - - - - -
                                Table 2 Default keys

                                Alias

                                -

                                Cloud Service

                                -

                                obs/default

                                -

                                Object Storage Service (OBS)

                                -

                                evs/default

                                -

                                Elastic Volume Service (EVS)

                                -

                                ims/default

                                -

                                Image Management Service (IMS)

                                -
                                -
                                -

                                A default key is automatically created when a user employs the KMS encryption function for the first time in another cloud service.

                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_0330.html b/docs/kms/umn/kms_01_0330.html deleted file mode 100644 index 1fe92a147..000000000 --- a/docs/kms/umn/kms_01_0330.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

                                Does an Imported Key Support Rotation?

                                -

                                Imported keys do not support rotation. After the imported key materials are deleted, ensure that the same key materials are imported.

                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_7774.html b/docs/kms/umn/kms_01_7774.html deleted file mode 100644 index c355535cb..000000000 --- a/docs/kms/umn/kms_01_7774.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

                                Disabling Key Rotation

                                -

                                This section describes how to disable rotation for a key on the KMS console.

                                -

                                Prerequisites

                                • The key is enabled.
                                • The Origin of the key is KMS.
                                • Key rotation has been enabled.
                                -
                                -

                                Procedure

                                1. Log in to the management console.
                                2. Click . Choose Security > Key Management Service. The Key Management Service page is displayed.
                                1. Click the alias of a symmetric key.
                                2. Click Rotation Policy and the dialog box is displayed.
                                3. Click to disable key rotation.
                                4. In the displayed confirmation dialog box, click OK.
                                5. Check the rotation status.
                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_7775.html b/docs/kms/umn/kms_01_7775.html deleted file mode 100644 index 08aa0f88f..000000000 --- a/docs/kms/umn/kms_01_7775.html +++ /dev/null @@ -1,61 +0,0 @@ - - -

                                Key Types

                                -

                                CMKs include custom keys and default keys. This section describes how to create, view, enable, disable, schedule the deletion, and cancel the deletion of custom keys.

                                -

                                Custom keys can be categorized into symmetric keys and asymmetric keys.

                                -

                                Symmetric keys are most commonly used for data encryption protection. Asymmetric keys are used for digital signature verification or sensitive information encryption in systems where the trust relationship is not mutual. An asymmetric key consists of a public key and a private key. The public key can be sent to anyone. The private key must be securely stored and only accessible to trusted users.

                                -

                                An asymmetric key can be used to generate and verify a signature. To securely transfer data, a signer sends the public key to a receiver, uses the private key to sign data, and then sends the data and signature to the receiver. The receiver can use the public key to verify the signature.

                                - -
                                - - - - - - - - - - - - - - - - - - - - - - - - -
                                Table 1 Key algorithms supported by KMS

                                Key Type

                                -

                                Algorithm Type

                                -

                                Key Specifications

                                -

                                Description

                                -

                                Usage

                                -

                                Symmetric key

                                -

                                AES

                                -
                                • AES_256
                                -

                                AES symmetric key

                                -

                                Encrypts and decrypts a small amount of data or data keys.

                                -

                                Asymmetric key

                                -

                                RSA

                                -
                                • RSA_2048
                                • RSA_3072
                                • RSA_4096
                                -

                                RSA asymmetric password

                                -

                                Encrypts and decrypts a small amount of data or creates digital signatures.

                                -

                                ECC

                                -
                                • EC_P256
                                • EC_P384
                                -

                                Elliptic curve recommended by NIST

                                -

                                Digital signature

                                -
                                -
                                -
                                -
                                - -
                                - diff --git a/docs/kms/umn/kms_01_9996.html b/docs/kms/umn/kms_01_9996.html new file mode 100644 index 000000000..1d3cbf3df --- /dev/null +++ b/docs/kms/umn/kms_01_9996.html @@ -0,0 +1,68 @@ + + +

                                Creating a Custom KMS Policy

                                +

                                Custom policies can be created as a supplement to the system policies of KMSfilter. For details about the actions supported by custom policies, see "Permissions Policies and Supported Actions" in Key Management Service API Reference.

                                +

                                You can create custom policies in either of the following ways:

                                +
                                • Visual editor: You can select policy configurations without the need to know policy syntax.
                                • JSON: Edit JSON policies from scratch or based on an existing policy. This section describes typical KMS custom policies.
                                +

                                Example Custom Policies of KMS

                                • Example: authorizing users to create and import keys
                                  {
                                  +    "Version": "1.1",
                                  +    "Statement": [
                                  +        {
                                  +            "Effect": "Allow",
                                  +            "Action": [
                                  +                "kms:cmk:create",
                                  +                "kms:cmk:getMaterial",
                                  +                "kms:cmkTag:create",
                                  +                "kms:cmkTag:batch",
                                  +                "kms:cmk:importMaterial"
                                  +            ]
                                  +        }
                                  +    ]
                                  +}
                                  +
                                +
                                +
                                • Example: authorizing users to use keys
                                  {
                                  +    "Version": "1.1",
                                  +    "Statement": [
                                  +        {
                                  +            "Effect": "Allow",
                                  +            "Action": [
                                  +                "kms:dek:crypto",
                                  +                "kms:cmk:get",
                                  +                "kms:cmk:crypto",
                                  +                "kms:cmk:generate",
                                  +                "kms:cmk:list"
                                  +            ]
                                  +        }
                                  +    ]
                                  +}
                                  +
                                • Example: multi-action policy

                                  A custom policy can contain actions of multiple services that are all of the global or project-level type. The following is a policy with multiple statements:

                                  +
                                  {
                                  +    "Version": "1.1",
                                  +    "Statement": [
                                  +        {
                                  +            "Effect": "Allow",
                                  +            "Action": [
                                  +                "rds:task:list"
                                  +            ]
                                  +        },
                                  +        {
                                  +            "Effect": "Allow",
                                  +            "Action": [
                                  +                "kms:dek:crypto",
                                  +                "kms:cmk:get",
                                  +                "kms:cmk:crypto",
                                  +                "kms:cmk:generate",
                                  +                "kms:cmk:list"
                                  +            ]
                                  +        }
                                  +    ]
                                  +}
                                  +
                                +
                                +
                                + +
                                + diff --git a/docs/kms/umn/kms_01_9997.html b/docs/kms/umn/kms_01_9997.html new file mode 100644 index 000000000..86e16afa9 --- /dev/null +++ b/docs/kms/umn/kms_01_9997.html @@ -0,0 +1,66 @@ + + +

                                Creating a User and Authorizing the User the Permission to Access KMS

                                +

                                This section describes IAM's fine-grained permissions management for your KMS resources. With IAM, you can:

                                +
                                • Create IAM users for employees based on the organizational structure of your enterprise. Each IAM user has its own security credentials to access KMS resources.
                                • Grant users only the permissions required to perform a task.
                                • Entrust an account or cloud service to perform efficient O&M on your KMS resources.
                                +

                                If your account does not need individual IAM users, skip this chapter.

                                +

                                This section describes the procedure for granting permissions (see Figure 1).

                                +

                                Prerequisites

                                Before granting permissions to a user group, you need to understand the available KMS permissions, and grant permissions based on the real-life scenario. The following tables describe the permissions supported in KMS.

                                + +
                                + + + + + + + + + + + + + + + + + + + + + +
                                Table 1 KMS permissions

                                Role/Policy

                                +

                                Description

                                +

                                Type

                                +

                                KMS Administrator

                                +

                                Administrator permissions for the encryption key

                                +

                                Role

                                +

                                KMS CMKFullAccess

                                +

                                All permissions for the encryption keys

                                +

                                Policy

                                +

                                KMS CMK Admin

                                +

                                All permissions for the encryption keys

                                +

                                Policy

                                +

                                KMS CMKReadOnlyAccess

                                +

                                Read-only permission for encryption keys

                                +

                                Policy

                                +
                                +
                                +
                                +

                                Authorization Process

                                Figure 1 Authorizing the KMS access permission to a user
                                +
                                1. Create a user group on the IAM console and grant the user group the KMS CMKFullAccess permission (indicating full permissions for keys).

                                  +
                                2. Create a user on the IAM console and add the user to the user group created in 1.

                                  +
                                3. .

                                  Log in to the console as newly created user, and verify that the user only has the assigned permissions.

                                  +
                                +
                                +

                                Tenant Guest Roles

                                If you have configured Tenant Guest permissions for the IAM account, apart from the read-only permissions for all cloud services except Identity and Access Management (IAM), you also have the following KMS permissions:

                                +
                                • kms:cmk:create: Create a key.
                                • kms:cmk:createDataKey: Create a DEK.
                                • kms:cmk:createDataKeyWithoutPlaintext: Create a plaintext-free DEK.
                                • kms:cmk:encryptDataKey: Encrypt the DEK.
                                • kms:cmk:decryptDataKey: Decrypt a DEK.
                                • kms:cmk:retireGrant: Retire a grant.
                                • kms:cmk:decryptData: Decrypt data.
                                • kms:cmk:encryptData: Encrypt data.
                                • kms::generateRandom: Generate a random number.
                                +

                                If you want to configure the Tenant Guest role for an IAM user but do not want to have the preceding permissions, you need to configure a custom deny policy for the IAM user. For details about how to configure a custom policy, see Creating a Custom KMS Policy.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/kms/umn/kms_01_9998.html b/docs/kms/umn/kms_01_9998.html new file mode 100644 index 000000000..aece1ffc9 --- /dev/null +++ b/docs/kms/umn/kms_01_9998.html @@ -0,0 +1,13 @@ + + +

                                Permissions Management

                                +
                                + + diff --git a/docs/kms/umn/kms_01_9999.html b/docs/kms/umn/kms_01_9999.html new file mode 100644 index 000000000..4a7881c6b --- /dev/null +++ b/docs/kms/umn/kms_01_9999.html @@ -0,0 +1,325 @@ + + +

                                KMS Permission Management

                                +

                                If you want to assign different access permissions to employees in an enterprise for the KMS resources purchased on the cloud platform, you can use Identity and Access Management (IAM) to perform refined permission management. IAM provides identity authentication, permissions management, and access control, helping you secure access to your resources.

                                +

                                With IAM, you can use your account to create IAM users for your employees, and grant permissions to control their access to specific resource types. For example, some software developers in your enterprise need to use KMS resources but must not delete them or perform any high-risk operations. To achieve this result, you can create IAM users for the software developers and grant them only the permissions required for using KMS resources.

                                +

                                If the system account has met your requirements and you do not need to create an independent IAM user for permission control, then you can skip this section. This will not affect other functions of KMS.

                                +

                                +

                                KMS Permissions

                                By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from their groups and can perform specified operations on cloud services based on the permissions.

                                +

                                KMS is a project-level service deployed and accessed in specific physical regions. To assign permissions to a user group, specify the scope as region-specific projects and select projects for the permissions to take effect. If All projects is selected, the permissions will take effect for the user group in all region-specific projects. Users need to switch to the authorized region when accessing KMS.

                                +

                                You can grant users permissions by using roles and policies.

                                +
                                • Roles: A type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. This mechanism provides only a limited number of service-level roles for authorization. When using roles to grant permissions, you must also assign other roles that the permissions depend on to take effect. However, roles are not an ideal choice for fine-grained authorization and secure access control.
                                • Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization, meeting requirements for secure access control. For example, you can grant KMS users only the permissions for managing a certain type of cloud servers. Most policies contain permissions for specific APIs, and permissions are defined using API actions.
                                +

                                For details, see Table 1.

                                + +
                                + + + + + + + + + + + + + + + + + + + + + +
                                Table 1 KMS permissions

                                Role/Policy

                                +

                                Description

                                +

                                Type

                                +

                                KMS Administrator

                                +

                                Administrator permissions for the encryption key

                                +

                                Role

                                +

                                KMS CMKFullAccess

                                +

                                All permissions for the encryption keys

                                +

                                Policy

                                +

                                KMS CMK Admin

                                +

                                All permissions for the encryption keys

                                +

                                Policy

                                +

                                KMS CMKReadOnlyAccess

                                +

                                Read-only permission for encryption keys

                                +

                                Policy

                                +
                                +
                                +

                                Table 2 lists the common operations supported by each system-defined permission of KMS. Select the permissions as needed.

                                + +
                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                Table 2 Common operations supported by each system-defined policy or role

                                Operation

                                +

                                KMS Administrator

                                +

                                KMS CMKFullAccess

                                +

                                Create a key

                                +

                                +

                                +

                                Enable a key

                                +

                                +

                                +

                                Disable a key

                                +

                                +

                                +

                                Schedule key deletion

                                +

                                +

                                +

                                Cancel scheduled key deletion

                                +

                                +

                                +

                                Modify a key alias

                                +

                                +

                                +

                                Modify key description

                                +

                                +

                                +

                                Generate a random number

                                +

                                +

                                +

                                Create a DEK

                                +

                                +

                                +

                                Create a plaintext-free DEK

                                +

                                +

                                +

                                Encrypt a DEK

                                +

                                +

                                +

                                Decrypt a DEK

                                +

                                +

                                +

                                Obtain parameters for importing a key

                                +

                                +

                                +

                                Import key materials

                                +

                                +

                                +

                                Delete key materials

                                +

                                +

                                +

                                Create a grant

                                +

                                +

                                +

                                Revoke a grant

                                +

                                +

                                +

                                Retire a grant

                                +

                                +

                                +

                                Query the grant list

                                +

                                +

                                +

                                Query retirable grants

                                +

                                +

                                +

                                Encrypt data

                                +

                                +

                                +

                                Decrypt data

                                +

                                +

                                +

                                Enable key rotation

                                +

                                +

                                +

                                Modify key rotation interval

                                +

                                +

                                +

                                Disable key rotation

                                +

                                +

                                +

                                Query key rotation status

                                +

                                +

                                +

                                Query CMK instances

                                +

                                +

                                +

                                Query key tags

                                +

                                +

                                +

                                Query project tags

                                +

                                +

                                +

                                Batch add or delete key tags

                                +

                                +

                                +

                                Add tags to a key

                                +

                                +

                                +

                                Delete key tags

                                +

                                +

                                +

                                Query the key list

                                +

                                +

                                +

                                Query key details

                                +

                                +

                                +

                                Query instance quantity

                                +

                                +

                                +

                                Query quotas

                                +

                                +

                                +
                                +
                                +
                                +
                                +
                                + +
                                + diff --git a/docs/kms/umn/public_sys-resources/imageclose.gif b/docs/kms/umn/public_sys-resources/imageclose.gif new file mode 100644 index 000000000..3a3344af4 Binary files /dev/null and b/docs/kms/umn/public_sys-resources/imageclose.gif differ diff --git a/docs/kms/umn/public_sys-resources/imageclosehover.gif b/docs/kms/umn/public_sys-resources/imageclosehover.gif new file mode 100644 index 000000000..8699d5e36 Binary files /dev/null and b/docs/kms/umn/public_sys-resources/imageclosehover.gif differ diff --git a/docs/kms/umn/public_sys-resources/imagemax.gif b/docs/kms/umn/public_sys-resources/imagemax.gif new file mode 100644 index 000000000..99c07dc25 Binary files /dev/null and b/docs/kms/umn/public_sys-resources/imagemax.gif differ diff --git a/docs/kms/umn/public_sys-resources/imagemaxhover.gif b/docs/kms/umn/public_sys-resources/imagemaxhover.gif new file mode 100644 index 000000000..d01d77d6e Binary files /dev/null and b/docs/kms/umn/public_sys-resources/imagemaxhover.gif differ diff --git a/docs/kms/umn/public_sys-resources/macFFBgHack.png b/docs/kms/umn/public_sys-resources/macFFBgHack.png new file mode 100644 index 000000000..ec811470c Binary files /dev/null and b/docs/kms/umn/public_sys-resources/macFFBgHack.png differ