This CLI tool allows you to easily perform basic operations (changes) on your LDAP server. It's aimed to ease these kind of tasks, without having to, necessarily, deal with LDIF files. Moreover, it permits you to do some of these things, in bulk!.
More precisely, this program, allows you to:
- Modify LDAP attributes (replace, add and delete modes, are supported!).
- Delete LDAP entries.
- Add LDAP entries with their corresponding attributes, by importing them from a CSV file!.
- Query the LDAP attributes of a particular entry, based on its DN.
- Search for entries matching an LDAP filter.
- Perform the following LDAP operations in bulk: add entries, delete entries and modify LDAP attributes!.
This is what it needs, in order to work:
- Python 3 (>=3.7)
- python-ldap library (tested with v3.3.1).
I don't take any responsibility on the consequences of the usage of this program!. Use it at your own risk!!.
It's advisable to always have a working backup of your LDAP database, prior to ANY modification!.
The recommended way to install this program, is by using pip:
pip install tiny-ldap-manager
To start with, here's the help output:
usage: tiny-ldap-manager [-h] [-v]
SERVER BINDDN {ls,search,modify,delete,bulk} ...
Easily perform several LDAP operations
positional arguments:
SERVER URI formatted address of the LDAP server
BINDDN DN of the user to bind the LDAP server
{ls,search,modify,delete,bulk}
ls List LDAP attributes for specified DN
search Perform an LDAP search of DNs
modify Modify an LDAP attribute
delete Delete an LDAP entry
bulk Perform an LDAP operation in bulk
optional arguments:
-h, --help show this help message and exit
-v, --version Show current version
The basic syntax you've to respect is the following:
tiny-ldap-manager [SERVER] [BINDDN] [ACTION] [ARGUMENTS]
In order of appearance:
[SERVER]belongs to the URI formatted address of your LDAP server.[BINDDN]is the DN ("Distinguished Name") of the LDAP user with permissions for the operation you wish to perform!.[ACTION]is the actual operation you want to perform. At present, there are five valid operations you can use:ls,search,modify,deleteorbulk. Make sure you only provide one of those!. Please, see below for more details.[ARGUMENTS]: when you perform an[ACTION], any of them requires, at least, one or more additional arguments. You can add the--helpargument to any of them, for specific details. Please, see below for more on this.
Please, note that positional arguments are mandatory!.
Take into account that, an authenticated session is always assumed. So you are gonna be asked for the corresponding credentials, each time you perform an operation!.
The ls action, allows you to quickly see the attributes of a particular LDAP
entry. For this, you have to provide the DN of the latter. For example:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" ls "uid=joe,ou=people,dc=somecorp,dc=com"
You can use the search action, to get a list of DNs that matches a provided
LDAP filter.
Make sure to respect the following syntax:
tiny-ldap-manager [SERVER] [USERDN] search [BASEDN] [LDAP_FILTER]
As shown above, besides the usual required arguments, the search action,
needs the [BASEDN] and [LDAP_FILTER] additional arguments!.
Here's an example:
tiny-ldap-manager ldaps://192.168.100.5 "cn=config" search "dc=somecorp,dc=com" "mail=*joe*"
Based on this example, it'll return every DN, whose mail attribute contains the string "joe" in it.
For modifying or adding an attribute to an LDAP entry, you logically use the
modify action. There are three types of modifications possible to use:
REPLACEis to be used whenever you want to modify the value of an existing attribute. This is the mode used by default!.ADDis for adding a non-existing attribute!.DELETEis, of course, for deleting an existing attribute!.
If you don't provide any additional arguments, the REPLACE mode is used by
default!. The complete syntax for it, is:
tiny-ldap-manager [SERVER] [USERDN] modify [DN] [ATTRIBUTE] [VALUE]
Where [DN] is the Distinguished Name (DN) of the LDAP object whose attribute
you wish to modify. The [ATTRIBUTE] is the name of the attribute to be modified,
and [VALUE] is the new value for that attribute!.
Let's see an example:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" modify "uid=joe,ou=people,dc=somecorp,dc=com" telephoneNumber "5555"
Above, we're modifying the existing telephoneNumber attribute with a new value
of5555.
Make sure that the new value for the attribute you're modifying, is NOT the same as its current value!. Otherwise, you'll get an error!.
In order to use a different mode for making a modification, you've to do it
using the -M argument, as follows:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" modify -M ADD "uid=willy,ou=people,dc=somecorp,dc=com" telephoneNumber "8006666"
With this latter example, we add the telephoneNumber attribute, with its
corresponding value.
It's important to note that this program is case-sensitive, so the modification mode always goes with capital letters!.
Finally, an example for using the DELETE mode, for removing an existing LDAP attribute:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" modify -M DELETE "uid=charles,ou=people,dc=somecorp,dc=com" telephoneNumber ""
Note that the double quotes at the end of the command, are necessary!.
You can simply remove an LDAP entry from your database, by indicating its DN, as is shown next:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" delete "uid=bob,ou=people,dc=somecorp,dc=com"
To perform an specific operation in bulk, use the bulk action followed by
the desired LDAP operation. Its syntax works as follows:
tiny-ldap-manager [SERVER] [BINDDN] bulk [OPERATION] [FILE]
As you can see from the syntax described above, each bulk operation requires
a [FILE] argument, which can consist either of a simple text file or a CSV
file, depending on each case. Please, see below for details.
The following bulk operations are supported:
--modify-attributes(modify LDAP attributes)--add-entries(add LDAP entries)--delete-entries(delete LDAP entries)
The way to add entries to an LDAP database with tiny-ldap-manager, is by
creating a CSV file using the header row (first row), to specify the attributes
for each new entry. You must ensure that you use a semi-colon (;) as the CSV
delimiter!.
Besides the CSV header row, the rest of them, are to be used to define the value of each corresponding attribute.
The order in which the LDAP attributes are specified in the CSV file, is not important, as long as there is a logical correlation between the value assigned to each attribute and the attribute itself!. Even then, for the sake of clarity, it's a good idea to always put the DN in the first place!.
Now, let's see an example of a CSV file content:
dn;objectClass;uid;cn;sn;givenName;displayName;mail
uid=cdarwin,ou=people,dc=scileague,dc=org;['inetOrgPerson','organizationalPerson'];cdarwin;cdarwin;Darwin;Charles;Charles Darwin;charlesdarwin@scileague.org
uid=alovelace,ou=people,dc=scileague,dc=org;inetOrgPerson;alovelace;alovelace;Lovelace;Ada;Ada Lovelace;adalovelace@scileague.org
uid=aeinstein,ou=people,dc=scileague,dc=org;inetOrgPerson;aeinstein;aeinstein;Einstein;Albert;Albert Einstein;alberteinstein@scileague.org
The following is how you would import such entries:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" bulk --add-entries scileague.csv
As you might noticed in the CSV, the entry that belongs to Charles Darwin, has
a formatted list of values for the objectClass attribute. That's a
supported way to include more than one value for a given attribute.
As a final note about importing new LDAP entries, if one or many of them, already exist in the LDAP database, you can be sure that they won't be imported, but equally important, is the fact that they won't interrupt the whole process neither. An output message is shown in each case.
The bulk removal of LDAP entries, works by specifying a plain text file as an argument, in which each line, contains a DN to be removed. Here's an example:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" bulk --delete-entries remove.txt
A simple example of the content of the text file:
uid=bob,ou=people,dc=somecorp,dc=com
uid=mike,ou=people,dc=somecorp,dc=com
Modifying LDAP attributes in bulk, works based on the premise that you want to either update the value of an existing LDAP attribute or create it right away, if it doesn't exist!. This is done by specifying a CSV file as an argument.
In each entry, the CSV file must contain the following data:
- The DN of the LDAP object to work with.
- The name of the attribute to create or modify, along with its desired value!.
Let's see an example of the CSV file content:
dn;telephoneNumber
uid=joe,ou=people,dc=somecorp,dc=com;1111
uid=robert,ou=people,dc=somecorp,dc=com;2222
uid=tom,ou=people,dc=somecorp,dc=com;3333
Now, here's an example of how to apply the changes, indicated by the CSV file above:
tiny-ldap-manager ldap://192.168.100.5 "cn=config" bulk --modify-attributes ldap_modify.csv
Some remarks to take into account, about the content of the CSV file:
- Remember to always use a semi-colon (
;) as the CSV delimiter!. - Use the header row (first row) for specifying both the DN and the attribute's name.
- The ONLY valid LDAP key name for the DN, is:
dn! (always use lower cases). Other names will be considered invalid!.
The following, is regarding the general behavior when modifying LDAP attributes in bulk:
- If a provided DN doesn't exist or is invalid, nothing will be done!.
- Note that if the DN does exist but the attribute doesn't, the latter and its provided value will be created!.
- In the case of an already existing attribute, whenever there isn't a match between its existing value and the one provided by the CSV file, the former will be updated!.
This software is distributed under the GPLv3 license.