Commit c7f367aaad052240415da2de4f669c391500da42

Authored by Georg Hopp
1 parent 0867968d

update README.md

Showing 1 changed file with 93 additions and 3 deletions
1   -# ldapscan
  1 +# ldapscan
2 2
3   -# summary
  3 +This is some python code to scan and visualize an ldap tree structure.
4 4
5   -This is some python code to scan and visualize an ldap tree structure.
\ No newline at end of file
  5 +## Synopsis
  6 +
  7 + ldaptree.py ARGUMENT... [OPTION]...
  8 +
  9 + LdapService.py ARGUMENT... [OPTION]... bindip bindport
  10 +
  11 +## Description
  12 +
  13 +Create a tree representation of all DNs starting with a given base DN.
  14 +
  15 +There are two programs:
  16 +
  17 + * ``ldaptree.py`` : commandline tool
  18 + * ``LdapService.py`` : web service via internal web server
  19 +
  20 +### ldaptree.py
  21 +
  22 +Supports simple and kerberos binds via GSSAPI.
  23 +
  24 +If no password OPTION is given for simple binds the password will be asked
  25 +interactive.
  26 +
  27 +If no outfile the given the result will be written to stdout.
  28 +
  29 +#### ARGUMENTS
  30 +
  31 + * ``-H URI, --hosturi=URI`` : LDAP URI
  32 + * ``-D DN, --binddn=DN`` : The DN to use for the LDAP bind.
  33 + * ``-b DN, --basedn=DN`` : The DN to start the tree with.
  34 +
  35 +##### LDAP URI (``-H URI, --hosturi=URI``)
  36 +
  37 +The URI to the ldap server to query in the form:
  38 +
  39 + ldap[s]://host.uri[:port]
  40 +
  41 +#### OPTIONS
  42 +
  43 + * ``-h, --help`` : Online Help
  44 + * ``-p PASSWORD, --password=PASSWORD`` : The password for the LDAP bind.
  45 + * ``-o FILENAME, --outfile=FILENAME`` : File to write the result to.
  46 + * ``-k, --kerberos`` : Use gssapi auth.
  47 +
  48 +### LdapService.py
  49 +
  50 +Start a webserver on the given ``bindip`` and ``bindport``. On the page a tree
  51 +representation of all DNs starting with a given base DN is visualized.
  52 +
  53 +Only simple binds to the directory with DN and password are supported.
  54 +
  55 +#### ARGUMENTS
  56 +
  57 + * ``-H URI, --hosturi=URI`` : LDAP URI
  58 + * ``-D DN, --binddn=DN`` : The DN to use for the LDAP bind.
  59 + * ``-b DN, --basedn=DN`` : The DN to start the tree with.
  60 + * ``-p PASSWORD, --password=PASSWORD`` : The password for the LDAP bind.
  61 +
  62 +#### OPTIONS
  63 +
  64 + * ``-h, --help`` : Online Help
  65 +
  66 +## Requirements
  67 +
  68 +Access to a directory service, OpenLDAP and SAMBA-4 AD are tested.
  69 +
  70 +## Dependencies
  71 +
  72 +* python with ldap module
  73 +
  74 +## Contributing
  75 +
  76 +Just write me an email.
  77 +
  78 +## License
  79 +
  80 + This program is free software: you can redistribute it and/or modify
  81 + it under the terms of the GNU General Public License as published by
  82 + the Free Software Foundation, either version 3 of the License, or
  83 + (at your option) any later version.
  84 +
  85 + This program is distributed in the hope that it will be useful,
  86 + but WITHOUT ANY WARRANTY; without even the implied warranty of
  87 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  88 + GNU General Public License for more details.
  89 +
  90 + You should have received a copy of the GNU General Public License
  91 + along with this program. If not, see <http://www.gnu.org/licenses/>.
  92 +
  93 +## Author
  94 +
  95 +Georg Hopp <georg@steffers.org>
... ...
Please register or login to post a comment