web commit by BrandenRobinson: Add brainstorming about email change notification.
[ikiwiki.git] / 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 source 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 appeat 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 have come just before yours, by forging svn log output. This could be guarded against somewhat by revision number scanning, since the forged revisions would duplicate the numbers of unforged ones. Or subversion could fix svn log to indent commit messages, which would make such forgery impossible..
50
51 ikiwiki escapes any html in svn commit logs to prevent other mischief.
52
53 ----
54
55 # Hopefully non-holes
56
57 (AKA, the assumptions that will be the root of most security holes...)
58
59 ## exploting ikiwiki with bad content
60
61 Someone could add bad content to the wiki and hope to exploit ikiwiki.
62 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
63
64 ## publishing cgi scripts
65
66 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
67 rather, the script is published, but it's not marked executable (except in
68 the case of "destination directory file replacement" below), so hopefully
69 your web server will not run it.
70
71 ## suid wrappers
72
73 ikiwiki --wrapper is intended to generate a wrapper program that
74 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
75 for example to be used in a [[post-commit]] hook by people who cannot write
76 to the html pages, etc.
77
78 If the wrapper script is made suid, then any bugs in this wrapper would be
79 security holes. The wrapper is written as securely as I know how, is based
80 on code that has a history of security use long before ikiwiki, and there's
81 been no problem yet.
82
83 ## shell exploits
84
85 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
86 system() at all, and the only use of backticks is on data supplied by the
87 wiki admin. And it runs with taint checks on of course..
88
89 ## destination directory file replacement
90
91 Any file in the destination directory that is a valid page filename can be
92 replaced, even if it was not originally rendered from a page. For example,
93 ikiwiki.cgi could be edited in the wiki, and it would write out a
94 replacement. File permission is preseved. Yipes!
95
96 This was fixed by making ikiwiki check if the file it's writing to exists;
97 if it does then it has to be a file that it's aware of creating before, or
98 it will refuse to create it.
99
100 Still, this sort of attack is something to keep in mind.
101
102 ## cgi data security
103
104 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
105 page to edit. It has to make sure to sanitise this page, to prevent eg,
106 editing of ../../../foo, or editing of files that are not part of the wiki,
107 such as subversion dotfiles. This is done by sanitising the filename
108 removing unallowed characters, then making sure it doesn't start with "/"
109 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
110 security holes breed. It needs a test suite at the very least.
111
112 ## cgi password security
113
114 Login to the wiki involves sending a password in cleartext over the net.
115 Cracking the password only allows editing the wiki as that user though.
116 If you care, you can use https, I suppose.
117
118 ## CGI::Session security
119
120 I've audited this module and it is massively insecure by default. ikiwiki
121 uses it in one of the few secure ways; by forcing it to write to a
122 directory it controls (and not /tmp) and by setting a umask that makes the
123 file not be world readable.
124
125 ## symlink attacks
126
127 Could a committer trick ikiwiki into following a symlink and operating on
128 some other tree that it shouldn't? svn supports symlinks, so one can get
129 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
130 tell it to follow symlinks, but it might be possible to race replacing a
131 directory with a symlink and trick it into following the link.
132
133 Also, if someone checks in a symlink to /etc/passwd, ikiwiki would read and publish that, which could be used to expose files a committer otherwise wouldn't see.
134
135 To avoid this, ikiwiki will avoid reading files that are symlinks, and uses locking to prevent more than one instance running at a time. The lock prevents one ikiwiki from running a svn up at the wrong time to race another ikiwiki. So only attackers who can write to the working copy on their own can race it.