Artikel zum Thema:
Schließen
Changelog
Schließen
Hilfe-Center
Control Panel

Configuring ONLYOFFICE SP and Shibboleth IdP

Control Panelv2.9 ONLYOFFICE Control Panel changelog

Version 2.9.1

Release date: 12/10/2020

Bug fixes

  • Bug Fixes & Performance Improvements.

Version 2.9

Release date: 10/14/2020

General

  • Control Panel is available in the free Community version with all settings excepting the editors logo replacement;
  • Added the vsyscall check to the installation scripts when installing Mail Server on Debian with kernel 4.18.0 and later;
  • Redesign of the navigation menu: added Common and Portal settings sections, added icons to menu items;
  • Added the advanced rebranding page in the Common Settings;
  • Added the possibility to reindex the full-text search;
  • Updated node.js, updated packages (transition to samlify for SSO);
  • Added the Encryption at rest block in the Storage section;
  • Added the Private Room section for the server version only;
  • Added the upgrade page with a proposal to upgrade to Enterprise Edition;
  • Added the activate page with a possibility to upload a license file;
  • Added the HideAuthPage option to the SSO settings to hide the authorization page. When the HideAuthPage option is enabled, an automatic redirect from the authorization page to the SSO service will occur.

LDAP

  • Added the Sign in to domain option on the authorization page.

Single Sign-on

  • Transition to the new samlify library;
  • Added the HideAuthPage option to the SSO settings to hide the authorization page. When the HideAuthPage option is enabled, an automatic redirect from the authorization page to the SSO service will occur.

Version 2.7

Release date: 04/25/2019

LDAP

  • Added more fields mapped for the users loaded via LDAP: user photo, birthday, contacts, primary phone number;
  • Added the setting to autosync LDAP on schedule;
  • Added the possibility to give administrator rights to the user group at the portal via LDAP;
  • Updated the rules for LDAP users.

Version 2.5.1

Release date: 04/07/2018

LDAP

  • Fixed the Server internal error error when using the groups enclosed inside each other in the AD (bug #37414).

Single Sign-on

  • Fixed the issue when the user data between the Service Provider and the portal was transferred via HTTP only, even when HTTPS was enabled.

Version 2.4.0

Release date: 01/13/2018

Single Sign-on

  • Fixed the Invalid ssoConfig error which occurred when the link to the IdP contained the question mark '?', e.g.: IdP Single Sign-On Endpoint URL: https://accounts.google.com/o/saml2/idp?idpid=777777;
  • Fixed the Invalid authentication token error which prevented from adding a user to the portal using the AD FS, in case the + or - characters were present when sending the encrypted data.

Version 2.3.0

Release date: 12/15/2017

General

  • Added the changelog for Control Panel and link to it;
  • Fixed the bug when JWT parameters were not sent when updating Document Server(bug #36270);
  • Fixed the bug when Audit Trail heading was present at the login history page (bug #36026);
  • The current machine is now checked for being linked with the domain name for multiple portals.

LDAP

  • Fixed the bug with the LDAP Domain not found error which occurred if the DN record had no DC records (the users with Sun/Oracle DS were affected); now if the LDAP domain could not be specified, the LDAP domain will acquire the unknown value or the ldap.domain value from the web.appsettings.config configuration file;
  • Fixed the bug with the Sizelimit Exceeded error when trying to get more than 1000 users from the Active Directory;
  • Increased the login speed with the Group Membership setting enabled;
  • Added additional logging;
  • Fixed the bug with LDAP operation hanging when using Mono v5.2.0 and older;
  • Fixed the bug with the error when trying to login using the email address entered in the fields different from the Mail Attribute;
  • Fixed the bug occurring in the enclosed groups, when the users were displayed not in all groups.

Version 2.2.0

Release date: 10/31/2017

General

  • Added the documentserver-prepare4shutdown.sh script launch when updating the document-server for the correct edited document saving.

LDAP

  • Dramatically changed LDAP integration, migrated to the single library for the work with LDAP (Novell.Directory.Ldap.NETStandard, Nuget, MIT);
  • Login and email are now split into two separate fields;
  • Added the support for big data;
  • Increased the work speed via the LDAP protocol (the connection to the server and receiving the data is now made once per session, added the limits when only a certain number of results is necessary, fixed the slow login for bit data, removed the sorting out used to find the SID parameter);
  • Fixed the user re-creation issue;
  • Fixed the duplicate username issue;
  • Fixed the already existing email issue;
  • Replaced the LDAP user deletion with account deactivation (for further data migration and data safety);
  • Instead of re-creating a user with an unknown SID but an existing email the data is updated;
  • Added the attempt to save the correct UserName/Login in case a similar one is already taken on the portal.

Single Sign-on

  • Added the AD FS support;
  • Replaced the Single Sign-on link at the authorization page with the customizable button, added the button customization to the SSO setting of the Control Panel.

Version 2.1.0

Release date: 07/03/2017

HTTPS

  • Added the support of letsencrypt service for the domain certificate generation.

Single Sign-on

  • Added the new sso.auth service;
  • Added the new SSO settings page;
  • Added the support for Shibboleth.

Version 2.0.0

Release date: 05/25/2017

General

  • The Control Panel migrated from MVC to Node.js.

Version 1.6.0

Release date: 12/05/2016

LDAP

  • Added LDAP synchronization for users and groups when saving the settings, after login and using the Sync button;
  • Changed email formation for LDAP users;
  • Fixed the problem of creation of users with invalid emails;
  • Fixed the problem of duplicate users;
  • Added icons and hints to the users in the list for the admin;
  • Blocked for editing the user profile fields imported using LDAP;
  • Added the real LDAP password saving to the database during login in case LDAP Auth is disabled, now the LDAP users will become common portal users when LDAP Auth is disabled;
  • Added new API Settings method - Sync LDAP;
  • Added new translations;
  • Bug fixes.

Version for Windows

  • Made changes at the Update page for the Control Panel for Windows;
  • Updates are performed using the downloaded installation packages for each module.
  • The current installed component version numbers are obtained via API request to the Community Server.
  • The new versions available for download are obtained via the request to the https://download.onlyoffice.com/install/windows/updates.txt file, where all the latest component version numbers and links for their download are stored in the JSON format.

Introduction

Single Sign-on (SSO) is a technology that allows users to sign in only once and then get access to multiple applications/services without re-authentication.

If a web portal includes several large independent sections (forum, chat, blogs etc.), a user can undergo the authentication procedure within one of the services and automatically get access to all other services without entering credentials several times.

SSO is always ensured by the joint operation of two applications: an Identity Provider and a Service Provider (hereinafter referred to as "IdP" and "SP"). ONLYOFFICE SSO implements the SP only. A lot of different providers can act as an IdP, but this article considers the Shibboleth implementation.

If you want to use SSO when connecting ONLYOFFICE Desktop Editors to your ONLYOFFICE Workspace, disable Private Rooms in the Control Panel.

Preparing ONLYOFFICE Workspace for the SSO setup

  1. Install ONLYOFFICE Workspace v. 11.0.0 for Docker or any later version with the SSO support.
  2. Add a domain name, e.g., myportal-address.com.
  3. On your portal, go to the Control Panel -> HTTPS, create and apply the letsencrypt certificate for the traffic encryption (to enable HTTPS on your portal).

Creating Shibboleth IdP

Requirements
  • To deploy Shibboleth IDP, a clean CentOS 7 host machine is required.
  • Time must be set correctly and the time synchronization service must be installed on the host machine for IDP:
    timedatectl  status
    yum install ntp
    systemctl enable ntpd.service
    ntpdate time.apple.com
  • The unzip package must be installed on the machine:
    yum install unzip
  • Docker and Docker Compose must be installed on the machine.
  • A domain name must be associated with the machine (for example, your-idp-domain.com)
Creating Shibboleth IdP

To create, configure and start Shibboleth IDP, download and execute the install.sh script.

Here's what the script does:

  • downloads docker files for creating Shibboleth Idp images and containers from github,
  • changes the default idptestbed.edu domain in the configuration files to the domain specified when executing the script,
  • adds access via the SAML protocol for the specified ONLYOFFICE SP domain,
  • specifies which attributes are required for ONLYOFFICE SP to issue information about users from Shibboleth IDP (the Attribute Mapping setting),
  • creates and configures LDAP and creates users for issuing,
  • enables dynamic loading of metadata from ONLYOFFICE SP to Shibboleth IDP,
  • enables Shibboleth SLO, if necessary.
  1. Download the install.sh script:
    curl -L https://bit.ly/3fwo5e6 -o install.sh
  2. Make the script executable:
    chmod +x install.sh
  3. Execute the script replacing parameters with your own ones:
    ./install.sh -id your-idp-domain.com -sd myportal-address.com --no_slo

    Script parameters:

    • -id - a domain name of the current machine for Shibboleth IDP.
    • -sd - a domain name where ONLYOFFICE SP is deployed.
    • --no_slo - disables Single Logout in Shibboleth IDP (optional parameter).
  4. Wait when Shibboleth IDP starts after executing the script.
  5. To verify that Shibboleth IDP started correctly, open the https://your-idp-domain.com/idp/shibboleth link in your browser. An xml file should be displayed.
  6. Copy the https://{your_idp_domain}/idp/shibboleth link (e.g., https://your-idp-domain.com/idp/shibboleth) and go to the ONLYOFFICE portal signing in as an administrator. Open the Control Panel -> SSO page.

Configuring ONLYOFFICE SP

  1. Make sure that you are signed in as an Administrator to your ONLYOFFICE Control Panel and click the SSO tab in the PORTAL SETTINGS section on the left sidebar.
    You can only register one enterprise Identity Provider for your organization on the ONLYOFFICE portal.
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
  2. Enable SSO using the Enable Single Sign-on Authentication switcher and paste the link to the Shibboleth IdP into the URL to Idp Metadata XML field.
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
  3. Press the button with the upward arrow to load the IdP metadata. The ONLYOFFICE SP Settings form will be automatically filled in with your data from the Shibboleth IdP.

    As we disabled SLO when executing the install.sh script by specifying the --no_slo parameter, the IdP Single Logout Endpoint URL field will be empty.

  4. Once the IdP metadata is loaded, two certificates will be added in the IdP Public certificates section. You'll also see the pop-up window with the following text: 'Multiple Idp verification certificates are not supported. Please leave only Primary certificate'.

    You need to delete the second certificate in the list and leave the first certificate only, which is the primary certificate. Use the Delete link next to the second certificate to remove it. If you do not remove the certificate, you'll not be able to save the settings.

  5. In the Custom login button caption field, you can enter any text instead of the default one (Single Sign-on). This text will be displayed on the button used to login to the portal with the Single Sign-on service at the ONLYOFFICE authentication page.
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
  6. Now you need to create self-signed certificates or add any other certificates in the SP Certificates section.
    Important!In the Use for list, choose the signing and encrypt option as your Shibboleth IdP is automatically configured with the install.sh script to verify that data is digitally signed and encrypted.
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP

    You should get nearly the same result:

    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
  7. In the Attribute Mapping section, set the correspondence of the fields in the ONLYOFFICE People module to the user attributes which will be returned from the Shibboleth IdP.
    First Name urn:oid:2.5.4.42
    Last Name urn:oid:2.5.4.4
    Email urn:oid:0.9.2342.19200300.100.1.3
    Location urn:oid:2.5.4.7
    Title urn:oid:2.5.4.12
    Phone urn:oid:0.9.2342.19200300.100.1.41
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP

    In the Advanced Settings section, you can check the Hide auth page option to hide default authentication page and automatically redirect to SSO service.

  8. Click the Save button.
  9. The ONLYOFFICE SP Metadata section should be opened.
  10. Verify that our settings are publicly available by clicking the Download SP Metadata XML button. The XML file contents should be displayed.
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP

    This xml file is usually used to configure Shibboleth IDP, but because the install.sh script enables DynamicHTTPMetadataProvider, we do not need to do that (Shibboleth IDP will download this xml file at the first request for the login).

Checking the work of the ONLYOFFICE SP with the Shibboleth IdP

The install.sh script created 4 users which can be used for testing the work of the ONLYOFFICE SP with the Shibboleth IdP.

Email Username Password Comment
student1@{your_idp_domain} student1 password Standard
student2@{your_idp_domain} student2 password Without givenName
student3@{your_idp_domain} student3 password With umlauts
staff1@{your_idp_domain} staff1 password Obligatory fields only
Logging in to ONLYOFFICE on the SP side
  1. Go to the ONLYOFFICE Authentication page (e.g., https://myportal-address.com/Auth.aspx).
  2. Click the Single sign-on button (the caption may differ if you have specified your own text when configuring ONLYOFFICE SP). If the button is missing, this means that SSO is not enabled.
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
  3. If all the SP and IdP parameters are set correctly, we will be redirected to the Shibboleth IdP login form:
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
  4. Enter the username and password of the Shibboleth IdP account (username: student1, password: password) and check the Don't Remember Login box.
  5. If the credentials are correct, a new window opens. Allow the provision of information to the service by clicking the Accept button.
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
  6. If everything is correct, we will be redirected to the main page of the portal (the user will be created automatically if missing, or the data will be updated if changed in the IDP).
    How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP
Profiles for users added with SSO authentication

The possibility to edit user profiles created using the SSO authentication is restricted. The user profile fields received from the IdP are disabled for editing (i.e. First Name, Last Name, Email, Title and Location). You can edit these fields from your IdP account only.

The figure below shows the Actions menu for an SSO user:

How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP

The following figure shows an SSO user profile opened for editing:

How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP

The users created using the SSO authentication are marked with the SSO icon in the user list for the portal administrators:

How to configure Shibboleth IdP and ONLYOFFICE SP How to configure Shibboleth IdP and ONLYOFFICE SP

To log out from the Shibboleth IdP (if you have not checked the Don't Remember Login box when logging in), go to the link that looks like this: https://{shibboleth-idp-domain}/idp/profile/Logout

Download Host on your own server Available for
Docker, Windows and Linux
Wer sich dafür interessiert hat,
hat auch das Folgende gelesen:
Schließen