make formatting more consistent
[ikiwiki.git] / doc / todo / Zoned_ikiwiki.mdwn
1 [[!toc levels=3]]
2
3 # Zoned ikiwiki
4
5 ## The idea
6
7 The idea behind this would be to have one ikiwiki behave as a dynamic private wiki in a specified area
8 and a more static publiczone wiki.
9
10 ## Use cases
11
12 This can be more or less difficult depending on the use case.
13
14 ### Purely static public zone with a single, controlled-access inward zone
15
16 For this case, only a known set of people are authorized to see the inward zone
17 or edit anything. Everybody else sees only the public zone. This use case is mostly
18 easy to handle now, as long as access to things like the `recentchanges` page and
19 repository browser are not granted for the public zone. In particular, the features
20 that allow information exposure via edit access are not of concern in this case.
21
22 ### Static public zone, more than one controlled inward zone
23
24 In this case, the known, controlled set of people with special access are divided
25 into groups with access to different (or overlapping) zones. The public still sees only a static zone.
26
27 Here, some of the harder issues, like information disclosure via edit access, do apply,
28 but only to members of the known, controlled groups. How much of a problem that is
29 depends on _how sensitive_ the information is that each group might reveal from another
30 zone. The rcs logs will show when a page has been edited to contain an [[ikiwiki/directive/inline]]
31 directive or other trick to reveal information, so if it is enough to treat the trusted users' conduct
32 as a management issue ("don't do that, please") then the risks can be acceptable in this case.
33
34 ### Public zone allows contribution/editing by external users
35
36 This case is the most difficult to cover at present, and probably shouldn't be attempted
37 without solutions to most or all of the **obstacles** identified here. 
38
39 ## Implementation techniques
40
41 ### Edit control by user and pagespec: lockedit
42
43 This works today, using the [[plugins/lockedit]] plugin. Because the `user` predicate
44 can be part of a [[ikiwiki/PageSpec]], this is all we need to flexibly control edit access
45 using any authentication method `ikiwiki` supports.
46
47 ### View control in the `http` server
48
49 We already can more or less do this for example with [[httpauth|/plugins/httpauth/]], `.htaccess` files and a proper `httpauth_pagespec`.
50
51 _Drawbacks:_ might be fiddly to configure and require maintaining two different user/pass logbases (native ikiwiki
52 signin), or impractical if ikiwiki is using an authentication method not natively supported
53 in the `http` server (e.g., OpenID).
54
55 ### View control in ikiwiki CGI
56
57 By requiring access to private zones to go through an ikiwiki CGI wrapper,
58 any ikiwiki-supported authentication method can be used, and the accessible
59 pages can be specified using the `user` predicate with [[ikiwiki/PageSpec]]s,
60 just as with the [[plugins/lockedit]] plugin.
61
62 The [[plugins/contrib/signinview]] plugin implements this idea, using very
63 simple configuration that is possible even in shared-hosting environments
64 without complete access to the `http` server configuration, as long as
65 `.htaccess` files or their equivalent can be created. The top directory of
66 a private zone needs only a `.htaccess` file with `Deny from All` or
67 `Require all denied` (or other equivalent directive for the `http` server
68 in use), and a `403` error handler of `{$cgiurl}?do=view`.
69
70 A plugin like [[plugins/contrib/pagespec_alias]] can be very useful for
71 defining a group of authorized users:
72
73     us: user(alice) or user(bob) or user(clotaldo)
74
75 so that zone access can be a simple [[ikiwiki/PageSpec]]:
76
77     us() and ours/*
78
79 *Drawbacks:* The private zones no longer reap all the benefits of a static
80 wiki generator, as a (fairly heavy) ikiwiki CGI wrapper must be started for
81 each access. (On the other hand, all it needs to do after confirming authorization
82 is basically `cat` the statically-generated page with appropriate response headers,
83 keeping the code simple and easy to audit.)
84
85 This can be adequate for a case where the static, public zone could receive a lot
86 of traffic, with the private zone(s) accessed only by a known small group of people.
87
88 ### View control with a FastCGI Authorizer
89
90 A plugin implementing a [FastCGI](http://www.fastcgi.com/)
91 [Authorizer](http://www.fastcgi.com/drupal/node/6?q=node/22#S6.3) could provide
92 the same benefits as [[plugins/contrib/signinview]] (any ikiwiki-supported auth
93 method, simple zone definition with [[ikiwiki/PageSpec]]s) with less overhead
94 per access.
95
96 ## Obstacles
97
98 A number of ikiwiki features aren't (yet) designed with zoning in mind,
99 and it will take some effort both to identify them all, and to think out how they
100 could be addressed. This section invites brainstorming of both kinds.
101 This might eventually merit a separate page [[Zoned ikiwiki obstacles]]
102 but I'll begin it here.
103
104 Note that not all of these issues will be problems for all **zoned ikiwiki use cases**.
105
106 ### Backlinks
107
108 What is problematic is when you link a public page in a private page : 
109 a backlink will be generated from the public page to the private page.
110
111 As noted in [[per_page_ACLs]] in the end users through backlink 
112 navigation will frequently hit HTTP/401 deterring browsing as well as for the admin at false-positive logwatching.
113
114 One can radically [[disable backlinks feature|todo/allow_disabling_backlinks]] but then no more neat backlink navigation that
115 is really good to have in both area.
116
117 Another way of just preventing this backlink leak in that case would be sufficient via i.e a *privatebacklinks* config and
118 a patch like this one [[!toggle id="backlinkpatch" text="(show)"]].
119
120 [[!toggleable id="backlinkpatch" text="""
121 Comments are welcome.
122
123 [[mathdesc]]
124
125
126 <pre>
127 diff --git a/IkiWiki.pm b/IkiWiki.pm
128 --- a/IkiWiki.pm
129 +++ b/IkiWiki.pm
130 @@ -294,6 +294,14 @@ sub getsetup () {
131                 safe => 1,
132                 rebuild => 1,
133         },
134 +       privatebacklinks => {
135 +               type => "pagespec",
136 +               example => "",
137 +               description => "PageSpec controlling which backlinks are private (ie users/*)",
138 +               link => "ikiwiki/PageSpec",
139 +               safe => 1,
140 +               rebuild => 1,
141 +       },
142         hardlink => {
143                 type => "boolean",
144                 default => 0,
145 diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
146 --- a/IkiWiki/Render.pm
147 +++ b/IkiWiki/Render.pm
148 @@ -52,7 +52,8 @@ sub backlinks ($) {
149                         $p_trimmed=~s/^\Q$dir\E// &&
150                         $page_trimmed=~s/^\Q$dir\E//;
151                                
152 -               push @links, { url => $href, page => pagetitle($p_trimmed) };
153 +               push @links, { url => $href, page => pagetitle($p_trimmed) }
154 +               unless defined $config{privatebacklinks} && length $config{privatebacklinks} && pagespec_match($p, $config{privatebacklinks}) && !pagespec_match($page, $config{privatebacklinks}) ;
155         }
156         return @links;
157  }
158
159 </pre>
160 """]]
161
162 In use cases where the main concern about backlinks is only the bad user experience when links are
163 shown that lead to access denial when clicked, a workable
164 solution could be to make the backlinks `div` invisible in `local.css`.
165
166 ### recentchanges page
167
168 An accessible `recentchanges` page can include links to changes to pages
169 that should not be accessible. Even if the links cannot be followed, the
170 existence of the pages and their edit history are leaked. If rcs integration
171 is configured, those links on the `recentchanges` page can leak complete contents
172 through the **rcs browser**.
173
174 It can be helpful to generate separate `recentchanges` pages for different zones.
175 The [[plugins/recentchanges]] plugin already allows this--a `recentchanges` page
176 can be created anywhere, just by using the `recentchanges` directive
177 with the right [[ikiwiki/PageSpec]] for the zone it should cover--except that it cannot yet
178 be configured to generate a different `recentchanges` link destination into pages
179 in different zones. So, it would be helpful if its configuration could allow multiple
180 `recentchangespage` values, paired with `PageSpec`s for the pages on which they
181 should be used.
182
183 ### rcs browser
184
185 If the repository browser is accessible, potentially all content can be exposed.
186 Even if links to the repository browser are not generated into public wiki pages,
187 if a user can obtain or guess the repository browser URL and construct arbitrary
188 requests, information can be revealed.
189
190 Solutions could involve authnz features of the revision control systems themselves
191 and their associated repository browsers; for example, `svn` supposedly has such
192 features, and recent versions of `viewvc` supposedly honor them. But such features
193 may not be available for every rcs, and where they are available, they'll have to
194 be configured separately and differently from ikiwiki itself. They might not support
195 the same auth methods (e.g. OpenID) being used by the wiki itself.
196
197 Another approach would be for ikiwiki's own rcs plugin to generate a CGI wrapper
198 that invokes the repository browser CGI (which itself would _not_ be made
199 executable via `http` request). The `historyurl` and `diffurl` would then refer
200 to this wrapper. (In fact, they would not have to be specified in the config file,
201 as the plugin would know where it generated them. Instead, what would need to be
202 specified would be the filesystem path for the rcs browser being wrapped). The
203 wrapper could dissect the request parameters, identify the pages being accessed,
204 and subject them to the same accessibility tests used for the wiki. The rcs browser
205 itself needs to be configured to use the wrapper URL in all its generated links,
206
207 This might not be very hard to do with `gitweb` as it is already implemented in Perl.
208 The wrapper could probably import it and use its already-supplied routines to parse
209 the request into the affected file names, and probably complete the whole request
210 without a second `exec`. Other rcs backends might or might not be as easy.
211
212 ### Search
213
214 If [[plugins/search]] is enabled, private content is indexed and
215 searchable to the public.
216
217 ### Information leaks allowed by edit access
218
219 > Have you considered all the ways that anyone with edit access to the
220 > public wiki could expose information from the public wiki? For example,
221 > you could inline all the private pages into a public page. --[[Joey]]
222
223 Many ikiwiki features could give information exposure opportunities to someone
224 with edit access. The list here is surely incomplete, and would take a purposeful
225 review of the code and plugins (including third-party plugins) to complete.
226
227 * Directives that can inline information from other pages
228     * [[ikiwiki/directive/inline]] *the most obvious one*
229     * [[ikiwiki/directive/map]]
230     * [[ikiwiki/directive/brokenlinks]] ?
231     * [[ikiwiki/directive/orphans]] ?
232     * [[ikiwiki/directive/linkmap]] ?
233     * _others_?
234 * Not to forget `contrib` plugins
235     * [[plugins/contrib/report]] ?
236     * _others_?