← Back to branch summary

~ubuntu-multiseat/ubuntu/trusty/udisks2/full-logind-support

« back to all changes in this revision

Viewing changes to doc/udisks2-docs.xml

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2012-06-13 17:01:30 UTC
  • mfrom: (1.1.1) (2.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20120613170130-9jggrd76bkv1vd0b
Tags: 1.98.0-1
* New upstream release.
* debian/control: Drop ntfsprogs Recommends. It is a transitional package
  for ntfs-3g now, which we already recommend.
* Add 00git_no_polkit_fallback.patch: Fix crash if polkit is not available.
  Patch backported from current upstream git head.
* Add debian/local/integration-test: Latest integration test suite from
  upstream git. 1.99 and later will ship that in the source tarball.
* Add debian/tests/control and debian/tests/upstream-system: DEP-8
  autopkgtest (adapted from udisks package).
* debian/control: Change suggestion of cryptsetup to cryptsetup-bin, as that
  is sufficient for udisks' needs.
* debian/copyright: Fix duplicate copyright line, thanks lintian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/udisks2-docs.xml
135
135
          calling user to be sufficiently authorized. Whether the user
136
136
          is authorized is checked using <ulink
137
137
          url="http://www.freedesktop.org/software/polkit/docs/latest/polkit.8.html">polkit</ulink>
138
 
          and the administrator can configure <ulink
139
 
          url="http://www.freedesktop.org/software/polkit/docs/latest/pklocalauthority.8.html">polkit's
140
 
          local authority</ulink> (but note that the system may be
141
 
          using another polkit authority implementation).
 
138
          allowing the administrator to configure fine-grained permissions via
 
139
          polkit authorization rules.
142
140
        </para>
143
141
        <para>
144
142
          There is not necessarily a one-to-one relationship between
174
172
          The polkit actions are not considered stable and may change
175
173
          from release to release so administrators should take notice
176
174
          when upgrading from one version of udisks to another. For
177
 
          example, <filename>.pkla</filename> files may need to be
178
 
          updated to match an updated policy.
 
175
          example, polkit authorization rules may need to be updated
 
176
          to match an updated policy.
 
177
        </para>
 
178
        <para>
 
179
          See <xref linkend="udisks-polkit-details"/> for the
 
180
          variables that can be used to assist in determining if the
 
181
          caller is authorized (note that each variable may not be set
 
182
          for request). For example, a polkit authorization rule for
 
183
          any of the
 
184
          <emphasis>org.freedesktop.udisks2.filesystem-mount*</emphasis>
 
185
          actions can use the <parameter>device</parameter> variable
 
186
          to determine if the caller is authorized to mount a specific
 
187
          block device.
 
188
        </para>
 
189
 
 
190
        <table frame="all" id="udisks-polkit-details">
 
191
          <title>Known polkit variables</title>
 
192
          <tgroup cols="2" align="left" colsep="1" rowsep="1">
 
193
            <thead>
 
194
              <row>
 
195
                <entry>key</entry>
 
196
                <entry>value</entry>
 
197
              </row>
 
198
            </thead>
 
199
            <tbody>
 
200
              <row>
 
201
                <entry><parameter>device</parameter></entry>
 
202
                <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.PreferredDevice">Block:PreferredDevice</link> property. If set, this is guaranteed to be a device file, for example <quote>/dev/vg_lucifer/lv_root</quote> or <quote>/dev/sda1</quote>. If the object is not a block device, this is not set.</entry>
 
203
              </row>
 
204
              <row>
 
205
                <entry><parameter>drive</parameter></entry>
 
206
                <entry>Like the <parameter>device</parameter> variable, but if the object is also a drive, this variable includes Vital Product Data about the drive such as the vendor and model identifiers (if available), for example <quote>INTEL SSDSA2MH080G1GC (/dev/sda1)</quote>. Otherwise is just set to the same value as <parameter>device</parameter>. If the object is not a block device, this is not set (it is however set if the object is a block device but not a drive).</entry>
 
207
              </row>
 
208
 
 
209
              <row>
 
210
                <entry><parameter>drive.wwn</parameter></entry>
 
211
                <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.WWN">Drive:WWN</link> property.</entry>
 
212
              </row>
 
213
              <row>
 
214
                <entry><parameter>drive.serial</parameter></entry>
 
215
                <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Serial">Drive:Serial</link> property.</entry>
 
216
              </row>
 
217
              <row>
 
218
                <entry><parameter>drive.vendor</parameter></entry>
 
219
                <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Vendor">Drive:Vendor</link> property.</entry>
 
220
              </row>
 
221
              <row>
 
222
                <entry><parameter>drive.model</parameter></entry>
 
223
                <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Model">Drive:Model</link> property.</entry>
 
224
              </row>
 
225
              <row>
 
226
                <entry><parameter>drive.revision</parameter></entry>
 
227
                <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Revision">Drive:Revision</link> property.</entry>
 
228
              </row>
 
229
              <row>
 
230
                <entry><parameter>drive.removable</parameter></entry>
 
231
                <entry>If the object is a drive (or a block device that is part of a drive), this is set to the string <quote>true</quote> only if the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Removable">Drive:Removable</link> property is <constant>TRUE</constant>.</entry>
 
232
              </row>
 
233
 
 
234
              <row>
 
235
                <entry><parameter>id.type</parameter></entry>
 
236
                <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdType">Block:IdType</link> property.</entry>
 
237
              </row>
 
238
              <row>
 
239
                <entry><parameter>id.usage</parameter></entry>
 
240
                <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdUsage">Block:IdUsage</link> property.</entry>
 
241
              </row>
 
242
              <row>
 
243
                <entry><parameter>id.version</parameter></entry>
 
244
                <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdVersion">Block:IdVersion</link> property.</entry>
 
245
              </row>
 
246
              <row>
 
247
                <entry><parameter>id.label</parameter></entry>
 
248
                <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdLabel">Block:IdLabel</link> property.</entry>
 
249
              </row>
 
250
              <row>
 
251
                <entry><parameter>id.uuid</parameter></entry>
 
252
                <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdUUID">Block:IdUUID</link> property.</entry>
 
253
              </row>
 
254
 
 
255
              <row>
 
256
                <entry><parameter>partition.number</parameter></entry>
 
257
                <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Number">Partition:Number</link> property.</entry>
 
258
              </row>
 
259
              <row>
 
260
                <entry><parameter>partition.type</parameter></entry>
 
261
                <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Type">Partition:Type</link> property.</entry>
 
262
              </row>
 
263
              <row>
 
264
                <entry><parameter>partition.flags</parameter></entry>
 
265
                <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Flags">Partition:Flags</link> property.</entry>
 
266
              </row>
 
267
              <row>
 
268
                <entry><parameter>partition.name</parameter></entry>
 
269
                <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Name">Partition:Name</link> property.</entry>
 
270
              </row>
 
271
              <row>
 
272
                <entry><parameter>partition.uuid</parameter></entry>
 
273
                <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.UUID">Partition:UUID</link> property.</entry>
 
274
              </row>
 
275
 
 
276
            </tbody>
 
277
          </tgroup>
 
278
        </table>
 
279
 
 
280
        <para>
179
281
          For reference, the polkit actions defined by udisks &version;
180
282
          are included here:
181
283
          <informalexample id="udisks-polkit-actions-file"><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../data/org.freedesktop.udisks2.policy.in"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></informalexample>