Key Management Service:Getting started with keys

1. Log on to the KMS console. In the top navigation bar, select a region. In the left-side navigation pane, choose Resource > Keys.

2. On the Keys page, click Default Key. Find the default key of the CMK type that you want to enable and click Enable in the Actions column. Set the key name to alias/main.

   

When you purchase an ECS instance on the buy page, select the default key named alias/main to enable server-side encryption.

When data is transferred to ECS, ECS calls the API operations of KMS to encrypt and decrypt the data. You do not need to manually process the data. In most cases, Alibaba Cloud services use envelope encryption to encrypt data. For more information, see Use envelope encryption.

1. Log on to the KMS console. In the top navigation bar, select a region. In the left-side navigation pane, choose Resource > Keys.

2. On the Keys tab, click Create Key and complete the configurations as prompted.

• KMS Instance: Select the purchased KMS instance

• Key Type: Select Symmetric Key.

• Key Specifications: Select Aliyun_AES_256.

1. Preparations

   Environment requirements

   Java Development Kit (JDK) V8 or later is downloaded and installed.

   Java version

   Run the java -version command on the terminal to check the JDK version.

2. Install an SDK

   Add Maven dependencies to your project. Then, a Java package is automatically downloaded from the Maven repository.

   Visit alibabacloud-dkms-gcs-java-sdk to view more installation information and the source code.

   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>alibabacloud-dkms-gcs-sdk</artifactId>
     <version>xx.xx.xx</version>
   </dependency>
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>tea</artifactId>
       <version>[1.2.3)</version>
   </dependency>
               

   Important

   • We recommend that you install the latest version of the SDK.

   • Install com.aliyun.tea 1.2.3 or later.

1. Log on to the KMS console. In the top navigation bar, select a region. In the left-side navigation pane, choose Application Access > AAPs.

2. Create an application access point (AAP)

   1. On the Application Access tab, click Create AAP. In the Create AAP panel, configure the parameters.

      Parameter	Description
      Mode	Select Quick Creation.
      Scope (KMS Instance)	Select the KMS instance that you want to access.
      Application Access Point Name	Enter the name of the AAP.
      Authentication Method	The value is fixed to ClientKey.
      Default Permission Policy	The value is fixed to key/*secret/*. Your application can access all keys and secrets in the specified KMS instance.

   2. Click OK. The browser automatically downloads the client key that is created.

      The client key contains Application Access Secret(ClientKeyContent) and Password. By default, Application Access Secret(ClientKeyContent) is saved in a file whose name is in the clientKey_****.json format. By default, Password is saved in a file whose name is in the clientKey_****_Password.txt format.

1. Log on to the KMS console. In the top navigation bar, select a region. In the left-side navigation pane, choose Resource > Instances.

2. Click Download below Instance CA Certificate.

   

1. Initialize KMS Instance SDK

     public static void initClient() throws Exception {
           Config config = new Config();
           config.setProtocol("https");
           config.setEndpoint("Instance ID.cryptoservice.KMS.aliyuncs.com"); // The endpoint of the KMS instance.
           config.setClientKeyFile("<YOUR-CLIENT-KEY-FILE>"); // The client key file address.
           // config.setClientKeyContent("<YOUR-CLIENT-KEY-CONTENT>"); // The content of the client key file. You can configure the client key file address or the content of the client key file.
           config.setPassword("<YOUR-PASSWORD>"); // The password for the client key.
           config.setCaFilePath("<path/to/yourCaCert>");// The CA certificate of the KMS instance. You can specify the path to the CA certificate.
           // config.setCa("<your-ca-certificate-content"); // The content of the CA certificate. You can configure the path to the CA certificate or the content of the CA certificate.
   
           client = new Client(config);
       }

2. Call the AdvanceEncrypt operation to encrypt data.

   /**
         
        * By default, KMS uses the Galois/Counter Mode (GCM) mode. 
        * @param keyId        You can set the keyId parameter to the key ID or the alias of a key.
        * @param plaintext The data that you want to encrypt.
        * @param aad     You can specify the aad parameter for the GCM mode based on your business requirements. You can set the parameter to null or leave the parameter empty. 
        * @return The ciphertext context of the AdvanceEncrypt operation, which includes the ciphertext (ciphertextBlob) and the related parameter ciphertext (aad). In this example, AdvanceEncryptContext is used. 
        */
       private static AdvanceEncryptContext advanceEncryptSample(String keyId, byte[] plaintext, byte[] aad) {
           AdvanceEncryptRequest request = new AdvanceEncryptRequest();
           request.setKeyId(keyId);
           request.setPlaintext(plaintext);
           request.setAad(aad);
           try {
               AdvanceEncryptResponse response = client.advanceEncrypt(request);
               return new AdvanceEncryptContext(response.getCiphertextBlob(), aad);
           } catch (TeaException e) {
               System.out.printf("code: %s%n", e.getCode());
               System.out.printf("message: %s%n", e.getMessage());
               System.out.printf("requestId: %s%n", e.getData().get("requestId"));
               e.printStackTrace();
               throw new RuntimeException(e);
           } catch (Exception e) {
               System.out.printf("advance encrypt err: %s%n", e.getMessage());
               e.printStackTrace();
               throw new RuntimeException(e);
           }
       }

3. Call the AdvanceDecrypt operation to decrypt data.

      /**
        * In this example, AdvanceDecrypt is used. 
        *
        * @param advanceEncryptContext The ciphertext context of the AdvanceEncrypt operation, which includes the ciphertext (ciphertextBlob) and related parameter ciphertext (aad). In this example, AdvanceEncryptContext is used. 
        * @return The plaintext that is obtained after decryption. 
        */
       private static byte[] advanceDecryptSample(final AdvanceEncryptContext advanceEncryptContext) {
           // Build an advanced decryption request object.
           AdvanceDecryptRequest request = new AdvanceDecryptRequest();
           request.setCiphertextBlob(advanceEncryptContext.getCiphertextBlob());
           request.setAad(advanceEncryptContext.getAad());
           try {
               AdvanceDecryptResponse response = client.advanceDecrypt(request);
               System.out.printf("RequestId: %s%n", response.getRequestId());
               return response.getPlaintext();
           } catch (TeaException e) {
               System.out.printf("code: %s%n", e.getCode());
               System.out.printf("message: %s%n", e.getMessage());
               System.out.printf("requestId: %s%n", e.getData().get("requestId"));
               e.printStackTrace();
               throw new RuntimeException(e);
           } catch (Exception e) {
               System.out.printf("advance decrypt err: %s%n", e.getMessage());
               e.printStackTrace();
               throw new RuntimeException(e);
           }
       }
   

For more information about complete code sample, see AdvanceEncryptAdvanceDecryptSample.java.