Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use LDAP API #254

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Use LDAP API #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a701514
Use LDAP API
gbonnefille Feb 26, 2020
bff1cc5
Fix typo
gbonnefille Feb 26, 2020
cfdae76
Fix indentation reported by linter
gbonnefille Aug 10, 2020
4231049
Fix spaces reported by linter
gbonnefille Aug 10, 2020
b6c97be
Add default for REST API endpoint
gbonnefille Aug 10, 2020
60597ef
Default groupType to none
gbonnefille Aug 10, 2020
4f55615
Tests expect default groupType value to 'static'
gbonnefille Aug 10, 2020
1458e4c
Only set expected arguments
gbonnefille Aug 10, 2020
e9b4045
Split long lines as requested by linter
gbonnefille Aug 10, 2020
9c057e6
Deal when ldap_map_groups_as_roles_type is absent
gbonnefille Aug 10, 2020
e2d57cd
Merge branch 'main' into use-ldap-api
zeitounator Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions defaults/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ nexus_api_validate_certs: "{{ nexus_api_scheme == 'https' }}"
nexus_api_context_path: "{{ nexus_default_context_path }}"
nexus_api_port: "{{ nexus_default_port }}"
nexus_api_timeout: 60
nexus_rest_api_endpoint_base: "service/rest"

# security realms
nexus_nuget_api_key_realm: false
Expand Down
133 changes: 133 additions & 0 deletions tasks/setup_ldap_each.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,136 @@
group_member_format: "{{ item.ldap_group_member_format | default('uid=${username},ou=users,dc=yourcompany') }}"
user_subtree: "{{ item.ldap_user_subtree | default(false) }}"
group_subtree: "{{ item.ldap_group_subtree | default(false) }}"
when: nexus_version is version_compare('3.19.0', '<')

- when: nexus_version is version_compare('3.19.0', '>=')
block:

- name: Check existence LDAP connections
uri:
url: "{{ nexus_api_scheme }}://{{ nexus_api_hostname }}:{{ nexus_api_port }}\
{{ nexus_api_context_path }}{{ nexus_rest_api_endpoint_base }}/beta/security/ldap/{{ item.ldap_name | urlencode }}"
user: 'admin'
password: "{{ current_nexus_admin_password }}"
method: GET
force_basic_auth: yes
validate_certs: "{{ nexus_api_validate_certs }}"
status_code: 200,404
return_content: yes
register: nexus_ldap_retrieved
check_mode: no

- name: Creating LDAP connections
uri:
url: "{{ nexus_api_scheme }}://{{ nexus_api_hostname }}:{{ nexus_api_port }}\
{{ nexus_api_context_path }}{{ nexus_rest_api_endpoint_base }}/beta/security/ldap"
user: 'admin'
password: "{{ current_nexus_admin_password }}"
headers:
Content-Type: "application/json"
method: POST
force_basic_auth: yes
validate_certs: "{{ nexus_api_validate_certs }}"
body: "{{ args | to_json }}"
status_code: 200,201,204
vars:
args:
name: "{{ item.ldap_name }}"
protocol: "{{ item.ldap_protocol }}"
host: "{{ item.ldap_hostname }}"
port: "{{ item.ldap_port }}"
authScheme: "{{ item.ldap_auth | default('NONE') }}"
authUsername: "{{ item.ldap_auth_username | default('') }}"
authPassword: "{{ item.ldap_auth_password | default('') }}"
searchBase: "{{ item.ldap_search_base }}"
userBaseDn: "{{ item.ldap_user_base_dn | default('ou=users') }}"
userLdapFilter: "{{ item.ldap_user_filter | default('') }}"
userObjectClass: "{{ item.ldap_user_object_class }}"
userIdAttribute: "{{ item.ldap_user_id_attribute }}"
userRealNameAttribute: "{{ item.ldap_user_real_name_attribute }}"
userEmailAddressAttribute: "{{ item.ldap_user_email_attribute }}"
ldapGroupsAsRoles: "{{ item.ldap_map_groups_as_roles | default(false) }}"
# 'static', 'dynamic' or none
groupType: "{{ item.ldap_map_groups_as_roles_type | default('static') }}"
userMemberOfAttribute: "{% if item.ldap_map_groups_as_roles_type is defined and item.ldap_map_groups_as_roles_type == 'dynamic' %}\
{{ item.ldap_user_memberof_attribute | default('memberOf') }}\
{% else %}\
{{ (omit) }}\
{% endif %}"
groupBaseDn: "{% if item.ldap_map_groups_as_roles_type is not defined or item.ldap_map_groups_as_roles_type == 'static' %}\
{{ item.ldap_group_base_dn | default('ou=groups') }}\
{% else %}\
{{ (omit) }}\
{% endif %}"
groupObjectClass: "{% if item.ldap_map_groups_as_roles_type is not defined or item.ldap_map_groups_as_roles_type == 'static' %}\
{{ item.ldap_group_object_class | default('groupOfNames') }}\
{% else %}\
{{ (omit) }}\
{% endif %}"
groupIdAttribute: "{% if item.ldap_map_groups_as_roles_type is not defined or item.ldap_map_groups_as_roles_type == 'static' %}\
{{ item.ldap_group_id_attribute | default('cn') }}\
{% else %}\
{{ (omit) }}\
{% endif %}"
groupMemberAttribute: "{% if item.ldap_map_groups_as_roles_type is not defined or item.ldap_map_groups_as_roles_type == 'static' %}\
{{ item.ldap_group_member_attribute | default('member') }}\
{% else %}\
{{ (omit) }}\
{% endif %}"
groupMemberFormat: "{% if item.ldap_map_groups_as_roles_type is not defined or item.ldap_map_groups_as_roles_type == 'static' %}\
{{ item.ldap_group_member_format | default('uid=${username},ou=users,dc=yourcompany') }}\
{% else %}\
{{ (omit) }}\
{% endif %}"
userSubtree: "{{ item.ldap_user_subtree | default(false) }}"
groupSubtree: "{{ item.ldap_group_subtree | default(false) }}"
connectionTimeoutSeconds: "{{ item.ldap_connection_timeout | default(1) }}"
connectionRetryDelaySeconds: "{{ item.ldap_connection_retry_delay | default(0) }}"
maxIncidentsCount: "{{ item.ldap_max_incidents_count | default(0) }}"
when: nexus_ldap_retrieved.status == 404

- name: Updating LDAP connections
uri:
url: "{{ nexus_api_scheme }}://{{ nexus_api_hostname }}:{{ nexus_api_port }}\
{{ nexus_api_context_path }}{{ nexus_rest_api_endpoint_base }}/beta/security/ldap/{{ item.ldap_name | urlencode }}"
user: 'admin'
password: "{{ current_nexus_admin_password }}"
headers:
Content-Type: "application/json"
method: PUT
force_basic_auth: yes
validate_certs: "{{ nexus_api_validate_certs }}"
body: "{{ args | to_json }}"
status_code: 200,201,204
vars:
args:
name: "{{ item.ldap_name }}"
protocol: "{{ item.ldap_protocol }}"
host: "{{ item.ldap_hostname }}"
port: "{{ item.ldap_port }}"
authScheme: "{{ item.ldap_auth | default('NONE') }}"
authUsername: "{{ item.ldap_auth_username | default('') }}"
authPassword: "{{ item.ldap_auth_password | default('') }}"
searchBase: "{{ item.ldap_search_base }}"
userBaseDn: "{{ item.ldap_user_base_dn | default('ou=users') }}"
userLdapFilter: "{{ item.ldap_user_filter | default('') }}"
userObjectClass: "{{ item.ldap_user_object_class }}"
userIdAttribute: "{{ item.ldap_user_id_attribute }}"
userRealNameAttribute: "{{ item.ldap_user_real_name_attribute }}"
userEmailAddressAttribute: "{{ item.ldap_user_email_attribute }}"
ldapGroupsAsRoles: "{{ item.ldap_map_groups_as_roles | default(false) }}"
groupType: "{{ item.ldap_map_groups_as_roles_type | default('static') }}"
userMemberOfAttribute: "{{ item.ldap_user_memberof_attribute | default('memberOf') }}"
groupBaseDn: "{{ item.ldap_group_base_dn | default('ou=groups') }}"
groupObjectClass: "{{ item.ldap_group_object_class | default('groupOfNames') }}"
groupIdAttribute: "{{ item.ldap_group_id_attribute | default('cn') }}"
groupMemberAttribute: "{{ item.ldap_group_member_attribute | default('member') }}"
groupMemberFormat: "{{ item.ldap_group_member_format | default('uid=${username},ou=users,dc=yourcompany') }}"
userSubtree: "{{ item.ldap_user_subtree | default(false) }}"
groupSubtree: "{{ item.ldap_group_subtree | default(false) }}"
connectionTimeoutSeconds: "{{ item.ldap_connection_timeout | default(1) }}"
connectionRetryDelaySeconds: "{{ item.ldap_connection_retry_delay | default(0) }}"
maxIncidentsCount: "{{ item.ldap_max_incidents_count | default(0) }}"
# Id should be present and so collected
id: "{{ (nexus_ldap_retrieved.content | from_json)['id'] }}"
when: nexus_ldap_retrieved.status == 200