conf: Add new secret type "passphrase"

Add a new secret type known as "passphrase" - it will handle adding the
secret objects that need a passphrase without a specific username.

The format is:

   <secret ...>
     <uuid>...</uuid>
     ...
     <usage type='passphrase'>
       <name>mumblyfratz</name>
     </usage>
   </secret>

Signed-off-by: John Ferlan <jferlan@redhat.com>

diff --git a/docs/aclpolkit.html.in b/docs/aclpolkit.html.in
index dae0814a828d92db34748bca84e0aae05174d7c3..4d0307d0d7dff9b81913c145270fd49db3129b33 100644 (file)
--- a/docs/aclpolkit.html.in
+++ b/docs/aclpolkit.html.in
@@ -224,6 +224,10 @@
           <td>secret_usage_target</td>
           <td>Name of the associated iSCSI target, if any</td>
         </tr>
+        <tr>
+          <td>secret_usage_name</td>
+          <td>Name of be associated passphrase secret, if any</td>
+        </tr>
       </tbody>
     </table>
 

diff --git a/docs/formatsecret.html.in b/docs/formatsecret.html.in
index c39d2a73d4ba9a9d1ba487aa83e8b0d9f667f6cc..f03d90ca691a2a89f5fc064a5632519b934103b2 100644 (file)
--- a/docs/formatsecret.html.in
+++ b/docs/formatsecret.html.in
@@ -41,8 +41,9 @@
       <dd>
         Specifies what this secret is used for.  A mandatory
         <code>type</code> attribute specifies the usage category, currently
-        only <code>volume</code>, <code>ceph</code> and <code>iscsi</code>
-        are defined. Specific usage categories are described below.
+        only <code>volume</code>, <code>ceph</code>, <code>iscsi</code>,
+        and <code>passphrase</code> are defined. Specific usage categories
+        are described below.
       </dd>
     </dl>
 
@@ -241,5 +242,57 @@
         &lt;secret usage='libvirtiscsi'/&gt;
       &lt;/auth&gt;
     </pre>
+
+    <h3><a name="passphraseUsageType">Usage type "passphrase"</a></h3>
+
+    <p>
+      This secret is a general purpose secret to be used by various libvirt
+      objects to provide a single passphrase as required by the object in
+      order to perform its authentication.
+      <span class="since">Since 2.1.0</span>. The following is an example
+      of a secret.xml file:
+    </p>
+
+    <pre>
+      # cat secret.xml
+      &lt;secret ephemeral='no' private='yes'&gt;
+         &lt;description&gt;sample passphrase secret&lt;/description&gt;
+         &lt;usage type='passphrase'&gt;
+            &lt;name&gt;name_example&lt;/name&gt;
+         &lt;/usage&gt;
+      &lt;/secret&gt;
+
+      # virsh secret-define secret.xml
+      Secret 718c71bd-67b5-4a2b-87ec-a24e8ca200dc created
+
+      # virsh secret-list
+       UUID                                 Usage
+      -----------------------------------------------------------
+       718c71bd-67b5-4a2b-87ec-a24e8ca200dc  passphrase  name_example
+      #
+
+    </pre>
+
+    <p>
+      A secret may also be defined via the
+      <a href="html/libvirt-libvirt-secret.html#virSecretDefineXML">
+       <code>virSecretDefineXML</code></a> API.
+
+      Once the secret is defined, a secret value will need to be set. This
+      value would be the same used to create and use the volume.
+      The following is a simple example of using
+      <code>virsh secret-set-value</code> to set the secret value. The
+      <a href="html/libvirt-libvirt-secret.html#virSecretSetValue">
+      <code>virSecretSetValue</code></a> API may also be used to set
+      a more secure secret without using printable/readable characters.
+    </p>
+
+    <pre>
+      # MYSECRET=`printf %s "letmein" | base64`
+      # virsh secret-set-value 718c71bd-67b5-4a2b-87ec-a24e8ca200dc $MYSECRET
+      Secret value set
+
+    </pre>
+
   </body>
 </html>

diff --git a/docs/schemas/secret.rng b/docs/schemas/secret.rng
index e21e7003253d8ab75ef40720039384fd32bf1fcd..cac8560fe87dc768c2562916465707b51065524d 100644 (file)
--- a/docs/schemas/secret.rng
+++ b/docs/schemas/secret.rng
@@ -36,6 +36,7 @@
               <ref name='usagevolume'/>
               <ref name='usageceph'/>
               <ref name='usageiscsi'/>
+              <ref name='usagepassphrase'/>
               <!-- More choices later -->
             </choice>
           </element>
@@ -71,4 +72,13 @@
     </element>
   </define>
 
+  <define name='usagepassphrase'>
+    <attribute name='type'>
+      <value>passphrase</value>
+    </attribute>
+    <element name='name'>
+      <ref name='genericName'/>
+    </element>
+  </define>
+
 </grammar>

diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h
index 3e5cdf621ccb5d73b302cb15a062a7f398650ed7..55b11e05f0b276cc4729355ced5309809384a863 100644 (file)
--- a/include/libvirt/libvirt-secret.h
+++ b/include/libvirt/libvirt-secret.h
@@ -4,7 +4,7 @@
  * Description: Provides APIs for the management of secrets
  * Author: Daniel Veillard <veillard@redhat.com>
  *
- * Copyright (C) 2006-2014 Red Hat, Inc.
+ * Copyright (C) 2006-2014, 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
@@ -43,6 +43,7 @@ typedef enum {
     VIR_SECRET_USAGE_TYPE_VOLUME = 1,
     VIR_SECRET_USAGE_TYPE_CEPH = 2,
     VIR_SECRET_USAGE_TYPE_ISCSI = 3,
+    VIR_SECRET_USAGE_TYPE_PASSPHRASE = 4,
 
 # ifdef VIR_ENUM_SENTINELS
     VIR_SECRET_USAGE_TYPE_LAST

diff --git a/src/access/viraccessdriverpolkit.c b/src/access/viraccessdriverpolkit.c
index 89bc8908f234d2424b360f76dcd39f229a615949..99b867f9e827715b1d06bdadbb67e6863ff6e9f7 100644 (file)
--- a/src/access/viraccessdriverpolkit.c
+++ b/src/access/viraccessdriverpolkit.c
@@ -338,6 +338,19 @@ virAccessDriverPolkitCheckSecret(virAccessManagerPtr manager,
                                           virAccessPermSecretTypeToString(perm),
                                           attrs);
     }   break;
+    case VIR_SECRET_USAGE_TYPE_PASSPHRASE: {
+        const char *attrs[] = {
+            "connect_driver", driverName,
+            "secret_uuid", uuidstr,
+            "secret_usage_name", secret->usage.name,
+            NULL,
+        };
+
+        return virAccessDriverPolkitCheck(manager,
+                                          "secret",
+                                          virAccessPermSecretTypeToString(perm),
+                                          attrs);
+    }   break;
     }
 }
 

diff --git a/src/conf/secret_conf.c b/src/conf/secret_conf.c
index d510645496b9e0e272f6c5d3fdf04958745fb000..a973aa9199e99747d32ee1307467e148ffc72cde 100644 (file)
--- a/src/conf/secret_conf.c
+++ b/src/conf/secret_conf.c
@@ -29,6 +29,7 @@
 #include "viralloc.h"
 #include "secret_conf.h"
 #include "virsecretobj.h"
+#include "virstring.h"
 #include "virerror.h"
 #include "virxml.h"
 #include "viruuid.h"
@@ -38,7 +39,7 @@
 VIR_LOG_INIT("conf.secret_conf");
 
 VIR_ENUM_IMPL(virSecretUsage, VIR_SECRET_USAGE_TYPE_LAST,
-              "none", "volume", "ceph", "iscsi")
+              "none", "volume", "ceph", "iscsi", "passphrase")
 
 const char *
 virSecretUsageIDForDef(virSecretDefPtr def)
@@ -56,6 +57,9 @@ virSecretUsageIDForDef(virSecretDefPtr def)
     case VIR_SECRET_USAGE_TYPE_ISCSI:
         return def->usage.target;
 
+    case VIR_SECRET_USAGE_TYPE_PASSPHRASE:
+        return def->usage.name;
+
     default:
         return NULL;
     }
@@ -85,6 +89,10 @@ virSecretDefFree(virSecretDefPtr def)
         VIR_FREE(def->usage.target);
         break;
 
+    case VIR_SECRET_USAGE_TYPE_PASSPHRASE:
+        VIR_FREE(def->usage.name);
+        break;
+
     default:
         VIR_ERROR(_("unexpected secret usage type %d"), def->usage_type);
         break;
@@ -145,6 +153,14 @@ virSecretDefParseUsage(xmlXPathContextPtr ctxt,
         }
         break;
 
+    case VIR_SECRET_USAGE_TYPE_PASSPHRASE:
+        if (!(def->usage.name = virXPathString("string(./usage/name)", ctxt))) {
+            virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
+                           _("passphrase usage specified, but name is missing"));
+            return -1;
+        }
+        break;
+
     default:
         virReportError(VIR_ERR_INTERNAL_ERROR,
                        _("unexpected secret usage type %d"),
@@ -297,6 +313,10 @@ virSecretDefFormatUsage(virBufferPtr buf,
         virBufferEscapeString(buf, "<target>%s</target>\n", def->usage.target);
         break;
 
+    case VIR_SECRET_USAGE_TYPE_PASSPHRASE:
+        virBufferEscapeString(buf, "<name>%s</name>\n", def->usage.name);
+        break;
+
     default:
         virReportError(VIR_ERR_INTERNAL_ERROR,
                        _("unexpected secret usage type %d"),

diff --git a/src/conf/secret_conf.h b/src/conf/secret_conf.h
index 4584403dcb47f50c5f4bb1ac8f504ef6f5105089..c34880fb099319f5f838f5d3cc4cf93de08050ba 100644 (file)
--- a/src/conf/secret_conf.h
+++ b/src/conf/secret_conf.h
@@ -40,6 +40,7 @@ struct _virSecretDef {
         char *volume;               /* May be NULL */
         char *ceph;
         char *target;
+        char *name;
     } usage;
 };
 

diff --git a/src/conf/virsecretobj.c b/src/conf/virsecretobj.c
index 30a5e80f6e40f8e5147a85fc805877894996990b..6714a0075c63eef3aa1790937d64609f435f0264 100644 (file)
--- a/src/conf/virsecretobj.c
+++ b/src/conf/virsecretobj.c
@@ -237,6 +237,11 @@ virSecretObjSearchName(const void *payload,
         if (STREQ(secret->def->usage.target, data->usageID))
             found = 1;
         break;
+
+    case VIR_SECRET_USAGE_TYPE_PASSPHRASE:
+        if (STREQ(secret->def->usage.name, data->usageID))
+            found = 1;
+        break;
     }
 
  cleanup:

diff --git a/tests/secretxml2xmlin/usage-passphrase.xml b/tests/secretxml2xmlin/usage-passphrase.xml
new file mode 100644 (file)
index 0000000..2b94b80
--- /dev/null
+++ b/tests/secretxml2xmlin/usage-passphrase.xml
@@ -0,0 +1,7 @@
+<secret ephemeral='no' private='no'>
+  <uuid>f52a81b2-424e-490c-823d-6bd4235bc572</uuid>
+  <description>Sample Passphrase Secret</description>
+  <usage type='passphrase'>
+    <name>mumblyfratz</name>
+  </usage>
+</secret>

diff --git a/tests/secretxml2xmltest.c b/tests/secretxml2xmltest.c
index 8dcbb40080b7e1d89c57d628e5033d2cbb47f2e6..c444e4d29badbcd3c9d5677be1612ad2d672cffb 100644 (file)
--- a/tests/secretxml2xmltest.c
+++ b/tests/secretxml2xmltest.c
@@ -80,6 +80,7 @@ mymain(void)
     DO_TEST("usage-volume");
     DO_TEST("usage-ceph");
     DO_TEST("usage-iscsi");
+    DO_TEST("usage-passphrase");
 
     return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
 }