The information on this page represents the experience of an NBIA user and is provided as a case study that you may find useful. It not meant to apply to all users.

Install OpenLDAP

1. Install OpenLDAP

   Install OpenLdap

   on Ubuntu.

   This is

   Note
   These instructions are based on

   ubuntu

   Ubuntu 18.04

   .

2. In

   To take care of the update/upgrade, open

   a terminal window

   and

   , issue the following commands:

   Code Block
   sudo apt-get update

   
   

   sudo apt-get upgrade

3. Once that finishes, you're ready to install OpenLDAP. For this, go back to the terminal window and issue the command:
   sudo apt install slapd ldap-utils

4. In a terminal window, then issue the following command.

   Code Block
   sudo apt install slapd ldap-utils

5. Modify

   After the installation completes, you may want to modify

   the default Directory Information Tree (DIT) suffix

   . Let's go ahead and do that. We'll change our DIT to dc=smab

   by changing the DIT to fit your company's network needs. For example,  dc=<org name>, dc=org.

   You can change yours to fit your company network needs.

   To do

   this

   so,

   run

   issue the following command

   :

   .

   Code Block
   sudo dpkg-reconfigure slapd

6. Enter the administrator's password.

7. Now we're going to add Add initial data to the LDAP database . We'll do this from a file and create a single entry. From your In a terminal window, issue the following command:.

   Code Block
   vi ldap_data.ldif

   The following information is returned.

   Code Block

   dn: ou=People,dc=smab<org name>,dc=org objectClass: organizationalUnit ou: People dn: ou=Groups,dc=smab<org name>,dc=org objectClass: organizationalUnit ou: Groups dn: cn=DEPARTMENT,ou=Groups,dc=smab<org name>,dc=org objectClass: posixGroup cn: SUBGROUP gidNumber: 5000 dn: uid=nciadevtest,ou=People,dc=smab<org name>,dc=org objectClass: inetOrgPerson objectClass: posixAccount objectClass: shadowAccount uid: nciadevtest sn: Last name givenName: First name cn: nciadevtest displayName: Name uidNumber: 10000 gidNumber: 5000 userPassword: password gecos: Whole Name loginShell: /bin/bash homeDirectory: USERDIRECTORY

   Note
   In this .ldif file, we created

   2 organizationalUnit . One is People, the other is

   two organizationalUnit values, People and Groups.

8. Also add Add the entities for these OU values. One entity is must be nciadevtest for the NBIA. The uid and cn must be this name. Because NBIA use uses cn to do as the default authentication be default. Some software applications use uid to do the authenticationauthenticate.

9. Add the following entities to the LDAP server

   :

   .
   

   Code Block
   ldapadd -x -D cn=admin,dc=smab,dc=org -W -f ldap_data.ldif

10. After adding these entities, we can use Use this command to search the exist recordexisting records. You can use the network loop IP address to test or use the real IP address.
    

    Code Block

    ldapsearch -x -LLL -h 127.0.0.1 -p 389 -D cn=admin,dc=smab<org name>,dc=org -w smab123456 <password>-b dc=smab<org name>,dc=org 'uid=nciadevtest' cn givenName gidNumber Result: dn: uid=nciadevtest,ou=People,dc=smab<org name>,dc=org givenName: XIAOHUIFirst Name cn: nciadevtest gidNumber: 5000 ldapsearch -x -LLL -h 69.71.4.10 -p 389 -D cn=admin,dc=smab<org name>,dc=org -w smab123456<password> -b dc=smab<org name>,dc=org 'cn=nciadevtest' uid givenName gidNumber Result: dn: uid=nciadevtest,ou=People,dc=smab<org name>,dc=org uid: nciadevtest givenName: XIAOHUIFirst Name gidNumber: 5000

11. Final configuration. After we install the openldap and add Add the records. We got the The LDAP server configuration belowlooks similar to the following.

    Code Block
    Title Value Base DN smab<org name>,dc=org Bind Admin admin,dc=smab<org name>,dc=org Bind Password Smab123456<password> User name for NBIA nciadevtest

...

Configuring the LDAP Administrator Client

You can add, modify, or remove records to or from the LDAP server in several ways.

• On a Linux server, use phpldapadmin to maintain the LDAP server. Refer to the following links to install phpldapadmin. (Note that phpldapadmin is not updated. There are some errors with php7.0 +).
  • https://www.techrepublic.com/article/how-to-install-phpldapadmin-on-ubuntu-18-04/
  • https://www.techrepublic.com/article/how-to-install-and-configure-ldap-and-phpldapadmin/

...

• Use a Windows LDAP client such as Softerra LDAP Administrator to access the remote LDAP server.

...

To How to use Softerra LDAP Administrator

1. Create a new profile.
2. Add the server host (IP or domain), Base DN, and port.
3. Add the bind admin information.

You can use the LDAP client to create/, delete/, and modify the entities with this information. Otherwise, you only have the read permission.

Troubleshooting

...

Note

...

OpenLdap can be installed on an Ubuntu Server. The phpldapadmin can also

...

work.

...

Use ldapsearch

...

to search the user information.

...

You may find that when you try to use the LDAP client to access this LDAP server

...

, the connection times out with no response from the LDAP server even if

...

all ports

...

are enabled. The user did not find any solution for this issue.

When installing

...

OpenLDAP on Ubuntu (Desktop version)

...

, all LDAP functions worked without any issues.

...

Any LDAP client

...

can access the remote LDAP server

...

.

NBIA LDAP

...

Settings

...

1. In nbia.properties (Tomcat7.0/lib/nbia.properties), ldap.user and ldap.pass must be the administrator information of LDAP server. Modify nbia.properties as follows.

   Code Block
   authentication.type=ldap-auth

...

1. ldap.url=ldap://

...

1. <ip address><port number> ldap.basedn=dc=

...

1. <org name>,dc=org

...

1. ldap.user=CN=admin,dc=

...

1. <org name>,dc=org

...

1. ldap.pass=

...

1. <password> ldap.memberOf.attribute.name=isMemberOf

...

1. ldap.mail.attribute.name=mail

...

1. ldap.group.ignore.list=PwmAdmins,devTeam,nlst,testGroup

...

1. public.collection.access.group.name=General User

...

1. product.variation=NBIA

...

2. Modify jaas.conf (Tomcat7.0/conf/jaas.conf) as follows:
   

   Code Block
   NCIA

...

1. {

...

1. gov.nih.nci.security.authentication.loginmodules.LDAPLoginModule Required

...

1. ldapHost="ldap://

...

1. <ip address><port number>" ldapSearchableBase="dc=

...

1. <org name>,dc=org"

...

1. ldapUserIdLabel="cn"

...

1. ldapAdminUserName="CN=admin,dc=

...

1. <org name>,dc=org"

...

1. ldapAdminPassword=

...

1. <password>;

...

1. };

...

1. 
   The jaas.conf is generated during

...

1. NBIA installation. The default ldapUserIdLabel is

...

1. cn, which means the LDAP server will search

...

1. the cn value, then compare it to the login username. If the user name

...

1. exists in the LDAP server, the LDAP server will

...

1. authenticate this user.
   
   Some LDAP

...

1. servers may use

...

1. another field to store the login username

...

1. , such as uid. In this case, change the username value to uid. For example, ldapUserIdLabel="cn"

...

1. Restart Tomcat for the change to take effect.