Skip to Content
Last modified by Agnease on 2026/06/24 16:39
From version 1.12
edited by Agnease
on 2026/05/22 03:35
Change comment: There is no comment for this version
To version 7.2
edited by Agnease
on 2026/06/23 08:35
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,26 +1,96 @@
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>
10 - XWiki security extension
84 + XWiki 2FA and MFA
11 11   </div>
12 12  
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 - This XWiki MFA / 2FA extension adds an additional verification step after the standard username and password login.
21 - Users can verify access with authenticator app codes, email-delivered one-time codes, or a combined setup requiring both methods.
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>
... ... @@ -32,24 +32,19 @@
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>
105 + <h2 id="overview-title">Two-factor authentication built into XWiki</h2>
36 36  
37 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.
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 - 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.
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.
47 47   </p>
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 53   </article>
54 54  
55 55   <aside class="product-info-card" aria-labelledby="quick-facts-title">
... ... @@ -56,13 +56,12 @@
56 56   <h3 id="quick-facts-title">Quick facts</h3>
57 57   <ul>
58 58   <li>Works with the standard XWiki login flow</li>
59 - <li>Supports authenticator app verification codes</li>
60 - <li>Supports email-delivered verification codes</li>
61 - <li>Can remember trusted clients beyond the current session</li>
62 - <li>Configuration available from wiki administration</li>
63 - <li>User setup available during login or from the user profile</li>
64 - <li>Administrators can enable, disable or reset MFA for users</li>
65 - <li>Can be used on the main wiki and subwikis</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>
66 66   </ul>
67 67   </aside>
68 68   </div>
... ... @@ -69,177 +69,218 @@
69 69   </div>
70 70  </section>
71 71  
72 -<section aria-labelledby="features-title">
136 +<section aria-labelledby="capabilities-title">
73 73   <div class="container">
74 - <h2 id="features-title">Main capabilities</h2>
138 + <h2 id="capabilities-title">Main capabilities</h2>
139 +
75 75   <p class="section-intro">
76 - The extension focuses on adding a practical second authentication step while keeping the standard XWiki login
77 - process and administration experience understandable.
141 + A focused set of MFA/2FA features for stronger XWiki account protection without changing the standard login experience.
78 78   </p>
79 79  
80 80   <div class="product-feature-grid">
81 - <article class="product-feature">
82 - <div class="feature-icon">
83 - <i class="fa fa-key" aria-hidden="true"></i>
84 - </div>
85 - <h3>Second login step</h3>
86 - <p>
87 - After the username and password are verified, users are asked to enter an additional verification code
88 - before accessing the wiki.
89 - </p>
90 - </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>
91 91  
92 - <article class="product-feature">
93 - <div class="feature-icon">
94 - <i class="fa fa-mobile" aria-hidden="true"></i>
95 - </div>
96 - <h3>Authenticator app codes</h3>
97 - <p>
98 - Users can verify access with codes generated by authenticator applications, such as mobile TOTP apps.
99 - </p>
100 - </article>
154 + <p>$entry.content</p>
155 + </article>
156 + #end
157 + </div>
158 + </div>
159 +</section>
101 101  
102 - <article class="product-feature">
103 - <div class="feature-icon">
104 - <i class="fa fa-envelope-o" aria-hidden="true"></i>
105 - </div>
106 - <h3>Email verification codes</h3>
107 - <p>
108 - Users can also receive a verification code by email, useful when an authenticator app is not available.
109 - </p>
110 - </article>
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>
111 111  
112 - <article class="product-feature">
113 - <div class="feature-icon">
114 - <i class="fa fa-qrcode" aria-hidden="true"></i>
115 - </div>
116 - <h3>User setup screen</h3>
117 117   <p>
118 - Users can configure their verification code setup during login or from their XWiki profile when needed.
168 + Many organizations need multi-factor authentication for internal tools, knowledge bases,
169 + intranets, documentation platforms and systems containing operational or sensitive information.
119 119   </p>
120 - </article>
121 121  
122 - <article class="product-feature">
123 - <div class="feature-icon">
124 - <i class="fa fa-clock-o" aria-hidden="true"></i>
125 - </div>
126 - <h3>Remember trusted clients</h3>
127 127   <p>
128 - Trusted browsers can be remembered beyond the current session, reducing repeated MFA prompts while keeping
129 - the second factor active for new or untrusted clients.
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.
130 130   </p>
131 131   </article>
132 132  
133 - <article class="product-feature">
134 - <div class="feature-icon">
135 - <i class="fa fa-sliders" aria-hidden="true"></i>
136 - </div>
137 - <h3>Administration controls</h3>
138 - <p>
139 - Administrators can enable the feature globally, manage user-level activation, and reset a user setup when required.
140 - </p>
141 - </article>
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>
189 + </div>
190 + </div>
191 +</section>
142 142  
143 - <article class="product-feature">
144 - <div class="feature-icon">
145 - <i class="fa fa-user" aria-hidden="true"></i>
146 - </div>
147 - <h3>Profile integration</h3>
148 - <p>
149 - The extension adds user profile controls so the second-factor setup can be reviewed or reset from XWiki.
150 - </p>
151 - </article>
193 +<section aria-labelledby="admin-experience-title">
194 + <div class="container">
195 + <h2 id="admin-experience-title">Administrator experience</h2>
152 152  
153 - <article class="product-feature">
154 - <div class="feature-icon">
155 - <i class="fa fa-random" aria-hidden="true"></i>
156 - </div>
157 - <h3>Fallback behavior</h3>
158 - <p>
159 - The extension can fall back to standard XWiki authentication when the feature is not enabled or not configured.
160 - </p>
161 - </article>
197 + <p class="section-intro">
198 + Administrators can configure the MFA policy, monitor adoption and reset user MFA setups when needed.
199 + </p>
162 162  
163 - <article class="product-feature">
164 - <div class="feature-icon">
165 - <i class="fa fa-sitemap" aria-hidden="true"></i>
166 - </div>
167 - <h3>Main wiki and subwikis</h3>
168 - <p>
169 - The extension is designed to support XWiki environments using the main wiki and subwikis.
170 - </p>
171 - </article>
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
172 172   </div>
215 +
216 + <p class="product-gallery-caption">
217 + Administration screens for configuring MFA and reviewing MFA adoption across users.
218 + </p>
219 +
220 +{{/html}}
221 +
222 +{{gallery}}
223 +[[image:mfa-admin-configuration.png]]
224 +[[image:mfa-admin-overview.png]]
225 +{{/gallery}}
226 +
227 +{{html clean="false"}}
228 +
173 173   </div>
174 174  </section>
175 175  
176 -<section aria-labelledby="use-cases-title">
232 +<section class="product-section-muted" aria-labelledby="user-experience-title">
177 177   <div class="container">
178 - <div class="product-layout">
179 - <article class="product-summary-card">
180 - <h2 id="use-cases-title">When this extension is useful</h2>
234 + <h2 id="user-experience-title">User experience</h2>
181 181  
182 - <p>
183 - Two-factor authentication is especially relevant when XWiki contains internal documentation, procedures,
184 - customer information, project knowledge, administrative pages, or business-critical content.
185 - </p>
236 + <p class="section-intro">
237 + Users can configure MFA from their profile and complete the second verification step during login.
238 + </p>
186 186  
187 - <p>
188 - It can also support organizations that need MFA as part of their cybersecurity controls, including companies
189 - working toward NIS 2 readiness. NIS 2 focuses on stronger cybersecurity risk management across essential and
190 - important entities in the EU, and MFA is often expected as part of enterprise access protection programs.
191 - </p>
240 + <div class="product-feature-grid">
241 + #foreach ($entry in $userExperienceItems)
242 + <article class="product-feature">
243 + <div class="card-heading">
244 + <div class="feature-icon">
245 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
246 + </div>
247 + <h3>$entry.title</h3>
248 + </div>
192 192  
193 - <p>
194 - It is also useful when many users access the wiki remotely, when administrator accounts need stronger protection,
195 - or when the organization wants to reduce the risk of compromised passwords.
196 - </p>
197 - </article>
250 + <p>$entry.content</p>
251 + </article>
252 + #end
253 + </div>
198 198  
199 - <aside class="product-info-card" aria-labelledby="good-fit-title">
200 - <h3 id="good-fit-title">Good fit for</h3>
201 - <ul>
202 - <li>Private XWiki knowledge bases</li>
203 - <li>Company intranets</li>
204 - <li>SOP and controlled-document platforms</li>
205 - <li>Documentation portals with sensitive content</li>
206 - <li>Wikis with several administrators or remote users</li>
207 - </ul>
208 - </aside>
255 + <p class="product-gallery-caption">
256 + User setup and login verification screens.
257 + </p>
258 +
259 +{{/html}}
260 +
261 +{{gallery}}
262 +[[image:mfa-user-setup-qr.png]]
263 +[[image:mfa-login-verification.png]]
264 +{{/gallery}}
265 +
266 +{{html clean="false"}}
267 +
268 + </div>
269 +</section>
270 +
271 +<section aria-labelledby="recovery-title">
272 + <div class="container">
273 + <h2 id="recovery-title">Recovery codes and trusted devices</h2>
274 +
275 + <p class="section-intro">
276 + Recovery codes and trusted devices help balance stronger access protection with a smoother user experience.
277 + </p>
278 +
279 + <div class="product-feature-grid">
280 + #foreach ($entry in $recoveryItems)
281 + <article class="product-feature">
282 + <div class="card-heading">
283 + <div class="feature-icon">
284 + <i class="fa fa-$entry.icon" aria-hidden="true"></i>
285 + </div>
286 + <h3>$entry.title</h3>
287 + </div>
288 +
289 + <p>$entry.content</p>
290 + </article>
291 + #end
209 209   </div>
293 +
294 + <p class="product-gallery-caption">
295 + Recovery codes, trusted devices and user profile management.
296 + </p>
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 +
210 210   </div>
211 211  </section>
212 212  
213 -<section class="product-section-muted" aria-labelledby="compliance-title">
312 +<section class="product-section-muted" aria-labelledby="rollout-title">
214 214   <div class="container">
215 215   <div class="product-layout">
216 216   <article class="product-summary-card">
217 - <h2 id="compliance-title">Useful for MFA adoption and NIS 2 readiness</h2>
316 + <h2 id="rollout-title">Rollout recommendations</h2>
218 218  
219 219   <p>
220 - Many organizations now need multi-factor authentication for enterprise software, especially when the
221 - platform contains internal documentation, procedures, operational knowledge or sensitive business data.
319 + For a smooth rollout, start with a small administrator or pilot group before requiring MFA for everyone.
320 + This helps validate the configuration, prepare user communication and reduce support issues.
222 222   </p>
223 223  
224 - <p>
225 - For organizations using XWiki as a knowledge platform, having MFA embedded in the standard XWiki login
226 - experience helps close a practical security gap without requiring a full replacement of the authentication flow.
227 - </p>
323 + <ol class="process-list">
324 + #foreach ($entry in $rolloutItems)
325 + <li>
326 + <strong>$entry.title</strong>
327 + $entry.content
328 + </li>
329 + #end
330 + </ol>
331 + </article>
228 228  
229 - <p>
230 - This can be relevant for companies preparing for NIS 2 requirements, where MFA is part of a broader
231 - cybersecurity risk management and access protection strategy.
333 + <aside class="product-info-card" aria-labelledby="planning-title">
334 + <h3 id="planning-title">Useful information before installation</h3>
335 +
336 + <p class="product-card-note">
337 + These details help evaluate compatibility, rollout scope and configuration options.
232 232   </p>
233 - </article>
234 234  
235 - <aside class="product-info-card" aria-labelledby="mfa-readiness-title">
236 - <h3 id="mfa-readiness-title">Security controls supported</h3>
237 237   <ul>
238 - <li>Second-factor verification after password login</li>
239 - <li>Authenticator app or email-based verification codes</li>
240 - <li>Reduced repeated prompts for trusted clients</li>
241 - <li>Administration controls for user-level MFA management</li>
242 - <li>Better protection for administrator and remote-access accounts</li>
341 + <li>XWiki version</li>
342 + <li>Single wiki or wiki farm with subwikis</li>
343 + <li>Current authentication setup</li>
344 + <li>Optional or globally required MFA policy</li>
345 + <li>Trusted-device policy</li>
346 + <li>Recovery-code policy</li>
347 + <li>Rollout communication needs</li>
243 243   </ul>
244 244   </aside>
245 245   </div>
... ... @@ -246,31 +246,15 @@
246 246   </div>
247 247  </section>
248 248  
249 -#*
250 -<section aria-labelledby="gallery-title">
251 - <div class="container">
252 - <div class="product-gallery-panel">
253 - <h2 id="gallery-title">Screenshots</h2>
254 - <p class="gallery-note">
255 - Use this area to show the login verification screen, first-time setup, user profile controls,
256 - and administration configuration.
257 - </p>
258 -
259 - <div class="product-gallery-placeholder">
260 - Replace this placeholder with the XWiki gallery macro and 3-5 screenshots from the application.
261 - </div>
262 - </div>
263 - </div>
264 -</section>
265 -*#
266 266  <section class="cta-section" aria-labelledby="cta-title">
267 267   <div class="container">
268 268   <div class="cta-panel">
269 269   <h2 id="cta-title">Interested in using this extension?</h2>
358 +
270 270   <p>
271 - Send a short message with your XWiki version, authentication setup, and whether you use a single wiki
272 - or a main wiki with subwikis.
360 + Send a short message with your XWiki version, current authentication setup and MFA rollout goal.
273 273   </p>
362 +
274 274   <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Contact Agnease</a>
275 275   </div>
276 276   </div>
mfa-admin-configuration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.Admin
Size
... ... @@ -1,0 +1,1 @@
1 +123.2 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