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