]> sipb.mit.edu Git - ikiwiki.git/blob - doc/security.mdwn
added signin form, although it needs to be hooked up to a user store
[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 sttacks.
56
57 So it's best if only one person can ever write to the checkout that ikiwiki
58 compiles the moo 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 ## cgi data security
67
68 When ikiwiki runs as a cgi to edit a page, it is passed the name of the
69 page to edit. It has to make sure to sanitise this page, to prevent eg,
70 editing of ../../../foo, or editing of files that are not part of the wiki,
71 such as subversion dotfiles. This is done by sanitising the filename
72 removing unallowed characters, then making sure it doesn't start with "/"
73 or contain ".." or "/.svn/". Annoyingly ad-hoc, this kind of code is where
74 security holes breed. It needs a test suite at the very least.
75
76 ## cgi password security
77
78 Login to the wiki involves sending a password in cleartext over the net.
79 Cracking the password only allows editing the moo as that user though.
80 If you care, you can use https, I suppose.
81
82 ## CGI::Session security
83
84 Is CGI::Session secure? Well, it writes the session files world-readable,
85 which could be used by a local attacker to take over someone's session.
86
87 I have no idea if CGI::Session writes session files securely to /tmp.
88 ikiwiki makes it write them to a directory it controls (but see "multiple
89 accessors of wiki source directory" above).
90
91 ----
92
93 # Probable non-holes
94
95 ## exploting ikiwiki with bad content
96
97 Someone could add bad content to the wiki and hope to exploit ikiwiki.
98 Note that ikiwiki runs with perl taint checks on, so this is unlikely.
99
100 ## publishing cgi scripts
101
102 ikiwiki does not allow cgi scripts to be published as part of the wiki. Or
103 rather, the script is published, but it's not marked executable, so
104 hopefully your web server will not run it.
105
106 ## suid wrappers
107
108 ikiwiki --wrapper is intended to generate a wrapper program that
109 runs ikiwiki to update a given wiki. The wrapper can in turn be made suid,
110 for example to be used in a [[post-commit]] hook by people who cannot write
111 to the html pages, etc.
112
113 If the wrapper script is made suid, then any bugs in this wrapper would be
114 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.
115
116 ## shell exploits
117
118 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..