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 ## symlink attacks
  34
  35 Could a committer trick ikiwiki into following a symlink and operating on
  36 some other tree that it shouldn't? svn supports symlinks, so one can get
  37 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
  38 tell it to follow symlinks, but it might be possible to race replacing a
  39 directory with a symlink and trick it into following.
  40
  41 It would certianly be possible to start out with a directory, let ikiwiki
  42 run and find a file in there, then replace it with a symlink, and ikiwiki
  43 would then go ahead and follow the symlink when it went to open that file
  44 to read it. If it was some private file and was running suid, that could be
  45 bad.
  46
  47 TODO: seems that locking to prevent more than one ikiwiki run at a time
  48 would both fix this and is a good idea in general. With locking, an
  49 attacker couldn't get ikiwiki to svn up while another instance was running.
  50
  51 Even with locking, if an attacker has local write access to the checkout,
  52 they could still fool ikiwiki using similar races. So it's best if only one
  53 person can ever write to the checkout that ikiwiki compiles the moo from.
  54
  55 ## webserver symlink attacks
  56
  57 If someone checks in a symlink to /etc/passwd, ikiwiki would publish that.
  58 To aoid this, ikiwiki will need to avoid reading files that are symlinks.
  59 TODO and note discussion of races above.
  60
  61 ## cgi security
  62
  63 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
  64 page to edit. It has to make sure to sanitise this page, to prevent eg,
  65 editing of ../../../foo, or editing of files that are not part of the wiki,
  66 such as subversion dotfiles. This is done by sanitising the filename
  67 removing unallowed characters, then making sure it doesn't start with "/"
  68 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
  69 security holes breed. It needs a test suite at the very least.
  70
  71 ----
  72
  73 # Probable non-holes
  74
  75 ## exploting ikiwiki with bad content
  76
  77 Someone could add bad content to the wiki and hope to exploit ikiwiki.
  78 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
  79
  80 ## publishing cgi scripts
  81
  82 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
  83 rather, the script is published, but it's not marked executable, so
  84 hopefully 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 on code that has a history of security use long before ikiwiki, and there's been no problem yet.
  95
  96 ## shell exploits
  97
  98 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use system() at all, and the only use of backticks is on data supplied by the wiki admin. And it runs with taint checks on of course..