Add timingsafe_bcmp(), for constant-time memory comparison

timingsafe_bcmp() should be used instead of memcmp() or a naive
for-loop, when comparing passwords or secret tokens, to avoid leaking
information about the secret token by timing. This commit just
introduces the function but does not change any existing code to use
it yet.

Co-authored-by: Jelte Fennema-Nio <github-tech@jeltef.nl>
Discussion: https://www.postgresql.org/message-id/7b86da3b-9356-4e50-aa1b-56570825e234@iki.fi
This commit is contained in:
Heikki Linnakangas 2025-04-02 15:32:40 +03:00
parent 85d799ba8a
commit 09be391126
6 changed files with 75 additions and 1 deletions

23
configure vendored
View File

@ -15927,6 +15927,16 @@ fi
cat >>confdefs.h <<_ACEOF cat >>confdefs.h <<_ACEOF
#define HAVE_DECL_STRSEP $ac_have_decl #define HAVE_DECL_STRSEP $ac_have_decl
_ACEOF _ACEOF
ac_fn_c_check_decl "$LINENO" "timingsafe_bcmp" "ac_cv_have_decl_timingsafe_bcmp" "$ac_includes_default"
if test "x$ac_cv_have_decl_timingsafe_bcmp" = xyes; then :
ac_have_decl=1
else
ac_have_decl=0
fi
cat >>confdefs.h <<_ACEOF
#define HAVE_DECL_TIMINGSAFE_BCMP $ac_have_decl
_ACEOF
# We can't use AC_CHECK_FUNCS to detect these functions, because it # We can't use AC_CHECK_FUNCS to detect these functions, because it
@ -16099,6 +16109,19 @@ esac
fi fi
ac_fn_c_check_func "$LINENO" "timingsafe_bcmp" "ac_cv_func_timingsafe_bcmp"
if test "x$ac_cv_func_timingsafe_bcmp" = xyes; then :
$as_echo "#define HAVE_TIMINGSAFE_BCMP 1" >>confdefs.h
else
case " $LIBOBJS " in
*" timingsafe_bcmp.$ac_objext "* ) ;;
*) LIBOBJS="$LIBOBJS timingsafe_bcmp.$ac_objext"
;;
esac
fi
ac_fn_c_check_func "$LINENO" "pthread_barrier_wait" "ac_cv_func_pthread_barrier_wait" ac_fn_c_check_func "$LINENO" "pthread_barrier_wait" "ac_cv_func_pthread_barrier_wait"

View File

@ -1805,7 +1805,7 @@ AC_CHECK_DECLS(posix_fadvise, [], [], [#include <fcntl.h>])
]) # fi ]) # fi
AC_CHECK_DECLS(fdatasync, [], [], [#include <unistd.h>]) AC_CHECK_DECLS(fdatasync, [], [], [#include <unistd.h>])
AC_CHECK_DECLS([strlcat, strlcpy, strnlen, strsep]) AC_CHECK_DECLS([strlcat, strlcpy, strnlen, strsep, timingsafe_bcmp])
# We can't use AC_CHECK_FUNCS to detect these functions, because it # We can't use AC_CHECK_FUNCS to detect these functions, because it
# won't handle deployment target restrictions on macOS # won't handle deployment target restrictions on macOS
@ -1826,6 +1826,7 @@ AC_REPLACE_FUNCS(m4_normalize([
strlcpy strlcpy
strnlen strnlen
strsep strsep
timingsafe_bcmp
])) ]))
AC_REPLACE_FUNCS(pthread_barrier_wait) AC_REPLACE_FUNCS(pthread_barrier_wait)

View File

@ -2569,6 +2569,7 @@ decl_checks = [
['strlcpy', 'string.h'], ['strlcpy', 'string.h'],
['strnlen', 'string.h'], ['strnlen', 'string.h'],
['strsep', 'string.h'], ['strsep', 'string.h'],
['timingsafe_bcmp', 'string.h'],
] ]
# Need to check for function declarations for these functions, because # Need to check for function declarations for these functions, because
@ -2826,6 +2827,7 @@ func_checks = [
['strsignal'], ['strsignal'],
['sync_file_range'], ['sync_file_range'],
['syncfs'], ['syncfs'],
['timingsafe_bcmp'],
['uselocale'], ['uselocale'],
['wcstombs_l'], ['wcstombs_l'],
] ]

View File

@ -464,6 +464,10 @@ extern size_t strnlen(const char *str, size_t maxlen);
extern char *strsep(char **stringp, const char *delim); extern char *strsep(char **stringp, const char *delim);
#endif #endif
#if !HAVE_DECL_TIMINGSAFE_BCMP
extern int timingsafe_bcmp(const void *b1, const void *b2, size_t len);
#endif
/* /*
* Callers should use the qsort() macro defined below instead of calling * Callers should use the qsort() macro defined below instead of calling
* pg_qsort() directly. * pg_qsort() directly.

View File

@ -73,6 +73,7 @@ replace_funcs_neg = [
['strlcpy'], ['strlcpy'],
['strnlen'], ['strnlen'],
['strsep'], ['strsep'],
['timingsafe_bcmp'],
] ]
if host_system != 'windows' if host_system != 'windows'

View File

@ -0,0 +1,43 @@
/*
* src/port/timingsafe_bcmp.c
*
* $OpenBSD: timingsafe_bcmp.c,v 1.3 2015/08/31 02:53:57 guenther Exp $
*/
/*
* Copyright (c) 2010 Damien Miller. All rights reserved.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include "c.h"
#ifdef USE_SSL
#include <openssl/crypto.h>
#endif
int
timingsafe_bcmp(const void *b1, const void *b2, size_t n)
{
#ifdef USE_SSL
return CRYPTO_memcmp(b1, b2, n);
#else
const unsigned char *p1 = b1,
*p2 = b2;
int ret = 0;
for (; n > 0; n--)
ret |= *p1++ ^ *p2++;
return (ret != 0);
#endif
}