From 017192ee84850454325e205e138d554b533ef8e4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mathias=20A=CC=8Ahsberg?= <mathias.ahsberg@resurs.se>
Date: Thu, 8 Apr 2021 18:47:02 +0000
Subject: [PATCH] Support multiline LDAP filter queries
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mathias Åhsberg <mathias.ahsberg@resurs.se>
---
 .changeset/green-otters-grin.md               |  5 +++
 .../ingestion/processors/ldap/config.test.ts  | 31 +++++++++++++++++++
 .../src/ingestion/processors/ldap/config.ts   |  7 ++++-
 3 files changed, 42 insertions(+), 1 deletion(-)
 create mode 100644 .changeset/green-otters-grin.md

diff --git a/.changeset/green-otters-grin.md b/.changeset/green-otters-grin.md
new file mode 100644
index 0000000000..abfd332a2b
--- /dev/null
+++ b/.changeset/green-otters-grin.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend': patch
+---
+
+Add support for configure an LDAP query filter on multiple lines.
diff --git a/plugins/catalog-backend/src/ingestion/processors/ldap/config.test.ts b/plugins/catalog-backend/src/ingestion/processors/ldap/config.test.ts
index 5e293766aa..aac9a091b8 100644
--- a/plugins/catalog-backend/src/ingestion/processors/ldap/config.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/ldap/config.test.ts
@@ -172,4 +172,35 @@ describe('readLdapConfig', () => {
     ];
     expect(actual).toEqual(expected);
   });
+
+  it('supports multiline ldap query filter', () => {
+    const config = {
+      providers: [
+        {
+          target: 'target',
+          users: {
+            dn: 'udn',
+            options: {
+              filter: `
+              (| 
+                (cn=foo bar) 
+                (cn=bar) 
+              )
+              `,
+            },
+          },
+          groups: {
+            dn: 'gdn',
+            options: {
+              filter: 'f',
+            },
+          },
+        },
+      ],
+    };
+    const actual = readLdapConfig(new ConfigReader(config));
+
+    const expected = '(|(cn=foo bar)(cn=bar))';
+    expect(actual[0].users.options.filter).toEqual(expected);
+  });
 });
diff --git a/plugins/catalog-backend/src/ingestion/processors/ldap/config.ts b/plugins/catalog-backend/src/ingestion/processors/ldap/config.ts
index 7608f247d4..625282ca05 100644
--- a/plugins/catalog-backend/src/ingestion/processors/ldap/config.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/ldap/config.ts
@@ -182,7 +182,7 @@ export function readLdapConfig(config: Config): LdapProviderConfig[] {
     }
     return {
       scope: c.getOptionalString('scope') as SearchOptions['scope'],
-      filter: c.getOptionalString('filter'),
+      filter: formatFilter(c.getOptionalString('filter')),
       attributes: c.getOptionalStringArray('attributes'),
       paged: c.getOptionalBoolean('paged'),
     };
@@ -260,6 +260,11 @@ export function readLdapConfig(config: Config): LdapProviderConfig[] {
     };
   }
 
+  function formatFilter(filter?: string): string | undefined {
+    // Remove extra whitespaces between blocks to support multiline filters from the configuration
+    return filter?.replace(/\s*(\(|\))/g, '$1')?.trim();
+  }
+
   const providerConfigs = config.getOptionalConfigArray('providers') ?? [];
   return providerConfigs.map(c => {
     const newConfig = {