sectionorder:
- Connect
- Collect
category: Authentication & Identity Management
provider: Open Source
commonfields:
  id: OpenLDAP
  version: -1
configuration:
- additionalinfo: The LDAP vendor to authenticate with.
  defaultvalue: Auto
  display: LDAP Server Vendor
  name: ldap_server_vendor
  options:
  - OpenLDAP
  - Active Directory
  - Auto
  required: true
  type: 15
  section: Connect
- display: Server IP or Host Name (e.g., 192.168.0.1)
  name: host
  required: true
  type: 0
  section: Connect
- display: Port. If not specified, default port is 389, or 636 for LDAPS.
  name: port
  type: 0
  section: Connect
  advanced: true
  required: false
- display: User DN (e.g., cn=admin,ou=users,dc=domain,dc=com)
  name: credentials
  required: true
  type: 9
  section: Connect
- display: Base DN (e.g., DC=domain,DC=com)
  name: base_dn
  required: true
  type: 0
  section: Connect
- defaultvalue: 'true'
  display: Auto populate groups
  name: fetch_groups
  type: 8
  section: Collect
  advanced: true
  required: false
- defaultvalue: posixGroup
  display: Groups Object Class
  name: group_filter_class
  type: 0
  additionalinfo: Relevant for OpenLDAP.
  section: Collect
  advanced: true
  required: false
- defaultvalue: gidNumber
  display: Groups Unique Identifier Attribute
  name: group_identifier_attribute
  type: 0
  additionalinfo: Relevant for OpenLDAP.
  section: Collect
  advanced: true
  required: false
- defaultvalue: memberUid
  display: Group Membership Identifier Attribute
  name: member_identifier_attribute
  type: 0
  additionalinfo: Relevant for OpenLDAP.
  section: Collect
  advanced: true
  required: false
- defaultvalue: posixAccount
  display: User Object Class
  name: user_filter_class
  type: 0
  additionalinfo: Relevant for OpenLDAP.
  section: Collect
  advanced: true
  required: false
- additionalinfo: User attributes will be added to the user filter in 'ad-authenticate-and-roles'. Attributes should be in the format "attrA=valA,attrB=valB,..." (Relevant for OpenLDAP).
  display: User Defined Attributes
  name: custom_attributes
  type: 0
  section: Collect
  advanced: true
  required: false
- defaultvalue: uid
  display: User Unique Identifier Attribute
  name: user_identifier_attribute
  type: 0
  additionalinfo: Relevant for OpenLDAP.
  section: Collect
  advanced: true
  required: false
- defaultvalue: '500'
  display: Page size
  name: page_size
  type: 0
  section: Collect
  required: false
- defaultvalue: None
  display: Connection Type
  name: connection_type
  options:
  - None
  - SSL
  - Start TLS
  required: true
  type: 15
  section: Connect
- additionalinfo: 'The SSL\TLS version to use in SSL or Start TLS connections types. Default is None. It is recommended to select the TLS_CLIENT option, which auto-negotiate the highest protocol version that both the client and server support, and configure the context client-side connections.'
  defaultvalue: None
  display: SSL Version
  name: ssl_version
  options:
  - None
  - TLS
  - TLSv1
  - TLSv1_1
  - TLSv1_2
  - TLS_CLIENT
  type: 15
  section: Connect
  advanced: true
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  section: Connect
  advanced: true
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8
  section: Connect
  advanced: true
  required: false
description: Authenticate using OpenLDAP or Active Directory.
display: LDAP Authentication
name: OpenLDAP
script:
  commands:
  - arguments:
    - description: The username for simple authentication.
      name: username
      required: true
    - description: The password for simple authentication.
      name: password
      required: true
      secret: true
    description: Performs a simple bind operation on the LDAP server.
    name: ad-authenticate
  - arguments:
    - description: A list of group object names to fetch. The list is delimited by a number sign (#).
      name: specific-groups
    description: Fetches LDAP groups under a given base DN.
    name: ad-groups
  - arguments:
    - description: The username for simple authentication.
      name: username
      required: true
    - description: The password for simple authentication.
      name: password
      required: true
      secret: true
    - defaultValue: mail
      description: Mail attribute to return in the response.
      name: attribute-mail
    - description: Name attribute to return in the response. Default is "name".
      name: attribute-name
    - defaultValue: mobile
      description: Phone attribute to return in the response.
      name: attribute-phone
    - auto: PREDEFINED
      defaultValue: 'true'
      description: 'Whether to return the name attribute.'
      name: attribute-name-pull
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      defaultValue: 'true'
      description: 'Whether to return the mail attribute.'
      name: attribute-mail-pull
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether to return the phone attribute.'
      name: attribute-phone-pull
      predefined:
      - 'true'
      - 'false'
    description: Performs a simple bind operation on the LDAP server and returns the authenticated user's groups.
    name: ad-authenticate-and-roles
  - arguments:
    - description: The location in the DIT where the search will start. Default is the provided Base DN in the configuration.
      name: search_base
      required: false
    - description: A string that describes what you are searching for. When provided with additional filter arguments, the OR join operator is used. If not provided, and no other filter arguments are present, all entries are returned. Search filters are based on assertions. One assertion is a bracketed expression that affirms something about an attribute and its values, as (givenName=John) or (maxRetries>=10). On the server, each assertion resolves to True, False, or Undefined (which is treated as False) for one or more entries in the DIT. Assertions can be grouped in boolean groups where all assertions (and group, specified with &) or at least one assertion (or group, specified with |) must be True. A single assertion can be negated (not group, specified with !). Each group must be bracketed, allowing for recursive filters. Operators allowed in an assertion are = (equal), <= (less than or equal), >= (greater than or equal), =* (present), ~= (approximate), and := (extensible). Surprisingly the less than and the greater than operators don’t exist in the LDAP filter syntax. The aproximate and the extensible operators are obscure and seldom used. In an equality filter you can use the * character as a wildcard.
      name: search_filter
      required: false
    - auto : PREDEFINED
      defaultValue: 'SUBTREE'
      description: Specifies how broad the search context. 'BASE'- retrieves attributes of the entry specified in the search_base. 'LEVEL'- retrieves attributes of the entries contained in the search_base. The base must reference a container object. 'SUBTREE' - retrieves attributes of the entries specified in the search_base and all subordinate containers downward.
      name: search_scope
      predefined:
      - 'BASE'
      - 'LEVEL'
      - 'SUBTREE'
    - auto : PREDEFINED
      defaultValue: 'all'
      description: A comma-separated list of attributes to return in the response. If attributes is 'none', no attributes will be returned except the dn. If attributes is 'all_user_attributes' or 'all_operational_attributes', all user attributes or all operational attributes are returned. If attributes is 'all', both user and operational attributes are returned.
      name: attributes
      predefined:
      - 'none'
      - 'all_user_attributes'
      - 'all_operational_attributes'
      - 'all'
    - description: A comma-separated list of CNs to filter the search by (AND operator is used to join them).
      name: cn
    - description:  A comma-separated list of UIDs to filter the search by (AND operator is used to join them).
      name: uid
    - description: A comma-separated list of objectClasses to filter the search by (AND operator is used to join them).
      name: object_class
    - description:  A comma-separated list of descriptions to filter the search by (AND operator is used to join them).
      name: description
    - name: page
      description: Page to return.
    - name: page_size
      description: Number of entries per page. Defaults to 50 (in case only page was provided). Maximum entries per page is 2000.
    - name: limit
      description: The maximum number of entries to return.
      defaultValue: 50
    description: A generic LDAP search command.
    name: ad-entries-search
  dockerimage: demisto/py3-tools:1.0.0.10895515
  runonce: false
  script: '-'
  subtype: python3
  type: python
tests:
- OpenLDAP - Test
- LDAP Authentication - Test
fromversion: 5.0.0