Cómo configurar ONLYOFFICE SP y AD FS IdP

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 Active Directory Federation Services (AD FS).

Requisitos del sistema

Los requisitos del sistema incluyen el siguiente software que ha sido probado y funciona correctamente con ONLYOFFICE SSO:

• Windows Server 2008 R2, Windows Server 2016;
• AD FS versión 3.0 o una versión posterior.

Preparación de ONLYOFFICE Workspace para configurar SSO

1. Instale ONLYOFFICE Workspace v9.5 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).

Preparación de AD FS para configurar SSO

1. Instale la última versión de AD DS (Active Directory Domain Service) con todas las actualizaciones oficiales y correcciones.
2. Instale la última versión de AD FS con todas las actualizaciones oficiales y correcciones.
   Para desplegar AD FS desde cero Usted puede usar las siguientes instrucciones.
3. Verifique que el enlace a los metadatos de AD FS está disponible al público. Para hacerlo,
   1. En el Administrador del servidor abra Tools (Herramientas) -> AD FS Management (Gestión de AD FS),
   2. Vaya a AD FS \ Service \ Endpoints (AD FS \ Servicio \ Puntos finales),
   3. Encuentre la fila con el tipo Federation Metadata (Metadatos de federación) en la tabla. El enlace a los metadatos IdP se construye con arreglo al esquema siguiente:

      https://{ad-fs-domain}/{path-to-FederationMetadata.xml}

      

      Como alternativa, Usted puede usar el comando siguiente PowerShell:

      PS C:\Users\Administrator> (Get-ADFSEndpoint | Where {$_.Protocol -eq "FederationMetadata" -or $_.Protocol -eq "Federation Metadata"}).FullUrl.ToString()

      Como resultado Usted debe recibir un enlace que tiene el siguiente aspecto:

      https://onlyofficevm.northeurope.cloudapp.azure.com/FederationMetadata/2007-06/FederationMetadata.xml

   4. Para verificar que AD FS se ha iniciado correctamente abra el enlace recibido en un navegador web. El xml debe ser mostrado o descargado. Copie el enlace al archivo xml de metadatos: será necesario en el próximo paso.

Configuración de ONLYOFFICE SP

1. Asegúrese de que se ha registrado como Administrador en el Panel de Control de 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 y pegue el enlace copiado del AD FS en el campo URL al XML Metadatos Idp.
   

   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 AD FS IdP.

3. 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.
   
4. En el selector Formato del NameID elija el siguiente valor: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress.
   
5. En la sección Certificados Públicos de IdP \ Ajustes avanzados desmarque la opción Verificar firma de respuestas de cierre de sesión, porque AD FS no lo requiere de forma predeterminada.
   
6. Ahora necesita añadir certificados a la sección Certificados de SP. Usted puede generar certificados autofirmados o añadir otros certificados.
   en la ventana Nuevos Certificados mueva el selector Usar para a la opción signing and encrypt, porque AD FS IdP se configura automáticamente para verificar firmas digitales y cifrar datos.
   

   Usted debe lograr casi el mismo resultado:

   
7. En la sección Certificados de SP \ Ajustes avanzados desmarque la casilla Firmar respuestas de cierre de sesión, porque AD FS no lo requiere de forma predeterminada.
   
   No es necesario ajustar el formulario Mapeo de atributos, porque configuraremos estos parámetros en el AD FS IdP más tarde.
8. Haga clic en el botón Guardar. La sección Metadatos de ONLYOFFICE SP debe abrirse.
   

   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.

9. Copie el enlace a los metadatos de ONLYOFFICE SP del campo ID de Entidad de SP (enlace al XML con metadatos) y vaya a la máquina donde AD FS está instalado.
   

Configuración de AD FS IdP

1. En el Administrador del servidor abra Tools (Herramientas) -> AD FS Management (Gestión de AD FS),
   
2. En el panel AD FS Management (Gestión de AD FS) seleccione la opción Trust Relationships > Relying Party Trusts (Relaciones de confianza > Usuario de confianza). Haga clic en la opción Add Relying Party Trust... (Agregar confianza) a la derecha. Se abrirá Add Relying Party Trust Wizard (la página de bienvenida),
   
3. En la página de bienvenida seleccione el botón de opción Import data about the relying party published online or on a local network (Importar datos acerca del usuario de confianza publicados en línea o en una red local), pegue el enlace previamente copiado a los metadatos de ONLYOFFICE SP en el campo Federation metadata address (host name or URL) (Dirección de metadatos de federación (el nombre del host o URL)) y haga clic en el botón Next (Siguiente),
   
4. En el campo Display name (Mostrar nombre) especifique cualquier nombre y haga clic en el botón Next (Siguiente),
   
5. Seleccione la opción I do not want to configure multi-factor authentication settings for this relying party trust at this time (No quiero configurar los ajustes de autenticación multi-factorial para este usuario de confianza en ese momento) y haga clic en el botón Next (Siguiente),
   
6. Seleccione la opción Permit all users to access this relying party (Permitir acceso a este usuario de confianza a todos los usuarios) y haga clic en el botón Next (Siguiente),
   
7. Verifique los ajustes resultantes y haga clic en el botón Next (Siguiente),
   
8. Deje la opción predeterminada sin cambios y haga clic en el botón Close (Cerrar),
   
9. Se abrirá nueva ventana. En la pestaña Issuance Transform Rules (Reglas de conversión de emisión) haga clic en el botón Add Rule... (Añadir regla...),
   
10. Seleccione la opción Send LDAP Attributes as Claims (Enviar atributos LDAP como aprobaciones) de la lista Claim rule template (Plantilla de la regla de aprobación) y haga clic en el botón Next (Siguiente),
    
11. Indique cualquier nombre en el campo Claim rule name (Nombre de la regla de aprobación). Seleccione la opción Active Directory (Directorio Activo) de la lista Attribute store (Almacenamiento de atributos) y complete el formulario Mapping of LDAP attributes to outgoing claim types (Mapeo de atributos LDAP según los tipos de aprobaciones salientes) de acuerdo a la tabla siguiente. Cuando todo está listo, pulse el botón Finish (Finalizar).

    LDAP Attribute/Atributo LDAP (Seleccione o escriba para añadir más)	Outgoing Claim Type/Tipo de aprobación saliente (Seleccione o escriba para añadir más)
    Given-Name	givenName
    Surname	sn
    E-Mail-Addresses	mail
    Telephone-Number	mobile
    Title	title
    physicalDeliveryOfficeName	l

    
12. En la ventana Edit Claim Rules (Editar reglas de aprobación) haga clic en el botón Add Rule... (Añadir regla...) de nuevo, seleccione la opción Transform an Incoming Claim (Convertir una aprobación entrante) de la lista Claim rule template (Plantilla de la regla de aprobación) y haga clic en el botón Next (Siguiente),
    
13. Indique cualquier nombre en el campo Claim rule name (Nombre de la regla de aprobación) y seleccione las siguientes opciones de las listas:
    • Incoming claim type: (Tipo de aprobación entrante) mail,
    • Outgoing claim type: (Tipo de aprobación saliente) Name ID,
    • Outgoing name ID format: (Formato ID del nombre saliente) Email
    

    Cuando todo está listo, haga clic en el botón Finish (Finalizar).

    Usted debe lograr casi el mismo resultado:

    

    Si logout (cierre de sesión) del AD FS no funciona, se recomienda añadir Custom Claim Rule (Regla personalizada de aprobación) reemplazando {portal-domain} por su dominio SP y cambiando {ad-fs-domain} a su dominio IdP:

    c:[Type == "mail"]
     => issue(Type = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier", Issuer = c.Issuer, OriginalIssuer = c.OriginalIssuer, Value = c.Value, ValueType = c.ValueType, Properties["http://schemas.xmlsoap.org/ws/2005/05/identity/claimproperties/format"] = "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", Properties["http://schemas.xmlsoap.org/ws/2005/05/identity/claimproperties/namequalifier"] = "http://{ad-fs-domain}/adfs/services/trust", Properties["http://schemas.xmlsoap.org/ws/2005/05/identity/claimproperties/spnamequalifier"] = "https://{portal-domain}/sso/metadata");

    
14. Pulse el botón OK,
15. Para que SSO pueda funcionar de la intranet Usted necesita activar la opción Forms Authentication (Formularios de Autenticación) en la ventana Edit Global Authentication Policy (Editar política de autenticación global) (menú contextual AD FS / Authentication Policies (AD FS / Políticas de Autenticación)),
    
16. Abra las propiedades del usuario de confianza creado y cambie a la pestaña Advanced (Ajustes avanzados),
    

    Seleccione la opción SHA-1 en la lista Secure hash algorithm (Algoritmo SHA).

    

Verificación del funcionamiento de ONLYOFFICE SP con AD FS IdP

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 AD FS IdP:
   
4. Introduzca el login y la contraseña de la cuenta en AD FS IdP y pulse el botón Sign in (Acceso).
5. Si las credenciales son correctas, 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: