doc/security.mdwn

   1 Let's do an ikiwiki security analysis.
   2
   3 If you are using ikiwiki to render pages that only you can edit, do not
   4 generate any wrappers, and do not use the cgi, then there are no more
   5 security issues with this program than with cat(1). If, however, you let
   6 others edit pages in your wiki, then some possible security issues do need
   7 to be kept in mind.
   8
   9 ----
  10
  11 # Probable holes
  12
  13 _(The list of things to fix.)_
  14
  15 ## commit spoofing
  16
  17 Anyone with direct commit access can forge "web commit from foo" and
  18 make it appear on [[RecentChanges]] like foo committed. One way to avoid
  19 this would be to limit web commits to those done by a certian user.
  20
  21 ## XML::Parser
  22
  23 XML::Parser is used by the aggregation plugin, and has some security holes
  24 that are still open in Debian unstable as of this writing. #378411 does not
  25 seem to affect our use, since the data is not encoded as utf-8 at that
  26 point. #378412 could affect us, although it doesn't seem very exploitable.
  27 It has a simple fix, which should be NMUed or something..
  28
  29 ## other stuff to look at
  30
  31 I need to audit the git backend a bit, and have been meaning to
  32 see if any CRLF injection type things can be done in the CGI code.
  33
  34 ----
  35
  36 # Potential gotchas
  37
  38 _(Things not to do.)_
  39
  40 ## image file etc attacks
  41
  42 If it enounters a file type it does not understand, ikiwiki just copies it
  43 into place. So if you let users add any kind of file they like, they can
  44 upload images, movies, windows executables, css files, etc (though not html
  45 files). If these files exploit security holes in the browser of someone
  46 who's viewing the wiki, that can be a security problem.
  47
  48 Of course nobody else seems to worry about this in other wikis, so should we?
  49
  50 Currently only people with direct svn commit access can upload such files
  51 (and if you wanted to you could block that with a svn pre-commit hook).
  52 Users with only web commit access are limited to editing pages as ikiwiki
  53 doesn't support file uploads from browsers (yet), so they can't exploit
  54 this.
  55
  56 ## multiple accessors of wiki directory
  57
  58 If multiple people can write to the source directory ikiwiki is using, or
  59 to the destination directory it writes files to, then one can cause trouble
  60 for the other when they run ikiwiki through symlink attacks.
  61
  62 So it's best if only one person can ever write to those directories.
  63
  64 ## setup files
  65
  66 Setup files are not safe to keep in subversion with the rest of the wiki.
  67 Just don't do it. [[ikiwiki.setup]] is *not* used as the setup file for
  68 this wiki, BTW.
  69
  70 ## page locking can be bypassed via direct svn commits
  71
  72 A locked page can only be edited on the web by an admin, but
  73 anyone who is allowed to commit direct to svn can bypass this. This is by
  74 design, although a subversion pre-commit hook could be used to prevent
  75 editing of locked pages when using subversion, if you really need to.
  76
  77 ## web server attacks
  78
  79 If your web server does any parsing of special sorts of files (for example,
  80 server parsed html files), then if you let anyone else add files to the wiki,
  81 they can try to use this to exploit your web server.
  82
  83 ----
  84
  85 # Hopefully non-holes
  86
  87 _(AKA, the assumptions that will be the root of most security holes...)_
  88
  89 ## exploting ikiwiki with bad content
  90
  91 Someone could add bad content to the wiki and hope to exploit ikiwiki.
  92 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
  93
  94 One fun thing in ikiwiki is its handling of a PageSpec, which involves
  95 translating it into perl and running the perl. Of course, this is done
  96 *very* carefully to guard against injecting arbitrary perl code.
  97
  98 ## publishing cgi scripts
  99
 100 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
 101 rather, the script is published, but it's not marked executable (except in
 102 the case of "destination directory file replacement" below), so hopefully
 103 your web server will not run it.
 104
 105 ## suid wrappers
 106
 107 ikiwiki --wrapper is intended to generate a wrapper program that
 108 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
 109 for example to be used in a [[post-commit]] hook by people who cannot write
 110 to the html pages, etc.
 111
 112 If the wrapper script is made suid, then any bugs in this wrapper would be
 113 security holes. The wrapper is written as securely as I know how, is based
 114 on code that has a history of security use long before ikiwiki, and there's
 115 been no problem yet.
 116
 117 ## shell exploits
 118
 119 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
 120 system() at all, and the only use of backticks is on data supplied by the
 121 wiki admin and untainted filenames. And it runs with taint checks on of
 122 course..
 123
 124 ## cgi data security
 125
 126 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
 127 page to edit. It has to make sure to sanitise this page, to prevent eg,
 128 editing of ../../../foo, or editing of files that are not part of the wiki,
 129 such as subversion dotfiles. This is done by sanitising the filename
 130 removing unallowed characters, then making sure it doesn't start with "/"
 131 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
 132 security holes breed. It needs a test suite at the very least.
 133
 134 ## CGI::Session security
 135
 136 I've audited this module and it is massively insecure by default. ikiwiki
 137 uses it in one of the few secure ways; by forcing it to write to a
 138 directory it controls (and not /tmp) and by setting a umask that makes the
 139 file not be world readable.
 140
 141 ## cgi password security
 142
 143 Login to the wiki involves sending a password in cleartext over the net.
 144 Cracking the password only allows editing the wiki as that user though.
 145 If you care, you can use https, I suppose.
 146
 147 ## XSS holes in CGI output
 148
 149 ikiwiki has not yet been audited to ensure that all cgi script input/output
 150 is sanitised to prevent XSS attacks. For example, a user can't register
 151 with a username containing html code (anymore).
 152
 153 It's difficult to know for sure if all such avenues have really been
 154 closed though.
 155
 156 ----
 157
 158 # Fixed holes
 159
 160 _(Unless otherwise noted, these were discovered and immediately fixed by the
 161 ikiwiki developers.)_
 162
 163 ## destination directory file replacement
 164
 165 Any file in the destination directory that is a valid page filename can be
 166 replaced, even if it was not originally rendered from a page. For example,
 167 ikiwiki.cgi could be edited in the wiki, and it would write out a
 168 replacement. File permission is preseved. Yipes!
 169
 170 This was fixed by making ikiwiki check if the file it's writing to exists;
 171 if it does then it has to be a file that it's aware of creating before, or
 172 it will refuse to create it.
 173
 174 Still, this sort of attack is something to keep in mind.
 175
 176 ## symlink attacks
 177
 178 Could a committer trick ikiwiki into following a symlink and operating on
 179 some other tree that it shouldn't? svn supports symlinks, so one can get
 180 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
 181 tell it to follow symlinks, but it might be possible to race replacing a
 182 directory with a symlink and trick it into following the link.
 183
 184 Also, if someone checks in a symlink to /etc/passwd, ikiwiki would read and
 185 publish that, which could be used to expose files a committer otherwise
 186 wouldn't see.
 187
 188 To avoid this, ikiwiki will skip over symlinks when scanning for pages, and
 189 uses locking to prevent more than one instance running at a time. The lock
 190 prevents one ikiwiki from running a svn up at the wrong time to race
 191 another ikiwiki. So only attackers who can write to the working copy on
 192 their own can race it.
 193
 194 ## symlink + cgi attacks
 195
 196 Similarly, a svn commit of a symlink could be made, ikiwiki ignores it
 197 because of the above, but the symlink is still there, and then you edit the
 198 page from the web, which follows the symlink when reading the page
 199 (exposing the content), and again when saving the changed page (changing
 200 the content).
 201
 202 This was fixed for page saving by making ikiwiki refuse to write to files
 203 that are symlinks, or that are in subdirectories that are symlinks,
 204 combined with the above locking.
 205
 206 For page editing, it's fixed by ikiwiki checking to make sure that it
 207 already has found a page by scanning the tree, before loading it for
 208 editing, which as described above, also is done in a way that avoids
 209 symlink attacks.
 210
 211 ## underlaydir override attacks
 212
 213 ikiwiki also scans an underlaydir for pages, this is used to provide stock
 214 pages to all wikis w/o needing to copy them into the wiki. Since ikiwiki
 215 internally stores only the base filename from the underlaydir or srcdir,
 216 and searches for a file in either directory when reading a page source,
 217 there is the potential for ikiwiki's scanner to reject a file from the
 218 srcdir for some reason (such as it being contained in a directory that is
 219 symlinked in), find a valid copy of the file in the underlaydir, and then
 220 when loading the file, mistakenly load the bad file from the srcdir.
 221
 222 This attack is avoided by making ikiwiki refuse to add any files from the
 223 underlaydir if a file also exists in the srcdir with the same name.
 224
 225 ## multiple page source issues
 226
 227 Note that I previously worried that underlay override attacks could also be
 228 accomplished if ikiwiki were extended to support other page markup
 229 languages besides markdown. However, a closer look indicates that this is
 230 not a problem: ikiwiki does preserve the file extension when storing the
 231 source filename of a page, so a file with another extension that renders to
 232 the same page name can't bypass the check. Ie, ikiwiki won't skip foo.rst
 233 in the srcdir, find foo.mdwn in the underlay, decide to render page foo and
 234 then read the bad foo.mdwn. Instead it will remember the .rst extension and
 235 only render a file with that extension.
 236
 237 ## XSS attacks in page content
 238
 239 ikiwiki supports protecting users from their own broken browsers via the
 240 [[plugins/htmlscrubber]] plugin, which is enabled by default.
 241
 242 ## svn commit logs
 243
 244 It's was possible to force a whole series of svn commits to appear to
 245 have come just before yours, by forging svn log output. This was
 246 guarded against by using svn log --xml.
 247
 248 ikiwiki escapes any html in svn commit logs to prevent other mischief.