External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-22 11:22:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: schema: Add basic documentation for the virtual RNG device support

Browse Source 
This patch documents XML elements used for (basic) support of virtual
RNG devices.

In the devices section in the domain XML users may specify:

For the default 'random' backend:
  <devices>
    <rng model='virtio'>
      <backend model='random'>/dev/urandom</backend>
    </rng>
  </devices>

For the slightly more advanced EGD backend:
  <devices>
    <rng model='virtio'>
      <backend model='egd' type='udp'>
        <!-- this is a definition of a character device -->
        <source mode='bind' service='1234'/>
        <source mode='connect' host='1.2.3.4' service='1234'/>
        <!-- or other valid character device configuration -->
      </backend>
    </rng>
  </devices>

For the planned random daemon/pool:
  <devices>
    <rng model='virtio'>
      <backend model='pool' pool='poolname'>class</backend>
    </rng>
  </devices>

to enable the RNG device for guests.
This commit is contained in:
Peter Krempa 2012-12-20 12:06:52 +01:00
parent 5e3c344785
commit fa16c80f52
2 changed files with 101 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/formatdomain.html.in
View File

@ -4279,6 +4279,75 @@ qemu-kvm -net nic,model=? /dev/null
</ul>
</dd>
</dl>
<h4><a name="elementsRng">Random number generator device</a></h4>
<p>
The virtual random number generator device allows the host to pass
through entropy to guest operating systems.
<span class="since">Since 1.0.3</span>
</p>
<p>
Example: usage of the RNG device:
</p>
<pre>
...
&lt;devices&gt;
&lt;rng model='virtio'&gt;
&lt;backend model='random'&gt;/dev/random&lt;/backend&gt;
&lt;!-- OR --&gt;
&lt;backend model='egd' type='udp'&gt;
&lt;source mode='bind' service='1234'&gt;
&lt;source mode='connect' host='1.2.3.4' service='1234'&gt;
&lt;/backend&gt;
&lt;/rng&gt;
&lt;/devices&gt;
...
</pre>
<dl>
<dt><code>model</code></dt>
<dd>
<p>
The required <code>model</code> attribute specifies what type
of RNG device is provided. Valid values are specific to
the virtualization platform:
</p>
<ul>
<li>'virtio' &mdash; supported by qemu and virtio-rng kernel module</li>
</ul>
</dd>
<dt><code>backend</code></dt>
<dd>
<p>
The <code>backend</code> element specifies the source of entropy
to be used for the domain. The source model is configured using the
<code>model</code> attribute. Supported source models are:
</p>
<ul>
<li>'random' &mdash; /dev/random (default) or similar device as source</li>
<li>'egd' &mdash; a EGD protocol backend</li>
</ul>
</dd>
<dt><code>backend type='random'</code></dt>
<dd>
<p>
This backend type expects a non-blocking character device as input.
Examples of such devices are /dev/random and /dev/urandom. The file
name is specified as contents of the <code>backend</code> element.
When no file name is specified the hypervisor default is used.
</p>
</dd>
<dt><code>backend type='egd'</code></dt>
<dd>
<p>
This backend connects to a source using the EGD protocol.
The source is specified as a character device. Refer to
<a href='#elementsCharHostInterface'>character device host interface</a>
for more information.
</p>
</dd>
</dl>
<h3><a name="seclabel">Security label</a></h3>

32
docs/schemas/domaincommon.rng
View File

@ -3126,6 +3126,7 @@
<ref name="hub"/>
<ref name="redirdev"/>
<ref name="redirfilter"/>
<ref name="rng"/>
</choice>
</zeroOrMore>
<optional>
@ -3514,6 +3515,37 @@
</element>
</define>
<define name="rng">
<element name="rng">
<attribute name="model">
<choice>
<value>virtio</value>
</choice>
</attribute>
<ref name="rng-backend"/>
</element>
</define>
<define name="rng-backend">
<element name="backend">
<choice>
<group>
<attribute name="model">
<value>random</value>
</attribute>
<ref name="filePath"/>
</group>
<group>
<attribute name="model">
<value>egd</value>
</attribute>
<ref name="qemucdevSrcType"/>
<ref name="qemucdevSrcDef"/>
</group>
</choice>
</element>
</define>
<define name="usbmaster">
<element name="master">
<attribute name="startport">