[libvirt] [PATCH v2 09/23] util: use glib base64 encoding/decoding APIs
Daniel P. Berrangé
berrange at redhat.com
Mon Oct 7 17:14:11 UTC 2019
Replace use of the gnulib base64 module with glib's own base64 API family.
Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
---
bootstrap.conf | 1 -
configure.ac | 5 -----
src/conf/virsecretobj.c | 26 ++++----------------------
src/libvirt_private.syms | 1 -
src/libxl/libxl_conf.c | 3 +--
src/qemu/qemu_agent.c | 6 ++----
src/qemu/qemu_command.c | 5 ++---
src/qemu/qemu_domain.c | 8 +++-----
src/secret/secret_driver.c | 1 -
src/storage/storage_backend_rbd.c | 4 +---
src/util/virstring.c | 21 ---------------------
src/util/virstring.h | 2 --
tools/virsh-secret.c | 17 ++++-------------
13 files changed, 17 insertions(+), 83 deletions(-)
diff --git a/bootstrap.conf b/bootstrap.conf
index 7105ae2eeb..acb0e25a37 100644
--- a/bootstrap.conf
+++ b/bootstrap.conf
@@ -20,7 +20,6 @@
gnulib_modules='
accept
areadlink
-base64
bind
byteswap
c-ctype
diff --git a/configure.ac b/configure.ac
index 81f061f058..1782665835 100644
--- a/configure.ac
+++ b/configure.ac
@@ -911,11 +911,6 @@ test "x$lv_cv_static_analysis" = xyes && t=1
AC_DEFINE_UNQUOTED([STATIC_ANALYSIS], [$t],
[Define to 1 when performing static analysis.])
-# Some GNULIB base64 symbols clash with a kerberos library
-AC_DEFINE_UNQUOTED([isbase64],[libvirt_gl_isbase64],[Hack to avoid symbol clash])
-AC_DEFINE_UNQUOTED([base64_encode],[libvirt_gl_base64_encode],[Hack to avoid symbol clash])
-AC_DEFINE_UNQUOTED([base64_encode_alloc],[libvirt_gl_base64_encode_alloc],[Hack to avoid symbol clash])
-
AC_CONFIG_FILES([run],
[chmod +x,-w run])
AC_CONFIG_FILES([\
diff --git a/src/conf/virsecretobj.c b/src/conf/virsecretobj.c
index aeae82332b..5bd84d82ed 100644
--- a/src/conf/virsecretobj.c
+++ b/src/conf/virsecretobj.c
@@ -31,7 +31,6 @@
#include "virhash.h"
#include "virlog.h"
#include "virstring.h"
-#include "base64.h"
#define VIR_FROM_THIS VIR_FROM_SECRET
@@ -698,8 +697,7 @@ virSecretObjSaveData(virSecretObjPtr obj)
if (!obj->value)
return 0;
- if (!(base64 = virStringEncodeBase64(obj->value, obj->value_size)))
- return -1;
+ base64 = g_base64_encode(obj->value, obj->value_size);
if (virFileRewriteStr(obj->base64File, S_IRUSR | S_IWUSR, base64) < 0)
return -1;
@@ -825,8 +823,6 @@ virSecretLoadValue(virSecretObjPtr obj)
int ret = -1, fd = -1;
struct stat st;
g_autofree char *contents = NULL;
- char *value = NULL;
- size_t value_size;
if ((fd = open(obj->base64File, O_RDONLY)) == -1) {
if (errno == ENOENT) {
@@ -851,7 +847,7 @@ virSecretLoadValue(virSecretObjPtr obj)
goto cleanup;
}
- if (VIR_ALLOC_N(contents, st.st_size) < 0)
+ if (VIR_ALLOC_N(contents, st.st_size + 1) < 0)
goto cleanup;
if (saferead(fd, contents, st.st_size) != st.st_size) {
@@ -859,29 +855,15 @@ virSecretLoadValue(virSecretObjPtr obj)
obj->base64File);
goto cleanup;
}
+ contents[st.st_size] = '\0';
VIR_FORCE_CLOSE(fd);
- if (!base64_decode_alloc(contents, st.st_size, &value, &value_size)) {
- virReportError(VIR_ERR_INTERNAL_ERROR,
- _("invalid base64 in '%s'"),
- obj->base64File);
- goto cleanup;
- }
- if (value == NULL)
- goto cleanup;
-
- obj->value = (unsigned char *)value;
- value = NULL;
- obj->value_size = value_size;
+ obj->value = g_base64_decode(contents, &obj->value_size);
ret = 0;
cleanup:
- if (value != NULL) {
- memset(value, 0, value_size);
- VIR_FREE(value);
- }
if (contents != NULL)
memset(contents, 0, st.st_size);
VIR_FORCE_CLOSE(fd);
diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms
index eeab820eca..b27b20ecd0 100644
--- a/src/libvirt_private.syms
+++ b/src/libvirt_private.syms
@@ -3069,7 +3069,6 @@ virSkipSpacesBackwards;
virStrcpy;
virStrdup;
virStringBufferIsPrintable;
-virStringEncodeBase64;
virStringFilterChars;
virStringHasCaseSuffix;
virStringHasChars;
diff --git a/src/libxl/libxl_conf.c b/src/libxl/libxl_conf.c
index c76704a11d..de56567cf0 100644
--- a/src/libxl/libxl_conf.c
+++ b/src/libxl/libxl_conf.c
@@ -999,8 +999,7 @@ libxlMakeNetworkDiskSrc(virStorageSourcePtr src, char **srcstr)
goto cleanup;
/* RBD expects an encoded secret */
- if (!(base64secret = virStringEncodeBase64(secret, secretlen)))
- goto cleanup;
+ base64secret = g_base64_encode(secret, secretlen);
}
if (!(*srcstr = libxlMakeNetworkDiskSrcStr(src, username, base64secret)))
diff --git a/src/qemu/qemu_agent.c b/src/qemu/qemu_agent.c
index 34e1a85d64..0ef8b563f5 100644
--- a/src/qemu/qemu_agent.c
+++ b/src/qemu/qemu_agent.c
@@ -39,7 +39,6 @@
#include "virtime.h"
#include "virobject.h"
#include "virstring.h"
-#include "base64.h"
#include "virenum.h"
#define VIR_FROM_THIS VIR_FROM_QEMU
@@ -2518,9 +2517,8 @@ qemuAgentSetUserPassword(qemuAgentPtr mon,
virJSONValuePtr reply = NULL;
char *password64 = NULL;
- if (!(password64 = virStringEncodeBase64((unsigned char *)password,
- strlen(password))))
- goto cleanup;
+ password64 = g_base64_encode((unsigned char *)password,
+ strlen(password));
if (!(cmd = qemuAgentMakeCommand("guest-set-user-password",
"b:crypted", crypted,
diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c
index cbf25d5f07..f3151caefd 100644
--- a/src/qemu/qemu_command.c
+++ b/src/qemu/qemu_command.c
@@ -834,9 +834,8 @@ qemuBuildRBDSecinfoURI(virBufferPtr buf,
switch ((qemuDomainSecretInfoType) secinfo->type) {
case VIR_DOMAIN_SECRET_INFO_TYPE_PLAIN:
- if (!(base64secret = virStringEncodeBase64(secinfo->s.plain.secret,
- secinfo->s.plain.secretlen)))
- return -1;
+ base64secret = g_base64_encode(secinfo->s.plain.secret,
+ secinfo->s.plain.secretlen);
virBufferEscape(buf, '\\', ":", ":id=%s", secinfo->s.plain.username);
virBufferEscape(buf, '\\', ":",
":key=%s:auth_supported=cephx\\;none",
diff --git a/src/qemu/qemu_domain.c b/src/qemu/qemu_domain.c
index b4175a846e..1186eb61af 100644
--- a/src/qemu/qemu_domain.c
+++ b/src/qemu/qemu_domain.c
@@ -1470,8 +1470,7 @@ qemuDomainSecretAESSetup(qemuDomainObjPrivatePtr priv,
goto cleanup;
/* Encode the IV and save that since qemu will need it */
- if (!(secinfo->s.aes.iv = virStringEncodeBase64(raw_iv, ivlen)))
- goto cleanup;
+ secinfo->s.aes.iv = g_base64_encode(raw_iv, ivlen);
/* Grab the unencoded secret */
if (virSecretGetSecretString(conn, seclookupdef, usageType,
@@ -1488,9 +1487,8 @@ qemuDomainSecretAESSetup(qemuDomainObjPrivatePtr priv,
memset(secret, 0, secretlen);
/* Now encode the ciphertext and store to be passed to qemu */
- if (!(secinfo->s.aes.ciphertext = virStringEncodeBase64(ciphertext,
- ciphertextlen)))
- goto cleanup;
+ secinfo->s.aes.ciphertext = g_base64_encode(ciphertext,
+ ciphertextlen);
ret = 0;
diff --git a/src/secret/secret_driver.c b/src/secret/secret_driver.c
index ed3bd3c751..13f75ee4fa 100644
--- a/src/secret/secret_driver.c
+++ b/src/secret/secret_driver.c
@@ -25,7 +25,6 @@
#include <unistd.h>
#include "internal.h"
-#include "base64.h"
#include "datatypes.h"
#include "driver.h"
#include "virlog.h"
diff --git a/src/storage/storage_backend_rbd.c b/src/storage/storage_backend_rbd.c
index c4781debd8..b10ca1503d 100644
--- a/src/storage/storage_backend_rbd.c
+++ b/src/storage/storage_backend_rbd.c
@@ -28,7 +28,6 @@
#include "storage_conf.h"
#include "viralloc.h"
#include "virlog.h"
-#include "base64.h"
#include "viruuid.h"
#include "virstring.h"
#include "virrandom.h"
@@ -218,8 +217,7 @@ virStorageBackendRBDOpenRADOSConn(virStorageBackendRBDStatePtr ptr,
&secret_value, &secret_value_size) < 0)
goto cleanup;
- if (!(rados_key = virStringEncodeBase64(secret_value, secret_value_size)))
- goto cleanup;
+ rados_key = g_base64_encode(secret_value, secret_value_size);
if (virStorageBackendRBDRADOSConfSet(ptr->cluster,
"key", rados_key) < 0)
diff --git a/src/util/virstring.c b/src/util/virstring.c
index 6b2b6ed24e..0abdcd8b04 100644
--- a/src/util/virstring.c
+++ b/src/util/virstring.c
@@ -22,7 +22,6 @@
#include <regex.h>
#include <locale.h>
-#include "base64.h"
#include "c-ctype.h"
#include "virstring.h"
#include "virthread.h"
@@ -1438,26 +1437,6 @@ virStringBufferIsPrintable(const uint8_t *buf,
}
-/**
- * virStringEncodeBase64:
- * @buf: buffer of bytes to encode
- * @buflen: number of bytes to encode
- *
- * Encodes @buf to base 64 and returns the resulting string. The caller is
- * responsible for freeing the result.
- */
-char *
-virStringEncodeBase64(const uint8_t *buf, size_t buflen)
-{
- char *ret;
-
- base64_encode_alloc((const char *) buf, buflen, &ret);
- if (!ret)
- abort();
-
- return ret;
-}
-
/**
* virStringTrimOptionalNewline:
* @str: the string to modify in-place
diff --git a/src/util/virstring.h b/src/util/virstring.h
index 3ffe51f7b8..af6e234d83 100644
--- a/src/util/virstring.h
+++ b/src/util/virstring.h
@@ -291,8 +291,6 @@ void virStringFilterChars(char *str, const char *valid);
bool virStringIsPrintable(const char *str);
bool virStringBufferIsPrintable(const uint8_t *buf, size_t buflen);
-char *virStringEncodeBase64(const uint8_t *buf, size_t buflen);
-
void virStringTrimOptionalNewline(char *str);
int virStringParsePort(const char *str,
diff --git a/tools/virsh-secret.c b/tools/virsh-secret.c
index b34ae12bbe..48058bea05 100644
--- a/tools/virsh-secret.c
+++ b/tools/virsh-secret.c
@@ -22,7 +22,6 @@
#include "virsh-secret.h"
#include "internal.h"
-#include "base64.h"
#include "virbuffer.h"
#include "viralloc.h"
#include "virfile.h"
@@ -192,7 +191,7 @@ cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
virSecretPtr secret;
size_t value_size;
const char *base64 = NULL;
- char *value;
+ unsigned char *value;
int res;
bool ret = false;
@@ -202,16 +201,9 @@ cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
if (vshCommandOptStringReq(ctl, cmd, "base64", &base64) < 0)
goto cleanup;
- if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
- vshError(ctl, "%s", _("Invalid base64 data"));
- goto cleanup;
- }
- if (value == NULL) {
- vshError(ctl, "%s", _("Failed to allocate memory"));
- goto cleanup;
- }
+ value = g_base64_decode(base64, &value_size);
- res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
+ res = virSecretSetValue(secret, value, value_size, 0);
memset(value, 0, value_size);
VIR_FREE(value);
@@ -267,8 +259,7 @@ cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
if (value == NULL)
goto cleanup;
- if (!(base64 = virStringEncodeBase64(value, value_size)))
- goto cleanup;
+ base64 = g_base64_encode(value, value_size);
vshPrint(ctl, "%s", base64);
ret = true;
--
2.21.0
More information about the libvir-list
mailing list