avoid linkifying escaped wikilinks
[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 ----
67
68 # Hopefully non-holes
69
70 (AKA, the assumptions that will be the root of most security holes...)
71
72 ## exploting ikiwiki with bad content
73
74 Someone could add bad content to the wiki and hope to exploit ikiwiki.
75 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
76
77 ## publishing cgi scripts
78
79 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
80 rather, the script is published, but it's not marked executable (except in
81 the case of "destination directory file replacement" below), so hopefully
82 your web server will not run it.
83
84 ## suid wrappers
85
86 ikiwiki --wrapper is intended to generate a wrapper program that
87 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
88 for example to be used in a [[post-commit]] hook by people who cannot write
89 to the html pages, etc.
90
91 If the wrapper script is made suid, then any bugs in this wrapper would be
92 security holes. The wrapper is written as securely as I know how, is based
93 on code that has a history of security use long before ikiwiki, and there's
94 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
99 system() at all, and the only use of backticks is on data supplied by the
100 wiki admin. And it runs with taint checks on of course..
101
102 ## destination directory file replacement
103
104 Any file in the destination directory that is a valid page filename can be
105 replaced, even if it was not originally rendered from a page. For example,
106 ikiwiki.cgi could be edited in the wiki, and it would write out a
107 replacement. File permission is preseved. Yipes!
108
109 This was fixed by making ikiwiki check if the file it's writing to exists;
110 if it does then it has to be a file that it's aware of creating before, or
111 it will refuse to create it.
112
113 Still, this sort of attack is something to keep in mind.
114
115 ## cgi data security
116
117 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
118 page to edit. It has to make sure to sanitise this page, to prevent eg,
119 editing of ../../../foo, or editing of files that are not part of the wiki,
120 such as subversion dotfiles. This is done by sanitising the filename
121 removing unallowed characters, then making sure it doesn't start with "/"
122 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
123 security holes breed. It needs a test suite at the very least.
124
125 ## cgi password security
126
127 Login to the wiki involves sending a password in cleartext over the net.
128 Cracking the password only allows editing the moo as that user though.
129 If you care, you can use https, I suppose.
130
131 ## CGI::Session security
132
133 I've audited this module and it is massively insecure by default. ikiwiki
134 uses it in one of the few secure ways; by forcing it to write to a
135 directory it controls (and not /tmp) and by setting a umask that makes the
136 file not be world readable.