Manual de instalación de Viafirma Documents

Configuración LDAP / Active Directory

Revisión: 30-jul-2019

Si tu instalación de Viafirma Documents va a integrarse con el Active Directory o LDAP de tu organización tendrás que tener en cuenta los parámetros de configuración específicos que te describimos en este capítulo, y que tendrás que agregar a tu fichero de configuración general config.properties.

Agregar Proveedor de Identidad

El param donde se definen los proveedores de identidad es IDPS, y por defecto ya cuenta con un proveedor del tipo database:

```

Para agregar en tu configuración un nuevo proveedor basado en LDAP (o Active Directory) solo habría que agregar en el param IPDS la siguiente configuración:

```IDPS=DATABASE:database,LDAP:myLDAP

Donde myLDAP corresponde al nombre que le quieras dar al proveedor, y sobre él se tendrán que aplicar las siguientes configuraciones disponibles para el tipo de proveedor LDAP.

Configuración del LDAP

A continuación todas las configuraciones posibles para el proveedor del tipo LDAP. Tendrás que sustuir {IDP_NAME} por el nombre que le hayas dado a tu proveedor, por ejemplo "myLDAP".

{IDP_NAME}.idp.url

  • Obligatorio: sí
  • Ejemplo: ldap://locahost:389
  • Disponible desde la versión 3.5.90

{IDP_NAME}.idp.domain

  • Obligatorio: sí
  • Ejemplo: ldap.idp.domain=MYDOMAIN
  • Disponible desde la versión 3.5.90

{IDP_NAME}.idp.user_query

Aquí podrás definir la QUERY para buscar los usuarios por código en base a la estructura de tu LDAP.

  • Obligatorio: sí
  • Ejemplo: ldap.idp.user_query=(&(objectClass=person)(sAMAccountName=<USER>))
  • Disponible desde la versión 3.5.90

{IDP_NAME}.idp.baseDN

Aquí podrás definir el BaseDN de tu LDAP, desde donde partirán las búsquedas de usuarios.

  • Obligatorio: sí
  • Ejemplo: ldap.idp.baseDN=DC=MAYCOMPANY,DC=local
  • Disponible desde la versión 3.5.90

{IDP_NAME}.idp.autoregister

Se usa para activar o desactivar el auto-registro de usuarios.

  • Obligatorio: no
  • Valores: true o false
  • Valor por defecto: false
  • Disponible desde la versión 3.5.90

{IDP_NAME}.idp.defaultGroups

Lista de grupos separados por coma ',' con los que se crearán los usuarios del LDAP en Viafirma Documents siempre y cuando no venga informado el grupo en uno de los atributos del LDAP. Requiere el uso del parámetro {IDP_NAME}.idp.groupAttributeName explicado más abajo.

  • Obligatorio = no
  • Ejemplo: ldap.idp.defaultGroups=grupo1,grupo2
  • Disponible desde la versión 3.5.90

{IDP_NAME}.idp.groupAttributeName

Nombre del atributo del LDAP que se utilizará para informar el grupo que le corresponderá al usuario en Viafirma Documents. Si no viene informado se utilizará el valor informado en el parámetro {IDP_NAME}.idp.defaultGroups.

  • Obligatorio = no
  • Ejemplo: ldap.idp.groupAttributeName=groupMembershipSAM
  • Disponible desde la versión 3.5.90

{IDP_NAME}.idp.defaultRoles

Aquí se debe informar el ROL que se le asignará automáticamente al usuario encontrado en el LDAP. Para asignarle más de un rol se podrán indicar separados por coma (,).

  • Obligatorio = no
  • Ejemplo: ldap.idp.defaultRoles=USER
  • Disponible desde la versión 3.5.90

Los roles disponibles en Viafirma Documents son:

  • ADMIN
  • DEVELOPER
  • DISPATCHER (administrador de grupos)
  • MANAGER
  • USER

En caso de querer automatizar el rol asignado en función de algún atributo que tengas informado en tu LDAP, podrás comentar este atributo defaultRoles y en su lugar el atributo roleAttributeName que te explicamos a continuación:

{IDP_NAME}.idp.roleAttributeName

Nombre del atributo del LDAP que se utilizará para informar el rol que le corresponderá al usuario en Viafirma Documents. Si no viene informado se utilizará el valor informado en el parámetro {IDP_NAME}.idp.defaultRoles.

  • Obligatorio = no
  • Ejemplo: ldap.idp.roleAttributeName=userParameters
  • Disponible desde la versión 3.5.90

Mapeo de datos de usuario encontrados en tu LDAP

A continuación te enumeramos qué atributos vamos a buscar en tu LDAP para asignarlos automáticamente a la ficha del usuario en la gestión de Viafirma. Si no los encontramos podrás gestionarlos directamente en Viafirma.

LDAP Attribute Correspondencia Viafirma Descripción
sAMAccountName userCode Código de Usuario
mobile mobile Número de teléfono del usuario
givenName name Nombre del usuario
sn surname Apellidos del usuario
mail email Correo electrónico del usuario

Ejemplo configuración LDAP

A continuación un ejemplo para configurar tu LDAP en Viafirma Documents:

Definimos un nombre para el proveedor LDAP, por ejemplo LDAP:myCompany, y trendrás que agregarlo como un IDP más, tal y como te mostramos a continuación.

```

y para el proveedor definido agregamos la siguiente configuración:

ldapMycompany.idp.url=ldap://192.168.110.65:389 ldapMycompany.idp.domain=MYCOMPANY ldapMycompany.idp.baseDN=DC=MYCOMPNAY,DC=com ldapMycompany.idp.autoregister=true ldapMycompany.idp.groupAttributeName=Customer ldapMycompany.idp.defaultGroups=MYGROUP ldapMycompany.idp.defaultRoles=USER ldapMycompany.idp.user_query=(&(objectClass=person)(sAMAccountName=)) ```