pythonのldap3でactive directoryのユーザ情報を検索する方法

こんにちは。sinyです。

この記事では、pythonのldap3というライブラリーを使ってActive Directoryのユーザ情報を検索する方法をご紹介します。

LDAP3とは？

ldap3とは、2006年6月にリリースされた公式RFCに準拠した完全準拠のLDAP v3クライアントライブラリです。
Python 2およびPython 3と互換性があり、Pythonの標準ライブラリ経由でLDAPサーバにアクセスすることができます。

ある程度の規模の企業でシステム管理に関わっている方であれば、LDAPからユーザ情報を取得したいといった要件が発生することがあると思います。

そんな時は、このpythnoライブラリであるldap3を使うと簡単にActive Directory上のユーザ情報を検索して情報を収集することができます。

ldap3ライブラリーの利用方法

ldap3を利用してActive Directoryからユーザ情報を検索する方法は以下の通りです。

事前準備

まず最初に、以下のコマンドでldap3をインストールします。

pip install ldap3

LDAPサーバへ接続

続いて、DLAPサーバへ接続するサンプルコードです。

from ldap3 import Server, Connection, ALL, NTLM,SUBTREE
server = Server('LDAPサーバ名', get_info=ALL)
conn = Connection(server, user='ドメイン名\ユーザ名', password='パスワード', check_names=True, read_only=True, auto_bind=True)

LDAPサーバに接続できているかどうかは、以下のコマンドで確認できます。

conn.extend.standard.who_am_i()

LDAPサーバ上のユーザ情報検索

ldap3を使った検索の最もシンプルな方法としてsearchメソッドがあります。

例えば、LDAPからユーザID、氏名、部門情報を抽出するには以下のようなコマンドを発行すればOKです。

conn.search('dc=xx,dc=xx,dc=xx', '(objectclass=person)', attributes=['cn', 'displayName', 'description'],paged_size=100))

ページ検索による方法

一度に1000件以上のユーザ情報を取得したい場合は、searchメソッドではなく、ページ検索と呼ばれる方法を使います。

この方法であれば、1000件を超えるユーザ情報を一括で取得することができます。
また、ページ検索には以下の2つの方法があります。

ジェネレータを利用する方法

ジェネレータを利用した検索方法のサンプルコードです。

entry_list = conn.extend.standard.paged_search(search_base = 'dc=xx,dc=xxxxxxx,dc=xxxxxxx', 
                                               search_filter = '(objectClass=person)', 
                                               attributes = ['cn', 'displayName', 'description'], 
                                               paged_size = 100, 
                                               generator=True)

extend.standard.paged_searchというメソッドを使いページ検索を行います。
ポイントは、「 generator=True」で、ジェネレータを有効化する点です。

ジェネレータを使わずリスト形式で情報を取得する方法

ジェネレータを使わずリスト形式で情報を取得する方法のサンプルコードです。

entry_list = conn.extend.standard.paged_search(search_base = 'dc=xx,dc=xxxxxxx,dc=xxxxxxx', 
                                               search_filter = '(objectClass=person)', 
                                               attributes = ['cn', 'displayName', 'description'], 
                                               paged_size = 100, 
                                               generator=False)

リスト形式の方法もextend.standard.paged_searchというメソッドを使いますが、ジェネレータの場合と違うのは、「 generator=False」の部分だけです。

今回は、このリスト形式の結果についてもう少し見ていきます。

上記コードを実行すると、戻り値として辞書のリストが返ってきます。

ldap_info = []												
for num, item in enumerate(entry_list):												
    if num > 3:												
        if item['attributes']['displayName'] and item['attributes']['description']:												
            ldap_info.append([item['attributes']['cn'],item['attributes']['displayName'] ,item['attributes']['description'][0]])												

with open('ldap_user.csv', 'w',newline='',encoding='cp932',errors='ignore') as f:				
    writer = csv.writer(f)				
    writer.writerows(ldap_info)				

以上、pythonのldap3でactive directoryのユーザ情報を検索する方法のご紹介でした。

この記事が良かったと思う方はTwitterフォロー(shiny)とリツイート頂けると嬉しいです！