Skip to Content
Last modified by Agnease on 2026/06/24 16:39
From version 5.1
edited by Agnease
on 2026/05/22 06:38
Change comment: There is no comment for this version
To version 7.1
edited by Agnease
on 2026/06/23 08:02
Change comment: Upload new image "mfa-admin-configuration.png", version 1.1

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -xwiki-two-factor-authentication
1 +XWiki Two-Factor Authentication
Content
... ... @@ -1,9 +1,83 @@
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': '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 +}])
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': 'Recovery and trusted devices',
25 + 'icon': 'shield',
26 + 'content': 'Configure recovery-code count and trusted-device duration according to the organization security policy.'
27 +},{
28 + 'title': 'Administration overview',
29 + 'icon': 'table',
30 + 'content': 'Review MFA adoption across users 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': 'Familiar login flow',
39 + 'icon': 'sign-in',
40 + 'content': 'After the normal login, users enter the configured verification code before accessing XWiki.'
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.'
45 +}])
46 +
47 +#set ($recoveryItems = [{
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 browsers or devices can skip repeated MFA prompts for a configured period.'
55 +},{
56 + 'title': 'Administrator reset',
57 + 'icon': 'refresh',
58 + 'content': 'Administrators can reset a user MFA setup when the user needs to restart the configuration process.'
59 +}])
60 +
61 +#set ($rolloutItems = [{
62 + 'title': 'Start with a pilot group',
63 + 'content': 'Test the extension with administrators or a small user group before enabling it widely.'
64 +},{
65 + 'title': 'Define the MFA policy',
66 + 'content': 'Decide whether MFA should be optional, required for administrators, or required for all users.'
67 +},{
68 + 'title': 'Configure recovery options',
69 + 'content': 'Choose whether recovery codes and trusted devices should be enabled.'
70 +},{
71 + 'title': 'Inform users',
72 + 'content': 'Explain how users configure MFA, save recovery codes and manage trusted devices.'
73 +},{
74 + 'title': 'Monitor adoption',
75 + 'content': 'Use the administration overview to identify users who still need to configure MFA.'
76 +}])
77 +
4 4  {{html clean="false"}}
5 5  
6 -<section class="hero hero-centered product-hero" aria-labelledby="product-title">
80 +<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>
... ... @@ -13,14 +13,10 @@
13 13   <h1 id="product-title">XWiki Two-Factor Authentication</h1>
14 14  
15 15   <p class="lead">
16 - Add a second verification step to the standard XWiki login flow.
90 + Protect XWiki logins with a second verification step using authenticator app codes,
91 + email verification codes, or both.
17 17   </p>
18 18  
19 - <p class="hero-support">
20 - Protect XWiki accounts with authenticator app codes, email verification codes,
21 - or a combined setup requiring both.
22 - </p>
23 -
24 24   <div class="hero-actions">
25 25   <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Ask about this extension</a>
26 26   <a class="btn btn-secondary" href="$xwiki.getURL('products.WebHome')">View all products</a>
... ... @@ -35,20 +35,16 @@
35 35   <h2 id="overview-title">Two-factor authentication built into XWiki</h2>
36 36  
37 37   <p>
38 - XWiki Two-Factor Authentication adds an additional verification screen after the standard
39 - XWiki username and password login. It improves account protection without replacing the
40 - familiar XWiki authentication flow.
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.
41 41   </p>
42 42  
43 43   <p>
44 - Users can verify access with TOTP codes generated by an authenticator app, with one-time
45 - codes delivered by email, or with a combined setup requiring both methods.
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.
46 46   </p>
47 -
48 - <p>
49 - Trusted browsers or devices can be remembered for a configured period, reducing repeated
50 - verification prompts on known clients while still requiring verification from new or untrusted ones.
51 - </p>
52 52   </article>
53 53  
54 54   <aside class="product-info-card" aria-labelledby="quick-facts-title">
... ... @@ -55,11 +55,12 @@
55 55   <h3 id="quick-facts-title">Quick facts</h3>
56 56   <ul>
57 57   <li>Works with the standard XWiki login flow</li>
58 - <li>Supports authenticator app codes using TOTP</li>
59 - <li>Supports email-delivered one-time verification codes</li>
60 - <li>Can require app code and email code together</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>
61 61   <li>Can remember trusted browsers or devices</li>
62 - <li>Includes administration and user setup controls</li>
129 + <li>Includes administration and user controls</li>
63 63   </ul>
64 64   </aside>
65 65   </div>
... ... @@ -66,92 +66,210 @@
66 66   </div>
67 67  </section>
68 68  
69 -<section aria-labelledby="features-title">
136 +<section aria-labelledby="capabilities-title">
70 70   <div class="container">
71 - <h2 id="features-title">Main capabilities</h2>
138 + <h2 id="capabilities-title">Main capabilities</h2>
72 72  
73 73   <p class="section-intro">
74 - A focused set of MFA/2FA features for organizations that want stronger XWiki account protection
75 - without changing the standard login experience.
141 + A focused set of MFA/2FA features for stronger XWiki account protection without changing the standard login experience.
76 76   </p>
77 77  
78 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 username and password verification, users must complete an additional verification step before accessing XWiki.
86 - </p>
87 - </article>
145 + #foreach ($entry in $mainCapabilityItems)
146 + <article class="product-feature">
147 + <div class="card-heading">
148 + <div class="feature-icon">
149 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
150 + </div>
151 + <h3>$entry.title</h3>
152 + </div>
88 88  
89 - <article class="product-feature">
90 - <div class="feature-icon">
91 - <i class="fa fa-mobile" aria-hidden="true"></i>
92 - </div>
93 - <h3>Authenticator app codes</h3>
94 - <p>
95 - Users can verify access with TOTP codes generated by authenticator applications on mobile or desktop devices.
96 - </p>
97 - </article>
154 + <p>$entry.content</p>
155 + </article>
156 + #end
157 + </div>
158 + </div>
159 +</section>
98 98  
99 - <article class="product-feature">
100 - <div class="feature-icon">
101 - <i class="fa fa-envelope-o" aria-hidden="true"></i>
102 - </div>
103 - <h3>Email verification codes</h3>
161 +<section class="product-section-muted" aria-labelledby="security-title">
162 + <div class="container">
163 + <div class="product-layout">
164 + <article class="product-summary-card">
165 + <h2 id="security-title">Useful for XWiki security and access protection</h2>
166 +
104 104   <p>
105 - Users can receive one-time verification codes by email when an authenticator app is not available or preferred.
168 + Many organizations need multi-factor authentication for internal tools, knowledge bases,
169 + intranets, documentation platforms and systems containing operational or sensitive information.
106 106   </p>
107 - </article>
108 108  
109 - <article class="product-feature">
110 - <div class="feature-icon">
111 - <i class="fa fa-plus-circle" aria-hidden="true"></i>
112 - </div>
113 - <h3>Combined verification</h3>
114 114   <p>
115 - The login flow can require both an authenticator app code and an email code when stricter verification is needed.
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.
116 116   </p>
117 117   </article>
177 +
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>
118 118   </div>
119 119   </div>
120 120  </section>
121 121  
122 -<section class="product-section-muted" aria-labelledby="security-title">
193 +<section aria-labelledby="admin-experience-title">
123 123   <div class="container">
195 + <h2 id="admin-experience-title">Administrator experience</h2>
196 +
197 + <p class="section-intro">
198 + Administrators can configure the MFA policy, monitor adoption and reset user MFA setups when needed.
199 + </p>
200 +
201 + <div class="product-feature-grid">
202 + #foreach ($entry in $adminExperienceItems)
203 + <article class="product-feature">
204 + <div class="card-heading">
205 + <div class="feature-icon">
206 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
207 + </div>
208 + <h3>$entry.title</h3>
209 + </div>
210 +
211 + <p>$entry.content</p>
212 + </article>
213 + #end
214 + </div>
215 +
216 + <p class="product-gallery-caption">
217 + Administration screens for configuring MFA and reviewing MFA adoption across users.
218 + </p>
219 + </div>
220 +</section>
221 +
222 +{{/html}}
223 +
224 +{{gallery}}
225 +[[image:mfa-admin-configuration.png]]
226 +[[image:mfa-admin-overview.png]]
227 +{{/gallery}}
228 +
229 +{{html clean="false"}}
230 +
231 +<section class="product-section-muted" aria-labelledby="user-experience-title">
232 + <div class="container">
233 + <h2 id="user-experience-title">User experience</h2>
234 +
235 + <p class="section-intro">
236 + Users can configure MFA from their profile and complete the second verification step during login.
237 + </p>
238 +
239 + <div class="product-feature-grid">
240 + #foreach ($entry in $userExperienceItems)
241 + <article class="product-feature">
242 + <div class="card-heading">
243 + <div class="feature-icon">
244 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
245 + </div>
246 + <h3>$entry.title</h3>
247 + </div>
248 +
249 + <p>$entry.content</p>
250 + </article>
251 + #end
252 + </div>
253 +
254 + <p class="product-gallery-caption">
255 + User setup and login verification screens.
256 + </p>
257 + </div>
258 +</section>
259 +
260 +{{/html}}
261 +
262 +{{gallery}}
263 +[[image:mfa-user-setup-qr.png]]
264 +[[image:mfa-login-verification.png]]
265 +{{/gallery}}
266 +
267 +{{html clean="false"}}
268 +
269 +<section aria-labelledby="recovery-title">
270 + <div class="container">
271 + <h2 id="recovery-title">Recovery codes and trusted devices</h2>
272 +
273 + <p class="section-intro">
274 + Recovery codes and trusted devices help balance stronger access protection with a smoother user experience.
275 + </p>
276 +
277 + <div class="product-feature-grid">
278 + #foreach ($entry in $recoveryItems)
279 + <article class="product-feature">
280 + <div class="card-heading">
281 + <div class="feature-icon">
282 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
283 + </div>
284 + <h3>$entry.title</h3>
285 + </div>
286 +
287 + <p>$entry.content</p>
288 + </article>
289 + #end
290 + </div>
291 +
292 + <p class="product-gallery-caption">
293 + Recovery codes, trusted devices and user profile management.
294 + </p>
295 + </div>
296 +</section>
297 +
298 +{{/html}}
299 +
300 +{{gallery}}
301 +[[image:mfa-recovery-codes.png]]
302 +[[image:mfa-trusted-devices.png]]
303 +[[image:mfa-user-profile-overview.png]]
304 +[[image:mfa-admin-user-management.png]]
305 +{{/gallery}}
306 +
307 +{{html clean="false"}}
308 +
309 +<section class="product-section-muted" aria-labelledby="rollout-title">
310 + <div class="container">
124 124   <div class="product-layout">
125 125   <article class="product-summary-card">
126 - <h2 id="security-title">Useful for XWiki security and NIS 2 readiness</h2>
313 + <h2 id="rollout-title">Rollout recommendations</h2>
127 127  
128 128   <p>
129 - Many organizations need multi-factor authentication for enterprise software, including internal
130 - knowledge bases, intranets, documentation platforms and systems containing operational procedures
131 - or sensitive business information.
316 + For a smooth rollout, start with a small administrator or pilot group before requiring MFA for everyone.
317 + This helps validate the configuration, prepare user communication and reduce support issues.
132 132   </p>
133 133  
134 - <p>
135 - For organizations using XWiki, adding two-factor authentication directly to the standard login flow
136 - can help close a practical access-control gap. It can be useful for administrator accounts, remote users,
137 - private knowledge bases and broader security readiness initiatives such as NIS 2 preparation.
138 - </p>
139 -
140 - <p>
141 - This extension is not a complete compliance solution on its own, but it can provide an important
142 - technical control for protecting access to XWiki.
143 - </p>
320 + <ol class="process-list">
321 + #foreach ($entry in $rolloutItems)
322 + <li>
323 + <strong>$entry.title</strong>
324 + $entry.content
325 + </li>
326 + #end
327 + </ol>
144 144   </article>
145 145  
146 - <aside class="product-info-card" aria-labelledby="security-controls-title">
147 - <h3 id="security-controls-title">Useful for</h3>
330 + <aside class="product-info-card" aria-labelledby="planning-title">
331 + <h3 id="planning-title">Useful information before installation</h3>
148 148   <ul>
149 - <li>XWiki 2FA rollout</li>
150 - <li>XWiki MFA adoption</li>
151 - <li>Administrator account protection</li>
152 - <li>Remote user access protection</li>
153 - <li>Private knowledge base security</li>
154 - <li>NIS 2 readiness initiatives</li>
333 + <li>XWiki version</li>
334 + <li>Single wiki or wiki farm with subwikis</li>
335 + <li>Current authentication setup</li>
336 + <li>Optional or globally required MFA policy</li>
337 + <li>Trusted-device policy</li>
338 + <li>Recovery-code policy</li>
339 + <li>Rollout communication needs</li>
155 155   </ul>
156 156   </aside>
157 157   </div>
... ... @@ -162,10 +162,13 @@
162 162   <div class="container">
163 163   <div class="cta-panel">
164 164   <h2 id="cta-title">Interested in using this extension?</h2>
350 +
165 165   <p>
166 - Send a short message with your XWiki version, authentication setup, and whether you need
167 - authenticator app codes, email verification codes, combined verification, or trusted-device remembering.
352 + Send a short message with your XWiki version, authentication setup and whether you need
353 + authenticator app codes, email verification codes, combined verification, recovery codes
354 + or trusted-device remembering.
168 168   </p>
356 +
169 169   <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Contact Agnease</a>
170 170   </div>
171 171   </div>
mfa-admin-configuration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +123.2 KB
Content