pgcrypto.c File Reference

#include "postgres.h"
#include <ctype.h>
#include "parser/scansup.h"
#include "pgcrypto.h"
#include "px-crypt.h"
#include "px.h"
#include "utils/builtins.h"
#include "utils/guc.h"
#include "varatt.h"

Include dependency graph for pgcrypto.c:

Go to the source code of this file.

Typedefs
typedef int(*	PFN) (const char *name, void **res)

Functions
	PG_MODULE_MAGIC_EXT (.name="pgcrypto",.version=PG_VERSION)
static void *	find_provider (text *name, PFN provider_lookup, const char *desc, int silent)
void	_PG_init (void)
	PG_FUNCTION_INFO_V1 (pg_digest)
Datum	pg_digest (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_hmac)
Datum	pg_hmac (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_gen_salt)
Datum	pg_gen_salt (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_gen_salt_rounds)
Datum	pg_gen_salt_rounds (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_crypt)
Datum	pg_crypt (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_encrypt)
Datum	pg_encrypt (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_decrypt)
Datum	pg_decrypt (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_encrypt_iv)
Datum	pg_encrypt_iv (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_decrypt_iv)
Datum	pg_decrypt_iv (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_random_bytes)
Datum	pg_random_bytes (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_random_uuid)
Datum	pg_random_uuid (PG_FUNCTION_ARGS)
	PG_FUNCTION_INFO_V1 (pg_check_fipsmode)
Datum	pg_check_fipsmode (PG_FUNCTION_ARGS)

Variables
static const struct config_enum_entry	builtin_crypto_options []
int	builtin_crypto_enabled = BC_ON

Typedef Documentation

PFN

typedef int(* PFN) (const char *name, void **res)

Definition at line 58 of file pgcrypto.c.

Function Documentation

_PG_init()

void _PG_init

(

void

)

Definition at line 68 of file pgcrypto.c.

{
    DefineCustomEnumVariable("pgcrypto.builtin_crypto_enabled",
                             "Sets if builtin crypto functions are enabled.",
                             "\"on\" enables builtin crypto, \"off\" unconditionally disables and \"fips\" "
                             "will disable builtin crypto if OpenSSL is in FIPS mode",
                             &builtin_crypto_enabled,
                             BC_ON,
                             builtin_crypto_options,
                             PGC_SUSET,
                             0,
                             NULL,
                             NULL,
                             NULL);
    MarkGUCPrefixReserved("pgcrypto");
}

References BC_ON, builtin_crypto_enabled, builtin_crypto_options, DefineCustomEnumVariable(), MarkGUCPrefixReserved(), and PGC_SUSET.

find_provider()

static void * find_provider ( text *  name, PFN  provider_lookup, const char *  desc, int  silent  )

static

Definition at line 496 of file pgcrypto.c.

{
    void       *res;
    char       *buf;
    int         err;
 
    buf = downcase_truncate_identifier(VARDATA_ANY(name),
                                       VARSIZE_ANY_EXHDR(name),
                                       false);
 
    err = provider_lookup(buf, &res);
 
    if (err && !silent)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("Cannot use \"%s\": %s", buf, px_strerror(err))));
 
    pfree(buf);
 
    return err ? NULL : res;
}

References buf, downcase_truncate_identifier(), ereport, err(), errcode(), errmsg(), ERROR, name, pfree(), px_strerror(), VARDATA_ANY, and VARSIZE_ANY_EXHDR.

Referenced by pg_decrypt(), pg_decrypt_iv(), pg_digest(), pg_encrypt(), pg_encrypt_iv(), and pg_hmac().

pg_check_fipsmode()

Datum pg_check_fipsmode

(

PG_FUNCTION_ARGS

)

Definition at line 490 of file pgcrypto.c.

{
    PG_RETURN_BOOL(CheckFIPSMode());
}

References CheckFIPSMode(), and PG_RETURN_BOOL.

pg_crypt()

Datum pg_crypt

(

PG_FUNCTION_ARGS

)

Definition at line 213 of file pgcrypto.c.

{
    text       *arg0 = PG_GETARG_TEXT_PP(0);
    text       *arg1 = PG_GETARG_TEXT_PP(1);
    char       *buf0,
               *buf1,
               *cres,
               *resbuf;
    text       *res;
 
    buf0 = text_to_cstring(arg0);
    buf1 = text_to_cstring(arg1);
 
    resbuf = palloc0(PX_MAX_CRYPT);
 
    cres = px_crypt(buf0, buf1, resbuf, PX_MAX_CRYPT);
 
    pfree(buf0);
    pfree(buf1);
 
    if (cres == NULL)
        ereport(ERROR,
                (errcode(ERRCODE_EXTERNAL_ROUTINE_INVOCATION_EXCEPTION),
                 errmsg("crypt(3) returned NULL")));
 
    res = cstring_to_text(cres);
 
    pfree(resbuf);
 
    PG_FREE_IF_COPY(arg0, 0);
    PG_FREE_IF_COPY(arg1, 1);
 
    PG_RETURN_TEXT_P(res);
}

References cstring_to_text(), ereport, errcode(), errmsg(), ERROR, palloc0(), pfree(), PG_FREE_IF_COPY, PG_GETARG_TEXT_PP, PG_RETURN_TEXT_P, px_crypt(), PX_MAX_CRYPT, and text_to_cstring().

pg_decrypt()

Datum pg_decrypt

(

PG_FUNCTION_ARGS

)

Definition at line 301 of file pgcrypto.c.

{
    int         err;
    bytea      *data,
               *key,
               *res;
    text       *type;
    PX_Combo   *c;
    unsigned    dlen,
                klen,
                rlen;
 
    type = PG_GETARG_TEXT_PP(2);
    c = find_provider(type, (PFN) px_find_combo, "Cipher", 0);
 
    data = PG_GETARG_BYTEA_PP(0);
    key = PG_GETARG_BYTEA_PP(1);
    dlen = VARSIZE_ANY_EXHDR(data);
    klen = VARSIZE_ANY_EXHDR(key);
 
    rlen = px_combo_decrypt_len(c, dlen);
    res = palloc(VARHDRSZ + rlen);
 
    err = px_combo_init(c, (uint8 *) VARDATA_ANY(key), klen, NULL, 0);
    if (!err)
        err = px_combo_decrypt(c, (uint8 *) VARDATA_ANY(data), dlen,
                               (uint8 *) VARDATA(res), &rlen);
 
    px_combo_free(c);
 
    if (err)
        ereport(ERROR,
                (errcode(ERRCODE_EXTERNAL_ROUTINE_INVOCATION_EXCEPTION),
                 errmsg("decrypt error: %s", px_strerror(err))));
 
    SET_VARSIZE(res, VARHDRSZ + rlen);
 
    PG_FREE_IF_COPY(data, 0);
    PG_FREE_IF_COPY(key, 1);
    PG_FREE_IF_COPY(type, 2);
 
    PG_RETURN_BYTEA_P(res);
}

References data, ereport, err(), errcode(), errmsg(), ERROR, find_provider(), sort-test::key, palloc(), PG_FREE_IF_COPY, PG_GETARG_BYTEA_PP, PG_GETARG_TEXT_PP, PG_RETURN_BYTEA_P, px_combo_decrypt, px_combo_decrypt_len, px_combo_free, px_combo_init, px_find_combo(), px_strerror(), SET_VARSIZE, type, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

pg_decrypt_iv()

Datum pg_decrypt_iv

(

PG_FUNCTION_ARGS

)

Definition at line 403 of file pgcrypto.c.

{
    int         err;
    bytea      *data,
               *key,
               *iv,
               *res;
    text       *type;
    PX_Combo   *c;
    unsigned    dlen,
                klen,
                rlen,
                ivlen;
 
    type = PG_GETARG_TEXT_PP(3);
    c = find_provider(type, (PFN) px_find_combo, "Cipher", 0);
 
    data = PG_GETARG_BYTEA_PP(0);
    key = PG_GETARG_BYTEA_PP(1);
    iv = PG_GETARG_BYTEA_PP(2);
    dlen = VARSIZE_ANY_EXHDR(data);
    klen = VARSIZE_ANY_EXHDR(key);
    ivlen = VARSIZE_ANY_EXHDR(iv);
 
    rlen = px_combo_decrypt_len(c, dlen);
    res = palloc(VARHDRSZ + rlen);
 
    err = px_combo_init(c, (uint8 *) VARDATA_ANY(key), klen,
                        (uint8 *) VARDATA_ANY(iv), ivlen);
    if (!err)
        err = px_combo_decrypt(c, (uint8 *) VARDATA_ANY(data), dlen,
                               (uint8 *) VARDATA(res), &rlen);
 
    px_combo_free(c);
 
    if (err)
        ereport(ERROR,
                (errcode(ERRCODE_EXTERNAL_ROUTINE_INVOCATION_EXCEPTION),
                 errmsg("decrypt_iv error: %s", px_strerror(err))));
 
    SET_VARSIZE(res, VARHDRSZ + rlen);
 
    PG_FREE_IF_COPY(data, 0);
    PG_FREE_IF_COPY(key, 1);
    PG_FREE_IF_COPY(iv, 2);
    PG_FREE_IF_COPY(type, 3);
 
    PG_RETURN_BYTEA_P(res);
}

References data, ereport, err(), errcode(), errmsg(), ERROR, find_provider(), sort-test::key, palloc(), PG_FREE_IF_COPY, PG_GETARG_BYTEA_PP, PG_GETARG_TEXT_PP, PG_RETURN_BYTEA_P, px_combo_decrypt, px_combo_decrypt_len, px_combo_free, px_combo_init, px_find_combo(), px_strerror(), SET_VARSIZE, type, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

pg_digest()

Datum pg_digest

(

PG_FUNCTION_ARGS

)

Definition at line 89 of file pgcrypto.c.

{
    bytea      *arg;
    text       *name;
    unsigned    len,
                hlen;
    PX_MD      *md;
    bytea      *res;
 
    name = PG_GETARG_TEXT_PP(1);
 
    /* will give error if fails */
    md = find_provider(name, (PFN) px_find_digest, "Digest", 0);
 
    hlen = px_md_result_size(md);
 
    res = (text *) palloc(hlen + VARHDRSZ);
    SET_VARSIZE(res, hlen + VARHDRSZ);
 
    arg = PG_GETARG_BYTEA_PP(0);
    len = VARSIZE_ANY_EXHDR(arg);
 
    px_md_update(md, (uint8 *) VARDATA_ANY(arg), len);
    px_md_finish(md, (uint8 *) VARDATA(res));
    px_md_free(md);
 
    PG_FREE_IF_COPY(arg, 0);
    PG_FREE_IF_COPY(name, 1);
 
    PG_RETURN_BYTEA_P(res);
}

References arg, find_provider(), len, name, palloc(), PG_FREE_IF_COPY, PG_GETARG_BYTEA_PP, PG_GETARG_TEXT_PP, PG_RETURN_BYTEA_P, px_find_digest(), px_md_finish, px_md_free, px_md_result_size, px_md_update, SET_VARSIZE, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

pg_encrypt()

Datum pg_encrypt

(

PG_FUNCTION_ARGS

)

Definition at line 252 of file pgcrypto.c.

{
    int         err;
    bytea      *data,
               *key,
               *res;
    text       *type;
    PX_Combo   *c;
    unsigned    dlen,
                klen,
                rlen;
 
    type = PG_GETARG_TEXT_PP(2);
    c = find_provider(type, (PFN) px_find_combo, "Cipher", 0);
 
    data = PG_GETARG_BYTEA_PP(0);
    key = PG_GETARG_BYTEA_PP(1);
    dlen = VARSIZE_ANY_EXHDR(data);
    klen = VARSIZE_ANY_EXHDR(key);
 
    rlen = px_combo_encrypt_len(c, dlen);
    res = palloc(VARHDRSZ + rlen);
 
    err = px_combo_init(c, (uint8 *) VARDATA_ANY(key), klen, NULL, 0);
    if (!err)
        err = px_combo_encrypt(c, (uint8 *) VARDATA_ANY(data), dlen,
                               (uint8 *) VARDATA(res), &rlen);
    px_combo_free(c);
 
    PG_FREE_IF_COPY(data, 0);
    PG_FREE_IF_COPY(key, 1);
    PG_FREE_IF_COPY(type, 2);
 
    if (err)
    {
        pfree(res);
        ereport(ERROR,
                (errcode(ERRCODE_EXTERNAL_ROUTINE_INVOCATION_EXCEPTION),
                 errmsg("encrypt error: %s", px_strerror(err))));
    }
 
    SET_VARSIZE(res, VARHDRSZ + rlen);
    PG_RETURN_BYTEA_P(res);
}

References data, ereport, err(), errcode(), errmsg(), ERROR, find_provider(), sort-test::key, palloc(), pfree(), PG_FREE_IF_COPY, PG_GETARG_BYTEA_PP, PG_GETARG_TEXT_PP, PG_RETURN_BYTEA_P, px_combo_encrypt, px_combo_encrypt_len, px_combo_free, px_combo_init, px_find_combo(), px_strerror(), SET_VARSIZE, type, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

pg_encrypt_iv()

Datum pg_encrypt_iv

(

PG_FUNCTION_ARGS

)

Definition at line 349 of file pgcrypto.c.

{
    int         err;
    bytea      *data,
               *key,
               *iv,
               *res;
    text       *type;
    PX_Combo   *c;
    unsigned    dlen,
                klen,
                ivlen,
                rlen;
 
    type = PG_GETARG_TEXT_PP(3);
    c = find_provider(type, (PFN) px_find_combo, "Cipher", 0);
 
    data = PG_GETARG_BYTEA_PP(0);
    key = PG_GETARG_BYTEA_PP(1);
    iv = PG_GETARG_BYTEA_PP(2);
    dlen = VARSIZE_ANY_EXHDR(data);
    klen = VARSIZE_ANY_EXHDR(key);
    ivlen = VARSIZE_ANY_EXHDR(iv);
 
    rlen = px_combo_encrypt_len(c, dlen);
    res = palloc(VARHDRSZ + rlen);
 
    err = px_combo_init(c, (uint8 *) VARDATA_ANY(key), klen,
                        (uint8 *) VARDATA_ANY(iv), ivlen);
    if (!err)
        err = px_combo_encrypt(c, (uint8 *) VARDATA_ANY(data), dlen,
                               (uint8 *) VARDATA(res), &rlen);
 
    px_combo_free(c);
 
    if (err)
        ereport(ERROR,
                (errcode(ERRCODE_EXTERNAL_ROUTINE_INVOCATION_EXCEPTION),
                 errmsg("encrypt_iv error: %s", px_strerror(err))));
 
    SET_VARSIZE(res, VARHDRSZ + rlen);
 
    PG_FREE_IF_COPY(data, 0);
    PG_FREE_IF_COPY(key, 1);
    PG_FREE_IF_COPY(iv, 2);
    PG_FREE_IF_COPY(type, 3);
 
    PG_RETURN_BYTEA_P(res);
}

References data, ereport, err(), errcode(), errmsg(), ERROR, find_provider(), sort-test::key, palloc(), PG_FREE_IF_COPY, PG_GETARG_BYTEA_PP, PG_GETARG_TEXT_PP, PG_RETURN_BYTEA_P, px_combo_encrypt, px_combo_encrypt_len, px_combo_free, px_combo_init, px_find_combo(), px_strerror(), SET_VARSIZE, type, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

PG_FUNCTION_INFO_V1() [1/12]

PG_FUNCTION_INFO_V1

(

pg_check_fipsmode

)

PG_FUNCTION_INFO_V1() [2/12]

PG_FUNCTION_INFO_V1

(

pg_crypt

)

PG_FUNCTION_INFO_V1() [3/12]

PG_FUNCTION_INFO_V1

(

pg_decrypt

)

PG_FUNCTION_INFO_V1() [4/12]

PG_FUNCTION_INFO_V1

(

pg_decrypt_iv

)

PG_FUNCTION_INFO_V1() [5/12]

PG_FUNCTION_INFO_V1

(

pg_digest

)

PG_FUNCTION_INFO_V1() [6/12]

PG_FUNCTION_INFO_V1

(

pg_encrypt

)

PG_FUNCTION_INFO_V1() [7/12]

PG_FUNCTION_INFO_V1

(

pg_encrypt_iv

)

PG_FUNCTION_INFO_V1() [8/12]

PG_FUNCTION_INFO_V1

(

pg_gen_salt

)

PG_FUNCTION_INFO_V1() [9/12]

PG_FUNCTION_INFO_V1

(

pg_gen_salt_rounds

)

PG_FUNCTION_INFO_V1() [10/12]

PG_FUNCTION_INFO_V1

(

pg_hmac

)

PG_FUNCTION_INFO_V1() [11/12]

PG_FUNCTION_INFO_V1

(

pg_random_bytes

)

PG_FUNCTION_INFO_V1() [12/12]

PG_FUNCTION_INFO_V1

(

pg_random_uuid

)

pg_gen_salt()

Datum pg_gen_salt

(

PG_FUNCTION_ARGS

)

Definition at line 168 of file pgcrypto.c.

{
    text       *arg0 = PG_GETARG_TEXT_PP(0);
    int         len;
    char        buf[PX_MAX_SALT_LEN + 1];
 
    text_to_cstring_buffer(arg0, buf, sizeof(buf));
    len = px_gen_salt(buf, buf, 0);
    if (len < 0)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("gen_salt: %s", px_strerror(len))));
 
    PG_FREE_IF_COPY(arg0, 0);
 
    PG_RETURN_TEXT_P(cstring_to_text_with_len(buf, len));
}

References buf, cstring_to_text_with_len(), ereport, errcode(), errmsg(), ERROR, len, PG_FREE_IF_COPY, PG_GETARG_TEXT_PP, PG_RETURN_TEXT_P, px_gen_salt(), PX_MAX_SALT_LEN, px_strerror(), and text_to_cstring_buffer().

pg_gen_salt_rounds()

Datum pg_gen_salt_rounds

(

PG_FUNCTION_ARGS

)

Definition at line 190 of file pgcrypto.c.

{
    text       *arg0 = PG_GETARG_TEXT_PP(0);
    int         rounds = PG_GETARG_INT32(1);
    int         len;
    char        buf[PX_MAX_SALT_LEN + 1];
 
    text_to_cstring_buffer(arg0, buf, sizeof(buf));
    len = px_gen_salt(buf, buf, rounds);
    if (len < 0)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("gen_salt: %s", px_strerror(len))));
 
    PG_FREE_IF_COPY(arg0, 0);
 
    PG_RETURN_TEXT_P(cstring_to_text_with_len(buf, len));
}

References buf, cstring_to_text_with_len(), ereport, errcode(), errmsg(), ERROR, len, PG_FREE_IF_COPY, PG_GETARG_INT32, PG_GETARG_TEXT_PP, PG_RETURN_TEXT_P, px_gen_salt(), PX_MAX_SALT_LEN, px_strerror(), and text_to_cstring_buffer().

pg_hmac()

Datum pg_hmac

(

PG_FUNCTION_ARGS

)

Definition at line 125 of file pgcrypto.c.

{
    bytea      *arg;
    bytea      *key;
    text       *name;
    unsigned    len,
                hlen,
                klen;
    PX_HMAC    *h;
    bytea      *res;
 
    name = PG_GETARG_TEXT_PP(2);
 
    /* will give error if fails */
    h = find_provider(name, (PFN) px_find_hmac, "HMAC", 0);
 
    hlen = px_hmac_result_size(h);
 
    res = (text *) palloc(hlen + VARHDRSZ);
    SET_VARSIZE(res, hlen + VARHDRSZ);
 
    arg = PG_GETARG_BYTEA_PP(0);
    key = PG_GETARG_BYTEA_PP(1);
    len = VARSIZE_ANY_EXHDR(arg);
    klen = VARSIZE_ANY_EXHDR(key);
 
    px_hmac_init(h, (uint8 *) VARDATA_ANY(key), klen);
    px_hmac_update(h, (uint8 *) VARDATA_ANY(arg), len);
    px_hmac_finish(h, (uint8 *) VARDATA(res));
    px_hmac_free(h);
 
    PG_FREE_IF_COPY(arg, 0);
    PG_FREE_IF_COPY(key, 1);
    PG_FREE_IF_COPY(name, 2);
 
    PG_RETURN_BYTEA_P(res);
}

References arg, find_provider(), sort-test::key, len, name, palloc(), PG_FREE_IF_COPY, PG_GETARG_BYTEA_PP, PG_GETARG_TEXT_PP, PG_RETURN_BYTEA_P, px_find_hmac(), px_hmac_finish, px_hmac_free, px_hmac_init, px_hmac_result_size, px_hmac_update, SET_VARSIZE, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

PG_MODULE_MAGIC_EXT()

PG_MODULE_MAGIC_EXT	(	.	name = "pgcrypto",
		.	version = PG_VERSION
	)

pg_random_bytes()

Datum pg_random_bytes

(

PG_FUNCTION_ARGS

)

Definition at line 457 of file pgcrypto.c.

{
    int         len = PG_GETARG_INT32(0);
    bytea      *res;
 
    if (len < 1 || len > 1024)
        ereport(ERROR,
                (errcode(ERRCODE_EXTERNAL_ROUTINE_INVOCATION_EXCEPTION),
                 errmsg("Length not in range")));
 
    res = palloc(VARHDRSZ + len);
    SET_VARSIZE(res, VARHDRSZ + len);
 
    /* generate result */
    if (!pg_strong_random(VARDATA(res), len))
        px_THROW_ERROR(PXE_NO_RANDOM);
 
    PG_RETURN_BYTEA_P(res);
}

References ereport, errcode(), errmsg(), ERROR, len, palloc(), PG_GETARG_INT32, PG_RETURN_BYTEA_P, pg_strong_random(), px_THROW_ERROR(), PXE_NO_RANDOM, SET_VARSIZE, VARDATA, and VARHDRSZ.

pg_random_uuid()

Datum pg_random_uuid

(

PG_FUNCTION_ARGS

)

Definition at line 481 of file pgcrypto.c.

{
    /* redirect to built-in function */
    return gen_random_uuid(fcinfo);
}

References gen_random_uuid().

Variable Documentation

builtin_crypto_enabled

int builtin_crypto_enabled = BC_ON

Definition at line 62 of file pgcrypto.c.

Referenced by _PG_init(), and CheckBuiltinCryptoMode().

builtin_crypto_options

const struct config_enum_entry builtin_crypto_options[]

static

Initial value:

= {
    {"on", BC_ON, false},
    {"off", BC_OFF, false},
    {"fips", BC_FIPS, false},
    {NULL, 0, false}
}

Definition at line 51 of file pgcrypto.c.

Referenced by _PG_init().