Skip to content

LDAP with Service Credentials (double-bind)#

RStudio Connect can integrate with your company's LDAP infrastructure using the LDAP authentication provider.

Using this integration, user authentication, group search, and user search requests will be directed to your LDAP service.

RStudio Connect requires service credentials to execute user and group searches in LDAP.

Note

If you are not able to obtain service credentials, you can still use LDAP solely for authentication purposes with your own user credentials by configuring RStudio Connect to use LDAP without Service Credentials

LDAP Example With Service credentials#

This sample configuration (partial) assumes the standard schema for LDAP.

Note

The Advanced LDAP / AD and LDAP configuration appendixes contain more detailed information about each LDAP configuration option.

; /etc/rstudio-connect/rstudio-connect.gcfg

[Authentication]
Provider = ldap

[LDAP "Sample LDAP Configuration With Service Credentials"]

; Connectivity

; For legacy SSL (ldaps) use these:
ServerAddress = ldaps.company.com:636
TLS = true
; Or for TLS (StartTLS extension) use these:
; ServerAddress = ldap.company.com:389
; StartTLS = true

TLSCACertificate= /etc/ssl/cert/ca.pem
; For TLS/SSL testing purposes only:
; ServerTLSInsecure = true

; Service credentials (recommended):
BindDN = "uid=admin,OU=users,DC=example,DC=com"
BindPassword = "XXXXXXXX"
; Or anonymous bind (less secure):
; AnonymousBind = true

; Users (OpenLDAP example)
UserSearchBaseDN = "OU=Users,DC=example,DC=com"
UserObjectClass = "posixAccount"
; UniqueIdAttribute - vendor-specific object attribute
; Please refer to your LDAP vendor documentation for the correct value.
; (OpenLDAP) UniqueIdAttribute = "entryUUID"
; (Oracle OID) UniqueIdAttribute = "orclGuid"
; (IBM RACF) UniqueIdAttribute = "ibm-entryUUID"
; (Novell eDirectory) UniqueIdAttribute = "GUID"
; (389 Directory Server) UniqueIdAttribute = "nsUniqueID"
UniqueIdAttribute = "entryUUID"
UsernameAttribute = "uid"
UserEmailAttribute = "mail"
UserFirstNameAttribute = "givenName"
UserLastNameAttribute = "sn"

; Groups (OpenLDAP example)
GroupSearchBaseDN = "OU=Users,DC=example,DC=com"
GroupObjectClass = "posixGroup"
; GroupUniqueIdAttribute - vendor-specific object attribute, same as the user one
GroupUniqueIdAttribute = "entryUUID"
GroupNameAttribute = "cn"
; Enable this for a better user experience, unless
; managing a large number of groups is a concern:
;GroupsAutoProvision = true

; When attempting to troubleshoot a problem relating to LDAP, 
; you can enable more verbose logging by enabling the following line
;Logging = true

User Provisioning#

LDAP users are created in RStudio Connect upon the first successful login attempt. In addition, users can also be created ahead of their first login by adding them as users within the "people" tab of the RStudio Connect dashboard or by using the Connect Server API.

LDAP.RegisterOnFirstLogin can be used to disable the registration through login behavior.

; /etc/rstudio-connect/rstudio-connect.gcfg
[LDAP "corporate LDAP"]
RegisterOnFirstLogin = false

RStudio Connect will collect the user's credentials and forward them to the LDAP server which will validate the authentication. If valid, the remote user's information will be returned to the RStudio Connect server.

Users within RStudio Connect are assigned Roles. Users are assigned the role specified by the Authorization.DefaultUserRole setting or one defined by the User Role Mapping if configured. Additionally, an administrator can reassign the role from within the dashboard or via the User Manager CLI.

Usernames#

Usernames are controlled by your LDAP server. However, RStudio Connect imposes some additional restrictions on the usernames it supports:

  • A username or DN containing a forward slash (/) is not supported.
  • The following values are prohibited: connect, apps, users, groups, setpassword, user-completion, confirm, recent, reports, plots, unpublished, settings, metrics, tokens, help, login, welcome, register, resetpassword, content

Duplicate Usernames#

Usernames in LDAP do not need to be unique. A user is uniquely identified by the attribute defined in LDAP.UniqueIdAttribute. (Users with the same username are differentiated via their personal passwords.)

Duplicate usernames are a reality of large LDAP deployments with multiple servers, which implies multiple LDAP server configurations in RStudio Connect.

Note

The RStudio Studio IDE does not support duplicate usernames when publishing to the same RStudio Connect host. However, it is unlikely that two users with the same usernames will be sharing the same IDE account or workstation.

Tip

Duplicate users may have adverse affects on content that tracks the user credentials. Please refer to the Credentials for Content in the Advanced Users and Group Topics appendix for alternatives under this condition.

User Attributes#

The following user information is required:

  • First name.
  • Last name.
  • Email address.
  • Username.

Different LDAP attributes may be used for each of these fields, but in general, all user attributes are provided by LDAP, and they should all be present in the RStudio Connect configuration.

Tip

If your LDAP server cannot provide some of these, be sure to not define the respective attributes in the RStudio Connect configuration, so that the profile information can be entered manually by users. Otherwise, the profile values will not be editable in RStudio Connect and will remain blank.

When changes are made to a user's name, email address, or username in your LDAP system, these changes will automatically propagate to RStudio Connect:

  • The next time that the user logs into RStudio Connect.

  • When the user is returned in a search result while adding new users.

  • As RStudio Connect synchronizes LDAP group memberships.

Editing User Attributes#

A username is the primary means of authentication. Therefore, it is required in the configuration, and never editable.

By default, the setting Authorization.UserInfoEditableBy has a value of AdminAndSelf, permitting users and administrators to manage these editable user profile information not configured to be managed by LDAP.

Configure Authorization.UserInfoEditableBy with Admin if profile editing should be restricted only to administrators.

Tip

It is recommended that if you disable LDAP.RegisterOnFirstLogin with a value of false, that you also configure Authorization.UserInfoEditableBy to Admin. A value of Admin means that users created by the administrator, cannot be changed by non-administrators.

Editing User Roles#

User roles are only editable in RStudio Connect if Automatic User Role Mapping is not configured, and the LDAP authentication provider is not configured to send roles in as part of the user profile.

Automatic User Role Mapping#

RStudio Connect offers ways to map their user information to valid roles when users login. This can be done with roles defined as part of the user profile or via LDAP group memberships.

Using Group Memberships#

Important

This option is not supported when using Locally Managed Groups.

Use the configuration option Authorization.UserRoleGroupMapping to enable user role mapping via groups.

Note

When group mapping is enabled, configuration options to receive roles from the authentication provider as part of the user profile information will be ignored and RStudio Connect will fail to start if Authorization.UserRoleMapping is also enabled.

When enabled, the configuration options Authorization.ViewerRoleMapping, Authorization.PublisherRoleMapping, and Authorization.AdministratorRoleMapping will refer to groups.

In the following example group names are used. Viewer mapping is purposely left out so that the remaining of the users will be assigned the based on the option Authorization.DefaultUserRole which defaults to viewer.

; /etc/rstudio-connect/rstudio-connect.gcfg
[Authorization]
UserRoleGroupMapping = true
PublisherRoleMapping = "cn=Developers,ou=Groups,dc=example,dc=com"
AdministratorRoleMapping = "cn=Dev-Leaders,ou=Groups,dc=example,dc=com"
AdministratorRoleMapping = "cn=IT-Administrators,ou=Groups,dc=example,dc=com"

Using User Profile Roles#

Use the configuration option Authorization.UserRoleMapping to enable user role mapping via a user profile attribute.

The LDAP.UserRoleAttribute configuration option should also be defined to receive role information as part of the user profile.

Note

User roles can be used directly from your authentication provider without the need of mapping values as long as it only returns the values of viewer, publisher and administrator to define roles in RStudio Connect.

When mapping is enabled, each role can be mapped to one or more values specific to your organization using the configuration options Authorization.ViewerRoleMapping, Authorization.PublisherRoleMapping, and Authorization.AdministratorRoleMapping.

In the following example the authentication provider returns department names:

; /etc/rstudio-connect/rstudio-connect.gcfg
[Authorization]
UserRoleMapping = true
ViewerRoleMapping = "HR"
ViewerRoleMapping = "Marketing"
PublisherRoleMapping = "Engineering"
AdministratorRoleMapping = "IT"

Multiple User Role Mappings#

When there are multiple matches between the configured mapping and the user or group information sent by the authentication provider, the role with the most privileges is selected. This behavior makes it easy to promote users to a new role.

Note

If there are concerns about security, a more restrictive behavior can be used in these scenarios with the configuration option Authorization.UserRoleMappingRestrictive. When enabled, it will cause the least privileged role to be selected.

LDAP Groups#

RStudio Connect automatically associates users to the groups already present in RStudio Connect for access control purposes as indicated by the existing group memberships in LDAP.

RStudio Connect needs to be configured to automatically recognize LDAP groups. If the settings for groups are omitted from the configuration, only Locally Managed Groups will be available.

Important

LDAP groups must be managed directly through your LDAP provider. RStudio Connect does not support management of LDAP groups.

A reference to a LDAP group is stored in RStudio Connect when manually added via "people" in the dashboard, via Connect Server API or automatically on log-in with the auto-provision option enabled.

Changes made to group names and Distinguished Named will automatically propagate to RStudio Connect:

  • The next time that a member of the groups logs into RStudio Connect.

  • When the group is returned in a search result while adding new groups.

  • As RStudio Connect synchronizes LDAP group memberships.

LDAP groups are uniquely identified by the attribute defined in LDAP.GroupUniqueIdAttribute (with the default of "DN"). For information on how to configure this setting for your specific LDAP server, see GroupUniqueIdAttribute.

Manual Group Provisioning#

Admins may use the "People" tab within the RStudio Connect dashboard to "add" references to groups from the proxy. Group membership of RStudio Connect users will be tracked for only these groups and not the entire list of groups that are returned from LDAP.

Tip

This is the default behavior, and a good option when the RStudio Connect users are associated with a large number of groups, but only some of them are useful for content access control purposes.

Warning

Care should be taken when removing groups via "people" in the dashboard or via Connect Server API. Removing a group will also remove all associations between the group being removed and existing content.

Automatic Group Provisioning#

In addition to delegating group membership management to LDAP, RStudio Connect can also delegate the management of groups themselves. By using LDAP.GroupsAutoProvision

RStudio Connect will automatically add references to groups based on the list of group memberships received from LDAP during authentication.

With this option enabled groups are provisioned in RStudio Connect when the first member is added and remain there indefinitely, even after the last member has been removed, so that any access to content is preserved for a future member of those groups.

Tip

Removing stale or unused groups can be done via the dashboard, via the RStudio Connect Server API, or ultimately via the usermanager CLI.

LDAP Group Membership Synchronization#

RStudio Connect prefetches all group memberships during every authentication. After that, the group memberships for LDAP users in RStudio Connect are updated in a regular interval to ensure that content access granted via groups is synchronized with LDAP.

By default, RStudio Connect will update each user individually every 4 hours, obtaining all their group memberships in the same way it is done during authentication. This interval can be modified via the configuration setting LDAP.MembershipUpdateInterval.

Important

In previous releases of RStudio Connect, access controls would validate group memberships directly with the LDAP server at access time. This approach prevented RStudio Connect from having a complete picture of the group memberships for a given user, what some situation resulted in reduced functionality when using LDAP authentication compared to other authentication providers.

Note

If you are running an earlier release of RStudio Connect, an automatic synchronization for all users will take place immediately after an upgrade. RStudio Connect uses a best-effort approach to have all users updated within the configured LDAP.MembershipUpdateInterval, but without disrupting the regular usage of the service. This process happens only once per installation and will not be needed in future version upgrades.

Please see the Performance Considerations in the Advanced LDAP / AD appendix for ways to optimize LDAP search performance in RStudio Connect if you observe a noticeable impact on the service such as:

  • Unusual delays during user log in.

  • Modifications made to groups in LDAP not being reflected in Connect after the interval configured in LDAP.MembershipUpdateInterval is passed.

  • Issues with content with scheduled email delivery that include member of LDAP groups.

  • Excess of activity or usage on the LDAP service.

  • Warnings about the membership update process in the logs.

Tip

The shorter the membership update interval is, the greater is the computational cost of running the synchronization. On the other hand, large or busy environments may need a longer update interval to be able to keep group memberships in sync consistently. The default interval value of 4 hours aims to offer a good balance between cost and user experience for most customers.

Use LDAP Groups To Limit Access to RStudio Connect#

By using LDAP groups it is also possible to restrict which users are allowed in RStudio Connect based on their group memberships, see the setting LDAP.PermittedLoginGroup for more details.

Scheduled Email Delivery & LDAP Group Memberships#

When using LDAP groups associated to content, the recipients of content configured for scheduled email delivery will include all active and unlocked RStudio Connect users members of that group as well as all other LDAP users members of the group with valid email addresses.

This functionality does not require or depend on the membership synchronization.

Locally Managed Groups#

You can still use groups in RStudio Connect if you decide to not configure support for LDAP groups.

Important

Locally managed groups have no relation with LDAP groups.

These groups are local to RStudio Connect, they can be created via the Dashboard or via the Connect Server API. Group memberships must also be managed using the same means.

Tip

If you do not want groups at all in RStudio Connect, set the Authorization.UserGroups configuration option to false.