Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 106 Next »

Icon

This is the documentation for plugin version 1.1 and greater. Documentation for version prior to 1.1 is located on separate page. Instructions for migration can be found here.

Compatibility Matrix

 

Apache DS

OpenLDAP

OpenDS

Active Directory

Anonymous

(tick)

(tick)

(tick)

 

Simple

(tick)

(tick)

(tick)

(tick)

LDAPS

(tick)

(tick)

 

(tick)

DIGEST-MD5

(tick)

 

(tick)

(tick)

CRAM-MD5

(tick)

 

(tick)

(tick)

GSSAPI

(tick)

 

 

 

(tick) - means that it has been successfully tested

Description

This plugin enables the delegation of SonarQube authentication and authorization to an external system. The plugin currently supports LDAP and Microsoft Active Directory.

The main features of the plugin are:

  • Password checking against the external authentication engine
  • Automatic synchronization of usernames and emails
  • Automatic synchronization of relationships between users and groups (authorization)
  • Ability to authenticate against both the external or internal authentication systems (technical SonarQube user accounts have no need for instance to be defined in LDAP)

During the first authentication trial, if the password is correct, the SonarQube database is automatically populated with the new user. Each time a user logs into SonarQube, the username, the email and the groups this user belongs to are automatically refreshed in the SonarQube database.

About the delegation of authorization, there is only one pre-requisite: the relationships between users and groups are only synchronized with groups which are already defined in SonarQube. So groups and related permissions must be first defined in SonarQube.

Installation

  1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQube server

Usage

  1. Configure the LDAP plugin by editing the SONARQUBE_HOME/conf/sonar.properties file (see below)

  2. Restart the SonarQube server and check the log file for:

    INFO org.sonar.INFO Security realm: LDAP
    ...

    INFO o.s.p.l.LdapContextFactory Test LDAP connection: OK

  3. Log into SonarQube

General Configuration

PropertyDescriptionDefault valueMandatoryExample
sonar.security.realm

This property must be defined to ask the SonarQube server to use first the LDAP plugin when trying to authenticate a user.

 

Yes

LDAP (no other value can be used)
sonar.security.savePasswordThis optional property can be used to ask SonarQube to save the user password in the SonarQube DB. When this property is activated, a user can log into SonarQube even when the LDAP server is not available.falseNo 
sonar.authenticator.createUsersBy default, the SonarQube DB is automatically populated when a new SonarQube user logs into SonarQube. Setting this value to false, make it mandatory for a System administrator to first declare a user in the SonarQube DB before allowing this user to log into SonarQube.trueNo 
sonar.authenticator.updateUserAttributesIf set to 'true', at each login, user's attributes (name, email, etc.) are re-synchronized. If set to 'false', user's attributes are not re-synchronized except when creating the user for the first time (sonar.authenticator.createUsers=true).
Available since SonarQube 3.6.
trueNo 
ldap.urlURL of the LDAP server. Note that if you are using ldaps, then you should install server certificate into java truststore. Yes (Not mandatory in case of Auto-discovery)ldap://localhost:10389
ldap.bindDnBind DN is the username of an LDAP user to connect (or bind) with. Leave blank for anonymous access to the LDAP directory. Nocn=sonar,ou=users,o=mycompany
ldap.bindPasswordBind Password is the password of the user to connect with. Leave blank for anonymous access to the LDAP directory. Nosecret
ldap.authenticationPossible values: 'simple', 'CRAM-MD5', 'DIGEST-MD5', 'GSSAPI'. See  http://java.sun.com/products/jndi/tutorial/ldap/security/auth.htmlsimpleNosee description
ldap.realm Noexample.org
ldap.contextFactoryClass(advanced option) Context factory class.com.sun.jndi.ldap.LdapCtxFactoryNo 

User Mapping

PropertyDescriptionDefault valueMandatoryExample for Active Directory Server
ldap.user.baseDnDistinguished Name (DN) of the root node in LDAP from which to search for users. Yes (Not mandatory in case of Auto-discovery)cn=users,dc=example,dc=org
ldap.user.request(available since plugin version 1.2)
(&(objectClass=inetOrgPerson)(uid={login}))
No
(&(objectClass=user)(sAMAccountName={login}))
ldap.user.objectClassDeprecated in plugin version 1.2 and replaced by 'ldap.user.request'. Object class of LDAP users.inetOrgPersonNouser
ldap.user.loginAttributeDeprecated in plugin version 1.2 and replaced by 'ldap.user.request'. Attribute in LDAP holding the user’s login.uidNosAMAccountName
ldap.user.realNameAttributeAttribute in LDAP holding the user’s real name.cnNo 
ldap.user.emailAttributeAttribute in LDAP holding the user’s email.mailNo 

Group Mapping

The following properties should be defined to allow SonarQube to automatically synchronized the relationships between users and groups.

There are two limitations:

  • Groups must be static and not dynamic
  • The user entry must contain the attribute 'memberOf' with list of groups
PropertyDescriptionDefault valueMandatoryExample for Active Directory Server
ldap.group.baseDnDistinguished Name (DN) of the root node in LDAP from which to search for groups. 

Yes in version 1.1.1

No in version 1.2, if you want to disable synchronization of groups.

cn=groups,dc=example,dc=org
ldap.group.request(available since plugin version 1.2)
(&(objectClass=groupOfUniqueNames)(uniqueMember={dn}))
No
(&(objectClass=group)(member={dn}))
ldap.group.objectClassDeprecated in plugin version 1.2 and replaced by 'ldap.group.request'. Object class of LDAP groups.groupOfUniqueNamesNogroup
ldap.group.idAttributeAttribute in LDAP holding the group's id.cnNo 
ldap.group.memberAttributeDeprecated in plugin version 1.2 and replaced by 'ldap.group.request'. Attribute in LDAP holding the group's member.uniqueMemberNomember

Example of LDAP Configuration

Advanced Configuration

Auto-discovery

Here is description of how auto-discovery works:

  1. Determine DNS Domain Name:
    • from "ldap.realm" property if set
    • from FQDN of machine, where SonarQube is installed (eg. if FQDN is "sonar.example.org", then DNS Domain Name will be "example.org")
  2. Determine URL of LDAP server:
    • from "ldap.url" property if set
    • from DNS server ( see known limitations ), here is example of SRV Record for domain "example.org":

      _ldap._tcp.example.org. 72784   IN      SRV     0 5 389 ldap.example.org.

      for this domain URL of LDAP server will be "ldap://ldap.example.org:389"

  3. Determining BaseDN:
    • from "ldap.baseDn" property if set
    • from DNS Domain Name (eg. if DNS Domain Name is "example.org", then BaseDN will be "dc=example,dc=org")

Authentication Methods

  • Simple
    Simple authentication is not recommended for production deployments not using the secure ldaps protocol as it sends a cleartext password over the network.
  • Anonymous
    Used when only needs read-only access to non-protected entries and attributes when binding to the LDAP server.
  • CRAM-MD5
    The Challenge-Response Authentication Method (CRAM) based on the HMAC-MD5 MAC algorithm (RFC 2195).
  • DIGEST-MD5
    This is an improvement on the CRAM-MD5 authentication method (RFC 2831).
  • GSSAPI
    GSS-API is Generic Security Service API (RFC 2744). One of the most popular security services available for GSS-API is the Kerberos v5, used in Microsoft's Windows 2000 platform.

For a full discussion of LDAP authentication approaches, see RFC 2829 and RFC 2251.

Known Limitations

Auto-discovery takes into account only one SRV record.

Troubleshooting

You can enable debug logging by adding the following to conf/logback.xml:

conf/logback.xml

Migration from plugin version 1.0 to version 1.1.1

Perform the following replacements:

 Replaced by
sonar.authenticator.class: org.sonar.plugins.ldap.LdapAuthenticatorsonar.security.realm: LDAP
ldap.baseDnldap.user.baseDn
ldap.userObjectClassldap.user.objectClass
ldap.loginAttributeldap.user.loginAttribute

Configure Group Mapping: at least by specifing new mandatory property - "ldap.group.baseDn".

Change Log

Loading

Release 1.2.1 (1 issues)

 

Loading

Release 1.2 (4 issues)

 

Loading

Release 1.1.1 (1 issues)

 

Loading

Release 1.1 (2 issues)

 

Loading

Release 1.0 (1 issues)

 

Loading

Release 0.1 (8 issues)

  • No labels