From a28431bfe7a9939112502cb6257e8c3b73579cd7 Mon Sep 17 00:00:00 2001 From: Tuan Dang Date: Mon, 26 Feb 2024 17:42:32 -0800 Subject: [PATCH] Finish preliminary LDAP --- .../services/license/__mocks__/licence-fns.ts | 5 +-- .../src/ee/services/license/licence-fns.ts | 6 ++-- .../src/ee/services/license/license-types.ts | 6 ++-- docs/documentation/platform/ldap/general.mdx | 36 +++++++++++++++++++ docs/documentation/platform/ldap/overview.mdx | 7 +++- docs/mint.json | 3 +- frontend/src/hooks/api/subscriptions/types.ts | 1 + 7 files changed, 54 insertions(+), 10 deletions(-) create mode 100644 docs/documentation/platform/ldap/general.mdx diff --git a/backend/src/ee/services/license/__mocks__/licence-fns.ts b/backend/src/ee/services/license/__mocks__/licence-fns.ts index 76fe063ed..8f52939c5 100644 --- a/backend/src/ee/services/license/__mocks__/licence-fns.ts +++ b/backend/src/ee/services/license/__mocks__/licence-fns.ts @@ -17,8 +17,9 @@ export const getDefaultOnPremFeatures = () => { customAlerts: false, auditLogs: false, auditLogsRetentionDays: 0, - samlSSO: true, - scim: true, + samlSSO: false, + scim: false, + ldap: false, status: null, trial_end: null, has_used_trial: true, diff --git a/backend/src/ee/services/license/licence-fns.ts b/backend/src/ee/services/license/licence-fns.ts index 98f8c5f24..8dca96737 100644 --- a/backend/src/ee/services/license/licence-fns.ts +++ b/backend/src/ee/services/license/licence-fns.ts @@ -23,9 +23,9 @@ export const getDefaultOnPremFeatures = (): TFeatureSet => ({ customAlerts: false, auditLogs: false, auditLogsRetentionDays: 0, - samlSSO: true, - scim: true, - ldap: true, + samlSSO: false, + scim: false, + ldap: false, status: null, trial_end: null, has_used_trial: true, diff --git a/backend/src/ee/services/license/license-types.ts b/backend/src/ee/services/license/license-types.ts index 830cacf99..80f422380 100644 --- a/backend/src/ee/services/license/license-types.ts +++ b/backend/src/ee/services/license/license-types.ts @@ -24,9 +24,9 @@ export type TFeatureSet = { customAlerts: false; auditLogs: false; auditLogsRetentionDays: 0; - samlSSO: true; - scim: true; - ldap: true; + samlSSO: false; + scim: false; + ldap: false; status: null; trial_end: null; has_used_trial: true; diff --git a/docs/documentation/platform/ldap/general.mdx b/docs/documentation/platform/ldap/general.mdx new file mode 100644 index 000000000..81c291c22 --- /dev/null +++ b/docs/documentation/platform/ldap/general.mdx @@ -0,0 +1,36 @@ +--- +title: "General LDAP" +description: "Log in to Infisical with LDAP" +--- + + + LDAP is a paid feature. + + If you're using Infisical Cloud, then it is available under the **Enterprise Tier**. If you're self-hosting Infisical, + then you should contact team@infisical.com to purchase an enterprise license to use it. + + +You can configure your organization in Infisical to have members authenticate with the platform via [LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) + + + + In Infisical, head to your Organization Settings > Authentication > LDAP Configuration and select **Set up LDAP**. + + Next, input your LDAP server settings. + + ![LDAP configuration](/images/platform/ldap/ldap-config.png) + + Here's some guidance for each field: + + - URL: The LDAP server to connect to such as `ldap://ldap.your-org.com`, `ldaps://ldap.myorg.com:636` (for connection over SSL/TLS), etc. + - Bind DN: The distinguished name of object to bind when performing the user search such as `cn=infisical,ou=Users,dc=acme,dc=com`. + - Bind Pass: The password to use along with `Bind DN` when performing the user search. + - Search Base / User DN: Base DN under which to perform user search such as `ou=Users,dc=example,dc=com` + - CA Certificate: The CA certificate to use when verifying the LDAP server certificate. + + + Enabling LDAP allows members in your organization to log into Infisical via LDAP. + + ![LDAP toggle](/images/platform/ldap/ldap-toggle.png) + + \ No newline at end of file diff --git a/docs/documentation/platform/ldap/overview.mdx b/docs/documentation/platform/ldap/overview.mdx index 9d16ed879..1c5723b7e 100644 --- a/docs/documentation/platform/ldap/overview.mdx +++ b/docs/documentation/platform/ldap/overview.mdx @@ -15,4 +15,9 @@ To note, configuring LDAP retains the end-to-end encrypted architecture of Infis LDAP providers: -- [JumpCloud LDAP](/documentation/platform/ldap/jumpcloud) \ No newline at end of file +- Active Directory +- [JumpCloud LDAP](/documentation/platform/ldap/jumpcloud) +- AWS Directory Service +- Foxpass + +Check out the general instructions for configuring LDAP [here](/documentation/platform/ldap/general). \ No newline at end of file diff --git a/docs/mint.json b/docs/mint.json index 3c2c210eb..726aa3b02 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -153,7 +153,8 @@ "group": "LDAP", "pages": [ "documentation/platform/ldap/overview", - "documentation/platform/ldap/jumpcloud" + "documentation/platform/ldap/jumpcloud", + "documentation/platform/ldap/general" ] }, { diff --git a/frontend/src/hooks/api/subscriptions/types.ts b/frontend/src/hooks/api/subscriptions/types.ts index 5680da02d..97b287084 100644 --- a/frontend/src/hooks/api/subscriptions/types.ts +++ b/frontend/src/hooks/api/subscriptions/types.ts @@ -19,6 +19,7 @@ export type SubscriptionPlan = { environmentLimit: number; samlSSO: boolean; scim: boolean; + ldap: boolean; status: | "incomplete" | "incomplete_expired"