Changes for page XWiki Two-Factor Authentication

Last modified by Agnease on 2026/06/24 16:39

Manage
- Copy
Actions
- Export
- Print Preview
Viewers
- Source
- Siblings
- Content
- Comments
- Attachments (13)
- History
- Information
- Likes

From 6.9 to 6.10 From 6.11 to 6.12

From version 6.10

edited by Agnease
on 2026/05/23 18:56

Change comment: There is no comment for this version

To version 6.11

edited by Agnease
on 2026/06/23 07:33

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,9 +1,82 @@
  {{velocity}}
  #set ($discard = $xwiki.ssx.use('PublicWebSite.WebHome'))
  #set ($discard = $xwiki.ssx.use('products.WebHome'))
++
++#set ($mainCapabilityItems = [{
++  'title': 'Second verification step',
++  'icon': 'key',
++  'content': 'After the normal username and password check, users complete an additional verification step before accessing XWiki.'
++},{
++  'title': 'Authenticator app codes',
++  'icon': 'mobile',
++  'content': 'Users can verify access with time-based TOTP codes generated by authenticator applications on mobile or desktop devices.'
++},{
++  'title': 'Email verification codes',
++  'icon': 'envelope-o',
++  'content': 'Users can receive one-time verification codes by email when an authenticator app is not available or preferred.'
++}])
++
++#set ($useCaseItems = [
++  'Protecting administrator accounts',
++  'Improving access security for internal knowledge bases',
++  'Securing private documentation platforms and intranets',
++  'Supporting remote-user access policies',
++  'Strengthening customer or partner portals',
++  'Preparing for security reviews or broader compliance initiatives'
++])
++
++#set ($adminCapabilityItems = [
++  'Require MFA for all users',
++  'Define the issuer name displayed in authenticator applications',
++  'Configure trusted-device duration',
++  'Configure how many recovery codes are generated',
++  'Reset a user’s MFA setup when needed',
++  'Review MFA adoption from the administration overview'
++])
++
++#set ($overviewItems = [
++  'Number of users scanned',
++  'Users with MFA configured',
++  'Users without MFA configured',
++  'Users with trusted devices',
++  'Recovery-code status',
++  'Unused and total recovery-code count',
++  'Trusted-device count'
++])
++
++#set ($profileItems = [
++  'Configure MFA',
++  'Review MFA status',
++  'Generate or regenerate recovery codes',
++  'Review trusted devices',
++  'Remove individual trusted devices',
++  'Remove all trusted devices',
++  'Reset MFA setup'
++])
++
++#set ($rolloutItems = [{
++  'title': 'Install and configure the extension',
++  'content': 'Start by validating compatibility with the current XWiki version and authentication setup.'
++},{
++  'title': 'Define the MFA policy',
++  'content': 'Decide whether MFA should be optional, required for administrators, or required for all users.'
++},{
++  'title': 'Configure recovery and trusted devices',
++  'content': 'Choose whether users can rely on recovery codes and whether trusted browsers or devices are allowed.'
++},{
++  'title': 'Test with a pilot group',
++  'content': 'Validate the setup and login flow with administrators or a small group before wider rollout.'
++},{
++  'title': 'Communicate the user process',
++  'content': 'Explain how users should configure MFA, store recovery codes and manage trusted devices.'
++},{
++  'title': 'Monitor adoption',
++  'content': 'Use the administration overview to identify users who still need to configure MFA.'
++}])
++
  {{html clean="false"}}
--<section class="hero hero-centered" aria-labelledby="hero-title">
++<section class="hero hero-centered" aria-labelledby="product-title">
    <div class="container hero-inner">
      <div class="hero-kicker">
        <i class="fa fa-lock" aria-hidden="true"></i>
@@ -31,19 +31,20 @@
          <h2 id="overview-title">Two-factor authentication built into XWiki</h2>
          <p>
--          XWiki Two-Factor Authentication adds an additional verification screen after the standard
--          XWiki username and password login. It improves account protection without replacing the
--          familiar XWiki authentication flow.
++          XWiki Two-Factor Authentication adds MFA/2FA support to the standard XWiki login flow.
++          Users continue to sign in with their normal username and password, then confirm access with
++          an additional verification method.
          </p>
          <p>
--          Users can verify access with TOTP codes generated by an authenticator app, with one-time
--          codes delivered by email, or with a combined setup requiring both methods.
++          The extension supports authenticator app codes, email-delivered verification codes, or a combined
++          setup where both methods are required. It improves account protection without replacing the familiar
++          XWiki authentication experience.
          </p>
          <p>
--          Trusted browsers or devices can be remembered for a configured period, reducing repeated
--          verification prompts on known clients while still requiring verification from new or untrusted ones.
++          It is designed for organizations that use XWiki for internal knowledge bases, intranets,
++          documentation platforms, customer portals, workflows or other business-critical applications.
          </p>
        </article>
@@ -54,6 +54,7 @@
            <li>Supports authenticator app codes using TOTP</li>
            <li>Supports email-delivered one-time verification codes</li>
            <li>Can require app code and email code together</li>
++          <li>Includes recovery codes for backup access</li>
            <li>Can remember trusted browsers or devices</li>
            <li>Includes administration and user setup controls</li>
          </ul>
@@ -67,86 +67,213 @@
      <h2 id="features-title">Main capabilities</h2>
      <p class="section-intro">
--      A focused set of MFA/2FA features for stronger XWiki account protection without changing the standard login experience.
++      A focused set of MFA/2FA features for stronger XWiki account protection without changing
++      the standard login experience.
      </p>
      <div class="product-feature-grid">
--      <article class="product-feature">
--        <div class="card-heading">
--          <div class="feature-icon">
--            <i class="fa fa-key" aria-hidden="true"></i>
++      #foreach ($entry in $mainCapabilityItems)
++        <article class="product-feature">
++          <div class="card-heading">
++            <div class="feature-icon">
++              <i class="fa fa-$entry.icon" aria-hidden="true"></i>
++            </div>
++            <h3>$entry.title</h3>
            </div>
--          <h3>Second verification step</h3>
--        </div>
++          <p>$entry.content</p>
++        </article>
++      #end
++    </div>
++  </div>
++</section>
++
++<section class="product-section-muted" aria-labelledby="security-title">
++  <div class="container">
++    <div class="product-layout">
++      <article class="product-summary-card">
++        <h2 id="security-title">Useful for XWiki security and NIS 2 readiness</h2>
++
          <p>
--          After username and password verification, users complete an additional step before accessing XWiki.
--          The flow can require one verification method or both app and email codes.
++          Many organizations need multi-factor authentication for enterprise software, including internal
++          knowledge bases, intranets, documentation platforms and systems containing operational procedures
++          or sensitive business information.
          </p>
++
++        <p>
++          For organizations using XWiki, adding two-factor authentication directly to the standard login flow
++          can help close a practical access-control gap. It can be useful for administrator accounts,
++          remote users, private knowledge bases and broader security readiness initiatives such as NIS 2 preparation.
++        </p>
++
++        <p>
++          This extension is not a complete compliance solution on its own, but it provides an important
++          technical control for protecting access to XWiki.
++        </p>
        </article>
--      <article class="product-feature">
--        <div class="card-heading">
--          <div class="feature-icon">
--            <i class="fa fa-mobile" aria-hidden="true"></i>
--          </div>
--          <h3>Authenticator app codes</h3>
--        </div>
++      <aside class="product-info-card" aria-labelledby="use-cases-title">
++        <h3 id="use-cases-title">Typical use cases</h3>
++        <ul>
++          #foreach ($item in $useCaseItems)
++            <li>$item</li>
++          #end
++        </ul>
++      </aside>
++    </div>
++  </div>
++</section>
++<section aria-labelledby="admin-title">
++  <div class="container">
++    <div class="product-layout">
++      <article class="product-summary-card">
++        <h2 id="admin-title">Administrator configuration</h2>
++
          <p>
--          Users can verify access with TOTP codes generated by authenticator applications on mobile or desktop devices.
++          Administrators configure MFA from the XWiki Administration section. The configuration is intentionally
++          simple, so the rollout can be adapted to the organization’s security policy and user base.
          </p>
++
++        <p>
++          MFA can be optional or required for all users. When MFA is required, users who have not configured it yet
++          are guided through the setup flow from their profile or during login.
++        </p>
++
++        <p>
++          If trusted devices should not be allowed, the trusted-device duration can be set to 0.
++          If recovery codes should not be available, the recovery-code number can be set to 0.
++        </p>
        </article>
--      <article class="product-feature">
--        <div class="card-heading">
--          <div class="feature-icon">
--            <i class="fa fa-envelope-o" aria-hidden="true"></i>
--          </div>
--          <h3>Email verification codes</h3>
--        </div>
++      <aside class="product-info-card" aria-labelledby="admin-capabilities-title">
++        <h3 id="admin-capabilities-title">Administrators can</h3>
++        <ul>
++          #foreach ($item in $adminCapabilityItems)
++            <li>$item</li>
++          #end
++        </ul>
++      </aside>
++    </div>
++  </div>
++</section>
++{{/html}}
++
++{{gallery}}
++[[image:mfa-admin-configuration.png]]
++{{/gallery}}
++
++{{html clean="false"}}
++
++<section aria-labelledby="admin-overview-title">
++  <div class="container">
++    <div class="product-layout">
++      <article class="product-summary-card">
++        <h2 id="admin-overview-title">MFA overview for administrators</h2>
++
          <p>
--          Users can receive one-time verification codes by email when an authenticator app is not available or preferred.
++          The Administration section includes an MFA overview page that helps administrators understand adoption
++          and usage across the wiki.
          </p>
++
++        <p>
++          The overview displays summary indicators and a Live Data table with MFA-related information.
++          The table is filterable and sortable, making it suitable for installations with many users.
++        </p>
        </article>
++
++      <aside class="product-info-card" aria-labelledby="overview-data-title">
++        <h3 id="overview-data-title">The overview can show</h3>
++        <ul>
++          #foreach ($item in $overviewItems)
++            <li>$item</li>
++          #end
++        </ul>
++      </aside>
      </div>
    </div>
  </section>
--<section class="product-section-muted" aria-labelledby="security-title">
++{{/html}}
++
++{{gallery}}
++[[image:mfa-admin-overview.png]]
++{{/gallery}}
++
++{{html clean="false"}}
++
++<section class="product-section-muted" aria-labelledby="user-setup-title">
    <div class="container">
      <div class="product-layout">
        <article class="product-summary-card">
--        <h2 id="security-title">Useful for XWiki security and NIS 2 readiness</h2>
++        <h2 id="user-setup-title">User setup experience</h2>
          <p>
--          Many organizations need multi-factor authentication for enterprise software, including internal
--          knowledge bases, intranets, documentation platforms and systems containing operational procedures
--          or sensitive business information.
++          Users can configure MFA from their profile page. During setup, the user scans a QR code with
++          an authenticator application.
          </p>
          <p>
--          For organizations using XWiki, adding two-factor authentication directly to the standard login flow
--          can help close a practical access-control gap. It can be useful for administrator accounts, remote users,
--          private knowledge bases and broader security readiness initiatives such as NIS 2 preparation.
++          If scanning is not possible, the setup page also provides the account name and secret key that can be
++          entered manually. After the generated verification code is entered successfully, MFA is activated for
++          the user account.
          </p>
++      </article>
++      <aside class="product-info-card" aria-labelledby="login-flow-title">
++        <h3 id="login-flow-title">Login flow</h3>
++        <ul>
++          <li>User signs in with the normal XWiki credentials</li>
++          <li>XWiki asks for the configured verification code</li>
++          <li>The user enters the app code, email code, or both</li>
++          <li>A recovery code can be used when enabled and available</li>
++          <li>A trusted browser or device can be remembered when allowed</li>
++        </ul>
++      </aside>
++    </div>
++  </div>
++</section>
++
++{{/html}}
++
++{{gallery}}
++[[image:mfa-user-setup-qr.png]]
++[[image:mfa-login-verification.png]]
++{{/gallery}}
++
++{{html clean="false"}}
++
++<section aria-labelledby="recovery-title">
++  <div class="container">
++    <div class="product-layout">
++      <article class="product-summary-card">
++        <h2 id="recovery-title">Recovery codes</h2>
++
          <p>
--          This extension is not a complete compliance solution on its own, but it can provide an important
--          technical control for protecting access to XWiki.
++          Recovery codes provide a backup access method when a user loses access to the authenticator application
++          or cannot complete the normal verification flow.
          </p>
++
++        <p>
++          Recovery codes are generated for the user and displayed only once. Each code can be used one time.
++          When new recovery codes are generated, previous recovery codes are invalidated.
++        </p>
++
++        <p>
++          Users should save their recovery codes in a secure location immediately after generation.
++          Administrators can configure how many recovery codes are generated, and setting the number to 0 disables them.
++        </p>
        </article>
--      <aside class="product-info-card" aria-labelledby="security-controls-title">
--        <h3 id="security-controls-title">Useful for</h3>
++      <aside class="product-info-card" aria-labelledby="trusted-devices-title">
++        <h3 id="trusted-devices-title">Trusted devices</h3>
          <ul>
--          <li>XWiki 2FA rollout</li>
--          <li>XWiki MFA adoption</li>
--          <li>Administrator account protection</li>
--          <li>Remote user access protection</li>
--          <li>Private knowledge base security</li>
--          <li>NIS 2 readiness initiatives</li>
++          <li>Reduce repeated MFA prompts on known browsers or devices</li>
++          <li>Remain valid for the configured number of days</li>
++          <li>Can be reviewed and removed from the user profile</li>
++          <li>The current trusted browser is marked in the list</li>
++          <li>Removed when a user’s MFA setup is reset</li>
          </ul>
        </aside>
      </div>
@@ -153,14 +153,122 @@
    </div>
  </section>
++{{/html}}
++
++{{gallery}}
++[[image:mfa-recovery-codes.png]]
++[[image:mfa-trusted-devices.png]]
++{{/gallery}}
++
++{{html clean="false"}}
++
++<section class="product-section-muted" aria-labelledby="profile-title">
++  <div class="container">
++    <div class="product-layout">
++      <article class="product-summary-card">
++        <h2 id="profile-title">User and administrator management</h2>
++
++        <p>
++          The user profile contains a dedicated MFA section. Users can configure MFA, review their status,
++          manage recovery codes and manage trusted devices from this area.
++        </p>
++
++        <p>
++          Administrators can also open a user profile and access the MFA section for that user.
++          This is useful when a user loses access to their authenticator application or needs to restart the setup process.
++        </p>
++
++        <p>
++          Resetting MFA removes the authenticator app setup, invalidates recovery codes and removes trusted devices.
++          If MFA is required globally, the user will be asked to configure MFA again at the next login.
++        </p>
++      </article>
++
++      <aside class="product-info-card" aria-labelledby="profile-actions-title">
++        <h3 id="profile-actions-title">Profile actions</h3>
++        <ul>
++          #foreach ($item in $profileItems)
++            <li>$item</li>
++          #end
++        </ul>
++      </aside>
++    </div>
++  </div>
++</section>
++
++{{/html}}
++
++{{gallery}}
++[[image:mfa-user-profile-overview.png]]
++[[image:mfa-admin-user-management.png]]
++{{/gallery}}
++
++{{html clean="false"}}
++
++<section aria-labelledby="rollout-title">
++  <div class="container">
++    <h2 id="rollout-title">Rollout recommendations</h2>
++
++    <p class="section-intro">
++      For a smooth rollout, start with a small administrator or pilot group before requiring MFA for everyone.
++      A gradual rollout helps validate the configuration, prepare communication and reduce support issues.
++    </p>
++
++    <ol class="process-list">
++      #foreach ($entry in $rolloutItems)
++        <li>
++          <strong>$entry.title</strong>
++          $entry.content
++        </li>
++      #end
++    </ol>
++  </div>
++</section>
++
++<section class="product-section-muted" aria-labelledby="planning-title">
++  <div class="container">
++    <div class="product-layout">
++      <article class="product-summary-card">
++        <h2 id="planning-title">Planning installation</h2>
++
++        <p>
++          Before installing or rolling out MFA, it is useful to review the current XWiki version,
++          authentication setup, user base and security expectations.
++        </p>
++
++        <p>
++          This helps define whether MFA should be optional, required for selected users, or enforced globally.
++          It also helps decide whether trusted devices and recovery codes should be enabled.
++        </p>
++      </article>
++
++      <aside class="product-info-card" aria-labelledby="planning-info-title">
++        <h3 id="planning-info-title">Useful information before installation</h3>
++        <ul>
++          <li>XWiki version</li>
++          <li>Single wiki or wiki farm with subwikis</li>
++          <li>Current authentication setup</li>
++          <li>Optional or globally required MFA policy</li>
++          <li>Trusted-device policy</li>
++          <li>Recovery-code policy</li>
++          <li>Rollout communication needs</li>
++        </ul>
++      </aside>
++    </div>
++  </div>
++</section>
++
  <section class="cta-section" aria-labelledby="cta-title">
    <div class="container">
      <div class="cta-panel">
        <h2 id="cta-title">Interested in using this extension?</h2>
++
        <p>
--        Send a short message with your XWiki version, authentication setup, and whether you need
--        authenticator app codes, email verification codes, combined verification, or trusted-device remembering.
++        Send a short message with your XWiki version, authentication setup and whether you need
++        authenticator app codes, email verification codes, combined verification, recovery codes
++        or trusted-device remembering.
        </p>
++
        <a class="btn btn-primary" href="$xwiki.getURL('contact.WebHome')">Contact Agnease</a>
      </div>
    </div>