# 对称密钥加解密算法规格


当前章节将说明系统目前支持的算法及其对应的规格。


对于每种算法采用支持的加密模式，将会在具体的每个算法规格中介绍。


## AES

算法库当前提供了[AES](crypto-sym-key-generation-conversion-spec.md#aes)加解密常用的7种加密模式：ECB、CBC、OFB、CFB、CTR、GCM和CCM。不同的加密模式适用的加解密参数不同，具体请参考[ParamsSpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#paramsspec)。

由于AES为分组加密算法，分组长度为128位。在实际应用中，最后一组明文可能不足128位（16字节），此时可以通过不同的[填充模式](#填充模式)进行数据填充。

由于需要填充至分组大小，所以实际算法库中的PKCS5和PKCS7都是以分组大小作为填充长度的，即AES加密填充至16字节。

> **说明：**
>
> ECB、CBC加密模式，明文长度不是128位整数倍，必须使用填充方法补足。
> CCM加密模式，必须指定附加验证数据aad且其长度必须大于等于1字节且小于等于2048字节。

当前支持以字符串参数完成AES加解密，具体的“字符串参数”由“对称密钥类型（加解密算法+密钥长度）”、“分组模式”和“填充模式”使用符号“|”拼接而成，用于在创建对称加解密实例时，指定算法规格。

- 如表所示，各取值范围（即[]中的内容）中，只能选取一项完成字符串拼接。
  
  举例说明：
  - 当需要分组模式为ECB、密钥长度为128bit、填充模式为PKCS7的AES密钥，其字符串参数为"AES128|ECB|PKCS7"。
  
  - 当需要分组模式为CFB、密钥长度为256bit、填充模式为NoPadding的AES密钥，其字符串参数为"AES256|CFB|NoPadding"。

  | 分组模式 | 密钥长度（bit） | 填充模式 | API版本 | 
  | -------- | -------- | -------- | -------- |
  | ECB | [128\|192\|256] | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | CBC | [128\|192\|256] | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | CTR | [128\|192\|256] | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | OFB | [128\|192\|256] | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | CFB | [128\|192\|256] | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | GCM | [128\|192\|256] | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | CCM | [128\|192\|256] | [NoPadding\|PKCS5\|PKCS7] | 9+ | 

- 从API版本10开始，支持对称加解密不带密钥长度的规格。加解密参数输入密钥类型时，支持不带长度，加解密运算取决于实际输入的密钥长度。
  
  举例说明，当需要分组模式为CFB、不带密钥长度、填充模式为NoPadding的AES密钥，其字符串参数为"AES|CFB|NoPadding"。


## 3DES

[3DES](crypto-sym-key-generation-conversion-spec.md#3des)算法的加解密过程分别是对明文/密文数据进行三次DES加密或解密，得到相应的密文或明文。

算法库当前提供了3DES加解密常用的4种加密模式：ECB、CBC、OFB和CFB。不同的加密模式适用的加解密参数不同，具体请参考[ParamsSpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#paramsspec)。

由于DES为分组加密算法，分组长度为64位。在实际应用中，最后一组明文可能不足64位（8字节），此时可以通过不同的[填充模式](#填充模式)进行数据填充。

由于需要填充至分组大小，所以实际算法库中的PKCS5和PKCS7都是以分组大小作为填充长度的，即3DES加密填充至8字节。

> **说明：**
>
> ECB、CBC加密模式，明文长度不是64位整数倍，必须使用填充方法补足。

当前支持以字符串参数完成3DES加解密，具体的“字符串参数”由“对称密钥类型（加解密算法+密钥长度）”、“分组模式”和“填充模式”使用符号“|”拼接而成，用于在创建对称加解密实例时，指定算法规格。

- 如表所示，各取值范围（即[]中的内容）中，只能选取一项完成字符串拼接。
  
  举例说明：
  - 当需要分组模式为ECB、密钥长度为192bit、填充模式为PKCS7的3DES密钥，其字符串参数为"3DES192|ECB|PKCS7"。
  
  - 当需要分组模式为OFB、密钥长度为192bit、填充模式为NoPadding的3DES密钥，其字符串参数为"3DES192|OFB|NoPadding"。

  | 分组模式 | 密钥长度（bit） | 填充模式 | API版本 | 
  | -------- | -------- | -------- | -------- |
  | ECB | 192 | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | CBC | 192 | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | OFB | 192 | [NoPadding\|PKCS5\|PKCS7] | 9+ | 
  | CFB | 192 | [NoPadding\|PKCS5\|PKCS7] | 9+ | 

- 从API版本10开始，支持对称加解密不带密钥长度的规格。加解密参数输入密钥类型时，支持不带长度，加解密运算取决于实际输入的密钥长度。
  举例说明，当需要分组模式为CFB、不带密钥长度、填充模式为NoPadding的3DES密钥，其字符串参数为"3DES|CFB|NoPadding"。


## SM4

算法库当前提供了[SM4](crypto-sym-key-generation-conversion-spec.md#sm4)加解密常用的7种加密模式：ECB、CBC、CTR、OFB、CFB、CFB128和GCM。不同的加密模式适用的加解密参数不同，具体请参考[ParamsSpec](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#paramsspec)。

由于SM4为分组加密算法，分组长度为128位。在实际应用中，最后一组明文可能不足128位（16字节），此时可以通过不同的[填充模式](#填充模式)进行数据填充。

由于需要填充至分组大小，所以实际算法库中的PKCS5和PKCS7都是以分组大小作为填充长度的，即SM4加密填充至16字节。

> **说明：**
>
> ECB、CBC加密模式，明文长度不是128位整数倍，必须使用填充方法补足。

当前支持以字符串参数完成SM4加解密，具体的“字符串参数”由“对称密钥类型（加解密算法+密钥长度）”、“分组模式”和“填充模式”使用符号“|”拼接而成，用于在创建对称加解密实例时，指定算法规格。

- 如表所示，各取值范围（即[]中的内容）中，只能选取一项完成字符串拼接。SM4算法和密钥长度中间采用符号“_”拼接。
  
  举例说明：
  - 当需要分组模式为ECB、密钥长度为128bit、填充模式为PKCS7的SM4密钥，其字符串参数为"SM4_128|ECB|PKCS7"。
  
  - 当需要分组模式为CFB、密钥长度为128bit、填充模式为NoPadding的SM4密钥，其字符串参数为"SM4_128|CFB|NoPadding"。

  - 当需要分组模式为GCM、密钥长度为128bit、填充模式为NoPadding的SM4密钥，其字符串参数为"SM4_128|GCM|NoPadding"。

  | 分组模式 | 密钥长度（bit） | 填充模式 | API版本 | 
  | -------- | -------- | -------- | -------- |
  | ECB | 128 | [NoPadding\|PKCS5\|PKCS7] | 10+ | 
  | CBC | 128 | [NoPadding\|PKCS5\|PKCS7] | 10+ | 
  | CTR | 128 | [NoPadding\|PKCS5\|PKCS7] | 10+ | 
  | OFB | 128 | [NoPadding\|PKCS5\|PKCS7] | 10+ | 
  | CFB | 128 | [NoPadding\|PKCS5\|PKCS7] | 10+ | 
  | CFB128 | 128 | [NoPadding\|PKCS5\|PKCS7] | 10+ | 
  | GCM | 128 | [NoPadding\|PKCS5\|PKCS7] | 12+ | 


## 填充模式

分组加密算法有固定的分组长度，在实际应用中，最后一组明文的数据量可能无法达到固定的长度要求，此时可以通过不同的填充模式进行数据填充。填充模式有：

- NoPadding：不带填充。输入数据需要与分组长度匹配。

- PKCS5：填充字符由一个字节序列组成，而且每个字节填充的值与要填充的字节序列长度相同。且PKCS5为8字节填充，即需将数据填充为八位字节的倍数。

- PKCS7：填充方法和PKCS5一致。但PKCS7的可以在1-255字节之间任意填充，PKCS5固定为8字节。

对于CFB、OFB、CTR、GCM、CCM这类将分组密码转化为流模式实现的模式，不需要填充，因此无论是否指定填充模式，都会按照NoPadding实现。