mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-07-11 12:25:52 +00:00
secret: move virSecretGetSecretString into virsecret
The function virSecretGetSecretString calls into secret driver and is used from other hypervisors drivers and as such makes more sense in util. Signed-off-by: Pavel Hrdina <phrdina@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
parent
a7f3b901aa
commit
894556ca81
@ -190,7 +190,6 @@
|
|||||||
@SRCDIR@/src/rpc/virnetsshsession.c
|
@SRCDIR@/src/rpc/virnetsshsession.c
|
||||||
@SRCDIR@/src/rpc/virnettlscontext.c
|
@SRCDIR@/src/rpc/virnettlscontext.c
|
||||||
@SRCDIR@/src/secret/secret_driver.c
|
@SRCDIR@/src/secret/secret_driver.c
|
||||||
@SRCDIR@/src/secret/secret_util.c
|
|
||||||
@SRCDIR@/src/security/security_apparmor.c
|
@SRCDIR@/src/security/security_apparmor.c
|
||||||
@SRCDIR@/src/security/security_dac.c
|
@SRCDIR@/src/security/security_dac.c
|
||||||
@SRCDIR@/src/security/security_driver.c
|
@SRCDIR@/src/security/security_driver.c
|
||||||
|
@ -1448,10 +1448,6 @@ virLogManagerFree;
|
|||||||
virLogManagerNew;
|
virLogManagerNew;
|
||||||
|
|
||||||
|
|
||||||
# secret/secret_util.h
|
|
||||||
virSecretGetSecretString;
|
|
||||||
|
|
||||||
|
|
||||||
# security/security_driver.h
|
# security/security_driver.h
|
||||||
virSecurityDriverLookup;
|
virSecurityDriverLookup;
|
||||||
|
|
||||||
@ -3001,6 +2997,7 @@ virSecurityLabelDefNew;
|
|||||||
|
|
||||||
|
|
||||||
# util/virsecret.h
|
# util/virsecret.h
|
||||||
|
virSecretGetSecretString;
|
||||||
virSecretLookupDefClear;
|
virSecretLookupDefClear;
|
||||||
virSecretLookupDefCopy;
|
virSecretLookupDefCopy;
|
||||||
virSecretLookupFormatSecret;
|
virSecretLookupFormatSecret;
|
||||||
|
@ -41,7 +41,7 @@
|
|||||||
#include "libxl_conf.h"
|
#include "libxl_conf.h"
|
||||||
#include "libxl_utils.h"
|
#include "libxl_utils.h"
|
||||||
#include "virstoragefile.h"
|
#include "virstoragefile.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
#include "cpu/cpu.h"
|
#include "cpu/cpu.h"
|
||||||
#include "xen_common.h"
|
#include "xen_common.h"
|
||||||
#include "xen_xl.h"
|
#include "xen_xl.h"
|
||||||
|
@ -56,7 +56,7 @@
|
|||||||
#include "vircrypto.h"
|
#include "vircrypto.h"
|
||||||
#include "virrandom.h"
|
#include "virrandom.h"
|
||||||
#include "virsystemd.h"
|
#include "virsystemd.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
#include "logging/log_manager.h"
|
#include "logging/log_manager.h"
|
||||||
#include "locking/domain_lock.h"
|
#include "locking/domain_lock.h"
|
||||||
#include "virdomainsnapshotobjlist.h"
|
#include "virdomainsnapshotobjlist.h"
|
||||||
|
@ -83,7 +83,7 @@
|
|||||||
#include "virnuma.h"
|
#include "virnuma.h"
|
||||||
#include "virstring.h"
|
#include "virstring.h"
|
||||||
#include "virhostdev.h"
|
#include "virhostdev.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
#include "configmake.h"
|
#include "configmake.h"
|
||||||
#include "nwfilter_conf.h"
|
#include "nwfilter_conf.h"
|
||||||
#include "netdev_bandwidth_conf.h"
|
#include "netdev_bandwidth_conf.h"
|
||||||
|
@ -42,7 +42,7 @@
|
|||||||
#include "configmake.h"
|
#include "configmake.h"
|
||||||
#include "qemu_tpm.h"
|
#include "qemu_tpm.h"
|
||||||
#include "virtpm.h"
|
#include "virtpm.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
|
|
||||||
#define VIR_FROM_THIS VIR_FROM_NONE
|
#define VIR_FROM_THIS VIR_FROM_NONE
|
||||||
|
|
||||||
|
@ -5,11 +5,6 @@ SECRET_DRIVER_SOURCES = \
|
|||||||
secret/secret_driver.c \
|
secret/secret_driver.c \
|
||||||
$(NULL)
|
$(NULL)
|
||||||
|
|
||||||
SECRET_UTIL_SOURCES = \
|
|
||||||
secret/secret_util.h \
|
|
||||||
secret/secret_util.c \
|
|
||||||
$(NULL)
|
|
||||||
|
|
||||||
|
|
||||||
DRIVER_SOURCE_FILES += $(addprefix $(srcdir)/,$(SECRET_DRIVER_SOURCES))
|
DRIVER_SOURCE_FILES += $(addprefix $(srcdir)/,$(SECRET_DRIVER_SOURCES))
|
||||||
STATEFUL_DRIVER_SOURCE_FILES += \
|
STATEFUL_DRIVER_SOURCE_FILES += \
|
||||||
@ -17,14 +12,8 @@ STATEFUL_DRIVER_SOURCE_FILES += \
|
|||||||
|
|
||||||
EXTRA_DIST += \
|
EXTRA_DIST += \
|
||||||
$(SECRET_DRIVER_SOURCES) \
|
$(SECRET_DRIVER_SOURCES) \
|
||||||
$(SECRET_UTIL_SOURCES) \
|
|
||||||
$(NULL)
|
$(NULL)
|
||||||
|
|
||||||
noinst_LTLIBRARIES += libvirt_secret.la
|
|
||||||
libvirt_la_BUILT_LIBADD += libvirt_secret.la
|
|
||||||
libvirt_secret_la_CFLAGS = $(AM_CFLAGS)
|
|
||||||
libvirt_secret_la_LDFLAGS = $(AM_LDFLAGS)
|
|
||||||
libvirt_secret_la_SOURCES = $(SECRET_UTIL_SOURCES)
|
|
||||||
|
|
||||||
if WITH_SECRETS
|
if WITH_SECRETS
|
||||||
mod_LTLIBRARIES += libvirt_driver_secret.la
|
mod_LTLIBRARIES += libvirt_driver_secret.la
|
||||||
|
@ -1,102 +0,0 @@
|
|||||||
/*
|
|
||||||
* secret_util.c: secret related utility functions
|
|
||||||
*
|
|
||||||
* Copyright (C) 2016 Red Hat, Inc.
|
|
||||||
*
|
|
||||||
* This library is free software; you can redistribute it and/or
|
|
||||||
* modify it under the terms of the GNU Lesser General Public
|
|
||||||
* License as published by the Free Software Foundation; either
|
|
||||||
* version 2.1 of the License, or (at your option) any later version.
|
|
||||||
*
|
|
||||||
* This library is distributed in the hope that it will be useful,
|
|
||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
* Lesser General Public License for more details.
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU Lesser General Public
|
|
||||||
* License along with this library. If not, see
|
|
||||||
* <http://www.gnu.org/licenses/>.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <config.h>
|
|
||||||
|
|
||||||
#include "secret_util.h"
|
|
||||||
#include "viralloc.h"
|
|
||||||
#include "virerror.h"
|
|
||||||
#include "virlog.h"
|
|
||||||
#include "virobject.h"
|
|
||||||
#include "viruuid.h"
|
|
||||||
#include "datatypes.h"
|
|
||||||
|
|
||||||
#define VIR_FROM_THIS VIR_FROM_SECRET
|
|
||||||
|
|
||||||
VIR_LOG_INIT("secret.secret_util");
|
|
||||||
|
|
||||||
|
|
||||||
/* virSecretGetSecretString:
|
|
||||||
* @conn: Pointer to the connection driver to make secret driver call
|
|
||||||
* @seclookupdef: Secret lookup def
|
|
||||||
* @secretUsageType: Type of secret usage for usage lookup
|
|
||||||
* @secret: returned secret as a sized stream of unsigned chars
|
|
||||||
* @secret_size: Return size of the secret - either raw text or base64
|
|
||||||
*
|
|
||||||
* Lookup the secret for the usage type and return it as raw text.
|
|
||||||
* It is up to the caller to encode the secret further.
|
|
||||||
*
|
|
||||||
* Returns 0 on success, -1 on failure. On success the memory in secret
|
|
||||||
* needs to be cleared and free'd after usage.
|
|
||||||
*/
|
|
||||||
int
|
|
||||||
virSecretGetSecretString(virConnectPtr conn,
|
|
||||||
virSecretLookupTypeDefPtr seclookupdef,
|
|
||||||
virSecretUsageType secretUsageType,
|
|
||||||
uint8_t **secret,
|
|
||||||
size_t *secret_size)
|
|
||||||
{
|
|
||||||
virSecretPtr sec = NULL;
|
|
||||||
int ret = -1;
|
|
||||||
|
|
||||||
switch (seclookupdef->type) {
|
|
||||||
case VIR_SECRET_LOOKUP_TYPE_UUID:
|
|
||||||
sec = conn->secretDriver->secretLookupByUUID(conn, seclookupdef->u.uuid);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case VIR_SECRET_LOOKUP_TYPE_USAGE:
|
|
||||||
sec = conn->secretDriver->secretLookupByUsage(conn, secretUsageType,
|
|
||||||
seclookupdef->u.usage);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!sec)
|
|
||||||
goto cleanup;
|
|
||||||
|
|
||||||
/* NB: NONE is a byproduct of the qemuxml2argvtest test mocking
|
|
||||||
* for UUID lookups. Normal secret XML processing would fail if
|
|
||||||
* the usage type was NONE and since we have no way to set the
|
|
||||||
* expected usage in that environment, let's just accept NONE */
|
|
||||||
if (sec->usageType != VIR_SECRET_USAGE_TYPE_NONE &&
|
|
||||||
sec->usageType != secretUsageType) {
|
|
||||||
char uuidstr[VIR_UUID_STRING_BUFLEN];
|
|
||||||
|
|
||||||
virUUIDFormat(seclookupdef->u.uuid, uuidstr);
|
|
||||||
virReportError(VIR_ERR_INVALID_ARG,
|
|
||||||
_("secret with uuid %s is of type '%s' not "
|
|
||||||
"expected '%s' type"),
|
|
||||||
uuidstr, virSecretUsageTypeToString(sec->usageType),
|
|
||||||
virSecretUsageTypeToString(secretUsageType));
|
|
||||||
goto cleanup;
|
|
||||||
}
|
|
||||||
|
|
||||||
*secret = conn->secretDriver->secretGetValue(sec, secret_size, 0,
|
|
||||||
VIR_SECRET_GET_VALUE_INTERNAL_CALL);
|
|
||||||
|
|
||||||
if (!*secret)
|
|
||||||
goto cleanup;
|
|
||||||
|
|
||||||
ret = 0;
|
|
||||||
|
|
||||||
cleanup:
|
|
||||||
virObjectUnref(sec);
|
|
||||||
return ret;
|
|
||||||
}
|
|
@ -1,33 +0,0 @@
|
|||||||
/*
|
|
||||||
* secret_util.h: secret related utility functions
|
|
||||||
*
|
|
||||||
* Copyright (C) 2016 Red Hat, Inc.
|
|
||||||
*
|
|
||||||
* This library is free software; you can redistribute it and/or
|
|
||||||
* modify it under the terms of the GNU Lesser General Public
|
|
||||||
* License as published by the Free Software Foundation; either
|
|
||||||
* version 2.1 of the License, or (at your option) any later version.
|
|
||||||
*
|
|
||||||
* This library is distributed in the hope that it will be useful,
|
|
||||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
* Lesser General Public License for more details.
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU Lesser General Public
|
|
||||||
* License along with this library. If not, see
|
|
||||||
* <http://www.gnu.org/licenses/>.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#include "internal.h"
|
|
||||||
#include "virsecret.h"
|
|
||||||
|
|
||||||
int virSecretGetSecretString(virConnectPtr conn,
|
|
||||||
virSecretLookupTypeDefPtr seclookupdef,
|
|
||||||
virSecretUsageType secretUsageType,
|
|
||||||
uint8_t **ret_secret,
|
|
||||||
size_t *ret_secret_size)
|
|
||||||
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(4)
|
|
||||||
ATTRIBUTE_NONNULL(5) G_GNUC_WARN_UNUSED_RESULT;
|
|
@ -39,7 +39,7 @@
|
|||||||
#include "virobject.h"
|
#include "virobject.h"
|
||||||
#include "virstring.h"
|
#include "virstring.h"
|
||||||
#include "viruuid.h"
|
#include "viruuid.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
#include "storage_util.h"
|
#include "storage_util.h"
|
||||||
|
|
||||||
#define VIR_FROM_THIS VIR_FROM_STORAGE
|
#define VIR_FROM_THIS VIR_FROM_STORAGE
|
||||||
|
@ -24,7 +24,7 @@
|
|||||||
#include <iscsi/scsi-lowlevel.h>
|
#include <iscsi/scsi-lowlevel.h>
|
||||||
|
|
||||||
#include "datatypes.h"
|
#include "datatypes.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
#include "storage_backend_iscsi_direct.h"
|
#include "storage_backend_iscsi_direct.h"
|
||||||
#include "storage_util.h"
|
#include "storage_util.h"
|
||||||
#include "viralloc.h"
|
#include "viralloc.h"
|
||||||
|
@ -33,7 +33,7 @@
|
|||||||
#include "virrandom.h"
|
#include "virrandom.h"
|
||||||
#include "rados/librados.h"
|
#include "rados/librados.h"
|
||||||
#include "rbd/librbd.h"
|
#include "rbd/librbd.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
#include "storage_util.h"
|
#include "storage_util.h"
|
||||||
|
|
||||||
#define VIR_FROM_THIS VIR_FROM_STORAGE
|
#define VIR_FROM_THIS VIR_FROM_STORAGE
|
||||||
|
@ -62,7 +62,7 @@
|
|||||||
#include "viralloc.h"
|
#include "viralloc.h"
|
||||||
#include "internal.h"
|
#include "internal.h"
|
||||||
#include "secret_conf.h"
|
#include "secret_conf.h"
|
||||||
#include "secret_util.h"
|
#include "virsecret.h"
|
||||||
#include "vircrypto.h"
|
#include "vircrypto.h"
|
||||||
#include "viruuid.h"
|
#include "viruuid.h"
|
||||||
#include "virstoragefile.h"
|
#include "virstoragefile.h"
|
||||||
|
@ -21,6 +21,7 @@
|
|||||||
|
|
||||||
#include <config.h>
|
#include <config.h>
|
||||||
|
|
||||||
|
#include "datatypes.h"
|
||||||
#include "viralloc.h"
|
#include "viralloc.h"
|
||||||
#include "virerror.h"
|
#include "virerror.h"
|
||||||
#include "virlog.h"
|
#include "virlog.h"
|
||||||
@ -125,3 +126,71 @@ virSecretLookupFormatSecret(virBufferPtr buf,
|
|||||||
virBufferAddLit(buf, "/>\n");
|
virBufferAddLit(buf, "/>\n");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* virSecretGetSecretString:
|
||||||
|
* @conn: Pointer to the connection driver to make secret driver call
|
||||||
|
* @seclookupdef: Secret lookup def
|
||||||
|
* @secretUsageType: Type of secret usage for usage lookup
|
||||||
|
* @secret: returned secret as a sized stream of unsigned chars
|
||||||
|
* @secret_size: Return size of the secret - either raw text or base64
|
||||||
|
*
|
||||||
|
* Lookup the secret for the usage type and return it as raw text.
|
||||||
|
* It is up to the caller to encode the secret further.
|
||||||
|
*
|
||||||
|
* Returns 0 on success, -1 on failure. On success the memory in secret
|
||||||
|
* needs to be cleared and free'd after usage.
|
||||||
|
*/
|
||||||
|
int
|
||||||
|
virSecretGetSecretString(virConnectPtr conn,
|
||||||
|
virSecretLookupTypeDefPtr seclookupdef,
|
||||||
|
virSecretUsageType secretUsageType,
|
||||||
|
uint8_t **secret,
|
||||||
|
size_t *secret_size)
|
||||||
|
{
|
||||||
|
virSecretPtr sec = NULL;
|
||||||
|
int ret = -1;
|
||||||
|
|
||||||
|
switch (seclookupdef->type) {
|
||||||
|
case VIR_SECRET_LOOKUP_TYPE_UUID:
|
||||||
|
sec = conn->secretDriver->secretLookupByUUID(conn, seclookupdef->u.uuid);
|
||||||
|
break;
|
||||||
|
|
||||||
|
case VIR_SECRET_LOOKUP_TYPE_USAGE:
|
||||||
|
sec = conn->secretDriver->secretLookupByUsage(conn, secretUsageType,
|
||||||
|
seclookupdef->u.usage);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!sec)
|
||||||
|
goto cleanup;
|
||||||
|
|
||||||
|
/* NB: NONE is a byproduct of the qemuxml2argvtest test mocking
|
||||||
|
* for UUID lookups. Normal secret XML processing would fail if
|
||||||
|
* the usage type was NONE and since we have no way to set the
|
||||||
|
* expected usage in that environment, let's just accept NONE */
|
||||||
|
if (sec->usageType != VIR_SECRET_USAGE_TYPE_NONE &&
|
||||||
|
sec->usageType != secretUsageType) {
|
||||||
|
char uuidstr[VIR_UUID_STRING_BUFLEN];
|
||||||
|
|
||||||
|
virUUIDFormat(seclookupdef->u.uuid, uuidstr);
|
||||||
|
virReportError(VIR_ERR_INVALID_ARG,
|
||||||
|
_("secret with uuid %s is of type '%s' not "
|
||||||
|
"expected '%s' type"),
|
||||||
|
uuidstr, virSecretUsageTypeToString(sec->usageType),
|
||||||
|
virSecretUsageTypeToString(secretUsageType));
|
||||||
|
goto cleanup;
|
||||||
|
}
|
||||||
|
|
||||||
|
*secret = conn->secretDriver->secretGetValue(sec, secret_size, 0,
|
||||||
|
VIR_SECRET_GET_VALUE_INTERNAL_CALL);
|
||||||
|
|
||||||
|
if (!*secret)
|
||||||
|
goto cleanup;
|
||||||
|
|
||||||
|
ret = 0;
|
||||||
|
|
||||||
|
cleanup:
|
||||||
|
virObjectUnref(sec);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
@ -56,3 +56,11 @@ int virSecretLookupParseSecret(xmlNodePtr secretnode,
|
|||||||
void virSecretLookupFormatSecret(virBufferPtr buf,
|
void virSecretLookupFormatSecret(virBufferPtr buf,
|
||||||
const char *secrettype,
|
const char *secrettype,
|
||||||
virSecretLookupTypeDefPtr def);
|
virSecretLookupTypeDefPtr def);
|
||||||
|
|
||||||
|
int virSecretGetSecretString(virConnectPtr conn,
|
||||||
|
virSecretLookupTypeDefPtr seclookupdef,
|
||||||
|
virSecretUsageType secretUsageType,
|
||||||
|
uint8_t **ret_secret,
|
||||||
|
size_t *ret_secret_size)
|
||||||
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(4)
|
||||||
|
ATTRIBUTE_NONNULL(5) G_GNUC_WARN_UNUSED_RESULT;
|
||||||
|
Loading…
Reference in New Issue
Block a user