Skip to Content
Last modified by Agnease on 2026/06/24 16:39
From version 6.12
edited by Agnease
on 2026/06/23 07:40
Change comment: There is no comment for this version
To version 22.6
edited by Agnease
on 2026/06/24 15:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,60 +2,105 @@
2 2  #set ($discard = $xwiki.ssx.use('PublicWebSite.WebHome'))
3 3  #set ($discard = $xwiki.ssx.use('products.WebHome'))
4 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.'
5 +#set ($businessValueItems = [{
6 + 'title': 'Reduce account compromise risk',
7 + 'icon': 'shield',
8 + 'content': 'Add a second verification step after password login to better protect private XWiki content and administrator accounts.'
9 9  },{
10 - 'title': 'Authenticator app codes',
11 - 'icon': 'mobile',
12 - 'content': 'Let users verify access with time-based TOTP codes generated by authenticator applications.'
10 + 'title': 'Keep the standard XWiki experience',
11 + 'icon': 'sign-in',
12 + 'content': 'Extend the familiar XWiki login flow instead of replacing it with a completely different authentication experience.'
13 13  },{
14 - 'title': 'Email verification codes',
15 - 'icon': 'envelope-o',
16 - 'content': 'Send one-time verification codes by email when this method is enabled or combined with app codes.'
14 + 'title': 'Support a controlled rollout',
15 + 'icon': 'tasks',
16 + 'content': 'Start with optional MFA, then require MFA for all users when the organization is ready.'
17 17  }])
18 18  
19 -#set ($adminExperienceItems = [{
20 - 'title': 'Simple MFA policy',
19 +#set ($adminControlItems = [{
20 + 'title': 'Global MFA policy',
21 21   'icon': 'cog',
22 - 'content': 'Administrators can make MFA optional or required for all users from the XWiki Administration section.'
22 + 'content': 'Administrators can decide whether MFA is optional or required for all users.'
23 23  },{
24 - 'title': 'Recovery and trusted devices',
25 - 'icon': 'shield',
26 - 'content': 'Configure recovery-code count and trusted-device duration according to the organization security policy.'
24 + 'title': 'Recovery policy',
25 + 'icon': 'life-ring',
26 + 'content': 'Configure how many one-time recovery codes are generated for each user, or disable recovery codes if needed.'
27 27  },{
28 - 'title': 'Administration overview',
28 + 'title': 'Trusted-device policy',
29 + 'icon': 'desktop',
30 + 'content': 'Configure how long a trusted browser remains valid, or disable trusted devices for stricter environments.'
31 +}])
32 +
33 +#set ($adminVisibilityItems = [{
34 + 'title': 'MFA adoption overview',
35 + 'icon': 'bar-chart',
36 + 'content': 'Review how many users are scanned, how many have MFA configured, and how many still need attention.'
37 +},{
38 + 'title': 'Filterable user table',
29 29   'icon': 'table',
30 - 'content': 'Review MFA adoption across users with summary indicators and a filterable Live Data table.'
40 + 'content': 'Use the Live Data table to review configured users, recovery-code status and trusted-device usage.'
41 +},{
42 + 'title': 'Operational monitoring',
43 + 'icon': 'search',
44 + 'content': 'Identify accounts with missing recovery codes or trusted devices from the administration area.'
31 31  }])
32 32  
33 -#set ($userExperienceItems = [{
47 +#set ($userAdoptionItems = [{
34 34   'title': 'Self-service setup',
35 35   'icon': 'qrcode',
36 - 'content': 'Users configure MFA from their profile by scanning a QR code or entering the setup key manually.'
50 + 'content': 'Users can configure MFA by scanning a QR code with their authenticator application.'
37 37  },{
38 - 'title': 'Familiar login flow',
39 - 'icon': 'sign-in',
40 - 'content': 'After the normal login, users enter the configured verification code before accessing XWiki.'
52 + 'title': 'Manual setup details',
53 + 'icon': 'keyboard-o',
54 + 'content': 'Users can also enter the account name and secret key manually if they cannot scan the QR code.'
41 41  },{
42 - 'title': 'Profile management',
43 - 'icon': 'user',
44 - 'content': 'Users can review MFA status, manage recovery codes and remove trusted devices from their profile.'
56 + 'title': 'Enforced setup flow',
57 + 'icon': 'lock',
58 + 'content': 'When MFA is required, users are guided to complete setup before continuing.'
45 45  }])
46 46  
47 -#set ($recoveryItems = [{
48 - 'title': 'Recovery codes',
61 +#set ($loginProtectionItems = [{
62 + 'title': 'Second login step',
63 + 'icon': 'key',
64 + 'content': 'After the normal username and password login, users enter the verification code from their authenticator app.'
65 +},{
66 + 'title': 'Backup login option',
67 + 'icon': 'unlock-alt',
68 + 'content': 'If recovery codes are enabled, users can use a recovery code when they lose access to the authenticator app.'
69 +},{
70 + 'title': 'Trusted browser option',
71 + 'icon': 'desktop',
72 + 'content': 'Users can trust the current browser for the configured duration after successful verification.'
73 +}])
74 +
75 +#set ($continuityItems = [{
76 + 'title': 'One-time recovery codes',
49 49   'icon': 'life-ring',
50 - 'content': 'Recovery codes provide backup access when a user loses access to the authenticator application.'
78 + 'content': 'Recovery codes help users regain access if they lose their authenticator device.'
51 51  },{
52 - 'title': 'Trusted devices',
80 + 'icon': 'life-ring',
81 + 'content': 'Recovery codes help users regain access if they lose their authenticator device.'
82 +},{
83 + 'title': 'Codes shown once',
84 + 'icon': 'eye-slash',
85 + 'content': 'Recovery codes are displayed only once and each code can be used a single time.'
86 +},{
87 + 'title': 'Trusted-device management',
53 53   'icon': 'desktop',
54 - 'content': 'Trusted browsers or devices can skip repeated MFA prompts for a configured period.'
89 + 'content': 'Users can review trusted devices, identify the current browser and remove devices they no longer use.'
90 +}])
91 +
92 +#set ($adminSupportItems = [{
93 + 'title': 'User MFA status',
94 + 'icon': 'user',
95 + 'content': 'Administrators can open a user profile and check whether MFA is configured for that account.'
55 55  },{
56 - 'title': 'Administrator reset',
97 + 'title': 'Helpdesk recovery',
57 57   'icon': 'refresh',
58 - 'content': 'Administrators can reset a user MFA setup when the user needs to restart the configuration process.'
99 + 'content': 'Administrators can reset MFA when a user loses access to the authenticator app or needs to restart setup.'
100 +},{
101 + 'title': 'Clean reset',
102 + 'icon': 'trash',
103 + 'content': 'Resetting MFA removes the authenticator setup, recovery codes and trusted devices for that user.'
59 59  }])
60 60  
61 61  #set ($rolloutItems = [{
... ... @@ -63,12 +63,12 @@
63 63   'content': 'Test the extension with administrators or a small user group before enabling it widely.'
64 64  },{
65 65   'title': 'Define the MFA policy',
66 - 'content': 'Decide whether MFA should be optional, required for administrators, or required for all users.'
111 + 'content': 'Decide whether MFA should be optional at first or required for all users.'
67 67  },{
68 68   'title': 'Configure recovery options',
69 - 'content': 'Choose whether recovery codes and trusted devices should be enabled.'
114 + 'content': 'Choose the number of recovery codes and whether trusted devices should be allowed.'
70 70  },{
71 - 'title': 'Inform users',
116 + 'title': 'Prepare user communication',
72 72   'content': 'Explain how users configure MFA, save recovery codes and manage trusted devices.'
73 73  },{
74 74   'title': 'Monitor adoption',
... ... @@ -77,8 +77,6 @@
77 77  
78 78  {{html clean="false"}}
79 79  
80 -<div class="product-doc-page product-mfa-page">
81 -
82 82  <section class="hero hero-centered" aria-labelledby="product-title">
83 83   <div class="container hero-inner">
84 84   <div class="hero-kicker">
... ... @@ -89,8 +89,8 @@
89 89   <h1 id="product-title">XWiki Two-Factor Authentication</h1>
90 90  
91 91   <p class="lead">
92 - Protect XWiki logins with a second verification step using authenticator app codes,
93 - email verification codes, or both.
135 + Protect XWiki logins with authenticator app verification, recovery codes, trusted devices
136 + and administrator visibility.
94 94   </p>
95 95  
96 96   <div class="hero-actions">
... ... @@ -104,18 +104,18 @@
104 104   <div class="container">
105 105   <div class="product-layout">
106 106   <article class="product-summary-card">
107 - <h2 id="overview-title">Two-factor authentication built into XWiki</h2>
150 + <h2 id="overview-title">MFA protection built for XWiki</h2>
108 108  
109 109   <p>
110 - XWiki Two-Factor Authentication adds MFA/2FA support to the standard XWiki login flow.
111 - Users continue to sign in with their normal username and password, then confirm access with
112 - an additional verification method.
153 + XWiki Two-Factor Authentication adds a second verification step to the standard XWiki login flow.
154 + Users continue to sign in with their normal username and password, then confirm access with a
155 + time-based code generated by an authenticator application.
113 113   </p>
114 114  
115 115   <p>
116 - The extension supports authenticator app codes, email-delivered verification codes, or a combined
117 - setup where both methods are required. It is designed to improve account protection without replacing
118 - the familiar XWiki authentication experience.
159 + The extension is designed for organizations that use XWiki to manage internal documentation,
160 + procedures, knowledge bases, customer portals or other private collaboration spaces where
161 + stronger account protection is needed.
119 119   </p>
120 120   </article>
121 121  
... ... @@ -123,12 +123,12 @@
123 123   <h3 id="quick-facts-title">Quick facts</h3>
124 124   <ul>
125 125   <li>Works with the standard XWiki login flow</li>
126 - <li>Supports TOTP authenticator applications</li>
127 - <li>Supports email-delivered one-time codes</li>
128 - <li>Can require app and email verification together</li>
129 - <li>Includes recovery codes for backup access</li>
130 - <li>Can remember trusted browsers or devices</li>
131 - <li>Includes administration and user controls</li>
169 + <li>Uses TOTP authenticator applications</li>
170 + <li>Can require MFA for all users</li>
171 + <li>Includes one-time recovery codes</li>
172 + <li>Supports trusted browsers or devices</li>
173 + <li>Includes user self-service controls</li>
174 + <li>Includes administration monitoring</li>
132 132   </ul>
133 133   </aside>
134 134   </div>
... ... @@ -135,16 +135,16 @@
135 135   </div>
136 136  </section>
137 137  
138 -<section aria-labelledby="capabilities-title">
181 +<section class="product-section-muted" aria-labelledby="business-value-title">
139 139   <div class="container">
140 - <h2 id="capabilities-title">Main capabilities</h2>
183 + <h2 id="business-value-title">Business value</h2>
141 141  
142 142   <p class="section-intro">
143 - A focused set of MFA/2FA features for stronger XWiki account protection without changing the standard login experience.
186 + The extension helps organizations strengthen XWiki access protection without making login and account recovery unnecessarily complex.
144 144   </p>
145 145  
146 146   <div class="product-feature-grid">
147 - #foreach ($entry in $mainCapabilityItems)
190 + #foreach ($entry in $businessValueItems)
148 148   <article class="product-feature">
149 149   <div class="card-heading">
150 150   <div class="feature-icon">
... ... @@ -160,48 +160,53 @@
160 160   </div>
161 161  </section>
162 162  
163 -<section class="product-section-muted" aria-labelledby="security-title">
206 +<section aria-labelledby="admin-control-title">
164 164   <div class="container">
165 - <div class="product-layout">
166 - <article class="product-summary-card">
167 - <h2 id="security-title">Useful for XWiki security and access protection</h2>
208 + <h2 id="admin-control-title">Administrator control</h2>
168 168  
169 - <p>
170 - Many organizations need multi-factor authentication for internal tools, knowledge bases,
171 - intranets, documentation platforms and systems containing operational or sensitive information.
172 - </p>
210 + <p class="section-intro">
211 + Administrators configure the MFA policy directly from the XWiki Administration section, without editing configuration files for day-to-day policy changes.
212 + </p>
173 173  
174 - <p>
175 - For XWiki, adding two-factor authentication directly to the standard login flow helps protect
176 - administrator accounts, remote users, private knowledge bases and customer or partner portals.
177 - </p>
178 - </article>
214 + <div class="product-feature-grid">
215 + #foreach ($entry in $adminControlItems)
216 + <article class="product-feature">
217 + <div class="card-heading">
218 + <div class="feature-icon">
219 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
220 + </div>
221 + <h3>$entry.title</h3>
222 + </div>
179 179  
180 - <aside class="product-info-card" aria-labelledby="use-cases-title">
181 - <h3 id="use-cases-title">Typical use cases</h3>
182 - <ul>
183 - <li>Administrator account protection</li>
184 - <li>Internal knowledge base security</li>
185 - <li>Private documentation platforms</li>
186 - <li>Remote user access protection</li>
187 - <li>Customer or partner portals</li>
188 - <li>Security review and NIS 2 readiness initiatives</li>
189 - </ul>
190 - </aside>
224 + <p>$entry.content</p>
225 + </article>
226 + #end
191 191   </div>
228 +
229 +{{/html}}
230 +
231 +{{gallery}}
232 +[[image:mfa-admin-configuration.png]]
233 +{{/gallery}}
234 +
235 +{{html clean="false"}}
236 +
237 + <p class="product-gallery-caption">
238 + Administration configuration for requiring MFA, setting the authenticator issuer name, recovery-code count and trusted-device duration.
239 + </p>
192 192   </div>
193 193  </section>
194 194  
195 -<section aria-labelledby="admin-experience-title">
243 +<section class="product-section-muted" aria-labelledby="admin-visibility-title">
196 196   <div class="container">
197 - <h2 id="admin-experience-title">Administrator experience</h2>
245 + <h2 id="admin-visibility-title">Administration overview and monitoring</h2>
198 198  
199 199   <p class="section-intro">
200 - Administrators can configure the MFA policy, monitor adoption and reset user MFA setups when needed.
248 + The administration overview helps teams understand MFA adoption and identify users who still need to complete setup or maintain recovery options.
201 201   </p>
202 202  
203 203   <div class="product-feature-grid">
204 - #foreach ($entry in $adminExperienceItems)
252 + #foreach ($entry in $adminVisibilityItems)
205 205   <article class="product-feature">
206 206   <div class="card-heading">
207 207   <div class="feature-icon">
... ... @@ -215,31 +215,31 @@
215 215   #end
216 216   </div>
217 217  
218 - <p class="product-gallery-caption">
219 - Administration screens for configuring MFA and reviewing MFA adoption across users.
220 - </p>
221 - </div>
222 -</section>
223 -
224 224  {{/html}}
225 225  
226 226  {{gallery}}
227 -[[image:mfa-admin-configuration.png]]
228 228  [[image:mfa-admin-overview.png]]
270 +[[image:mfa-admin-full.png]]
229 229  {{/gallery}}
230 230  
231 231  {{html clean="false"}}
232 232  
233 -<section class="product-section-muted" aria-labelledby="user-experience-title">
275 + <p class="product-gallery-caption">
276 + MFA adoption indicators and a filterable user overview for administrators.
277 + </p>
278 + </div>
279 +</section>
280 +
281 +<section aria-labelledby="user-adoption-title">
234 234   <div class="container">
235 - <h2 id="user-experience-title">User experience</h2>
283 + <h2 id="user-adoption-title">User setup and adoption</h2>
236 236  
237 237   <p class="section-intro">
238 - Users can configure MFA from their profile and complete the second verification step during login.
286 + Users can configure MFA themselves by scanning a QR code or entering the setup information manually in their authenticator application.
239 239   </p>
240 240  
241 241   <div class="product-feature-grid">
242 - #foreach ($entry in $userExperienceItems)
290 + #foreach ($entry in $userAdoptionItems)
243 243   <article class="product-feature">
244 244   <div class="card-heading">
245 245   <div class="feature-icon">
... ... @@ -253,31 +253,68 @@
253 253   #end
254 254   </div>
255 255  
304 +{{/html}}
305 +
306 +{{gallery}}
307 +[[image:mfa-user-setup-qr.png]]
308 +[[image:mfa-login-verification-setup.png]]
309 +{{/gallery}}
310 +
311 +{{html clean="false"}}
312 +
256 256   <p class="product-gallery-caption">
257 - User setup and login verification screens.
314 + Profile-based setup and enforced setup during login when MFA is required.
258 258   </p>
259 259   </div>
260 260  </section>
261 261  
319 +<section class="product-section-muted" aria-labelledby="login-protection-title">
320 + <div class="container">
321 + <h2 id="login-protection-title">Login protection</h2>
322 +
323 + <p class="section-intro">
324 + After MFA is configured, XWiki asks for a verification code after the normal username and password step.
325 + </p>
326 +
327 + <div class="product-feature-grid">
328 + #foreach ($entry in $loginProtectionItems)
329 + <article class="product-feature">
330 + <div class="card-heading">
331 + <div class="feature-icon">
332 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
333 + </div>
334 + <h3>$entry.title</h3>
335 + </div>
336 +
337 + <p>$entry.content</p>
338 + </article>
339 + #end
340 + </div>
341 +
262 262  {{/html}}
263 263  
264 264  {{gallery}}
265 -[[image:mfa-user-setup-qr.png]]
266 -[[image:mfa-login-verification.png]]
345 +[[image:mfa-login-verification-code.png]]
267 267  {{/gallery}}
268 268  
269 269  {{html clean="false"}}
270 270  
271 -<section aria-labelledby="recovery-title">
350 + <p class="product-gallery-caption">
351 + Verification screen displayed after the standard XWiki username and password login.
352 + </p>
353 + </div>
354 +</section>
355 +
356 +<section aria-labelledby="continuity-title">
272 272   <div class="container">
273 - <h2 id="recovery-title">Recovery codes and trusted devices</h2>
358 + <h2 id="continuity-title">Recovery codes and trusted devices</h2>
274 274  
275 275   <p class="section-intro">
276 - Recovery codes and trusted devices help balance stronger access protection with a smoother user experience.
361 + Recovery codes and trusted devices help balance stronger access protection with practical day-to-day usability.
277 277   </p>
278 278  
279 279   <div class="product-feature-grid">
280 - #foreach ($entry in $recoveryItems)
365 + #foreach ($entry in $continuityItems)
281 281   <article class="product-feature">
282 282   <div class="card-heading">
283 283   <div class="feature-icon">
... ... @@ -291,24 +291,62 @@
291 291   #end
292 292   </div>
293 293  
379 +{{/html}}
380 +
381 +{{gallery}}
382 +[[image:mfa-recovery-codes-not-generated.png]]
383 +[[image:mfa-recovery-codes-generated.png]]
384 +[[image:mfa-trusted-devices.png]]
385 +[[image:mfa-user-profile-overview.png]]
386 +[[image:mfa-user-profile-full.png]]
387 +{{/gallery}}
388 +
389 +{{html clean="false"}}
390 +
294 294   <p class="product-gallery-caption">
295 - Recovery codes, trusted devices and user profile management.
392 + User profile screens for recovery-code generation, trusted-device review and MFA self-service management.
296 296   </p>
297 297   </div>
298 298  </section>
299 299  
397 +<section class="product-section-muted" aria-labelledby="admin-support-title">
398 + <div class="container">
399 + <h2 id="admin-support-title">Administrator support and user recovery</h2>
400 +
401 + <p class="section-intro">
402 + Administrators can help users recover from lost devices or restart MFA setup when needed.
403 + </p>
404 +
405 + <div class="product-feature-grid">
406 + #foreach ($entry in $adminSupportItems)
407 + <article class="product-feature">
408 + <div class="card-heading">
409 + <div class="feature-icon">
410 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
411 + </div>
412 + <h3>$entry.title</h3>
413 + </div>
414 +
415 + <p>$entry.content</p>
416 + </article>
417 + #end
418 + </div>
419 +
300 300  {{/html}}
301 301  
302 302  {{gallery}}
303 -[[image:mfa-recovery-codes.png]]
304 -[[image:mfa-trusted-devices.png]]
305 -[[image:mfa-user-profile-overview.png]]
306 306  [[image:mfa-admin-user-management.png]]
307 307  {{/gallery}}
308 308  
309 309  {{html clean="false"}}
310 310  
311 -<section class="product-section-muted" aria-labelledby="rollout-title">
428 + <p class="product-gallery-caption">
429 + Administrator view for checking and resetting a user MFA setup.
430 + </p>
431 + </div>
432 +</section>
433 +
434 +<section aria-labelledby="rollout-title">
312 312   <div class="container">
313 313   <div class="product-layout">
314 314   <article class="product-summary-card">
... ... @@ -331,6 +331,11 @@
331 331  
332 332   <aside class="product-info-card" aria-labelledby="planning-title">
333 333   <h3 id="planning-title">Useful information before installation</h3>
457 +
458 + <p class="product-card-note">
459 + These details help evaluate compatibility, rollout scope and configuration options.
460 + </p>
461 +
334 334   <ul>
335 335   <li>XWiki version</li>
336 336   <li>Single wiki or wiki farm with subwikis</li>
... ... @@ -351,9 +351,7 @@
351 351   <h2 id="cta-title">Interested in using this extension?</h2>
352 352  
353 353   <p>
354 - Send a short message with your XWiki version, authentication setup and whether you need
355 - authenticator app codes, email verification codes, combined verification, recovery codes
356 - or trusted-device remembering.
482 + Send a short message with your XWiki version, current authentication setup and MFA rollout goal.
357 357   </p>
358 358  
359 359   <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Contact Agnease</a>
... ... @@ -361,7 +361,5 @@
361 361   </div>
362 362  </section>
363 363  
364 -</div>
365 -
366 366  {{/html}}
367 367  {{/velocity}}
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