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