Cómo configurar ONLYOFFICE SP y Shibboleth IdP

Control Panel v3.5 ONLYOFFICE Control Panel changelog

Introducción

Single Sign-on (SSO) es una tecnología que permite a los usuarios ingresar sólo una vez y luego obtener acceso a múltiples aplicaciones/servicios sin re-autenticación.

SSO es siempre una operación conjunta de dos aplicaciones: un Proveedor de Identidad y un Proveedor de Servicios (en lo sucesivo denominados "IdP" y "SP"). ONLYOFFICE SSO aplica sólo SP. Diferentes proveedores pueden actuar como IdP, pero este artículo considera la implementación de Shibboleth.

Preparación de ONLYOFFICE Workspace para configurar SSO

1. Instale ONLYOFFICE Workspace v. 11.0.0 para Docker o cualquier versión posterior con el soporte de SSO.
2. Añada un nombre del dominio, por ejemplo, myportal-address.com.
3. En su portal vaya al Panel de Control -> HTTPS, cree y aplique el certificado letsencrypt para la encriptación del tráfico (para activar HTTPS en su portal).

Creación de 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)

Creación de 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 (por ejemplo, https://your-idp-domain.com/idp/shibboleth) y vaya al portal ONLYOFFICE ingresando como un administrador. Abra la página Panel de Control -> SSO.

Configuración de ONLYOFFICE SP

1. Asegúrese de que se ha registrado como Administrador en el Panel de Control de su ONLYOFFICE y haga clic en la pestaña SSO.
   Usted puede registrar sólo un proveedor de identidad corporativo para su organización en el portal ONLYOFFICE.
   
2. Active SSO usando el conmutador Activar Autenticación Single Sign-on and paste the link to the Shibboleth IdP into the URL to Idp Metadata XML field.
   
3. Pulse el botón con la flecha hacia arriba para cargar los metadatos IdP. El formulario Ajustes de ONLYOFFICE SP se llenará automáticamente con sus datos del 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. En el campo Texto personalizado para botón de acceso Usted puede introducir cualquier texto en vez del estándar (Single Sign-on). Este texto se mostrará en el botón usado para acceso al portal con el servicio Single Sign-on en la página de autenticación de ONLYOFFICE.
   
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.
   

   You should get nearly the same result:

   
7. En la sección Mapeo de Atributos indique la correspondencia de los campos en el módulo Personas ONLYOFFICE para los atributos de usuario que serán devueltos del 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

   
8. Haga clic en el botón Guardar.
9. La sección Metadatos de ONLYOFFICE SP debe abrirse.
10. Verifique que nuestros ajustes están disponibles al público pulsando el botón Descargar XML de Metadatos de SP. El contenido del archivo XML debe ser mostrado.
    

    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).

Verificación del funcionamiento del ONLYOFFICE SP con el 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

Acceso al ONLYOFFICE en el lado de SP

1. Vaya a la página de Autenticación de ONLYOFFICE (por ejemplo, https://myportal-address.com/Auth.aspx).
2. Haga clic en el botón Single sign-on (el nombre del botón puede variar si Usted ha especificado su propio texto al configurar ONLYOFFICE SP). Si el botón está desaparecido, esto significa que SSO no está activado.
   
3. Si todos los parámetros de SP y IdP están correctamente configurados, nos redirigirá al formulario de acceso en Shibboleth IdP:
   
4. Introduzca el login y la contraseña de la cuenta en Shibboleth IdP (username: student1, password: password) y marque la casilla Don't Remember Login.
5. Si las credenciales son correctas, se abrirá la nueva ventana. Permita la prestación de información al servicio haciendo clic en el botón Accept.
   
6. Si todo es correcto, nos redirigirá a la página principal del portal (si no hay tal usuario en el portal, él se creará automáticamente, o si los datos han sido modificados en el IDP, ellos se actualizarán).
   

Perfiles de usuarios añadidos con autenticación SSO

La posibilidad de editar perfiles de usuarios creados usando la autenticación SSO está restringida. Los campos del perfil de usuario recibidos del IdP están desactivados para edición (como Nombre, Apellido, Correo, Posición y Ubicación). Usted puede editar estos campos sólo en su cuenta IdP.

La imagen debajo muestra el menú "Acciones" para un usuario SSO:

La imagen siguiente muestra el perfil de un usuario SSO abierto para edición:

Los usuarios creados usando la autenticación SSO están marcados con el icono SSO en la lista de usuarios para los administradores del portal:

Para desconectarse del Shibboleth IdP (si Usted no ha marcado la casilla Don't Remember Login al iniciar la sesión), siga el enlace que tiene el siguiente aspecto: https://{shibboleth-idp-domain}/idp/profile/Logout