hmac_openssl.c File Reference

#include "postgres.h"
#include <openssl/err.h>
#include <openssl/hmac.h>
#include "common/hmac.h"
#include "common/md5.h"
#include "common/sha1.h"
#include "common/sha2.h"
#include "utils/memutils.h"
#include "utils/resowner.h"

Include dependency graph for hmac_openssl.c:

Go to the source code of this file.

Data Structures
struct	pg_hmac_ctx

Macros
#define	USE_RESOWNER_FOR_HMAC
#define	ALLOC(size)   MemoryContextAlloc(TopMemoryContext, size)
#define	FREE(ptr)   pfree(ptr)

Typedefs
typedef enum pg_hmac_errno	pg_hmac_errno

Enumerations
enum	pg_hmac_errno {   PG_HMAC_ERROR_NONE = 0 , PG_HMAC_ERROR_OOM , PG_HMAC_ERROR_INTERNAL , PG_HMAC_ERROR_NONE = 0 ,   PG_HMAC_ERROR_DEST_LEN , PG_HMAC_ERROR_OPENSSL }

Functions
static void	ResOwnerReleaseHMAC (Datum res)
static void	ResourceOwnerRememberHMAC (ResourceOwner owner, pg_hmac_ctx *ctx)
static void	ResourceOwnerForgetHMAC (ResourceOwner owner, pg_hmac_ctx *ctx)
static const char *	SSLerrmessage (unsigned long ecode)
pg_hmac_ctx *	pg_hmac_create (pg_cryptohash_type type)
int	pg_hmac_init (pg_hmac_ctx *ctx, const uint8 *key, size_t len)
int	pg_hmac_update (pg_hmac_ctx *ctx, const uint8 *data, size_t len)
int	pg_hmac_final (pg_hmac_ctx *ctx, uint8 *dest, size_t len)
void	pg_hmac_free (pg_hmac_ctx *ctx)
const char *	pg_hmac_error (pg_hmac_ctx *ctx)

Variables
static const ResourceOwnerDesc	hmac_resowner_desc

Macro Definition Documentation

ALLOC

#define ALLOC

(

size

)

MemoryContextAlloc(TopMemoryContext, size)

Definition at line 43 of file hmac_openssl.c.

FREE

#define FREE

(

ptr

)

pfree(ptr)

Definition at line 44 of file hmac_openssl.c.

USE_RESOWNER_FOR_HMAC

#define USE_RESOWNER_FOR_HMAC

Definition at line 42 of file hmac_openssl.c.

Typedef Documentation

pg_hmac_errno

typedef enum pg_hmac_errno pg_hmac_errno

Enumeration Type Documentation

pg_hmac_errno

enum pg_hmac_errno

Enumerator
PG_HMAC_ERROR_NONE
PG_HMAC_ERROR_OOM
PG_HMAC_ERROR_INTERNAL
PG_HMAC_ERROR_NONE
PG_HMAC_ERROR_DEST_LEN
PG_HMAC_ERROR_OPENSSL

Definition at line 51 of file hmac_openssl.c.

{
    PG_HMAC_ERROR_NONE = 0,
    PG_HMAC_ERROR_DEST_LEN,
    PG_HMAC_ERROR_OPENSSL,
} pg_hmac_errno;

Function Documentation

pg_hmac_create()

pg_hmac_ctx * pg_hmac_create

(

pg_cryptohash_type

type

)

Definition at line 117 of file hmac_openssl.c.

{
    pg_hmac_ctx *ctx;
 
    ctx = ALLOC(sizeof(pg_hmac_ctx));
    if (ctx == NULL)
        return NULL;
    memset(ctx, 0, sizeof(pg_hmac_ctx));
 
    ctx->type = type;
    ctx->error = PG_HMAC_ERROR_NONE;
    ctx->errreason = NULL;
 
 
    /*
     * Initialization takes care of assigning the correct type for OpenSSL.
     * Also ensure that there aren't any unconsumed errors in the queue from
     * previous runs.
     */
    ERR_clear_error();
 
#ifdef USE_RESOWNER_FOR_HMAC
    ResourceOwnerEnlarge(CurrentResourceOwner);
#endif
 
    ctx->hmacctx = HMAC_CTX_new();
 
    if (ctx->hmacctx == NULL)
    {
        explicit_bzero(ctx, sizeof(pg_hmac_ctx));
        FREE(ctx);
#ifndef FRONTEND
        ereport(ERROR,
                (errcode(ERRCODE_OUT_OF_MEMORY),
                 errmsg("out of memory")));
#endif
        return NULL;
    }
 
 
#ifdef USE_RESOWNER_FOR_HMAC
    ctx->resowner = CurrentResourceOwner;
    ResourceOwnerRememberHMAC(CurrentResourceOwner, ctx);
#endif
 
    return ctx;
}

References ALLOC, CurrentResourceOwner, ereport, errcode(), errmsg(), pg_hmac_ctx::error, ERROR, pg_hmac_ctx::errreason, explicit_bzero(), FREE, pg_hmac_ctx::hmacctx, PG_HMAC_ERROR_NONE, ResourceOwnerEnlarge(), ResourceOwnerRememberHMAC(), pg_hmac_ctx::resowner, type, and pg_hmac_ctx::type.

pg_hmac_error()

const char * pg_hmac_error

(

pg_hmac_ctx *

ctx

)

Definition at line 336 of file hmac_openssl.c.

{
    if (ctx == NULL)
        return _("out of memory");
 
    /*
     * If a reason is provided, rely on it, else fallback to any error code
     * set.
     */
    if (ctx->errreason)
        return ctx->errreason;
 
    switch (ctx->error)
    {
        case PG_HMAC_ERROR_NONE:
            return _("success");
        case PG_HMAC_ERROR_DEST_LEN:
            return _("destination buffer too small");
        case PG_HMAC_ERROR_OPENSSL:
            return _("OpenSSL failure");
    }
 
    Assert(false);              /* cannot be reached */
    return _("success");
}

References _, Assert(), pg_hmac_ctx::error, pg_hmac_ctx::errreason, PG_HMAC_ERROR_DEST_LEN, PG_HMAC_ERROR_NONE, and PG_HMAC_ERROR_OPENSSL.

pg_hmac_final()

int pg_hmac_final	(	pg_hmac_ctx *	ctx,
		uint8 *	dest,
		size_t	len
	)

Definition at line 242 of file hmac_openssl.c.

{
    int         status = 0;
    uint32      outlen;
 
    if (ctx == NULL)
        return -1;
 
    switch (ctx->type)
    {
        case PG_MD5:
            if (len < MD5_DIGEST_LENGTH)
            {
                ctx->error = PG_HMAC_ERROR_DEST_LEN;
                return -1;
            }
            break;
        case PG_SHA1:
            if (len < SHA1_DIGEST_LENGTH)
            {
                ctx->error = PG_HMAC_ERROR_DEST_LEN;
                return -1;
            }
            break;
        case PG_SHA224:
            if (len < PG_SHA224_DIGEST_LENGTH)
            {
                ctx->error = PG_HMAC_ERROR_DEST_LEN;
                return -1;
            }
            break;
        case PG_SHA256:
            if (len < PG_SHA256_DIGEST_LENGTH)
            {
                ctx->error = PG_HMAC_ERROR_DEST_LEN;
                return -1;
            }
            break;
        case PG_SHA384:
            if (len < PG_SHA384_DIGEST_LENGTH)
            {
                ctx->error = PG_HMAC_ERROR_DEST_LEN;
                return -1;
            }
            break;
        case PG_SHA512:
            if (len < PG_SHA512_DIGEST_LENGTH)
            {
                ctx->error = PG_HMAC_ERROR_DEST_LEN;
                return -1;
            }
            break;
    }
 
    status = HMAC_Final(ctx->hmacctx, dest, &outlen);
 
    /* OpenSSL internals return 1 on success, 0 on failure */
    if (status <= 0)
    {
        ctx->errreason = SSLerrmessage(ERR_get_error());
        ctx->error = PG_HMAC_ERROR_OPENSSL;
        return -1;
    }
    return 0;
}

References generate_unaccent_rules::dest, pg_hmac_ctx::error, pg_hmac_ctx::errreason, pg_hmac_ctx::hmacctx, len, MD5_DIGEST_LENGTH, PG_HMAC_ERROR_DEST_LEN, PG_HMAC_ERROR_OPENSSL, PG_MD5, PG_SHA1, PG_SHA224, PG_SHA224_DIGEST_LENGTH, PG_SHA256, PG_SHA256_DIGEST_LENGTH, PG_SHA384, PG_SHA384_DIGEST_LENGTH, PG_SHA512, PG_SHA512_DIGEST_LENGTH, SHA1_DIGEST_LENGTH, SSLerrmessage(), and pg_hmac_ctx::type.

pg_hmac_free()

void pg_hmac_free

(

pg_hmac_ctx *

ctx

)

Definition at line 314 of file hmac_openssl.c.

{
    if (ctx == NULL)
        return;
 
    HMAC_CTX_free(ctx->hmacctx);
#ifdef USE_RESOWNER_FOR_HMAC
    if (ctx->resowner)
        ResourceOwnerForgetHMAC(ctx->resowner, ctx);
#endif
 
    explicit_bzero(ctx, sizeof(pg_hmac_ctx));
    FREE(ctx);
}

References explicit_bzero(), FREE, pg_hmac_ctx::hmacctx, ResourceOwnerForgetHMAC(), and pg_hmac_ctx::resowner.

Referenced by ResOwnerReleaseHMAC().

pg_hmac_init()

int pg_hmac_init	(	pg_hmac_ctx *	ctx,
		const uint8 *	key,
		size_t	len
	)

Definition at line 171 of file hmac_openssl.c.

{
    int         status = 0;
 
    if (ctx == NULL)
        return -1;
 
    switch (ctx->type)
    {
        case PG_MD5:
            status = HMAC_Init_ex(ctx->hmacctx, key, len, EVP_md5(), NULL);
            break;
        case PG_SHA1:
            status = HMAC_Init_ex(ctx->hmacctx, key, len, EVP_sha1(), NULL);
            break;
        case PG_SHA224:
            status = HMAC_Init_ex(ctx->hmacctx, key, len, EVP_sha224(), NULL);
            break;
        case PG_SHA256:
            status = HMAC_Init_ex(ctx->hmacctx, key, len, EVP_sha256(), NULL);
            break;
        case PG_SHA384:
            status = HMAC_Init_ex(ctx->hmacctx, key, len, EVP_sha384(), NULL);
            break;
        case PG_SHA512:
            status = HMAC_Init_ex(ctx->hmacctx, key, len, EVP_sha512(), NULL);
            break;
    }
 
    /* OpenSSL internals return 1 on success, 0 on failure */
    if (status <= 0)
    {
        ctx->errreason = SSLerrmessage(ERR_get_error());
        ctx->error = PG_HMAC_ERROR_OPENSSL;
        return -1;
    }
 
    return 0;
}

References pg_hmac_ctx::error, pg_hmac_ctx::errreason, pg_hmac_ctx::hmacctx, sort-test::key, len, PG_HMAC_ERROR_OPENSSL, PG_MD5, PG_SHA1, PG_SHA224, PG_SHA256, PG_SHA384, PG_SHA512, SSLerrmessage(), and pg_hmac_ctx::type.

pg_hmac_update()

int pg_hmac_update	(	pg_hmac_ctx *	ctx,
		const uint8 *	data,
		size_t	len
	)

Definition at line 217 of file hmac_openssl.c.

{
    int         status = 0;
 
    if (ctx == NULL)
        return -1;
 
    status = HMAC_Update(ctx->hmacctx, data, len);
 
    /* OpenSSL internals return 1 on success, 0 on failure */
    if (status <= 0)
    {
        ctx->errreason = SSLerrmessage(ERR_get_error());
        ctx->error = PG_HMAC_ERROR_OPENSSL;
        return -1;
    }
    return 0;
}

References data, pg_hmac_ctx::error, pg_hmac_ctx::errreason, pg_hmac_ctx::hmacctx, len, PG_HMAC_ERROR_OPENSSL, and SSLerrmessage().

ResourceOwnerForgetHMAC()

static void ResourceOwnerForgetHMAC ( ResourceOwner  owner, pg_hmac_ctx *  ctx  )

inlinestatic

Definition at line 91 of file hmac_openssl.c.

{
    ResourceOwnerForget(owner, PointerGetDatum(ctx), &hmac_resowner_desc);
}

References hmac_resowner_desc, PointerGetDatum(), and ResourceOwnerForget().

Referenced by pg_hmac_free().

ResourceOwnerRememberHMAC()

static void ResourceOwnerRememberHMAC ( ResourceOwner  owner, pg_hmac_ctx *  ctx  )

inlinestatic

Definition at line 86 of file hmac_openssl.c.

{
    ResourceOwnerRemember(owner, PointerGetDatum(ctx), &hmac_resowner_desc);
}

References hmac_resowner_desc, PointerGetDatum(), and ResourceOwnerRemember().

Referenced by pg_hmac_create().

ResOwnerReleaseHMAC()

static void ResOwnerReleaseHMAC ( Datum  res )

static

Definition at line 366 of file hmac_openssl.c.

{
    pg_hmac_ctx *ctx = (pg_hmac_ctx *) DatumGetPointer(res);
 
    ctx->resowner = NULL;
    pg_hmac_free(ctx);
}

References DatumGetPointer(), pg_hmac_free(), and pg_hmac_ctx::resowner.

SSLerrmessage()

static const char * SSLerrmessage ( unsigned long  ecode )

static

Definition at line 98 of file hmac_openssl.c.

{
    if (ecode == 0)
        return NULL;
 
    /*
     * This may return NULL, but we would fall back to a default error path if
     * that were the case.
     */
    return ERR_reason_error_string(ecode);
}

Referenced by pg_hmac_final(), pg_hmac_init(), and pg_hmac_update().

Variable Documentation

hmac_resowner_desc

const ResourceOwnerDesc hmac_resowner_desc

static

Initial value:

=
{
    .name = "OpenSSL HMAC context",
    .release_phase = RESOURCE_RELEASE_BEFORE_LOCKS,
    .release_priority = RELEASE_PRIO_HMAC_CONTEXTS,
    .ReleaseResource = ResOwnerReleaseHMAC,
    .DebugPrint = NULL          
}

Definition at line 75 of file hmac_openssl.c.

Referenced by ResourceOwnerForgetHMAC(), and ResourceOwnerRememberHMAC().