feat: Ldap Service (#43)

Author: SolarFactories

client.go

@@ -42,6 +42,7 @@ type Client struct {
 	Config            ConfigService
 	Finding           FindingService
 	Event             EventService
+	LDAP              LDAPService
 	License           LicenseService
 	Metrics           MetricsService
 	OIDC              OIDCService
@@ -91,6 +92,7 @@ func NewClient(baseURL string, options ...ClientOption) (*Client, error) {
 	client.Config = ConfigService{client: &client}
 	client.Finding = FindingService{client: &client}
 	client.Event = EventService{client: &client}
+	client.LDAP = LDAPService{client: &client}
 	client.License = LicenseService{client: &client}
 	client.Metrics = MetricsService{client: &client}
 	client.OIDC = OIDCService{client: &client}

ldap.go

@@ -0,0 +1,103 @@
+package dtrack
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	"github.com/google/uuid"
+)
+
+type LDAPService struct {
+	client *Client
+}
+
+type LdapUser struct {
+	Username          string       `json:"username,omitempty"`
+	DistinguishedName string       `json:"dn,omitempty"`
+	Teams             []Team       `json:"teams,omitempty"`
+	Email             string       `json:"email,omitempty"`
+	Permissions       []Permission `json:"permissions,omitempty"`
+}
+
+type MappedLdapGroupRequest struct {
+	Team              uuid.UUID `json:"team"`
+	DistinguishedName string    `json:"dn"`
+}
+
+type MappedLdapGroup struct {
+	DistinguishedName string    `json:"dn,omitempty"`
+	UUID              uuid.UUID `json:"uuid"`
+}
+
+func (s LDAPService) AddMapping(ctx context.Context, mapping MappedLdapGroupRequest) (g MappedLdapGroup, err error) {
+	req, err := s.client.newRequest(ctx, http.MethodPut, "/api/v1/ldap/mapping", withBody(mapping))
+	if err != nil {
+		return
+	}
+
+	_, err = s.client.doRequest(req, &g)
+	return
+}
+
+func (s LDAPService) RemoveMapping(ctx context.Context, mappingId uuid.UUID) (err error) {
+	req, err := s.client.newRequest(ctx, http.MethodDelete, fmt.Sprintf("/api/v1/ldap/mapping/%s", mappingId.String()))
+	if err != nil {
+		return
+	}
+
+	_, err = s.client.doRequest(req, nil)
+	return
+}
+
+func (s LDAPService) GetAllAccessibleGroups(ctx context.Context, po PageOptions) (gs Page[string], err error) {
+	req, err := s.client.newRequest(ctx, http.MethodGet, "/api/v1/ldap/groups", withPageOptions(po))
+	if err != nil {
+		return
+	}
+
+	res, err := s.client.doRequest(req, &gs.Items)
+	gs.TotalCount = res.TotalCount
+	return
+}
+
+func (s LDAPService) GetTeamMappings(ctx context.Context, teamUUID uuid.UUID) (gs []MappedLdapGroup, err error) {
+	req, err := s.client.newRequest(ctx, http.MethodGet, fmt.Sprintf("/api/v1/ldap/team/%s", teamUUID.String()))
+	if err != nil {
+		return
+	}
+
+	_, err = s.client.doRequest(req, &gs)
+	return
+}
+
+func (s LDAPService) GetUsers(ctx context.Context, po PageOptions) (us Page[LdapUser], err error) {
+	req, err := s.client.newRequest(ctx, http.MethodGet, "/api/v1/user/ldap", withPageOptions(po))
+	if err != nil {
+		return
+	}
+
+	res, err := s.client.doRequest(req, &us.Items)
+	us.TotalCount = res.TotalCount
+	return
+}
+
+func (s LDAPService) CreateUser(ctx context.Context, user LdapUser) (userOut LdapUser, err error) {
+	req, err := s.client.newRequest(ctx, http.MethodPut, "/api/v1/user/ldap", withBody(user))
+	if err != nil {
+		return
+	}
+
+	_, err = s.client.doRequest(req, &userOut)
+	return
+}
+
+func (s LDAPService) DeleteUser(ctx context.Context, user LdapUser) (err error) {
+	req, err := s.client.newRequest(ctx, http.MethodDelete, "/api/v1/user/ldap", withBody(user))
+	if err != nil {
+		return
+	}
+
+	_, err = s.client.doRequest(req, nil)
+	return
+}

ldap_test.go

@@ -0,0 +1,103 @@
+package dtrack
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestLdapMappings(t *testing.T) {
+	// 1. Confirm absence of mappings
+	// 2. Add mapping
+	// 3. Confirm presence of mapping
+	// 4. Remove mapping
+	// 5. Confirm absence of mapping
+	client := setUpContainer(t, testContainerOptions{
+		APIPermissions: []string{
+			PermissionAccessManagement,
+		},
+	})
+
+	team, err := client.Team.Create(context.Background(), Team{
+		Name: "TestLdapMappings",
+	})
+	require.NoError(t, err)
+
+	mappings, err := client.LDAP.GetTeamMappings(context.Background(), team.UUID)
+	require.NoError(t, err)
+	require.Empty(t, mappings)
+
+	mapping, err := client.LDAP.AddMapping(context.Background(), MappedLdapGroupRequest{
+		Team:              team.UUID,
+		DistinguishedName: "test.mapping.ldap.dependencytrack",
+	})
+	require.NoError(t, err)
+	require.Equal(t, mapping.DistinguishedName, "test.mapping.ldap.dependencytrack")
+	require.NotEmpty(t, mapping.UUID)
+
+	mappings, err = client.LDAP.GetTeamMappings(context.Background(), team.UUID)
+	require.NoError(t, err)
+	require.Equal(t, len(mappings), 1)
+	require.Equal(t, mappings[0].DistinguishedName, mapping.DistinguishedName)
+	require.Equal(t, mappings[0].UUID, mapping.UUID)
+
+	err = client.LDAP.RemoveMapping(context.Background(), mapping.UUID)
+	require.NoError(t, err)
+
+	mappings, err = client.LDAP.GetTeamMappings(context.Background(), team.UUID)
+	require.NoError(t, err)
+	require.Empty(t, mappings)
+}
+
+func TestLdapUsers(t *testing.T) {
+	// 1. Confirm absence of users
+	// 2. Create user
+	// 3. Confirm presence of user
+	// 4. Delete user
+	// 5. Confirm absence of user
+	client := setUpContainer(t, testContainerOptions{
+		APIPermissions: []string{
+			PermissionAccessManagement,
+		},
+	})
+
+	users, err := client.LDAP.GetUsers(context.Background(), PageOptions{
+		PageSize: 10,
+	})
+	require.NoError(t, err)
+	require.Equal(t, users.TotalCount, 0)
+	require.Empty(t, users.Items)
+
+	user, err := client.LDAP.CreateUser(context.Background(), LdapUser{
+		Username:          "TestLdapUsers",
+		DistinguishedName: "test.user.ldap.dependencytrack",
+		Email:             "test@localhost",
+	})
+	require.NoError(t, err)
+	require.Equal(t, user.Username, "TestLdapUsers")
+	require.Equal(t, user.DistinguishedName, "Syncing...")
+	require.Empty(t, user.Email)
+	require.Empty(t, user.Permissions)
+	require.Empty(t, user.Teams)
+
+	users, err = client.LDAP.GetUsers(context.Background(), PageOptions{
+		PageSize: 10,
+	})
+	require.NoError(t, err)
+	require.Equal(t, users.TotalCount, 1)
+	require.Equal(t, len(users.Items), 1)
+	require.Equal(t, users.Items[0].DistinguishedName, user.DistinguishedName)
+	require.Equal(t, users.Items[0].Email, user.Email)
+	require.Equal(t, users.Items[0].Username, user.Username)
+
+	err = client.LDAP.DeleteUser(context.Background(), user)
+	require.NoError(t, err)
+
+	users, err = client.LDAP.GetUsers(context.Background(), PageOptions{
+		PageSize: 10,
+	})
+	require.NoError(t, err)
+	require.Equal(t, users.TotalCount, 0)
+	require.Empty(t, users.Items)
+}