Skip to Content
Last modified by Agnease on 2026/06/29 13:22
From version 1.9
edited by Agnease
on 2026/05/22 03:22
Change comment: There is no comment for this version
To version 22.4
edited by Agnease
on 2026/06/24 15:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -xwiki-two-factor-authentication
1 +XWiki Two-Factor Authentication
Content
... ... @@ -1,30 +1,117 @@
1 1  {{velocity}}
2 2  #set ($discard = $xwiki.ssx.use('PublicWebSite.WebHome'))
3 3  #set ($discard = $xwiki.ssx.use('products.WebHome'))
4 +
5 +#set ($mainCapabilityItems = [{
6 +'title': 'Second verification step',
7 +'icon': 'key',
8 +'content': 'Add an additional verification screen after the normal XWiki username and password login.'
9 +},{
10 +'title': 'Authenticator app codes',
11 +'icon': 'mobile',
12 +'content': 'Let users verify access with time-based TOTP codes generated by authenticator applications.'
13 +},{
14 +'title': 'Recovery and trusted devices',
15 +'icon': 'shield',
16 +'content': 'Provide backup access with recovery codes and reduce repeated prompts on trusted browsers.'
17 +}])
18 +
19 +#set ($adminExperienceItems = [{
20 +'title': 'MFA policy',
21 +'icon': 'cog',
22 +'content': 'Make MFA optional or required for all users from the XWiki Administration section.'
23 +},{
24 +'title': 'Configuration options',
25 +'icon': 'sliders',
26 +'content': 'Set the authenticator issuer name, recovery-code count and trusted-device duration.'
27 +},{
28 +'title': 'Administration overview',
29 +'icon': 'table',
30 +'content': 'Review MFA adoption with summary indicators and a filterable Live Data table.'
31 +}])
32 +
33 +#set ($userExperienceItems = [{
34 +'title': 'Self-service setup',
35 +'icon': 'qrcode',
36 +'content': 'Users configure MFA from their profile by scanning a QR code or entering the setup key manually.'
37 +},{
38 +'title': 'Login verification',
39 +'icon': 'sign-in',
40 +'content': 'After the normal login, users enter the code generated by their authenticator app.'
41 +},{
42 +'title': 'Trusted browser option',
43 +'icon': 'desktop',
44 +'content': 'Users can trust the current browser for the configured duration after successful verification.'
45 +}])
46 +
47 +#set ($selfServiceItems = [{
48 +'title': 'Recovery codes',
49 +'icon': 'life-ring',
50 +'content': 'Recovery codes provide backup access when a user loses access to the authenticator application.'
51 +},{
52 +'title': 'Trusted devices',
53 +'icon': 'desktop',
54 +'content': 'Trusted devices can be reviewed and removed from the user profile.'
55 +},{
56 +'title': 'Profile management',
57 +'icon': 'user',
58 +'content': 'Users can review MFA status, generate recovery codes, manage trusted devices and reset MFA.'
59 +}])
60 +
61 +#set ($adminSupportItems = [{
62 +'title': 'User MFA status',
63 +'icon': 'user',
64 +'content': 'Administrators can open a user profile and check the MFA status for that account.'
65 +},{
66 +'title': 'MFA reset',
67 +'icon': 'refresh',
68 +'content': 'Administrators can reset MFA when a user needs to restart the configuration process.'
69 +},{
70 +'title': 'Controlled recovery',
71 +'icon': 'unlock-alt',
72 +'content': 'Resetting MFA removes the authenticator setup, recovery codes and trusted devices for that user.'
73 +}])
74 +
75 +#set ($rolloutItems = [{
76 +'title': 'Start with a pilot group',
77 +'content': 'Test the extension with administrators or a small user group before enabling it widely.'
78 +},{
79 +'title': 'Define the MFA policy',
80 +'content': 'Decide whether MFA should be optional at first or required for all users.'
81 +},{
82 +'title': 'Configure recovery options',
83 +'content': 'Choose the number of recovery codes and whether trusted devices should be allowed.'
84 +},{
85 +'title': 'Inform users',
86 +'content': 'Explain how users configure MFA, save recovery codes and manage trusted devices.'
87 +},{
88 +'title': 'Monitor adoption',
89 +'content': 'Use the administration overview to identify users who still need to configure MFA.'
90 +}])
91 +
4 4  {{html clean="false"}}
5 5  
6 -<section class="hero hero-centered product-hero" aria-labelledby="product-title">
94 +<section class="hero hero-centered" aria-labelledby="product-title">
7 7   <div class="container hero-inner">
8 8   <div class="hero-kicker">
9 9   <i class="fa fa-lock" aria-hidden="true"></i>
10 - XWiki security extension
98 + XWiki 2FA and MFA
11 11   </div>
12 12  
13 - <h1 id="product-title">XWiki Two-Factor Authentication</h1>
101 +```
102 +<h1 id="product-title">XWiki Two-Factor Authentication</h1>
14 14  
15 - <p class="lead">
16 - Add a second verification step to the standard XWiki login flow.
17 - </p>
104 +<p class="lead">
105 + Protect XWiki logins with a second verification step using authenticator app codes,
106 + recovery codes and trusted devices.
107 +</p>
18 18  
19 - <p class="hero-support">
20 - This extension protects XWiki accounts with an additional verification step after the standard username and password login.
21 - Users can verify access with an authenticator app code or an email-delivered code, while XWiki keeps its familiar login experience.
22 - </p>
109 +<div class="hero-actions">
110 + <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Ask about this extension</a>
111 + <a class="btn btn-secondary" href="$xwiki.getURL('products.WebHome')">View all products</a>
112 +</div>
113 +```
23 23  
24 - <div class="hero-actions">
25 - <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Ask about this extension</a>
26 - <a class="btn btn-secondary" href="$xwiki.getURL('products.WebHome')">View all products</a>
27 - </div>
28 28   </div>
29 29  </section>
30 30  
... ... @@ -32,171 +32,339 @@
32 32   <div class="container">
33 33   <div class="product-layout">
34 34   <article class="product-summary-card">
35 - <h2 id="overview-title">Stronger login protection for XWiki</h2>
122 + <h2 id="overview-title">Two-factor authentication built into XWiki</h2>
36 36  
37 - <p>
38 - The XWiki Two-Factor Authentication extension adds an additional verification screen after the standard
39 - username and password login. Users confirm their identity with a time-based one-time code generated by an
40 - authenticator app, or with a verification code delivered by email.
41 - </p>
124 +```
125 + <p>
126 + XWiki Two-Factor Authentication adds MFA support to the standard XWiki login flow.
127 + Users continue to sign in with their normal username and password, then confirm access
128 + with a time-based verification code from an authenticator application.
129 + </p>
42 42  
43 - <p>
44 - The extension is designed for organizations that want to improve account security while keeping authentication
45 - close to the standard XWiki login experience. It also supports remembering trusted clients beyond the current
46 - session, so users are not forced to enter a second factor again on every login from the same trusted browser.
47 - </p>
131 + <p>
132 + The extension is designed for organizations that want stronger access protection for
133 + internal knowledge bases, intranets, documentation platforms, customer portals and other
134 + XWiki-based applications.
135 + </p>
136 + </article>
48 48  
49 - <p>
50 - It can be useful for internal knowledge bases, intranets, documentation platforms, SOP systems, or other
51 - XWiki environments where access to content and administration should be better protected.
52 - </p>
53 - </article>
138 + <aside class="product-info-card" aria-labelledby="quick-facts-title">
139 + <h3 id="quick-facts-title">Quick facts</h3>
140 + <ul>
141 + <li>Works with the standard XWiki login flow</li>
142 + <li>Supports TOTP authenticator applications</li>
143 + <li>Can require MFA for all users</li>
144 + <li>Includes one-time recovery codes</li>
145 + <li>Can remember trusted browsers or devices</li>
146 + <li>Includes user self-service controls</li>
147 + <li>Includes an administration overview</li>
148 + </ul>
149 + </aside>
150 +</div>
151 +```
54 54  
55 - <aside class="product-info-card" aria-labelledby="quick-facts-title">
56 - <h3 id="quick-facts-title">Quick facts</h3>
57 - <ul>
58 - <li>Works with the standard XWiki login flow</li>
59 - <li>Adds a second TOTP verification step</li>
60 - <li>Configuration available from wiki administration</li>
61 - <li>User setup available during login or from the user profile</li>
62 - <li>Administrators can enable, disable or reset MFA for users</li>
63 - <li>Can be used on the main wiki and subwikis</li>
64 - </ul>
65 - </aside>
66 - </div>
67 67   </div>
68 68  </section>
69 69  
70 -<section aria-labelledby="features-title">
156 +<section aria-labelledby="capabilities-title">
71 71   <div class="container">
72 - <h2 id="features-title">Main capabilities</h2>
73 - <p class="section-intro">
74 - The extension focuses on adding a practical second authentication step while keeping the standard XWiki login
75 - process and administration experience understandable.
76 - </p>
158 + <h2 id="capabilities-title">Main capabilities</h2>
77 77  
78 - <div class="product-feature-grid">
79 - <article class="product-feature">
80 - <div class="feature-icon">
81 - <i class="fa fa-key" aria-hidden="true"></i>
82 - </div>
83 - <h3>Second login step</h3>
84 - <p>
85 - After the username and password are verified, users are asked to enter a time-based verification code.
86 - </p>
87 - </article>
160 +```
161 +<p class="section-intro">
162 + A focused set of MFA features for stronger XWiki account protection without replacing the familiar login experience.
163 +</p>
88 88  
89 - <article class="product-feature">
165 +<div class="product-feature-grid">
166 + #foreach ($entry in $mainCapabilityItems)
167 + <article class="product-feature">
168 + <div class="card-heading">
90 90   <div class="feature-icon">
91 - <i class="fa fa-qrcode" aria-hidden="true"></i>
170 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
92 92   </div>
93 - <h3>User setup screen</h3>
94 - <p>
95 - Users can configure their verification code setup during login or from their XWiki profile when needed.
96 - </p>
97 - </article>
172 + <h3>$entry.title</h3>
173 + </div>
98 98  
99 - <article class="product-feature">
175 + <p>$entry.content</p>
176 + </article>
177 + #end
178 +</div>
179 +```
180 +
181 + </div>
182 +</section>
183 +
184 +<section class="product-section-muted" aria-labelledby="security-title">
185 + <div class="container">
186 + <div class="product-layout">
187 + <article class="product-summary-card">
188 + <h2 id="security-title">Useful for XWiki security and access protection</h2>
189 +
190 +```
191 + <p>
192 + Many organizations use XWiki to store internal documentation, procedures, operational
193 + knowledge and business-critical information. Adding a second authentication factor helps
194 + reduce the risk of account compromise when a password is exposed or reused.
195 + </p>
196 +
197 + <p>
198 + The extension is especially useful for protecting administrator accounts, remote users,
199 + private knowledge bases and customer or partner portals.
200 + </p>
201 + </article>
202 +
203 + <aside class="product-info-card" aria-labelledby="use-cases-title">
204 + <h3 id="use-cases-title">Typical use cases</h3>
205 + <ul>
206 + <li>Administrator account protection</li>
207 + <li>Internal knowledge base security</li>
208 + <li>Private documentation platforms</li>
209 + <li>Remote user access protection</li>
210 + <li>Customer or partner portals</li>
211 + <li>Security review and NIS 2 readiness initiatives</li>
212 + </ul>
213 + </aside>
214 +</div>
215 +```
216 +
217 + </div>
218 +</section>
219 +
220 +<section aria-labelledby="admin-experience-title">
221 + <div class="container">
222 + <h2 id="admin-experience-title">Administrator configuration and monitoring</h2>
223 +
224 +```
225 +<p class="section-intro">
226 + Administrators can configure the MFA policy, define recovery options and monitor adoption from the XWiki Administration section.
227 +</p>
228 +
229 +<div class="product-feature-grid">
230 + #foreach ($entry in $adminExperienceItems)
231 + <article class="product-feature">
232 + <div class="card-heading">
100 100   <div class="feature-icon">
101 - <i class="fa fa-sliders" aria-hidden="true"></i>
234 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
102 102   </div>
103 - <h3>Administration controls</h3>
104 - <p>
105 - Administrators can enable the feature globally, manage user-level activation, and reset a user setup when required.
106 - </p>
107 - </article>
236 + <h3>$entry.title</h3>
237 + </div>
108 108  
109 - <article class="product-feature">
239 + <p>$entry.content</p>
240 + </article>
241 + #end
242 +</div>
243 +```
244 +
245 +{{/html}}
246 +
247 +{{gallery}}
248 +[[image:mfa-admin-configuration.png]]
249 +[[image:mfa-admin-overview.png]]
250 +[[image:mfa-admin-full.png]]
251 +{{/gallery}}
252 +
253 +{{html clean="false"}}
254 +
255 +```
256 +<p class="product-gallery-caption">
257 + Administration screens for configuring MFA and reviewing MFA adoption across users.
258 +</p>
259 +```
260 +
261 + </div>
262 +</section>
263 +
264 +<section class="product-section-muted" aria-labelledby="user-experience-title">
265 + <div class="container">
266 + <h2 id="user-experience-title">User setup and login verification</h2>
267 +
268 +```
269 +<p class="section-intro">
270 + Users can configure MFA from their profile or during the enforced setup flow, then verify future logins with their authenticator app.
271 +</p>
272 +
273 +<div class="product-feature-grid">
274 + #foreach ($entry in $userExperienceItems)
275 + <article class="product-feature">
276 + <div class="card-heading">
110 110   <div class="feature-icon">
111 - <i class="fa fa-user" aria-hidden="true"></i>
278 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
112 112   </div>
113 - <h3>Profile integration</h3>
114 - <p>
115 - The extension adds user profile controls so the second-factor setup can be reviewed or reset from XWiki.
116 - </p>
117 - </article>
280 + <h3>$entry.title</h3>
281 + </div>
118 118  
119 - <article class="product-feature">
283 + <p>$entry.content</p>
284 + </article>
285 + #end
286 +</div>
287 +```
288 +
289 +{{/html}}
290 +
291 +{{gallery}}
292 +[[image:mfa-user-setup-qr.png]]
293 +[[image:mfa-login-verification-setup.png]]
294 +[[image:mfa-login-verification-code.png]]
295 +{{/gallery}}
296 +
297 +{{html clean="false"}}
298 +
299 +```
300 +<p class="product-gallery-caption">
301 + User setup, enforced MFA configuration and login verification screens.
302 +</p>
303 +```
304 +
305 + </div>
306 +</section>
307 +
308 +<section aria-labelledby="self-service-title">
309 + <div class="container">
310 + <h2 id="self-service-title">Recovery codes and trusted devices</h2>
311 +
312 +```
313 +<p class="section-intro">
314 + Recovery codes and trusted devices help balance stronger access protection with a smoother user experience.
315 +</p>
316 +
317 +<div class="product-feature-grid">
318 + #foreach ($entry in $selfServiceItems)
319 + <article class="product-feature">
320 + <div class="card-heading">
120 120   <div class="feature-icon">
121 - <i class="fa fa-random" aria-hidden="true"></i>
322 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
122 122   </div>
123 - <h3>Fallback behavior</h3>
124 - <p>
125 - The extension can fall back to standard XWiki authentication when the feature is not enabled or not configured.
126 - </p>
127 - </article>
324 + <h3>$entry.title</h3>
325 + </div>
128 128  
129 - <article class="product-feature">
327 + <p>$entry.content</p>
328 + </article>
329 + #end
330 +</div>
331 +```
332 +
333 +{{/html}}
334 +
335 +{{gallery}}
336 +[[image:mfa-user-profile-overview.png]]
337 +[[image:mfa-recovery-codes-not-generated.png]]
338 +[[image:mfa-recovery-codes-generated.png]]
339 +[[image:mfa-trusted-devices.png]]
340 +[[image:mfa-user-profile-full.png]]
341 +{{/gallery}}
342 +
343 +{{html clean="false"}}
344 +
345 +```
346 +<p class="product-gallery-caption">
347 + User profile screens for recovery codes, trusted devices and MFA self-service management.
348 +</p>
349 +```
350 +
351 + </div>
352 +</section>
353 +
354 +<section class="product-section-muted" aria-labelledby="admin-support-title">
355 + <div class="container">
356 + <h2 id="admin-support-title">Administrator support and user recovery</h2>
357 +
358 +```
359 +<p class="section-intro">
360 + Administrators can help users recover from lost devices or restart MFA setup when needed.
361 +</p>
362 +
363 +<div class="product-feature-grid">
364 + #foreach ($entry in $adminSupportItems)
365 + <article class="product-feature">
366 + <div class="card-heading">
130 130   <div class="feature-icon">
131 - <i class="fa fa-sitemap" aria-hidden="true"></i>
368 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
132 132   </div>
133 - <h3>Main wiki and subwikis</h3>
134 - <p>
135 - The extension is designed to support XWiki environments using the main wiki and subwikis.
136 - </p>
137 - </article>
138 - </div>
370 + <h3>$entry.title</h3>
371 + </div>
372 +
373 + <p>$entry.content</p>
374 + </article>
375 + #end
376 +</div>
377 +```
378 +
379 +{{/html}}
380 +
381 +{{gallery}}
382 +[[image:mfa-admin-user-management.png]]
383 +{{/gallery}}
384 +
385 +{{html clean="false"}}
386 +
387 +```
388 +<p class="product-gallery-caption">
389 + Administrator view for checking and resetting a user MFA setup.
390 +</p>
391 +```
392 +
139 139   </div>
140 140  </section>
141 141  
142 -<section aria-labelledby="use-cases-title">
396 +<section aria-labelledby="rollout-title">
143 143   <div class="container">
144 144   <div class="product-layout">
145 145   <article class="product-summary-card">
146 - <h2 id="use-cases-title">When this extension is useful</h2>
400 + <h2 id="rollout-title">Rollout recommendations</h2>
147 147  
148 - <p>
149 - Two-factor authentication is especially relevant when XWiki contains internal documentation, procedures,
150 - customer information, project knowledge, administrative pages, or business-critical content.
151 - </p>
402 +```
403 + <p>
404 + For a smooth rollout, start with a small administrator or pilot group before requiring MFA for everyone.
405 + This helps validate the configuration, prepare user communication and reduce support issues.
406 + </p>
152 152  
153 - <p>
154 - It is also useful when many users access the wiki remotely, when administrator accounts need stronger protection,
155 - or when the organization wants to reduce the risk of compromised passwords.
156 - </p>
157 - </article>
408 + <ol class="process-list">
409 + #foreach ($entry in $rolloutItems)
410 + <li>
411 + <strong>$entry.title</strong>
412 + $entry.content
413 + </li>
414 + #end
415 + </ol>
416 + </article>
158 158  
159 - <aside class="product-info-card" aria-labelledby="good-fit-title">
160 - <h3 id="good-fit-title">Good fit for</h3>
161 - <ul>
162 - <li>Private XWiki knowledge bases</li>
163 - <li>Company intranets</li>
164 - <li>SOP and controlled-document platforms</li>
165 - <li>Documentation portals with sensitive content</li>
166 - <li>Wikis with several administrators or remote users</li>
167 - </ul>
168 - </aside>
169 - </div>
170 - </div>
171 -</section>
418 + <aside class="product-info-card" aria-labelledby="planning-title">
419 + <h3 id="planning-title">Useful information before installation</h3>
172 172  
173 -#*
174 -<section aria-labelledby="gallery-title">
175 - <div class="container">
176 - <div class="product-gallery-panel">
177 - <h2 id="gallery-title">Screenshots</h2>
178 - <p class="gallery-note">
179 - Use this area to show the login verification screen, first-time setup, user profile controls,
180 - and administration configuration.
181 - </p>
421 + <p class="product-card-note">
422 + These details help evaluate compatibility, rollout scope and configuration options.
423 + </p>
182 182  
183 - <div class="product-gallery-placeholder">
184 - Replace this placeholder with the XWiki gallery macro and 3-5 screenshots from the application.
185 - </div>
186 - </div>
425 + <ul>
426 + <li>XWiki version</li>
427 + <li>Single wiki or wiki farm with subwikis</li>
428 + <li>Current authentication setup</li>
429 + <li>Optional or globally required MFA policy</li>
430 + <li>Trusted-device policy</li>
431 + <li>Recovery-code policy</li>
432 + <li>Rollout communication needs</li>
433 + </ul>
434 + </aside>
435 +</div>
436 +```
437 +
187 187   </div>
188 188  </section>
189 -*#
440 +
190 190  <section class="cta-section" aria-labelledby="cta-title">
191 191   <div class="container">
192 192   <div class="cta-panel">
193 193   <h2 id="cta-title">Interested in using this extension?</h2>
194 - <p>
195 - Send a short message with your XWiki version, authentication setup, and whether you use a single wiki
196 - or a main wiki with subwikis.
197 - </p>
198 - <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Contact Agnease</a>
199 - </div>
445 +
446 +```
447 + <p>
448 + Send a short message with your XWiki version, current authentication setup and MFA rollout goal.
449 + </p>
450 +
451 + <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Contact Agnease</a>
452 +</div>
453 +```
454 +
200 200   </div>
201 201  </section>
202 202  
mfa-admin-configuration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +125.3 KB
Content
mfa-admin-full.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +184.3 KB
Content
mfa-admin-overview.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +64.7 KB
Content
mfa-admin-user-management.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +26.9 KB
Content
mfa-login-verification-code.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +23.6 KB
Content
mfa-login-verification-setup.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +115.9 KB
Content
mfa-recovery-codes-generated.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +38.5 KB
Content
mfa-recovery-codes-not-generated.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +27.0 KB
Content
mfa-trusted-devices.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +59.1 KB
Content
mfa-user-profile-full.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +197.5 KB
Content
mfa-user-profile-overview.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +193.4 KB
Content
mfa-user-setup-qr.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +176.6 KB
Content
Agnease.Code.SEODetailsClass[0]
metaDescription
... ... @@ -1,0 +1,1 @@
1 +Agnease Two-Factor Authentication for XWiki adds a second login verification step with authenticator app codes, email codes, combined verification and trusted-device remembering.
metaTitle
... ... @@ -1,0 +1,1 @@
1 +XWiki Two-Factor Authentication with 2FA and MFA Support | Agnease