Skip to Content
Last modified by Agnease on 2026/06/24 16:39
From version 22.6
edited by Agnease
on 2026/06/24 15:24
Change comment: There is no comment for this version
To version 18.1
edited by Agnease
on 2026/06/24 14:58
Change comment: Upload new image "mfa-recovery-codes-not-generated.png", version 1.1

Summary

Details

Page properties
Content
... ... @@ -2,105 +2,60 @@
2 2  #set ($discard = $xwiki.ssx.use('PublicWebSite.WebHome'))
3 3  #set ($discard = $xwiki.ssx.use('products.WebHome'))
4 4  
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.'
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 9  },{
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.'
10 + 'title': 'Authenticator app codes',
11 + 'icon': 'mobile',
12 + 'content': 'Let users verify access with time-based TOTP codes generated by authenticator applications.'
13 13  },{
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.'
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.'
17 17  }])
18 18  
19 -#set ($adminControlItems = [{
20 - 'title': 'Global MFA policy',
19 +#set ($adminExperienceItems = [{
20 + 'title': 'MFA policy',
21 21   'icon': 'cog',
22 - 'content': 'Administrators can decide whether MFA is optional or required for all users.'
22 + 'content': 'Make MFA optional or required for all users from the XWiki Administration section.'
23 23  },{
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.'
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.'
27 27  },{
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',
28 + 'title': 'Administration overview',
39 39   'icon': '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.'
30 + 'content': 'Review MFA adoption across users with summary indicators and a filterable Live Data table.'
45 45  }])
46 46  
47 -#set ($userAdoptionItems = [{
33 +#set ($userExperienceItems = [{
48 48   'title': 'Self-service setup',
49 49   'icon': 'qrcode',
50 - 'content': 'Users can configure MFA by scanning a QR code with their authenticator application.'
36 + 'content': 'Users configure MFA from their profile by scanning a QR code or entering the setup key manually.'
51 51  },{
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.'
38 + 'title': 'Familiar login flow',
39 + 'icon': 'sign-in',
40 + 'content': 'After the normal login, users enter the configured verification code before accessing XWiki.'
55 55  },{
56 - 'title': 'Enforced setup flow',
57 - 'icon': 'lock',
58 - 'content': 'When MFA is required, users are guided to complete setup before continuing.'
42 + 'title': 'Profile management',
43 + 'icon': 'user',
44 + 'content': 'Users can review MFA status, manage recovery codes and remove trusted devices from their profile.'
59 59  }])
60 60  
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',
47 +#set ($recoveryItems = [{
48 + 'title': 'Recovery codes',
77 77   'icon': 'life-ring',
78 - 'content': 'Recovery codes help users regain access if they lose their authenticator device.'
50 + 'content': 'Recovery codes provide backup access when a user loses access to the authenticator application.'
79 79  },{
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',
52 + 'title': 'Trusted devices',
88 88   'icon': 'desktop',
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.'
54 + 'content': 'Trusted browsers or devices can skip repeated MFA prompts for a configured period.'
96 96  },{
97 - 'title': 'Helpdesk recovery',
56 + 'title': 'Administrator reset',
98 98   'icon': 'refresh',
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.'
58 + 'content': 'Administrators can reset a user MFA setup when the user needs to restart the configuration process.'
104 104  }])
105 105  
106 106  #set ($rolloutItems = [{
... ... @@ -108,12 +108,12 @@
108 108   'content': 'Test the extension with administrators or a small user group before enabling it widely.'
109 109  },{
110 110   'title': 'Define the MFA policy',
111 - 'content': 'Decide whether MFA should be optional at first or required for all users.'
66 + 'content': 'Decide whether MFA should be optional, required for administrators, or required for all users.'
112 112  },{
113 113   'title': 'Configure recovery options',
114 - 'content': 'Choose the number of recovery codes and whether trusted devices should be allowed.'
69 + 'content': 'Choose whether recovery codes and trusted devices should be enabled.'
115 115  },{
116 - 'title': 'Prepare user communication',
71 + 'title': 'Inform users',
117 117   'content': 'Explain how users configure MFA, save recovery codes and manage trusted devices.'
118 118  },{
119 119   'title': 'Monitor adoption',
... ... @@ -132,8 +132,8 @@
132 132   <h1 id="product-title">XWiki Two-Factor Authentication</h1>
133 133  
134 134   <p class="lead">
135 - Protect XWiki logins with authenticator app verification, recovery codes, trusted devices
136 - and administrator visibility.
90 + Protect XWiki logins with a second verification step using authenticator app codes,
91 + email verification codes, or both.
137 137   </p>
138 138  
139 139   <div class="hero-actions">
... ... @@ -147,18 +147,18 @@
147 147   <div class="container">
148 148   <div class="product-layout">
149 149   <article class="product-summary-card">
150 - <h2 id="overview-title">MFA protection built for XWiki</h2>
105 + <h2 id="overview-title">Two-factor authentication built into XWiki</h2>
151 151  
152 152   <p>
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.
108 + XWiki Two-Factor Authentication adds MFA/2FA support to the standard XWiki login flow.
109 + Users continue to sign in with their normal username and password, then confirm access with
110 + an additional verification method.
156 156   </p>
157 157  
158 158   <p>
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.
114 + The extension supports authenticator app codes, email-delivered verification codes, or a combined
115 + setup where both methods are required. It improves account protection without replacing the familiar
116 + XWiki authentication experience.
162 162   </p>
163 163   </article>
164 164  
... ... @@ -166,12 +166,12 @@
166 166   <h3 id="quick-facts-title">Quick facts</h3>
167 167   <ul>
168 168   <li>Works with the standard XWiki login flow</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>
124 + <li>Supports TOTP authenticator applications</li>
125 + <li>Supports email-delivered one-time codes</li>
126 + <li>Can require app and email verification together</li>
127 + <li>Includes recovery codes for backup access</li>
128 + <li>Can remember trusted browsers or devices</li>
129 + <li>Includes administration and user controls</li>
175 175   </ul>
176 176   </aside>
177 177   </div>
... ... @@ -178,16 +178,16 @@
178 178   </div>
179 179  </section>
180 180  
181 -<section class="product-section-muted" aria-labelledby="business-value-title">
136 +<section aria-labelledby="capabilities-title">
182 182   <div class="container">
183 - <h2 id="business-value-title">Business value</h2>
138 + <h2 id="capabilities-title">Main capabilities</h2>
184 184  
185 185   <p class="section-intro">
186 - The extension helps organizations strengthen XWiki access protection without making login and account recovery unnecessarily complex.
141 + A focused set of MFA/2FA features for stronger XWiki account protection without changing the standard login experience.
187 187   </p>
188 188  
189 189   <div class="product-feature-grid">
190 - #foreach ($entry in $businessValueItems)
145 + #foreach ($entry in $mainCapabilityItems)
191 191   <article class="product-feature">
192 192   <div class="card-heading">
193 193   <div class="feature-icon">
... ... @@ -203,53 +203,48 @@
203 203   </div>
204 204  </section>
205 205  
206 -<section aria-labelledby="admin-control-title">
161 +<section class="product-section-muted" aria-labelledby="security-title">
207 207   <div class="container">
208 - <h2 id="admin-control-title">Administrator control</h2>
163 + <div class="product-layout">
164 + <article class="product-summary-card">
165 + <h2 id="security-title">Useful for XWiki security and access protection</h2>
209 209  
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>
167 + <p>
168 + Many organizations need multi-factor authentication for internal tools, knowledge bases,
169 + intranets, documentation platforms and systems containing operational or sensitive information.
170 + </p>
213 213  
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>
172 + <p>
173 + For XWiki, adding two-factor authentication directly to the standard login flow helps protect
174 + administrator accounts, remote users, private knowledge bases and customer or partner portals.
175 + </p>
176 + </article>
223 223  
224 - <p>$entry.content</p>
225 - </article>
226 - #end
178 + <aside class="product-info-card" aria-labelledby="use-cases-title">
179 + <h3 id="use-cases-title">Typical use cases</h3>
180 + <ul>
181 + <li>Administrator account protection</li>
182 + <li>Internal knowledge base security</li>
183 + <li>Private documentation platforms</li>
184 + <li>Remote user access protection</li>
185 + <li>Customer or partner portals</li>
186 + <li>Security review and NIS 2 readiness initiatives</li>
187 + </ul>
188 + </aside>
227 227   </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>
240 240   </div>
241 241  </section>
242 242  
243 -<section class="product-section-muted" aria-labelledby="admin-visibility-title">
193 +<section aria-labelledby="admin-experience-title">
244 244   <div class="container">
245 - <h2 id="admin-visibility-title">Administration overview and monitoring</h2>
195 + <h2 id="admin-experience-title">Administrator experience</h2>
246 246  
247 247   <p class="section-intro">
248 - The administration overview helps teams understand MFA adoption and identify users who still need to complete setup or maintain recovery options.
198 + Administrators can configure the MFA policy, monitor adoption and reset user MFA setups when needed.
249 249   </p>
250 250  
251 251   <div class="product-feature-grid">
252 - #foreach ($entry in $adminVisibilityItems)
202 + #foreach ($entry in $adminExperienceItems)
253 253   <article class="product-feature">
254 254   <div class="card-heading">
255 255   <div class="feature-icon">
... ... @@ -266,6 +266,7 @@
266 266  {{/html}}
267 267  
268 268  {{gallery}}
219 +[[image:mfa-admin-configuration.png]]
269 269  [[image:mfa-admin-overview.png]]
270 270  [[image:mfa-admin-full.png]]
271 271  {{/gallery}}
... ... @@ -273,21 +273,21 @@
273 273  {{html clean="false"}}
274 274  
275 275   <p class="product-gallery-caption">
276 - MFA adoption indicators and a filterable user overview for administrators.
227 + Administration screens for configuring MFA and reviewing MFA adoption across users.
277 277   </p>
278 278   </div>
279 279  </section>
280 280  
281 -<section aria-labelledby="user-adoption-title">
232 +<section class="product-section-muted" aria-labelledby="user-experience-title">
282 282   <div class="container">
283 - <h2 id="user-adoption-title">User setup and adoption</h2>
234 + <h2 id="user-experience-title">User experience</h2>
284 284  
285 285   <p class="section-intro">
286 - Users can configure MFA themselves by scanning a QR code or entering the setup information manually in their authenticator application.
237 + Users can configure MFA from their profile and complete the second verification step during login.
287 287   </p>
288 288  
289 289   <div class="product-feature-grid">
290 - #foreach ($entry in $userAdoptionItems)
241 + #foreach ($entry in $userExperienceItems)
291 291   <article class="product-feature">
292 292   <div class="card-heading">
293 293   <div class="feature-icon">
... ... @@ -306,42 +306,6 @@
306 306  {{gallery}}
307 307  [[image:mfa-user-setup-qr.png]]
308 308  [[image:mfa-login-verification-setup.png]]
309 -{{/gallery}}
310 -
311 -{{html clean="false"}}
312 -
313 - <p class="product-gallery-caption">
314 - Profile-based setup and enforced setup during login when MFA is required.
315 - </p>
316 - </div>
317 -</section>
318 -
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 -
342 -{{/html}}
343 -
344 -{{gallery}}
345 345  [[image:mfa-login-verification-code.png]]
346 346  {{/gallery}}
347 347  
... ... @@ -348,21 +348,21 @@
348 348  {{html clean="false"}}
349 349  
350 350   <p class="product-gallery-caption">
351 - Verification screen displayed after the standard XWiki username and password login.
266 + User setup and login verification screens.
352 352   </p>
353 353   </div>
354 354  </section>
355 355  
356 -<section aria-labelledby="continuity-title">
271 +<section aria-labelledby="recovery-title">
357 357   <div class="container">
358 - <h2 id="continuity-title">Recovery codes and trusted devices</h2>
273 + <h2 id="recovery-title">Recovery codes and trusted devices</h2>
359 359  
360 360   <p class="section-intro">
361 - Recovery codes and trusted devices help balance stronger access protection with practical day-to-day usability.
276 + Recovery codes and trusted devices help balance stronger access protection with a smoother user experience.
362 362   </p>
363 363  
364 364   <div class="product-feature-grid">
365 - #foreach ($entry in $continuityItems)
280 + #foreach ($entry in $recoveryItems)
366 366   <article class="product-feature">
367 367   <div class="card-heading">
368 368   <div class="feature-icon">
... ... @@ -379,47 +379,9 @@
379 379  {{/html}}
380 380  
381 381  {{gallery}}
382 -[[image:mfa-recovery-codes-not-generated.png]]
383 -[[image:mfa-recovery-codes-generated.png]]
297 +[[image:mfa-recovery-codes.png]]
384 384  [[image:mfa-trusted-devices.png]]
385 385  [[image:mfa-user-profile-overview.png]]
386 -[[image:mfa-user-profile-full.png]]
387 -{{/gallery}}
388 -
389 -{{html clean="false"}}
390 -
391 - <p class="product-gallery-caption">
392 - User profile screens for recovery-code generation, trusted-device review and MFA self-service management.
393 - </p>
394 - </div>
395 -</section>
396 -
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 -
420 -{{/html}}
421 -
422 -{{gallery}}
423 423  [[image:mfa-admin-user-management.png]]
424 424  {{/gallery}}
425 425  
... ... @@ -426,12 +426,12 @@
426 426  {{html clean="false"}}
427 427  
428 428   <p class="product-gallery-caption">
429 - Administrator view for checking and resetting a user MFA setup.
306 + Recovery codes, trusted devices and user profile management.
430 430   </p>
431 431   </div>
432 432  </section>
433 433  
434 -<section aria-labelledby="rollout-title">
311 +<section class="product-section-muted" aria-labelledby="rollout-title">
435 435   <div class="container">
436 436   <div class="product-layout">
437 437   <article class="product-summary-card">
mfa-admin-user-management.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Admin
Size
... ... @@ -1,1 +1,0 @@
1 -26.9 KB
Content
mfa-recovery-codes-generated.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Admin
Size
... ... @@ -1,1 +1,0 @@
1 -38.5 KB
Content
mfa-trusted-devices.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Admin
Size
... ... @@ -1,1 +1,0 @@
1 -59.1 KB
Content
mfa-user-profile-full.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.Admin
Size
... ... @@ -1,1 +1,0 @@
1 -197.5 KB
Content