Configuración
Internamente, el módulo SAML de Overleaf utiliza la biblioteca passport-saml; la mayoría de las siguientes opciones de configuración se transmiten apassport-saml. Si tienes problemas para configurar SAML, vale la pena leer el README de passport-saml para hacerte una idea de la configuración que espera.
La variable de entorno EXTERNAL_AUTH es necesaria para habilitar el módulo de autenticación SAML. Esta variable de entorno especifica qué métodos de autenticación externa se activan. Su valor es una lista. Si la lista incluye saml, se activará la autenticación SAML.
Por ejemplo: EXTERNAL_AUTH=ldap saml
Al utilizar el método de autenticación SAML, el usuario es redirigido al sitio de autenticación del proveedor de identidad (IdP). Si el IdP autentica correctamente al usuario, se busca en la base de datos de usuarios de Overleaf un registro que contenga un campo samlIdentifiers con la siguiente estructura:
externalUserId debe coincidir con el valor de la propiedad especificada por userIdAttribute en el perfil de usuario devuelto por el servidor del IdP.
Si no se encuentra ningún registro coincidente, se busca en la base de datos un usuario cuya dirección de correo electrónico principal coincida con el correo del perfil de usuario del IdP:
- Si se encuentra dicho usuario, se elimina el campo
hashedPasswordpara deshabilitar la autenticación local y se añade el camposamlIdentifiers. - Si no se encuentra ningún usuario coincidente, se crea un nuevo usuario con la dirección de correo electrónico y los
samlIdentifiersdel perfil del IdP.
providerId de samlIdentifiers está fijado en '1'.
Variables de entorno
OVERLEAF_SAML_IDENTITY_SERVICE_NAME- Nombre visible del servicio de identidad, que se usa en la página de inicio de sesión (por defecto:
Log in with SAML IdP).
- Nombre visible del servicio de identidad, que se usa en la página de inicio de sesión (por defecto:
OVERLEAF_SAML_USER_ID_FIELD- Overleaf usará el valor de este atributo como ID de usuario externo; por defecto,
nameID.
- Overleaf usará el valor de este atributo como ID de usuario externo; por defecto,
OVERLEAF_SAML_EMAIL_FIELD- Nombre del campo de correo electrónico en el perfil de usuario; por defecto,
nameID.
- Nombre del campo de correo electrónico en el perfil de usuario; por defecto,
OVERLEAF_SAML_FIRST_NAME_FIELD- Nombre del campo firstName en el perfil de usuario; por defecto,
givenName.
- Nombre del campo firstName en el perfil de usuario; por defecto,
OVERLEAF_SAML_LAST_NAME_FIELD- Nombre del campo lastName en el perfil de usuario; por defecto,
lastName
- Nombre del campo lastName en el perfil de usuario; por defecto,
OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN- Si se establece en
true, actualiza los camposfirst_nameylast_namedel usuario al iniciar sesión y desactiva el formulario de datos del usuario en la página/user/settings.
- Si se establece en
OVERLEAF_SAML_ENTRYPOINT(obligatoria)- URL del punto de entrada del servicio de identidad SAML.
- Ejemplo:
https://idp.example.com/simplesaml/saml2/idp/SSOService.php - Ejemplo de Azure:
https://login.microsoftonline.com/8b26b46a-6dd3-45c7-a104-f883f4db1f6b/saml2
- Ejemplo:
- URL del punto de entrada del servicio de identidad SAML.
OVERLEAF_SAML_ISSUER(obligatoria)- El nombre del emisor (Issuer).
OVERLEAF_SAML_AUDIENCE- Audience esperado en la respuesta SAML; por defecto, el valor de
OVERLEAF_SAML_ISSUER.
- Audience esperado en la respuesta SAML; por defecto, el valor de
OVERLEAF_SAML_IDP_CERT(obligatoria)- Ruta a un archivo que contiene el certificado público del proveedor de identidad, utilizado para validar las firmas de las respuestas SAML entrantes. Si el proveedor de identidad tiene varios certificados de firma válidos, puede ser un array JSON de rutas a los certificados.
- Ejemplo (un certificado):
/var/lib/overleaf/certs/idp_cert.pem - Ejemplo (varios certificados):
["var/lib/overleaf/certs/idp_cert.pem", "/var/lib/overleaf/certs/idp_cert_old.pem"]
- Ejemplo (un certificado):
- Ruta a un archivo que contiene el certificado público del proveedor de identidad, utilizado para validar las firmas de las respuestas SAML entrantes. Si el proveedor de identidad tiene varios certificados de firma válidos, puede ser un array JSON de rutas a los certificados.
OVERLEAF_SAML_PUBLIC_CERT- Ruta a un archivo que contiene el certificado público de firma que se incrusta en las solicitudes de autenticación para que el IdP pueda validar las firmas de la solicitud SAML entrante. Es obligatorio al configurar el endpoint de metadatos cuando la estrategia se configura con
OVERLEAF_SAML_PRIVATE_KEY. Se puede proporcionar un array JSON de rutas a certificados para permitir la rotación de certificados. Al proporcionar un array de certificados, la primera entrada del array debe corresponder a laOVERLEAF_SAML_PRIVATE_KEYactual. Las entradas adicionales del array pueden usarse para publicar en los IdP los próximos certificados antes de cambiarOVERLEAF_SAML_PRIVATE_KEY.
- Ruta a un archivo que contiene el certificado público de firma que se incrusta en las solicitudes de autenticación para que el IdP pueda validar las firmas de la solicitud SAML entrante. Es obligatorio al configurar el endpoint de metadatos cuando la estrategia se configura con
OVERLEAF_SAML_PRIVATE_KEY- Ruta a un archivo que contiene una clave privada en formato PEM correspondiente a
OVERLEAF_SAML_PUBLIC_CERT, utilizada para firmar las solicitudes de autenticación enviadas por passport-saml.
- Ruta a un archivo que contiene una clave privada en formato PEM correspondiente a
OVERLEAF_SAML_DECRYPTION_CERT- Ruta a un archivo que contiene un certificado público, utilizado para el endpoint de metadatos.
OVERLEAF_SAML_DECRYPTION_PVK- Ruta a un archivo que contiene la clave privada correspondiente a
OVERLEAF_SAML_DECRYPTION_CERT, que se utilizará para intentar descifrar las aserciones cifradas que se reciban.
- Ruta a un archivo que contiene la clave privada correspondiente a
OVERLEAF_SAML_SIGNATURE_ALGORITHM- Permite establecer opcionalmente el algoritmo de firma para firmar las solicitudes; los valores válidos son ‘sha1’ (predeterminado), ‘sha256’ (preferido) y ‘sha512’ (el más seguro; comprueba si tu IdP lo admite).
OVERLEAF_SAML_ADDITIONAL_PARAMS- Diccionario JSON de parámetros de consulta adicionales que se añadirán a todas las solicitudes.
OVERLEAF_SAML_ADDITIONAL_AUTHORIZE_PARAMS- Diccionario JSON de parámetros de consulta adicionales que se añadirán a las solicitudes ‘authorize’.
- Ejemplo:
{"some_key": "some_value"}
- Ejemplo:
- Diccionario JSON de parámetros de consulta adicionales que se añadirán a las solicitudes ‘authorize’.
OVERLEAF_SAML_IDENTIFIER_FORMAT- Formato del identificador de nombre que se solicitará al proveedor de identidad (por defecto:
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress). Si usasurn:oasis:names:tc:SAML:2.0:nameid-format:persistent, asegúrate de que la variable de entornoOVERLEAF_SAML_EMAIL_FIELDesté definida. Si se requiereurn:oasis:names:tc:SAML:2.0:nameid-format:transient, también debes definir la variable de entornoOVERLEAF_SAML_USER_ID_FIELD, que puede establecerse, por ejemplo, en la dirección de correo electrónico del usuario.
- Formato del identificador de nombre que se solicitará al proveedor de identidad (por defecto:
OVERLEAF_SAML_ACCEPTED_CLOCK_SKEW_MS- Desfase de tiempo, en milisegundos, aceptable entre el cliente y el servidor al comprobar las marcas de tiempo de validez de las condiciones de aserción OnBefore y NotOnOrAfter. Si se establece en -1, se deshabilita por completo la comprobación de estas condiciones. El valor predeterminado es 0.
OVERLEAF_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX- Atributo
AttributeConsumingServiceIndexque se añade a AuthnRequest para indicar al IdP qué conjunto de atributos debe adjuntar a la respuesta (enlace).
- Atributo
OVERLEAF_SAML_AUTHN_CONTEXT- Array JSON de valores de formato de identificador de nombre para solicitar el contexto de autenticación. Por defecto:
["urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"].
- Array JSON de valores de formato de identificador de nombre para solicitar el contexto de autenticación. Por defecto:
OVERLEAF_SAML_FORCE_AUTHN- Si es
true, la solicitud SAML inicial del proveedor de servicios especifica que el IdP debe forzar la reautenticación del usuario, incluso si tiene una sesión válida.
- Si es
OVERLEAF_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT- Si es
true, no se solicita un contexto de autenticación específico. Por ejemplo, puedes establecerlo entruepara permitir contextos adicionales, como inicios de sesión sin contraseña (urn:oasis:names:tc:SAML:2.0:ac:classes:X509). La compatibilidad con contextos adicionales depende de tu IdP.
- Si es
OVERLEAF_SAML_AUTHN_REQUEST_BINDING- Si se establece en
HTTP-POST, solicitará la autenticación al IdP mediante el binding HTTP POST; de lo contrario, se usa HTTP-Redirect por defecto.
- Si se establece en
OVERLEAF_SAML_VALIDATE_IN_RESPONSE_TO- Si es
always, se validará InResponseTo en las respuestas SAML entrantes. - Si es
never, no se validará InResponseTo (predeterminado). - Si es
ifPresent, InResponseTo solo se validará si está presente en la respuesta SAML entrante.
- Si es
OVERLEAF_SAML_WANT_ASSERTIONS_SIGNEDyOVERLEAF_SAML_WANT_AUTHN_RESPONSE_SIGNED- Cuando se establecen en
true(predeterminado), Overleaf espera que las aserciones SAML y, respectivamente, toda la respuesta de autenticación SAML estén firmadas por el IdP. Cuando ambas opciones sonfalse, al menos las aserciones o la respuesta deben estar firmadas.
- Cuando se establecen en
OVERLEAF_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS- Define el tiempo de expiración tras el cual un ID de solicitud generado para una solicitud SAML dejará de ser válido si aparece en el campo
InResponseTode una respuesta SAML. Por defecto: 28800000 (8 horas).
- Define el tiempo de expiración tras el cual un ID de solicitud generado para una solicitud SAML dejará de ser válido si aparece en el campo
OVERLEAF_SAML_LOGOUT_URL- Dirección base a la que se envían las solicitudes de cierre de sesión (por defecto:
entryPoint).- Ejemplo:
https://idp.example.com/simplesaml/saml2/idp/SingleLogoutService.php
- Ejemplo:
- Dirección base a la que se envían las solicitudes de cierre de sesión (por defecto:
OVERLEAF_SAML_ADDITIONAL_LOGOUT_PARAMS- Diccionario JSON de parámetros de consulta adicionales que se añadirán a las solicitudes ‘logout’.
OVERLEAF_SAML_IS_ADMIN_FIELDyOVERLEAF_SAML_IS_ADMIN_FIELD_VALUE- Cuando ambas variables de entorno están definidas, el proceso de inicio de sesión establece
user.isAdmin = truesi el perfil devuelto por el IdP SAML contiene el atributo especificado enOVERLEAF_SAML_IS_ADMIN_FIELDy su valor coincide conOVERLEAF_SAML_IS_ADMIN_FIELD_VALUEo es un array que contieneOVERLEAF_SAML_IS_ADMIN_FIELD_VALUE; en caso contrario,user.isAdminse establece enfalse. Si alguna de estas variables no está definida, el estado de administrador solo se establece entruedurante la creación del usuario administrador en Launchpad.
- Cuando ambas variables de entorno están definidas, el proceso de inicio de sesión establece
http://my-overleaf-instance.com/saml/meta
El proveedor de identidad deberá configurarse para reconocer el servidor de Overleaf como “proveedor de servicios” (Service Provider). Consulta la documentación de tu servidor SAML para obtener instrucciones sobre cómo hacerlo.
A continuación se muestra un ejemplo de metadatos adecuados del proveedor de servicios:
ol-meta.xml
ol-meta.xml
AssertionConsumerService.Location, SingleLogoutService.Location y EntityDescriptor.entityID y configúralos según corresponda en la configuración de tu IdP, o envía el archivo de metadatos al administrador del IdP.
Ejemplo de archivo variables.env (mínimo)
Ejemplo de archivo variables.env (mínimo)
Paso a paso: goauthentik
Esta guía describe una configuración probada con goauthentik. Sustituyehttps://overleaf.example.com por tu OVERLEAF_SITE_URL y https://authentik.example.com por la dirección de tu Authentik.
Crear el proveedor y la aplicación
overleaf, y haz clic en Next:
Authentik: nombre y slug de la aplicación

Authentik: elegir el proveedor SAML
- Authorization Flow:
default-provider-authorization-implicit-consent - ACS URL:
https://overleaf.example.com/saml/login/callback - Audience: un nombre para Overleaf, por ejemplo
overleaf. Overleaf lo envía comoOVERLEAF_SAML_ISSUER.

Authentik: el proveedor SAML de la aplicación
- Signing Certificate: un certificado, por ejemplo
authentik Self-signed Certificate - Sign assertions y Sign responses: ambos activados
- Service Provider Binding:
Post

Authentik: firma y binding de un proveedor probado (instancia de prueba)
Copiar los valores de la página del proveedor

Authentik: vista general de un proveedor SAML (instancia de prueba)
Instalar el certificado de firma
data/overleaf/certs/idp_cert.pem en tu directorio del Toolkit. El contenedor lo ve como /var/lib/overleaf/certs/idp_cert.pem:Asignar los atributos
http://schemas.xmlsoap.org/claims/Group, en forma de lista. Para que los miembros del grupo Admins de Authentik sean administradores de Overleaf:Archivo variables.env probado para goauthentik
Archivo variables.env probado para goauthentik

