HACKING

   1 The guidelines in this file are the ideals; it's better to send a
   2 not-fully-following-guidelines patch than no patch at all, though.  We
   3 can always polish it up.
   4
   5 Mailing list
   6 ===
   7
   8 The D-BUS mailing list is message-bus-list@freedesktop.org; discussion
   9 of patches, etc. should go there.
  10
  11 Security
  12 ===
  13
  14 Most of D-BUS is security sensitive.  Guidelines related to that:
  15
  16  - avoid memcpy(), sprintf(), strlen(), snprintf, strlcat(),
  17    strstr(), strtok(), or any of this stuff. Use DBusString.
  18    If DBusString doesn't have the feature you need, add it
  19    to DBusString.
  20
  21    There are some exceptions, for example
  22    if your strings are just used to index a hash table
  23    and you don't do any parsing/modification of them, perhaps
  24    DBusString is wasteful and wouldn't help much. But definitely
  25    if you're doing any parsing, reallocation, etc. use DBusString.
  26
  27  - do not include system headers outside of dbus-memory.c,
  28    dbus-sysdeps.c, and other places where they are already
  29    included. This gives us one place to audit all external
  30    dependencies on features in libc, etc.
  31
  32  - do not use libc features that are "complicated"
  33    and may contain security holes. For example, you probably shouldn't
  34    try to use regcomp() to compile an untrusted regular expression.
  35    Regular expressions are just too complicated, and there are many
  36    different libc's out there.
  37
  38  - we need to design the message bus daemon (and any similar features)
  39    to use limited privileges, run in a chroot jail, and so on.
  40
  41 http://vsftpd.beasts.org/ has other good security suggestions.
  42
  43 Coding Style
  44 ===
  45
  46  - The C library uses GNU coding conventions, with GLib-like
  47    extensions (e.g. lining up function arguments). The
  48    Qt wrapper uses KDE coding conventions.
  49
  50  - Write docs for all non-static functions and structs and so on. try
  51    "doxygen Doxyfile" prior to commit and be sure there are no
  52    warnings printed.
  53
  54  - All external interfaces (network protocols, file formats, etc.)
  55    should have documented specifications sufficient to allow an
  56    alternative implementation to be written. Our implementation should
  57    be strict about specification compliance (should not for example
  58    heuristically parse a file and accept not-well-formed
  59    data). Avoiding heuristics is also important for security reasons;
  60    if it looks funny, ignore it (or exit, or disconnect).
  61
  62 Making a release
  63 ===
  64
  65 To make a release of D-BUS, do the following:
  66
  67  - check out a fresh copy from CVS
  68
  69  - increment the version number in configure.in
  70
  71  - verify that the libtool versioning/library soname is
  72    changed if it needs to be, or not changed if not
  73
  74  - update the file NEWS based on the ChangeLog
  75
  76  - add a ChangeLog entry containing the version number
  77    you're releasing ("Released 0.3" or something)
  78    so people can see which changes were before and after
  79    a given release.
  80
  81  - "make distcheck" (DO NOT just "make dist" - pass the check!)
  82
  83  - if make distcheck fails, fix it.
  84
  85  - once distcheck succeeds, "cvs commit"
  86
  87  - if someone else made changes and the commit fails,
  88    you have to "cvs up" and run "make distcheck" again
  89
  90  - once the commit succeeds, "cvs tag DBUS_X_Y_Z" where
  91    X_Y_Z map to version X.Y.Z
  92
  93  - scp your tarball to freedesktop.org server and copy it
  94    to /home/www/twiki/Software/dbus/releases. This should
  95    be possible if you're in group "dbus"
  96
  97  - update the wiki page http://pdx.freedesktop.org/Software/dbus
  98    to list your new release
  99
 100  - post to message-bus-list@freedesktop.org announcing the release.
 101
 102
 103 Environment variables
 104 ===
 105
 106 These are the environment variables that are used by the D-BUS client library
 107
 108 DBUS_VERBOSE=1
 109 Turns on printing verbose messages. This only works if D-BUS has been
 110 compiled with --enable-verbose-mode
 111
 112 DBUS_MALLOC_FAIL_NTH=n
 113 Can be set to a number, causing every nth call to dbus_alloc or
 114 dbus_realloc to fail. This only works if D-BUS has been compiled with
 115 --enable-tests.
 116
 117 DBUS_MALLOC_FAIL_GREATER_THAN=n
 118 Can be set to a number, causing every call to dbus_alloc or
 119 dbus_realloc to fail if the number of bytes to be allocated is greater
 120 than the specified number. This only works if D-BUS has been compiled with
 121 --enable-tests.
 122
 123 Tests
 124 ===
 125
 126 These are the test programs that are built if dbus is compiled using
 127 --enable-tests.
 128
 129 dbus/dbus-test
 130 This is the main unit test program that tests all aspects of the D-BUS
 131 client library.
 132
 133 dbus/bus-test
 134 This it the unit test program for the message bus.
 135
 136 test/break-loader
 137 A test that tries to break the message loader by passing it randomly
 138 created invalid messages.
 139
 140 "make check" runs all the deterministic test programs (i.e. not break-loader).
 141
 142 "make check-coverage" is available if you configure with --enable-gcov and
 143 gives a complete report on test suite coverage. You can also run
 144 "test/decode-gcov foo.c" on any source file to get annotated source,
 145 after running make check with a gcov-enabled tree.
 146
 147 Patches
 148 ===
 149
 150 Please file them at http://bugzilla.freedesktop.org under component
 151 dbus, and also post to the mailing list for discussion.  The commit
 152 rules are:
 153
 154  - for fixes that don't affect API or protocol, they can be committed
 155    if any one qualified reviewer other than patch author
 156    reviews and approves
 157
 158  - for fixes that do affect API or protocol, two people
 159    in the reviewer group have to review and approve the commit, and
 160    posting to the list is definitely mandatory
 161
 162  - if there's a live unresolved controversy about a change,
 163    don't commit it while the argument is still raging.
 164
 165  - regardless of reviews, to commit a patch:
 166     - make check must pass
 167     - the test suite must be extended to cover the new code
 168       as much as reasonably feasible
 169     - the patch has to follow the portability, security, and
 170       style guidelines
 171     - the patch should as much as reasonable do one thing,
 172       not many unrelated changes
 173    No reviewer should approve a patch without these attributes, and
 174    failure on these points is grounds for reverting the patch.
 175
 176 The reviewer group that can approve patches: Havoc Pennington, Michael
 177 Meeks, Alex Larsson, Zack Rusin, Joe Shaw, Mikael Hallendal, Richard
 178 Hult, Owen Fraser-Green, Olivier Andrieu.
 179
 180