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 # Probable holes
  10
  11 ## html attacks
  12
  13 ikiwiki does not attempt to do any santization of the html on the wiki.
  14 [[MarkDown]] allows embedding of arbitrary html into a markdown document. If
  15 you let anyone else edit files on the wiki, then anyone can have fun exploiting
  16 the web browser bug of the day. This type of attack is typically referred
  17 to as an XSS attack ([google](http://www.google.com/search?q=xss+attack)).
  18
  19 ## image files etc attacks
  20
  21 If it enounters a file type it does not understand, ikiwiki just copies it
  22 into place. So if you let users add any kind of file they like, they can
  23 upload images, movies, windows executables, css files, etc. If these files exploit security holes in the browser of someone who's viewing the wiki, that can be a security problem.
  24
  25 Of course nobody else seems to worry about this in other wikis, so should we?
  26
  27 ## web server attacks
  28
  29 If your web server does any parsing of special sorts of files (for example,
  30 server parsed html files), then if you let anyone else add files to the wiki,
  31 they can try to use this to exploit your web server.
  32
  33 ## multiple accessors of wiki directory
  34
  35 If multiple people can write to the source directory ikiwiki is using, or to the destination directory it writes files to, then one can cause trouble for the other when they run ikiwiki through symlink attacks.
  36
  37 So it's best if only one person can ever write to those directories.
  38
  39 ## setup files
  40
  41 Setup files are not safe to keep in subversion with the rest of the wiki.
  42 Just don't do it. [[ikiwiki.setup]] is *not* used as the setup file for
  43 this wiki, BTW.
  44
  45 ## svn commit logs
  46
  47 Anyone with svn commit access can forge "web commit from foo" and make it appear on [[RecentChanges]] like foo committed. One way to avoid this would be to limit web commits to those done by a certian user.
  48
  49 It's actually possible to force a whole series of svn commits to appear to
  50 have come just before yours, by forging svn log output. This could be
  51 guarded against by using svn log --xml.
  52
  53 ikiwiki escapes any html in svn commit logs to prevent other mischief.
  54
  55 ## page locking can be bypassed via direct svn commits
  56
  57 A [[lock]]ed page can only be edited on the web by an admin, but
  58 anyone who is allowed to commit direct to svn can bypass this. This is by
  59 design, although a subversion pre-commit hook could be used to prevent
  60 editing of locked pages when using subversion, if you really need to.
  61
  62 ----
  63
  64 # Hopefully non-holes
  65
  66 (AKA, the assumptions that will be the root of most security holes...)
  67
  68 ## exploting ikiwiki with bad content
  69
  70 Someone could add bad content to the wiki and hope to exploit ikiwiki.
  71 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
  72
  73 ## publishing cgi scripts
  74
  75 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
  76 rather, the script is published, but it's not marked executable (except in
  77 the case of "destination directory file replacement" below), so hopefully
  78 your web server will not run it.
  79
  80 ## suid wrappers
  81
  82 ikiwiki --wrapper is intended to generate a wrapper program that
  83 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
  84 for example to be used in a [[post-commit]] hook by people who cannot write
  85 to the html pages, etc.
  86
  87 If the wrapper script is made suid, then any bugs in this wrapper would be
  88 security holes. The wrapper is written as securely as I know how, is based
  89 on code that has a history of security use long before ikiwiki, and there's
  90 been no problem yet.
  91
  92 ## shell exploits
  93
  94 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
  95 system() at all, and the only use of backticks is on data supplied by the
  96 wiki admin and untainted filenames. And it runs with taint checks on of course..
  97
  98 ## cgi data security
  99
 100 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
 101 page to edit. It has to make sure to sanitise this page, to prevent eg,
 102 editing of ../../../foo, or editing of files that are not part of the wiki,
 103 such as subversion dotfiles. This is done by sanitising the filename
 104 removing unallowed characters, then making sure it doesn't start with "/"
 105 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
 106 security holes breed. It needs a test suite at the very least.
 107
 108 ## CGI::Session security
 109
 110 I've audited this module and it is massively insecure by default. ikiwiki
 111 uses it in one of the few secure ways; by forcing it to write to a
 112 directory it controls (and not /tmp) and by setting a umask that makes the
 113 file not be world readable.
 114
 115 ## cgi password security
 116
 117 Login to the wiki involves sending a password in cleartext over the net.
 118 Cracking the password only allows editing the wiki as that user though.
 119 If you care, you can use https, I suppose.
 120
 121 # Fixed holes
 122
 123 _(Unless otherwise noted, these were discovered and immediatey fixed by the ikiwiki developers.)_
 124
 125 ## destination directory file replacement
 126
 127 Any file in the destination directory that is a valid page filename can be
 128 replaced, even if it was not originally rendered from a page. For example,
 129 ikiwiki.cgi could be edited in the wiki, and it would write out a
 130 replacement. File permission is preseved. Yipes!
 131
 132 This was fixed by making ikiwiki check if the file it's writing to exists;
 133 if it does then it has to be a file that it's aware of creating before, or
 134 it will refuse to create it.
 135
 136 Still, this sort of attack is something to keep in mind.
 137
 138 ## symlink attacks
 139
 140 Could a committer trick ikiwiki into following a symlink and operating on
 141 some other tree that it shouldn't? svn supports symlinks, so one can get
 142 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
 143 tell it to follow symlinks, but it might be possible to race replacing a
 144 directory with a symlink and trick it into following the link.
 145
 146 Also, if someone checks in a symlink to /etc/passwd, ikiwiki would read and
 147 publish that, which could be used to expose files a committer otherwise
 148 wouldn't see.
 149
 150 To avoid this, ikiwiki will skip over symlinks when scanning for pages, and
 151 uses locking to prevent more than one instance running at a time. The lock
 152 prevents one ikiwiki from running a svn up at the wrong time to race
 153 another ikiwiki. So only attackers who can write to the working copy on
 154 their own can race it.
 155
 156 ## symlink + cgi attacks
 157
 158 Similarly, a svn commit of a symlink could be made, ikiwiki ignores it
 159 because of the above, but the symlink is still there, and then you edit the
 160 page from the web, which follows the symlink when reading the page, and
 161 again when saving the changed page.
 162
 163 This was fixed by making ikiwiki refuse to read or write to files that are
 164 symlinks, or that are in subdirectories that are symlinks, combined with
 165 the above locking.
 166
 167 ## underlaydir override attacks
 168
 169 ikiwiki also scans an underlaydir for pages, this is used to provide stock
 170 pages to all wikis w/o needing to copy them into the wiki. Since ikiwiki
 171 internally stores only the base filename from the underlaydir or srcdir,
 172 and searches for a file in either directory when reading a page source,
 173 there is the potential for ikiwiki's scanner to reject a file from the
 174 srcdir for some reason (such as it being a symlink), find a valid copy of
 175 the file in the underlaydir, and then when loading the file, mistekenly
 176 load the bad file from the srcdir.
 177
 178 This attack is avoided by making ikiwiki scan the srcdir first, and refuse
 179 to add any files from the underlaydir if a file also exists in the srcdir
 180 with the same name. **But**, note that this assumes that any given page can
 181 be produced from a file with only one name (`page.mdwn` => `page.html`).
 182
 183 If it's possible for files with different names to produce a given page, it
 184 would still be possible to use this attack to confuse ikiwiki into
 185 rendering the wrong thing. This is not currently possible, but must be kept
 186 in mind in the future when for example adding support for generating html
 187 pages from source with some other extension.