digest(data text, type text) returns bytea
digest(data bytea, type text) returns bytea

计算给定data的二进制哈希值。type是要使用的算法。标准算法包括md5、sha1、sha224、sha256、sha384和sha512。如果pgcrypto是在有 OpenSSL 的情况下构建的，则还有更多算法可用，详见表 F.18。

如果想把摘要表示为十六进制字符串，可以对结果使用encode()。例如：

CREATE OR REPLACE FUNCTION sha1(bytea) returns text AS $$
    SELECT encode(digest($1, 'sha1'), 'hex')
$$ LANGUAGE SQL STRICT IMMUTABLE;

hmac(data text, key text, type text) returns bytea
hmac(data bytea, key text, type text) returns bytea

使用密钥key为data计算基于散列的消息认证码（HMAC）。 type与digest()中的相同。

这与digest()类似，但只有知道密钥时才能重新计算该哈希。 这可以防止有人篡改数据后再同时修改哈希使之匹配。

如果密钥大于哈希块大小，则会先对其进行哈希，并将结果用作密钥。

crypt(password text, salt text) returns text

计算password的一个 crypt(3) 风格哈希。 存储新密码时，需要使用gen_salt()生成新的salt值。 校验密码时，把已存储的哈希值作为salt传入，并测试结果是否与已存储值匹配。

设置一个新密码的示例：

UPDATE ... SET pswhash = crypt('new password', gen_salt('md5'));

Example of authentication:

SELECT pswhash = crypt('entered password', pswhash) FROM ... ;

如果输入的密码正确，这会返回 true。

gen_salt(type text [, iter_count integer ]) returns text

生成一个供crypt()使用的新随机盐值字符串。 该盐值字符串还会告诉crypt()应使用哪种算法。

type参数指定 hash 算法。 接受的类型有：des、xdes、md5和bf。

iter_count参数允许用户为支持该参数的算法指定迭代次数。 次数越高，对密码进行 hash 所需的时间越长，从而破解它所需时间也越长。 不过，如果次数过高，计算一个 hash 可能需要数年时间 — 这显然不切实际。 若省略iter_count参数，则使用默认迭代次数。 允许的iter_count值取决于算法，如表 F.16所示。

对xdes算法还有额外的限制：迭代计数必须是一个奇数。

为了选择合适的迭代次数，可以考虑原始 DES crypt 在当时硬件上的设计速度是每秒 4 次 hash。 低于每秒 4 次 hash 可能会影响可用性，而高于每秒 100 次 hash 则很可能过快。

表 F.17概述了不同 hash 算法之间的相对速度差异。 该表展示了在 8 字符密码上尝试所有字符组合所需的时间，假定密码只包含小写字母， 或者包含大小写字母和数字。在crypt-bf条目中， 斜杠后的数字是gen_salt的iter_count参数值。

注意：

请注意，“尝试所有组合”并不是现实中的做法。 通常密码破解是借助词典完成的，其中包含常见单词及其各种变体。 因此，即使是稍微有点像单词的密码，被破解的速度也可能远快于上表所示； 而一个 6 字符、不像单词的密码则可能逃过破解，也可能不会。

pgp_sym_encrypt(data text, psw text [, options text ]) returns bytea
pgp_sym_encrypt_bytea(data bytea, psw text [, options text ]) returns bytea

使用对称 PGP 密码psw加密data。 options参数可以包含下文所述的选项设置。

pgp_sym_decrypt(msg bytea, psw text [, options text ]) returns text
pgp_sym_decrypt_bytea(msg bytea, psw text [, options text ]) returns bytea

解密一个经过对称密钥加密的 PGP 消息。

bytea数据不能用pgp_sym_decrypt解密。 这是为了避免输出无效字符数据。若原始数据本来是文本， 则使用pgp_sym_decrypt_bytea解密也没有问题。

options参数可以包含下文所述的选项设置。

pgp_pub_encrypt(data text, key bytea [, options text ]) returns bytea
pgp_pub_encrypt_bytea(data bytea, key bytea [, options text ]) returns bytea

使用 PGP 公钥key加密data。 向该函数提供私钥会报错。

options参数可以包含下文所述的选项设置。

pgp_pub_decrypt(msg bytea, key bytea [, psw text [, options text ]]) returns text
pgp_pub_decrypt_bytea(msg bytea, key bytea [, psw text [, options text ]]) returns bytea

解密经过公钥加密的消息。key必须是与加密时所用公钥对应的私钥。 如果私钥受密码保护，则必须在psw中给出密码。 如果没有密码但想指定选项，则需要传入空密码。

bytea数据不能用pgp_pub_decrypt解密。 这是为了避免输出无效字符数据。若原始数据本来是文本， 则使用pgp_pub_decrypt_bytea解密也没有问题。

options参数可以包含下文所述的选项设置。

pgp_key_id(bytea) returns text

pgp_key_id提取 PGP 公钥或私钥的密钥 ID。 如果传入的是加密消息，则返回用于加密该数据的密钥 ID。

它可以返回两个特殊的密钥 ID：

注意，不同的密钥可能具有相同的 ID。这种情况虽然罕见，但属于正常情况。 客户端应用此时应该尝试使用每一个密钥解密，以判断哪个匹配 — 就像处理ANYKEY时一样。

armor(data bytea) returns text
dearmor(data text) returns bytea

这些函数将二进制数据封装/解封装为 PGP ASCII-armor 格式， 它本质上就是带 CRC 和附加格式信息的 Base64。

这些选项的命名方式与 GnuPG 类似。选项值应写在等号后面； 各选项之间用逗号分隔。例如：

pgp_sym_encrypt(data, psw, 'compress-algo=1, cipher-algo=aes256')

除convert-crlf外，所有选项都只适用于加密函数。 解密函数会从 PGP 数据中获取这些参数。

最值得关注的选项可能是compress-algo和unicode-mode。 其余选项应该都具有合理的默认值。

要生成新密钥：

gpg --gen-key

首选的密钥类型是“DSA 和 Elgamal”。

对于 RSA 加密，你必须先创建一个仅用于签名的 DSA 或 RSA 主密钥， 然后使用gpg --edit-key添加 RSA 加密子密钥。

要列出密钥：

gpg --list-secret-keys

要以 ASCII-armor 格式导出公钥：

gpg -a --export KEYID > public.key

要以 ASCII-armor 格式导出私钥：

gpg -a --export-secret-keys KEYID > secret.key

在把这些密钥交给 PGP 函数之前，需要先用dearmor()处理它们。 或者，如果你能处理二进制数据，也可以从命令中去掉-a。

更多细节见man gpg、GNU Privacy Handbook以及http://www.gnupg.org上的其他文档。

pgcrypto会根据 PostgreSQL 主configure脚本的探测结果自行配置。影响它的选项有--with-zlib和--with-openssl。

如果编译时包含 zlib，PGP 加密函数就能够在加密前压缩数据。

如果编译时包含 OpenSSL，则会有更多算法可用。同时公钥加密函数也会更快，因为 OpenSSL 具有更加优化的 BIGNUM 函数。

注意：

按照 SQL 的标准，只要任一参数为 NULL，所有函数都返回 NULL。 这在使用不慎时可能带来安全风险。

所有pgcrypto函数都在数据库服务器内部运行。 这意味着所有数据和密码都会在pgcrypto与客户端应用之间以明文传输。 因此，你必须：

如果做不到，最好在客户端应用内部执行密码学操作。

该实现无法抵御侧信道攻击。例如，对于给定大小的密文，pgcrypto解密函数完成所需的时间会因具体密文不同而变化。