list: Define new API virConnectListAllSecrets

This is to list the secret objects. Supports to filter the secrets
by its storage location, and whether it's private or not.

include/libvirt/libvirt.h.in: Declare enum virConnectListAllSecretFlags
                              and virConnectListAllSecrets.
python/generator.py: Skip auto-generating
src/driver.h: (virDrvConnectListAllSecrets)
src/libvirt.c: Implement the public API
src/libvirt_public.syms: Export the symbol to public
This commit is contained in:
Osier Yang 2012-09-14 16:38:48 +08:00
parent 9b096843cb
commit 7a236982fe
5 changed files with 95 additions and 0 deletions

View File

@ -3249,6 +3249,27 @@ int virConnectNumOfSecrets (virConnectPtr conn);
int virConnectListSecrets (virConnectPtr conn, int virConnectListSecrets (virConnectPtr conn,
char **uuids, char **uuids,
int maxuuids); int maxuuids);
/*
* virConnectListAllSecrets:
*
* Flags used to filter the returned secrets. Flags in each group
* are exclusive attributes of a secret.
*/
typedef enum {
VIR_CONNECT_LIST_SECRETS_EPHEMERAL = 1 << 0, /* kept in memory, never
stored persistently */
VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1,
VIR_CONNECT_LIST_SECRETS_PRIVATE = 1 << 2, /* not revealed to any caller
of libvirt, nor to any other
node */
VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3,
} virConnectListAllSecretsFlags;
int virConnectListAllSecrets(virConnectPtr conn,
virSecretPtr **secrets,
unsigned int flags);
virSecretPtr virSecretLookupByUUID(virConnectPtr conn, virSecretPtr virSecretLookupByUUID(virConnectPtr conn,
const unsigned char *uuid); const unsigned char *uuid);
virSecretPtr virSecretLookupByUUIDString(virConnectPtr conn, virSecretPtr virSecretLookupByUUIDString(virConnectPtr conn,

View File

@ -466,6 +466,7 @@ skip_function = (
'virConnectListAllInterfaces', # overridden in virConnect.py 'virConnectListAllInterfaces', # overridden in virConnect.py
'virConnectListAllNodeDevices', # overridden in virConnect.py 'virConnectListAllNodeDevices', # overridden in virConnect.py
'virConnectListAllNWFilters', # overridden in virConnect.py 'virConnectListAllNWFilters', # overridden in virConnect.py
'virConnectListAllSecrets', # overridden in virConnect.py
'virStreamRecvAll', # Pure python libvirt-override-virStream.py 'virStreamRecvAll', # Pure python libvirt-override-virStream.py
'virStreamSendAll', # Pure python libvirt-override-virStream.py 'virStreamSendAll', # Pure python libvirt-override-virStream.py

View File

@ -1567,6 +1567,10 @@ typedef int
(*virDrvListSecrets) (virConnectPtr conn, (*virDrvListSecrets) (virConnectPtr conn,
char **uuids, char **uuids,
int maxuuids); int maxuuids);
typedef int
(*virDrvListAllSecrets) (virConnectPtr conn,
virSecretPtr **secrets,
unsigned int flags);
typedef struct _virSecretDriver virSecretDriver; typedef struct _virSecretDriver virSecretDriver;
typedef virSecretDriver *virSecretDriverPtr; typedef virSecretDriver *virSecretDriverPtr;
@ -1588,6 +1592,7 @@ struct _virSecretDriver {
virDrvNumOfSecrets numOfSecrets; virDrvNumOfSecrets numOfSecrets;
virDrvListSecrets listSecrets; virDrvListSecrets listSecrets;
virDrvListAllSecrets listAllSecrets;
virDrvSecretLookupByUUID lookupByUUID; virDrvSecretLookupByUUID lookupByUUID;
virDrvSecretLookupByUsage lookupByUsage; virDrvSecretLookupByUsage lookupByUsage;
virDrvSecretDefineXML defineXML; virDrvSecretDefineXML defineXML;

View File

@ -14593,6 +14593,73 @@ error:
return -1; return -1;
} }
/**
* virConnectListAllSecrets:
* @conn: Pointer to the hypervisor connection.
* @secrets: Pointer to a variable to store the array containing the secret
* objects or NULL if the list is not required (just returns the
* number of secrets).
* @flags: extra flags; not used yet, so callers should always pass 0
*
* Collect the list of secrets, and allocate an array to store those
* objects.
*
* Normally, all secrets are returned; however, @flags can be used to
* filter the results for a smaller list of targeted secrets. The valid
* flags are divided into groups, where each group contains bits that
* describe mutually exclusive attributes of a secret, and where all bits
* within a group describe all possible secrets.
*
* The first group of @flags is used to filter secrets by its storage
* location. Flag VIR_CONNECT_LIST_SECRETS_EPHEMERAL selects secrets that
* are kept only in memory. Flag VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL
* selects secrets that are kept in persistent storage.
*
* The second group of @flags is used to filter secrets by privacy. Flag
* VIR_CONNECT_LIST_SECRETS_PRIVATE seclets secrets that are never revealed
* to any caller of libvirt nor to any other node. Flag
* VIR_CONNECT_LIST_SECRETS_NO_PRIVATE selects non-private secrets.
*
* Returns the number of secrets found or -1 and sets @secrets to NULL in case
* of error. On success, the array stored into @secrets is guaranteed to
* have an extra allocated element set to NULL but not included in the return count,
* to make iteration easier. The caller is responsible for calling
* virSecretFree() on each array element, then calling free() on @secrets.
*/
int
virConnectListAllSecrets(virConnectPtr conn,
virSecretPtr **secrets,
unsigned int flags)
{
VIR_DEBUG("conn=%p, secrets=%p, flags=%x", conn, secrets, flags);
virResetLastError();
if (secrets)
*secrets = NULL;
if (!VIR_IS_CONNECT(conn)) {
virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
virDispatchError(NULL);
return -1;
}
if (conn->secretDriver &&
conn->secretDriver->listAllSecrets) {
int ret;
ret = conn->secretDriver->listAllSecrets(conn, secrets, flags);
if (ret < 0)
goto error;
return ret;
}
virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
virDispatchError(conn);
return -1;
}
/** /**
* virConnectListSecrets: * virConnectListSecrets:
* @conn: virConnect connection * @conn: virConnect connection

View File

@ -560,6 +560,7 @@ LIBVIRT_0.10.2 {
virConnectListAllNetworks; virConnectListAllNetworks;
virConnectListAllNodeDevices; virConnectListAllNodeDevices;
virConnectListAllNWFilters; virConnectListAllNWFilters;
virConnectListAllSecrets;
virConnectListAllStoragePools; virConnectListAllStoragePools;
virStoragePoolListAllVolumes; virStoragePoolListAllVolumes;
} LIBVIRT_0.10.0; } LIBVIRT_0.10.0;