PolarDB-O 云原生数据库 DBMS_CRYPTO

DECRYPT

通过使用您指定的加密算法、键及可选的初始化向量，函数DECRYPT或存储过程DECRYPT可解密数据。函数DECRYPT的语法如下：

DECRYPT
  (src IN RAW, typ IN INTEGER, key IN RAW, iv IN RAW 
   DEFAULT NULL) RETURN RAW
			

存储过程DECRYPT的语法如下：

DECRYPT
  (dst INOUT BLOB, src IN BLOB, typ IN INTEGER, key IN RAW, 
   iv IN RAW DEFAULT NULL)

或

DECRYPT
  (dst INOUT CLOB, src IN CLOB, typ IN INTEGER, key IN RAW, 
   iv IN RAW DEFAULT NULL) 

当把DECRYPT作为存储过程调用时，DECRYPT返回给您指定的BLOB的是BLOB或CLOB数据。

参数

dst

Dst用于指定BLOB数据的名称，存储过程DECRYPT的输出将会编写到这个指定名称的BLOB数据中。存储过程DECRYPT将覆写当前dst中任何已有的数据。

src

Src用于指定要解密的源数据。如果您把DECRYPT作为函数调用，那么就要指定RAW数据。如果您把DECRYPT作为存储过程调用，那么就要指定BLOB或CLOB数据。

typ

typ用于指定分组密码类型及任何修改器。 当对src加密时，应和指定的类型相匹配。PolarDB支持下列表中的分组加密算法、修改器及密码组：

key

Key用于指定用户定义的解密键。当对src加密时，应和指定的键相匹配。

iv

iv （可选的）用于指定初始化向量。当对src加密时，如果指定了一个初始化向量，那么您必须在解密src时也指定一个初始化向量。缺省值为NULL：

示例

下列示例使用函数DBMS_CRYPTO .DECRYPT来解密从表passwords中检索出的加密的口令。

CREATE TABLE passwords
(
  principal  VARCHAR2(90) PRIMARY KEY,  -- username
  ciphertext RAW(9)                     -- encrypted password
);
CREATE FUNCTION get_password(username VARCHAR2) RETURN RAW AS
 typ        INTEGER := DBMS_CRYPTO.DES_CBC_PKCS5;
 key        RAW(128) := 'my secret key';
 iv         RAW(100) := 'my initialization vector';
 password   RAW(2048);
BEGIN

  SELECT ciphertext INTO password FROM passwords WHERE principal = username;

  RETURN dbms_crypto.decrypt(password, typ, key, iv);
END;

需要注意的是，当调用DECRYPT时，您必须传递在ENCRYPTING对象时使用过的相同的密码类型、键值及初始化向量。

ENCRYPT

函数ENCRYPT或存储过程ENCRYPT使用用户定义的算法、键及可选的初始化向量来对RAW、BLOB 或 CLOB数据加密。函数ENCRYPT的语法如下：

ENCRYPT
  (src IN RAW, typ IN INTEGER, key IN RAW, 
   iv IN RAW DEFAULT NULL) RETURN RAW

存储过程ENCRYPT的语法如下：

ENCRYPT
  (dst INOUT BLOB, src IN BLOB, typ IN INTEGER, key IN RAW, 
   iv IN RAW DEFAULT NULL)

或

ENCRYPT
  (dst INOUT BLOB, src IN CLOB, typ IN INTEGER, key IN RAW, 
   iv IN RAW DEFAULT NULL) 

当把ENCRYPT作为存储过程调用时，ENCRYPT返回给用户指定的BLOB的是BLOB或CLOB数据。

参数

dst

Dst用于指定BLOB数据的名称，存储过程ENCRYPT的输出将会编写到这个指定名称的BLOB数据中。存储过程ENCRYPT将覆写当前dst中任何已有的数据。

src

Src用于指定要加密的源数据。如果您把ENCRYPT作为函数调用，那么就要指定RAW数据。如果您把ENCRYPT 作为存储过程调用，那么就要指定BLOB或CLOB数据。

typ

key

Key用于指定加密键。

iv

iv（可选的）用于指定初始化向量。通过缺省方式，iv值为NULL。

示例

下列示例使用了DBMS_CRYPTO.DES_CBC_PKCS5分组密码组（一组预先定义的算法和修改器）来对从表passwords中检索出的值加密：

CREATE TABLE passwords
(
  principal  VARCHAR2(90) PRIMARY KEY,  -- username
  ciphertext RAW(9)                     -- encrypted password
);
CREATE PROCEDURE set_password(username VARCHAR2, cleartext RAW) AS
 typ        INTEGER := DBMS_CRYPTO.DES_CBC_PKCS5;
 key        RAW(128) := 'my secret key';
 iv         RAW(100) := 'my initialization vector';
 encrypted  RAW(2048);
BEGIN
  encrypted := dbms_crypto.encrypt(cleartext, typ, key, iv); 
  UPDATE passwords SET ciphertext = encrypted WHERE principal = username;
END;

当对password 加密时，ENCRYPT使用了my secret key的一个键值和my initialization vector的一个初始化向量。那么当解密password时就要指定相同的键和初始化向量。

HASH

函数HASH使用了一个用户指定的算法来返回RAW或CLOB值的哈希值。有三种可使用的HASH函数形式：

HASH
  (src IN RAW, typ IN INTEGER) RETURN RAW
HASH
  (src IN CLOB, typ IN INTEGER) RETURN RAW 

参数

src

src 用于指定将要产生的哈希值。您可以指定一个RAW、 BLOB或 CLOB值。

typ

示例

下列示例使用了DBMS_CRYPTO.HASH来查找字符串cleartext source的md5哈希值：

DECLARE
  typ        INTEGER := DBMS_CRYPTO.HASH_MD5;
  hash_value RAW(100);
BEGIN

  hash_value := DBMS_CRYPTO.HASH('cleartext source', typ);

END;

MAC

MAC 函数使用了一个用户指定的MAC 函数来返回RAW 或CLOB 值的MAC 哈希值。MAC 函数有三种形式：

MAC
  (src IN RAW, typ IN INTEGER, key IN RAW) RETURN RAW
MAC
  (src IN CLOB, typ IN INTEGER, key IN RAW) RETURN RAW

参数

src

src 用于指定将要产生的MAC值。您可以指定一个RAW、 BLOB或 CLOB值。

typ

key

key 用于指定将要用来计算MAC 哈希值的键。

示例

下面为查找字符串cleartext source 的MAC 哈希值的示例：

DECLARE
  typ       INTEGER := DBMS_CRYPTO.HMAC_MD5;
  key       RAW(100) := 'my secret key';
  mac_value RAW(100);
BEGIN

  mac_value := DBMS_CRYPTO.MAC('cleartext source', typ, key);

END;

在计算cleartext source的MAC值时，DBMS_CRYPTO.MAC使用了my secret key的键值。

RANDOMBYTES

RANDOMBYTES函数返回的是指定长度的RAW值，包含加密的随机字节。语法如下：

RANDOMBYTES
  (number_bytes IN INTEGER) RETURNS RAW

参数

number bytes

number_bytes 用于指定要返回的随机字节的数量。

示例

下列示例使用RANDOMBYTES 返回的值长度为102 4 字节：

DECLARE
  result RAW(1024);
BEGIN
  result := DBMS_CRYPTO.RANDOMBYTES(1024);
END;

RANDOMINTEGER

RANDOMINTEGER() 函数返回的是一个介于0 和 2 68, 435, 455之间的随机INTEGER。语法如下：

RANDOMINTEGER() RETURNS INTEGER

示例

下列示例使用了RANDOMINTEGER函数来返回加密型随机INTEGER值：

DECLARE
  result INTEGER;
BEGIN
  result := DBMS_CRYPTO.RANDOMINTEGER();
  DBMS_OUTPUT.PUT_LINE(result);
END;

RANDOMNUMBER

RANDOMNUMBER()函数返回的随机NUMBER介于0 和268、435、455之间。语法如下：

RANDOMNUMBER() RETURNS NUMBER

示例

下列示例使用了RANDOMINTEGER函数来返回加密型随机数字：

DECLARE
  result NUMBER;
BEGIN
  result := DBMS_CRYPTO.RANDOMNUMBER();
  DBMS_OUTPUT.PUT_LINE(result);
END;