summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: Remove obsolete message about man2htmlSimon McVittie2018-12-041-1/+0
| | | | | | | We no longer run man2html. Signed-off-by: Simon McVittie <smcv@collabora.com> (cherry picked from commit f134e2d2c7ae53965dfba0c85bf76ad38fb7fa4c)
* CONTRIBUTING: Reformat as MarkdownSimon McVittie2018-12-041-1/+1
| | | | Signed-off-by: Simon McVittie <smcv@collabora.com>
* Rename HACKING to CONTRIBUTINGSimon McVittie2018-12-041-1/+1
| | | | Signed-off-by: Simon McVittie <smcv@collabora.com>
* build: Uninstall JavaScript and CSS from htmldirSimon McVittie2018-04-271-0/+2
| | | | | | | Otherwise, distcheck fails when mallard-ducktype is available. Signed-off-by: Simon McVittie <smcv@collabora.com> (cherry picked from commit 9391d769ae335872e5b770f6741855fde45b8186)
* dbus-daemon(1): Mention and deprecate shared session busesSimon McVittie2018-04-251-0/+13
| | | | | | | | | | | | | | | | This might (?) have made sense behind a firewall in 2003; but now it's 2018, the typical threat model that we are defending against has changed from "vandals want to feel proud of their l33t skills" to "organised crime wants your money", and a "trusted" local LAN probably contains an obsolete phone, tablet, games console or Internet-of-Things-enabled toaster with remote root exploits. This make network topologies that used to be acceptable look increasingly irresponsible. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106004 Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> (cherry picked from commit d0a16b59a8572fbd1934e941e2e3004840306222)
* dbus-daemon(1): Recommend requiring EXTERNAL on non-Windows OSsSimon McVittie2018-04-251-0/+4
| | | | | | | | | | | | This is the default, and blocks TCP-based attacks by making the attacker fail to authenticate (while also preventing inadvisable TCP-based configurations from working). Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106004 Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Ralf Habacker <ralf.habacker@freenet.de> Reviewed-by: Philip Withnall <withnall@endlessm.com> (cherry picked from commit aef4475939a773e1a205a71d641ea2bb6793ab92)
* dbus-daemon(1): Put some scary warnings on <allow_anonymous/>Simon McVittie2018-04-251-0/+7
| | | | | | | | | | | I'm far from convinced that this option should even *exist*, but it should definitely be documented as a very bad thing. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106004 Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Ralf Habacker <ralf.habacker@freenet.de> Reviewed-by: Philip Withnall <withnall@endlessm.com> (cherry picked from commit 5d3680486712891c13b85c07fab629bb70f623cc)
* dbus-daemon(1): Recommend against remote TCP for debuggingSimon McVittie2018-04-251-0/+10
| | | | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106004 Reviewed-by: Ralf Habacker <ralf.habacker@freenet.de> Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: Add a TODO comment as suggested] Signed-off-by: Simon McVittie <smcv@collabora.com> (cherry picked from commit cf47380641aac0e5b40694b0ae09ffb85ec4b5fc)
* dbus-daemon(1): Say that non-local TCP is insecureSimon McVittie2018-04-251-2/+22
| | | | | | | | | | | | | | With some fairly reasonable threat models (active or passive local attacker able to eavesdrop on the network link, confidential information being transferred via D-Bus), secure authentication is insufficient to make this transport secure: it does not protect confidentiality or integrity either. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106004 Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Ralf Habacker <ralf.habacker@freenet.de> Reviewed-by: Philip Withnall <withnall@endlessm.com> (cherry picked from commit 2513f84db68a9edad8558806b777ed6c284016b9)
* doxygen_to_devhelp: Produce Devhelp index format v2Simon McVittie2018-04-233-3/+9
| | | | | | | | | | The old version-1 format is deprecated and now produces warnings. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106186 Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: Add the .devhelp2 file to .gitignore as suggested] Signed-off-by: Simon McVittie <smcv@collabora.com> (cherry picked from commit fa922639207de16d459983144ddad28b7abe60c2)
* doxygen_to_devhelp: Make the API reference the front pageSimon McVittie2018-04-231-1/+2
| | | | | | | | | | | | | The tutorial is not necessarily a great entry point for the libdbus documentation: it's infrequently updated, and we should probably have the "If you use this low-level API directly, you're signing up for some pain" message from the API reference show up in devhelp more immediately. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106186 Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: Add longer commit message with rationale] Signed-off-by: Simon McVittie <smcv@collabora.com> (cherry picked from commit c84ac8b1ef3a9fa18127b2462ead369c4e8846bd)
* doc: Install highlight.pack.js if presentSimon McVittie2018-04-232-0/+2
| | | | | | | | | | | Newer versions of yelp-build use this instead of a jQuery syntax highlighter. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106171 Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: Also add it to .gitignore as suggested] Signed-off-by: Simon McVittie <smcv@collabora.com> (cherry picked from commit 49ad5b110fd5f5f4e41405d98007a11d8eb741f7)
* doc: Only install ancillary files from yelp-build if they existSimon McVittie2018-04-231-3/+14
| | | | | | | | | Newer versions of yelp-build don't install jquery. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=106171 Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> (cherry picked from commit bab857fb6f75ffe0ac3771de4b8272ad97623a2c)
* doc: Fix bracket escaping in Ducktype API design filePhilip Withnall2018-02-081-22/+22
| | | | | | | | | | | | | There’s no need to escape closing brackets if the paired opening bracket is escaped (or doesn’t need escaping). See https://github.com/projectmallard/mallard-ducktype/issues/16#issuecomment-362590519. Signed-off-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=104925 Reviewed-by: Simon McVittie <smcv@collabora.com> (cherry picked from commit ad72d6bc5f45e78d21f64099f670a89dcf32507d)
* doc: Fix dbus-send.1 uint16 typoDavid King2017-10-091-1/+1
| | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=103075 Bug-RedHat: https://bugzilla.redhat.com/show_bug.cgi?id=1467415 Reviewed-by: Philip Withnall <withnall@endlessm.com> Reviewed-by: Simon McVittie <smcv@collabora.com>
* policy: Add max_fds, min_fds qualifiers for send, receive rulesSimon McVittie2017-07-281-0/+20
| | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101848 Reviewed-by: Thiago Macieira <thiago@kde.org> [smcv: Revert an incorrect comment change] Signed-off-by: Simon McVittie <smcv@collabora.com>
* Add send_broadcast as an attribute of <allow> and <deny> elementsSimon McVittie2017-07-281-0/+11
| | | | | | | | | | | | | | | | | | <allow send_broadcast="true" ...> only matches broadcasts, which are signals with a NULL destination. There was previously no way for the policy language to express "NULL destination", only "any destination". <allow send_broadcast="false" ...> only matches non-broadcasts, which are non-signals or signals with a non-NULL destination. There was previously no way for the policy language to express "any non-NULL destination", only "any destination". Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: improved documentation as per Philip's review] Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
* dbus-daemon(1): Document how send_* and receive_* work in generalSimon McVittie2017-07-281-0/+26
| | | | | | Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
* dbus-daemon(1): Be more truthful about the default policySimon McVittie2017-07-281-3/+7
| | | | | | | | | We don't allow sending unrequested replies, but the documentation implied that we did. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
* dbus-daemon(1): Clarify how user, group rules workSimon McVittie2017-07-281-8/+12
| | | | | | Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
* dbus-daemon(1): Actually document "own" rulesSimon McVittie2017-07-281-0/+11
| | | | | | Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
* dbus-daemon(1): Document the wildcard attribute value "*" more clearlySimon McVittie2017-07-281-19/+30
| | | | | | Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
* spec: Update my email addressSimon McVittie2017-06-291-1/+1
| | | | Signed-off-by: Simon McVittie <smcv@collabora.com>
* Start 1.11.16 developmentSimon McVittie2017-06-291-4/+4
| | | | Signed-off-by: Simon McVittie <smcv@collabora.com>
* 1.11.14dbus-1.11.14Simon McVittie2017-06-291-3/+33
| | | | Signed-off-by: Simon McVittie <smcv@collabora.com>
* spec: Document versioning of eavesdrop='true'Simon McVittie2017-06-291-0/+7
| | | | | | | | | The wording and formatting used here is consistent with other semi-recently-added match keys. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
* spec: Formally deprecate eavesdroppingSimon McVittie2017-06-291-22/+42
| | | | | | | Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: Wrap BecomeMonitor in <literal> as per Philip's review] Signed-off-by: Simon McVittie <smcv@collabora.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
* spec: Do not promise match rules with eavesdrop='true' can be addedSimon McVittie2017-06-291-6/+1
| | | | | | | | | | This is no longer true, and it seems less misleading to raise an error than to obey the letter of the spec by quietly ignoring calls from an inappropriate caller. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
* Add unix:dir=/something addressesSimon McVittie2017-06-291-6/+32
| | | | | | | | | | | | | | | | | | | | | | These are like unix:tmpdir=/something, except that the resulting socket is always path-based, never abstract. This is desirable for two reasons: * If a Linux container manager wants to expose a path-based socket into the container, it can do so by bind-mounting it in the container's filesystem namespace. That cannot work for abstract sockets because they are not files. * Conversely, if a Linux container manager does not want to expose a path-based socket in the container, it can avoid bind-mounting it, or bind-mount some harmless object like /dev/null over it. That cannot work for abstract sockets because access to abstract sockets is part of the network namespace, which is all-or-nothing. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
* spec: Document the Features and Interfaces properties on o.fd.DBusSimon McVittie2017-06-081-0/+116
| | | | | | Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101257
* spec: Document the Peer and Properties interfaces for the message busSimon McVittie2017-06-081-0/+8
| | | | | | Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101257
* spec: Document the canonical object path for the bus driverSimon McVittie2017-06-021-1/+19
| | | | | | Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101256
* spec: Fix indentationTom Gundersen2017-05-311-1/+1
| | | | | [smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
* spec: Re-word documentation of ListQueuedOwnersTom Gundersen2017-05-311-3/+1
| | | | | | | | | This was previously written in an unusual message-passing-oriented style, which obscured the meaning. Use a more method-call-oriented style instead. [smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
* spec: Re-word documentation of ReleaseNameTom Gundersen2017-05-311-9/+7
| | | | | | | | | This was previously written in an unusual message-passing-oriented style, which obscured the meaning. Use a more method-call-oriented style instead. [smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
* Spec: Re-word documentation of RequestNameTom Gundersen2017-05-311-8/+6
| | | | | | | | | This was previously written in an unusual message-passing-oriented style, which obscured the meaning. Use a more method-call-oriented style instead. [smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
* spec: Move ListQueuedOwners API description to list of methodsSimon McVittie2017-05-311-56/+56
| | | | | | | | | | | | | Tom Gundersen pointed out that RequestName, ReleaseName and ListQueuedOwners were documented in their own section instead of being put together with the other method calls, which makes it more difficult to apply changes consistently across all methods. I'm moving them one at a time to make the changes reviewable, since the diff resulting from moving all three as a unit is too large to review sensibly. Signed-off-by: Simon McVittie <smcv@collabora.com>
* spec: Move ReleaseName API description to list of methodsSimon McVittie2017-05-311-95/+95
| | | | | | | | | | | | | Tom Gundersen pointed out that RequestName, ReleaseName and ListQueuedOwners were documented in their own section instead of being put together with the other method calls, which makes it more difficult to apply changes consistently across all methods. I'm moving them one at a time to make the changes reviewable, since the diff resulting from moving all three as a unit is too large to review sensibly. Signed-off-by: Simon McVittie <smcv@collabora.com>
* spec: Move RequestName API description to list of methodsSimon McVittie2017-05-311-240/+241
| | | | | | | | | | | | | Tom Gundersen pointed out that RequestName, ReleaseName and ListQueuedOwners were documented in their own section instead of being put together with the other method calls, which makes it more difficult to apply changes consistently across all methods. I'm moving them one at a time to make the changes reviewable, since the diff resulting from moving all three as a unit is too large to review sensibly. Signed-off-by: Simon McVittie <smcv@collabora.com>
* Ensure hyphen/minus is treated as literal in regexesSimon McVittie2017-04-181-1/+1
| | | | | | | | | | | | | | | | | | Each U+002D HYPHEN-MINUS in [0-9A-Za-z_-/.\] is treated as a member of a range. The third one, which appears to have been intended to be a literal, is part of an empty range because the starting point U+005F LOW LINE is greater than the endpoint U+002F SOLIDUS, resulting in at least some grep implementations not considering U+002D, U+002F or U+005F to match the pattern. This resulted in one of the dbus-launch tests being unintentionally skipped when it used a regex based on the one in the spec. regex(7) suggests "To include a literal '-' [in a bracketed character set], make it the first or last character". Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=100686
* doc: Clarify /etc/dbus-1/system.d and /usr/share/dbus-1/system.dPhilip Withnall2017-02-242-2/+8
| | | | | | | | | | | The documentation generally only mentioned the directory in /etc, even though we actually prefer security policies to be installed in /usr/share to allow for stateless and volatile systems (i.e. booting up with an empty /etc). Signed-off-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=99901 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
* dbus-daemon(1): Describe how session and system services are foundSimon McVittie2017-02-211-17/+179
| | | | | | | | | | | | | | | | | | For Unix, this partially duplicates the D-Bus Specification, but provides more detail about the intention of each search path element. It also documents the non-standardized path elements searched by the reference implementation. For Windows, there are no standardized path elements in the D-Bus Specification (and it isn't clear how useful it would be to standardize them, since Windows software that uses D-Bus tends to be installed as an integrated "stack" with a bundled copy of a suitable dbus-daemon), so we just document what the reference implementation does. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=99825 Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: fix formatting nitpicks] Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
* spec: Don't say implementation-specific locations must be lowest prioritySimon McVittie2017-02-211-7/+3
| | | | | | | | | | | | We're treating transient services as higher-priority than those in the XDG_DATA_HOME or XDG_DATA_DIRS, which is consistent with systemd. The specific list used by the standard session dbus-daemon will be added to dbus-daemon(1) in the next commit. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=99825 Reviewed-by: Philip Withnall <withnall@endlessm.com> Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
* Start towards 1.11.10Simon McVittie2016-11-291-2/+10
| | | | Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
* dbus 1.11.8 and D-Bus Specification 0.30dbus-1.11.8Simon McVittie2016-11-281-2/+15
| | | | Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
* Spec: document AppArmor mediation of auto-startingSimon McVittie2016-11-281-0/+77
| | | | | | Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98666
* Spec: be clearer about "starting" and "activation" being synonymsSimon McVittie2016-11-221-3/+8
| | | | | | Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
* spec: Clarify behaviour of o.f.D.P.GetAllPhilip Withnall2016-11-221-0/+11
| | | | | | | | | | | | | | | | | | Clarify its intended behaviour in two situations: • For interfaces which have no properties. • Where some properties are not visible to the caller (due to access control, for example). The intention here is for this behaviour to be mandatory, but given that this is quite late on in the specification’s life, and various D-Bus libraries like dbus-glib and telepathy-glib cannot support access control at a per-property level, for example. GDBus can, although it’s questionable whether this is a good idea. Deliberately leave the specification open to allow access control at a higher level as well (such as per-(object, interface)). Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36190 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
* Spec: mostly use versioned interface and bus namesSimon McVittie2016-11-221-18/+18
| | | | | | | | | | | | | | Using versioned names here reinforces the advice given in <https://dbus.freedesktop.org/doc/dbus-api-design.html#api-versioning>. I haven't added versions to the sample parameters "com.example.tea" and "com.example.cappuccino" for methods that query information about names, on the basis that I assume they are more likely to be intended to represent an implementation than an API. Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
* Spec: document systemd activationSimon McVittie2016-11-221-0/+33
| | | | | | | | | We didn't say that SystemdService existed. Now we do, together with enough context to make it make sense. Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
View Lorry Controller Status