lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-11-03 22:13:11 +03:00
Code Activity

wincng: Added explicit clear memory feature to WinCNG backend

Browse Source 
This re-introduces the original feature proposed during
the development of the WinCNG crypto backend. It still needs
to be added to libssh2 itself and probably other backends.

Memory is cleared using the function SecureZeroMemory which is
available on Windows systems, just like the WinCNG backend.
This commit is contained in:
Marc Hoersken
2015-03-22 16:51:54 +01:00
parent 77020c7961
commit 57dea4df6d
2 changed files with 104 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
configure.ac
View File

@@ -97,6 +97,7 @@ AC_ARG_WITH(libz,
use_libz=$withval,use_libz=auto) use_libz=$withval,use_libz=auto)
found_crypto=none found_crypto=none
support_clear_memory=no
# Look for OpenSSL # Look for OpenSSL
if test "$found_crypto" = "none" && test "$use_openssl" != "no"; then if test "$found_crypto" = "none" && test "$use_openssl" != "no"; then
@@ -150,6 +151,7 @@ if test "$ac_cv_libbcrypt" = "yes"; then
LIBS="$LIBS -lcrypt32" LIBS="$LIBS -lcrypt32"
fi fi
found_crypto="Windows Cryptography API: Next Generation" found_crypto="Windows Cryptography API: Next Generation"
support_clear_memory=yes
fi fi
AM_CONDITIONAL(WINCNG, test "$ac_cv_libbcrypt" = "yes") AM_CONDITIONAL(WINCNG, test "$ac_cv_libbcrypt" = "yes")
@@ -197,6 +199,26 @@ if test "$GEX_NEW" != "no"; then
AC_DEFINE(LIBSSH2_DH_GEX_NEW, 1, [Enable newer diffie-hellman-group-exchange-sha1 syntax]) AC_DEFINE(LIBSSH2_DH_GEX_NEW, 1, [Enable newer diffie-hellman-group-exchange-sha1 syntax])
fi fi
AC_ARG_ENABLE(clear-memory,
AC_HELP_STRING([--disable-clear-memory],[Disable clearing of memory before being freed]),
[CLEAR_MEMORY=$enableval])
if test "$CLEAR_MEMORY" != "no"; then
if test "$support_clear_memory" = "yes"; then
AC_DEFINE(LIBSSH2_CLEAR_MEMORY, 1, [Enable clearing of memory before being freed])
enable_clear_memory=yes
else
AC_MSG_ERROR([secure clearing/zeroing of memory is not supported by the selected crypto backend])
enable_clear_memory=unsupported
fi
else
if test "$support_clear_memory" = "yes"; then
enable_clear_memory=no
else
AC_MSG_WARN([secure clearing/zeroing of memory is not supported by the selected crypto backend])
enable_clear_memory=unsupported
fi
fi
dnl ************************************************************ dnl ************************************************************
dnl option to switch on compiler debug options dnl option to switch on compiler debug options
dnl dnl
@@ -362,6 +384,7 @@ AC_MSG_NOTICE([summary of build options:
Compiler flags: ${CFLAGS} Compiler flags: ${CFLAGS}
Library types: Shared=${enable_shared}, Static=${enable_static} Library types: Shared=${enable_shared}, Static=${enable_static}
Crypto library: ${found_crypto} Crypto library: ${found_crypto}
Clear memory: $enable_clear_memory
Debug build: $enable_debug Debug build: $enable_debug
Build examples: $build_examples Build examples: $build_examples
Path to sshd: $ac_cv_path_SSHD (only for self-tests) Path to sshd: $ac_cv_path_SSHD (only for self-tests)

138
src/wincng.c
View File

@@ -285,6 +285,20 @@ _libssh2_wincng_random(void *buf, int len)
return BCRYPT_SUCCESS(ret) ? 0 : -1; return BCRYPT_SUCCESS(ret) ? 0 : -1;
} }
static void
_libssh2_wincng_safe_free(void *buf, int len)
{
if (!buf)
return;
#ifdef LIBSSH2_CLEAR_MEMORY
if (len > 0)
SecureZeroMemory(buf, len);
#endif
free(buf);
}
/*******************************************************************/ /*******************************************************************/
/* /*
@@ -327,7 +341,7 @@ _libssh2_wincng_hash_init(_libssh2_wincng_hash_ctx *ctx,
pbHashObject, dwHashObject, pbHashObject, dwHashObject,
key, keylen, 0); key, keylen, 0);
if (!BCRYPT_SUCCESS(ret)) { if (!BCRYPT_SUCCESS(ret)) {
free(pbHashObject); _libssh2_wincng_safe_free(pbHashObject, dwHashObject);
return -1; return -1;
} }
@@ -360,11 +374,11 @@ _libssh2_wincng_hash_final(_libssh2_wincng_hash_ctx *ctx,
ret = BCryptFinishHash(ctx->hHash, hash, ctx->cbHash, 0); ret = BCryptFinishHash(ctx->hHash, hash, ctx->cbHash, 0);
BCryptDestroyHash(ctx->hHash); BCryptDestroyHash(ctx->hHash);
ctx->hHash = NULL;
if (ctx->pbHashObject) _libssh2_wincng_safe_free(ctx->pbHashObject, ctx->dwHashObject);
free(ctx->pbHashObject); ctx->pbHashObject = NULL;
ctx->dwHashObject = 0;
memset(ctx, 0, sizeof(_libssh2_wincng_hash_ctx));
return ret; return ret;
} }
@@ -408,11 +422,11 @@ void
_libssh2_wincng_hmac_cleanup(_libssh2_wincng_hash_ctx *ctx) _libssh2_wincng_hmac_cleanup(_libssh2_wincng_hash_ctx *ctx)
{ {
BCryptDestroyHash(ctx->hHash); BCryptDestroyHash(ctx->hHash);
ctx->hHash = NULL;
if (ctx->pbHashObject) _libssh2_wincng_safe_free(ctx->pbHashObject, ctx->dwHashObject);
free(ctx->pbHashObject); ctx->pbHashObject = NULL;
ctx->dwHashObject = 0;
memset(ctx, 0, sizeof(_libssh2_wincng_hash_ctx));
} }
@@ -454,17 +468,17 @@ _libssh2_wincng_key_sha1_verify(_libssh2_wincng_key_ctx *ctx,
_libssh2_wincng.hAlgHashSHA1, _libssh2_wincng.hAlgHashSHA1,
hash, hashlen); hash, hashlen);
free(data); _libssh2_wincng_safe_free(data, datalen);
if (ret) { if (ret) {
free(hash); _libssh2_wincng_safe_free(hash, hashlen);
return -1; return -1;
} }
datalen = sig_len; datalen = sig_len;
data = malloc(datalen); data = malloc(datalen);
if (!data) { if (!data) {
free(hash); _libssh2_wincng_safe_free(hash, hashlen);
return -1; return -1;
} }
@@ -479,8 +493,8 @@ _libssh2_wincng_key_sha1_verify(_libssh2_wincng_key_ctx *ctx,
ret = BCryptVerifySignature(ctx->hKey, pPaddingInfo, ret = BCryptVerifySignature(ctx->hKey, pPaddingInfo,
hash, hashlen, data, datalen, flags); hash, hashlen, data, datalen, flags);
free(hash); _libssh2_wincng_safe_free(hash, hashlen);
free(data); _libssh2_wincng_safe_free(data, datalen);
return BCRYPT_SUCCESS(ret) ? 0 : -1; return BCRYPT_SUCCESS(ret) ? 0 : -1;
} }
@@ -611,7 +625,7 @@ _libssh2_wincng_asn_decode(unsigned char *pbEncoded,
pbEncoded, cbEncoded, 0, NULL, pbEncoded, cbEncoded, 0, NULL,
pbDecoded, &cbDecoded); pbDecoded, &cbDecoded);
if (!ret) { if (!ret) {
free(pbDecoded); _libssh2_wincng_safe_free(pbDecoded, cbDecoded);
return -1; return -1;
} }
@@ -682,7 +696,7 @@ _libssh2_wincng_asn_decode_bn(unsigned char *pbEncoded,
*ppbDecoded = pbDecoded; *ppbDecoded = pbDecoded;
*pcbDecoded = cbDecoded; *pcbDecoded = cbDecoded;
} }
free(pbInteger); _libssh2_wincng_safe_free(pbInteger, cbInteger);
} }
return ret; return ret;
@@ -727,10 +741,10 @@ _libssh2_wincng_asn_decode_bns(unsigned char *pbEncoded,
*pcbCount = length; *pcbCount = length;
} else { } else {
for (length = 0; length < index; length++) { for (length = 0; length < index; length++) {
if (rpbDecoded[length]) { _libssh2_wincng_safe_free(rpbDecoded[length],
free(rpbDecoded[length]); rcbDecoded[length]);
rpbDecoded[length] = NULL; rpbDecoded[length] = NULL;
} rcbDecoded[length] = 0;
} }
free(rpbDecoded); free(rpbDecoded);
free(rcbDecoded); free(rcbDecoded);
@@ -743,7 +757,7 @@ _libssh2_wincng_asn_decode_bns(unsigned char *pbEncoded,
ret = -1; ret = -1;
} }
free(pbDecoded); _libssh2_wincng_safe_free(pbDecoded, cbDecoded);
} }
return ret; return ret;
@@ -889,7 +903,7 @@ _libssh2_wincng_rsa_new(libssh2_rsa_ctx **rsa,
ret = BCryptImportKeyPair(_libssh2_wincng.hAlgRSA, NULL, lpszBlobType, ret = BCryptImportKeyPair(_libssh2_wincng.hAlgRSA, NULL, lpszBlobType,
&hKey, key, keylen, 0); &hKey, key, keylen, 0);
if (!BCRYPT_SUCCESS(ret)) { if (!BCRYPT_SUCCESS(ret)) {
free(key); _libssh2_wincng_safe_free(key, keylen);
return -1; return -1;
} }
@@ -897,7 +911,7 @@ _libssh2_wincng_rsa_new(libssh2_rsa_ctx **rsa,
*rsa = malloc(sizeof(libssh2_rsa_ctx)); *rsa = malloc(sizeof(libssh2_rsa_ctx));
if (!(*rsa)) { if (!(*rsa)) {
BCryptDestroyKey(hKey); BCryptDestroyKey(hKey);
free(key); _libssh2_wincng_safe_free(key, keylen);
return -1; return -1;
} }
@@ -926,7 +940,7 @@ _libssh2_wincng_rsa_new_private_parse(libssh2_rsa_ctx **rsa,
PKCS_RSA_PRIVATE_KEY, PKCS_RSA_PRIVATE_KEY,
&pbStructInfo, &cbStructInfo); &pbStructInfo, &cbStructInfo);
free(pbEncoded); _libssh2_wincng_safe_free(pbEncoded, cbEncoded);
if (ret) { if (ret) {
return -1; return -1;
@@ -937,7 +951,7 @@ _libssh2_wincng_rsa_new_private_parse(libssh2_rsa_ctx **rsa,
LEGACY_RSAPRIVATE_BLOB, &hKey, LEGACY_RSAPRIVATE_BLOB, &hKey,
pbStructInfo, cbStructInfo, 0); pbStructInfo, cbStructInfo, 0);
if (!BCRYPT_SUCCESS(ret)) { if (!BCRYPT_SUCCESS(ret)) {
free(pbStructInfo); _libssh2_wincng_safe_free(pbStructInfo, cbStructInfo);
return -1; return -1;
} }
@@ -945,7 +959,7 @@ _libssh2_wincng_rsa_new_private_parse(libssh2_rsa_ctx **rsa,
*rsa = malloc(sizeof(libssh2_rsa_ctx)); *rsa = malloc(sizeof(libssh2_rsa_ctx));
if (!(*rsa)) { if (!(*rsa)) {
BCryptDestroyKey(hKey); BCryptDestroyKey(hKey);
free(pbStructInfo); _libssh2_wincng_safe_free(pbStructInfo, cbStructInfo);
return -1; return -1;
} }
@@ -1079,7 +1093,7 @@ _libssh2_wincng_rsa_sha1_sign(LIBSSH2_SESSION *session,
ret = STATUS_NO_MEMORY; ret = STATUS_NO_MEMORY;
} }
free(data); _libssh2_wincng_safe_free(data, datalen);
return BCRYPT_SUCCESS(ret) ? 0 : -1; return BCRYPT_SUCCESS(ret) ? 0 : -1;
} }
@@ -1091,12 +1105,10 @@ _libssh2_wincng_rsa_free(libssh2_rsa_ctx *rsa)
return; return;
BCryptDestroyKey(rsa->hKey); BCryptDestroyKey(rsa->hKey);
rsa->hKey = NULL;
if (rsa->pbKeyObject) _libssh2_wincng_safe_free(rsa->pbKeyObject, rsa->cbKeyObject);
free(rsa->pbKeyObject); _libssh2_wincng_safe_free(rsa, sizeof(libssh2_rsa_ctx));
memset(rsa, 0, sizeof(libssh2_rsa_ctx));
free(rsa);
} }
@@ -1190,7 +1202,7 @@ _libssh2_wincng_dsa_new(libssh2_dsa_ctx **dsa,
ret = BCryptImportKeyPair(_libssh2_wincng.hAlgDSA, NULL, lpszBlobType, ret = BCryptImportKeyPair(_libssh2_wincng.hAlgDSA, NULL, lpszBlobType,
&hKey, key, keylen, 0); &hKey, key, keylen, 0);
if (!BCRYPT_SUCCESS(ret)) { if (!BCRYPT_SUCCESS(ret)) {
free(key); _libssh2_wincng_safe_free(key, keylen);
return -1; return -1;
} }
@@ -1198,7 +1210,7 @@ _libssh2_wincng_dsa_new(libssh2_dsa_ctx **dsa,
*dsa = malloc(sizeof(libssh2_dsa_ctx)); *dsa = malloc(sizeof(libssh2_dsa_ctx));
if (!(*dsa)) { if (!(*dsa)) {
BCryptDestroyKey(hKey); BCryptDestroyKey(hKey);
free(key); _libssh2_wincng_safe_free(key, keylen);
return -1; return -1;
} }
@@ -1225,7 +1237,7 @@ _libssh2_wincng_dsa_new_private_parse(libssh2_dsa_ctx **dsa,
ret = _libssh2_wincng_asn_decode_bns(pbEncoded, cbEncoded, ret = _libssh2_wincng_asn_decode_bns(pbEncoded, cbEncoded,
&rpbDecoded, &rcbDecoded, &length); &rpbDecoded, &rcbDecoded, &length);
free(pbEncoded); _libssh2_wincng_safe_free(pbEncoded, cbEncoded);
if (ret) { if (ret) {
return -1; return -1;
@@ -1244,10 +1256,9 @@ _libssh2_wincng_dsa_new_private_parse(libssh2_dsa_ctx **dsa,
} }
for (index = 0; index < length; index++) { for (index = 0; index < length; index++) {
if (rpbDecoded[index]) { _libssh2_wincng_safe_free(rpbDecoded[index], rcbDecoded[index]);
free(rpbDecoded[index]);
rpbDecoded[index] = NULL; rpbDecoded[index] = NULL;
} rcbDecoded[index] = 0;
} }
free(rpbDecoded); free(rpbDecoded);
@@ -1361,14 +1372,14 @@ _libssh2_wincng_dsa_sha1_sign(libssh2_dsa_ctx *dsa,
memcpy(sig_fixed, sig, siglen); memcpy(sig_fixed, sig, siglen);
} }
free(sig); _libssh2_wincng_safe_free(sig, siglen);
} else } else
ret = STATUS_NO_MEMORY; ret = STATUS_NO_MEMORY;
} else } else
ret = STATUS_NO_MEMORY; ret = STATUS_NO_MEMORY;
} }
free(data); _libssh2_wincng_safe_free(data, datalen);
return BCRYPT_SUCCESS(ret) ? 0 : -1; return BCRYPT_SUCCESS(ret) ? 0 : -1;
} }
@@ -1380,12 +1391,10 @@ _libssh2_wincng_dsa_free(libssh2_dsa_ctx *dsa)
return; return;
BCryptDestroyKey(dsa->hKey); BCryptDestroyKey(dsa->hKey);
dsa->hKey = NULL;
if (dsa->pbKeyObject) _libssh2_wincng_safe_free(dsa->pbKeyObject, dsa->cbKeyObject);
free(dsa->pbKeyObject); _libssh2_wincng_safe_free(dsa, sizeof(libssh2_dsa_ctx));
memset(dsa, 0, sizeof(libssh2_dsa_ctx));
free(dsa);
} }
#endif #endif
@@ -1430,7 +1439,7 @@ _libssh2_wincng_pub_priv_keyfile_parse(LIBSSH2_SESSION *session,
ret = _libssh2_wincng_asn_decode_bns(pbEncoded, cbEncoded, ret = _libssh2_wincng_asn_decode_bns(pbEncoded, cbEncoded,
&rpbDecoded, &rcbDecoded, &length); &rpbDecoded, &rcbDecoded, &length);
free(pbEncoded); _libssh2_wincng_safe_free(pbEncoded, cbEncoded);
if (ret) { if (ret) {
return -1; return -1;
@@ -1503,10 +1512,9 @@ _libssh2_wincng_pub_priv_keyfile_parse(LIBSSH2_SESSION *session,
for (index = 0; index < length; index++) { for (index = 0; index < length; index++) {
if (rpbDecoded[index]) { _libssh2_wincng_safe_free(rpbDecoded[index], rcbDecoded[index]);
free(rpbDecoded[index]);
rpbDecoded[index] = NULL; rpbDecoded[index] = NULL;
} rcbDecoded[index] = 0;
} }
free(rpbDecoded); free(rpbDecoded);
@@ -1667,10 +1675,10 @@ _libssh2_wincng_cipher_init(_libssh2_cipher_ctx *ctx,
ret = BCryptImportKey(*type.phAlg, NULL, BCRYPT_KEY_DATA_BLOB, &hKey, ret = BCryptImportKey(*type.phAlg, NULL, BCRYPT_KEY_DATA_BLOB, &hKey,
pbKeyObject, dwKeyObject, key, keylen, 0); pbKeyObject, dwKeyObject, key, keylen, 0);
free(key); _libssh2_wincng_safe_free(key, keylen);
if (!BCRYPT_SUCCESS(ret)) { if (!BCRYPT_SUCCESS(ret)) {
free(pbKeyObject); _libssh2_wincng_safe_free(pbKeyObject, dwKeyObject);
return -1; return -1;
} }
@@ -1678,7 +1686,7 @@ _libssh2_wincng_cipher_init(_libssh2_cipher_ctx *ctx,
pbIV = malloc(dwBlockLength); pbIV = malloc(dwBlockLength);
if (!pbIV) { if (!pbIV) {
BCryptDestroyKey(hKey); BCryptDestroyKey(hKey);
free(pbKeyObject); _libssh2_wincng_safe_free(pbKeyObject, dwKeyObject);
return -1; return -1;
} }
dwIV = dwBlockLength; dwIV = dwBlockLength;
@@ -1737,7 +1745,7 @@ _libssh2_wincng_cipher_crypt(_libssh2_cipher_ctx *ctx,
memcpy(block, pbOutput, cbOutput); memcpy(block, pbOutput, cbOutput);
} }
free(pbOutput); _libssh2_wincng_safe_free(pbOutput, cbOutput);
} else } else
ret = STATUS_NO_MEMORY; ret = STATUS_NO_MEMORY;
} }
@@ -1749,13 +1757,11 @@ void
_libssh2_wincng_cipher_dtor(_libssh2_cipher_ctx *ctx) _libssh2_wincng_cipher_dtor(_libssh2_cipher_ctx *ctx)
{ {
BCryptDestroyKey(ctx->hKey); BCryptDestroyKey(ctx->hKey);
ctx->hKey = NULL;
if (ctx->pbKeyObject) { _libssh2_wincng_safe_free(ctx->pbKeyObject, ctx->dwKeyObject);
free(ctx->pbKeyObject);
ctx->pbKeyObject = NULL; ctx->pbKeyObject = NULL;
} ctx->dwKeyObject = 0;
memset(ctx, 0, sizeof(_libssh2_cipher_ctx));
} }
@@ -1789,6 +1795,12 @@ _libssh2_wincng_bignum_resize(_libssh2_bn *bn, unsigned long length)
if (length == bn->length) if (length == bn->length)
return 0; return 0;
#ifdef LIBSSH2_CLEAR_MEMORY
if (bn->bignum && bn->length > 0 && length < bn->length) {
SecureZeroMemory(bn->bignum + length, bn->length - length);
}
#endif
bignum = realloc(bn->bignum, length); bignum = realloc(bn->bignum, length);
if (!bignum) if (!bignum)
return -1; return -1;
@@ -1896,7 +1908,7 @@ _libssh2_wincng_bignum_mod_exp(_libssh2_bn *r,
r->bignum, r->length, &offset, r->bignum, r->length, &offset,
BCRYPT_PAD_NONE); BCRYPT_PAD_NONE);
free(bignum); _libssh2_wincng_safe_free(bignum, length);
if (BCRYPT_SUCCESS(ret)) { if (BCRYPT_SUCCESS(ret)) {
_libssh2_wincng_bignum_resize(r, offset); _libssh2_wincng_bignum_resize(r, offset);
@@ -1910,7 +1922,7 @@ _libssh2_wincng_bignum_mod_exp(_libssh2_bn *r,
BCryptDestroyKey(hKey); BCryptDestroyKey(hKey);
} }
free(key); _libssh2_wincng_safe_free(key, keylen);
return BCRYPT_SUCCESS(ret) ? 0 : -1; return BCRYPT_SUCCESS(ret) ? 0 : -1;
} }
@@ -1988,6 +2000,10 @@ _libssh2_wincng_bignum_from_bin(_libssh2_bn *bn, unsigned long len,
if (offset > 0) { if (offset > 0) {
memmove(bn->bignum, bn->bignum + offset, length); memmove(bn->bignum, bn->bignum + offset, length);
#ifdef LIBSSH2_CLEAR_MEMORY
SecureZeroMemory(bn->bignum + length, offset);
#endif
bignum = realloc(bn->bignum, length); bignum = realloc(bn->bignum, length);
if (bignum) { if (bignum) {
bn->bignum = bignum; bn->bignum = bignum;
@@ -2009,11 +2025,11 @@ _libssh2_wincng_bignum_free(_libssh2_bn *bn)
{ {
if (bn) { if (bn) {
if (bn->bignum) { if (bn->bignum) {
free(bn->bignum); _libssh2_wincng_safe_free(bn->bignum, bn->length);
bn->bignum = NULL; bn->bignum = NULL;
} }
bn->length = 0; bn->length = 0;
free(bn); _libssh2_wincng_safe_free(bn, sizeof(_libssh2_bn));
} }
} }