ce4c6f718202581e3dc3871d8b4a64cead0c82b0
[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 ## 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 ## multiple accessors of wiki source directory
52
53 If multiple people can write to the source directory ikiwiki is using, then
54 one can cause trouble for the other when they run ikiwiki through symlink
55 attacks.
56
57 So it's best if only one person can ever write to the checkout that ikiwiki
58 compiles the wiki from.
59
60 ## webserver symlink attacks
61
62 If someone checks in a symlink to /etc/passwd, ikiwiki would publish that.
63 To aoid this, ikiwiki will need to avoid reading files that are symlinks.
64 TODO and note discussion of races above.
65
66 ## setup files
67
68 Setup files are not safe to keep in subversion with the rest of the wiki.
69 Just don't do it. [[ikiwiki.setup]] is *not* used as the setup file for
70 this wiki, BTW.
71
72 ## svn commit logs
73
74 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.
75
76 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..
77
78 ikiwiki escapes any html in svn commit logs to prevent other mischief.
79
80 ----
81
82 # Hopefully non-holes
83
84 (AKA, the assumptions that will be the root of most security holes...)
85
86 ## exploting ikiwiki with bad content
87
88 Someone could add bad content to the wiki and hope to exploit ikiwiki.
89 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
90
91 ## publishing cgi scripts
92
93 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
94 rather, the script is published, but it's not marked executable (except in
95 the case of "destination directory file replacement" below), so hopefully
96 your web server will not run it.
97
98 ## suid wrappers
99
100 ikiwiki --wrapper is intended to generate a wrapper program that
101 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
102 for example to be used in a [[post-commit]] hook by people who cannot write
103 to the html pages, etc.
104
105 If the wrapper script is made suid, then any bugs in this wrapper would be
106 security holes. The wrapper is written as securely as I know how, is based
107 on code that has a history of security use long before ikiwiki, and there's
108 been no problem yet.
109
110 ## shell exploits
111
112 ikiwiki does not expose untrusted data to the shell. In fact it doesn't use
113 system() at all, and the only use of backticks is on data supplied by the
114 wiki admin. And it runs with taint checks on of course..
115
116 ## destination directory file replacement
117
118 Any file in the destination directory that is a valid page filename can be
119 replaced, even if it was not originally rendered from a page. For example,
120 ikiwiki.cgi could be edited in the wiki, and it would write out a
121 replacement. File permission is preseved. Yipes!
122
123 This was fixed by making ikiwiki check if the file it's writing to exists;
124 if it does then it has to be a file that it's aware of creating before, or
125 it will refuse to create it.
126
127 Still, this sort of attack is something to keep in mind.
128
129 ## cgi data security
130
131 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
132 page to edit. It has to make sure to sanitise this page, to prevent eg,
133 editing of ../../../foo, or editing of files that are not part of the wiki,
134 such as subversion dotfiles. This is done by sanitising the filename
135 removing unallowed characters, then making sure it doesn't start with "/"
136 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
137 security holes breed. It needs a test suite at the very least.
138
139 ## cgi password security
140
141 Login to the wiki involves sending a password in cleartext over the net.
142 Cracking the password only allows editing the wiki as that user though.
143 If you care, you can use https, I suppose.
144
145 ## CGI::Session security
146
147 I've audited this module and it is massively insecure by default. ikiwiki
148 uses it in one of the few secure ways; by forcing it to write to a
149 directory it controls (and not /tmp) and by setting a umask that makes the
150 file not be world readable.