add blog post template
[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 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 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 ## page locking can be bypassed via direct svn commits
54
55 A [[lock]]ed page can only be edited on the web by an admin, but
56 anyone who is allowed to commit direct to svn can bypass this. This is by
57 design, although a subversion pre-commit hook could be used to prevent
58 editing of locked pages when using subversion, if you really need to.
59
60 ----
61
62 # Hopefully non-holes
63
64 (AKA, the assumptions that will be the root of most security holes...)
65
66 ## exploting ikiwiki with bad content
67
68 Someone could add bad content to the wiki and hope to exploit ikiwiki.
69 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
70
71 ## publishing cgi scripts
72
73 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
74 rather, the script is published, but it's not marked executable (except in
75 the case of "destination directory file replacement" below), so hopefully
76 your web server will not run it.
77
78 ## suid wrappers
79
80 ikiwiki --wrapper is intended to generate a wrapper program that
81 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
82 for example to be used in a [[post-commit]] hook by people who cannot write
83 to the html pages, etc.
84
85 If the wrapper script is made suid, then any bugs in this wrapper would be
86 security holes. The wrapper is written as securely as I know how, is based
87 on code that has a history of security use long before ikiwiki, and there's
88 been no problem yet.
89
90 ## shell exploits
91
92 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
93 system() at all, and the only use of backticks is on data supplied by the
94 wiki admin and untainted filenames. And it runs with taint checks on of course..
95
96 ## cgi data security
97
98 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
99 page to edit. It has to make sure to sanitise this page, to prevent eg,
100 editing of ../../../foo, or editing of files that are not part of the wiki,
101 such as subversion dotfiles. This is done by sanitising the filename
102 removing unallowed characters, then making sure it doesn't start with "/"
103 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
104 security holes breed. It needs a test suite at the very least.
105
106 ## CGI::Session security
107
108 I've audited this module and it is massively insecure by default. ikiwiki
109 uses it in one of the few secure ways; by forcing it to write to a
110 directory it controls (and not /tmp) and by setting a umask that makes the
111 file not be world readable.
112
113 ## cgi password security
114
115 Login to the wiki involves sending a password in cleartext over the net.
116 Cracking the password only allows editing the wiki as that user though.
117 If you care, you can use https, I suppose.
118
119 # Fixed holes
120
121 _(Unless otherwise noted, these were discovered and immediatey fixed by the ikiwiki developers.)_
122
123 ## destination directory file replacement
124
125 Any file in the destination directory that is a valid page filename can be
126 replaced, even if it was not originally rendered from a page. For example,
127 ikiwiki.cgi could be edited in the wiki, and it would write out a
128 replacement. File permission is preseved. Yipes!
129
130 This was fixed by making ikiwiki check if the file it's writing to exists;
131 if it does then it has to be a file that it's aware of creating before, or
132 it will refuse to create it.
133
134 Still, this sort of attack is something to keep in mind.
135
136 ## symlink attacks
137
138 Could a committer trick ikiwiki into following a symlink and operating on
139 some other tree that it shouldn't? svn supports symlinks, so one can get
140 into the repo. ikiwiki uses File::Find to traverse the repo, and does not
141 tell it to follow symlinks, but it might be possible to race replacing a
142 directory with a symlink and trick it into following the link.
143
144 Also, if someone checks in a symlink to /etc/passwd, ikiwiki would read and
145 publish that, which could be used to expose files a committer otherwise
146 wouldn't see.
147
148 To avoid this, ikiwiki will skip over symlinks when scanning for pages, and
149 uses locking to prevent more than one instance running at a time. The lock
150 prevents one ikiwiki from running a svn up at the wrong time to race
151 another ikiwiki. So only attackers who can write to the working copy on
152 their own can race it.
153
154 ## symlink + cgi attacks
155
156 Similarly, a svn commit of a symlink could be made, ikiwiki ignores it
157 because of the above, but the symlink is still there, and then you edit the
158 page from the web, which follows the symlink when reading the page, and
159 again when saving the changed page.
160
161 This was fixed by making ikiwiki refuse to read or write to files that are
162 symlinks, combined with the above locking.