Skip to content

GitLab Next

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • GitLab GitLab
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 39,511
    • Issues 39,511
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
  • Merge requests 1,223
    • Merge requests 1,223
  • Requirements
    • Requirements
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
    • Value stream
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.org
  • GitLabGitLab
  • Merge requests
  • !45712

Merged
Created Oct 20, 2020 by DJ Mountney@twk3Maintainer5 of 13 tasks completed5/13 tasks

Add encrypted ldap secrets support

  • Overview 71
  • Commits 8
  • Pipelines 18
  • Changes 7

What does this MR do?

Add encrypted ldap secrets support

Adds a new ldap_secrets path setting for optional ldap secrets file. And adds a new set of ldap secrets rake commands for showing/editing an ldap secret

Adds support for loading ldap servers' password and/or user_bn from the encrypted secrets.

  • documentation MR !48090 (merged)
  • omnibus MR for generating the secret omnibus-gitlab!4687 (merged)
  • charts MR for generating the secret gitlab-org/charts/gitlab!1617 (merged)
  • adding to usage data MR !48210 (merged)

Part of #238483 (closed) and currently depends on !43220 (merged)

Usage

Users first need to ensure their secrets.yml has a encrypted_settings_key_base. This can be done by running a rake command with the optional generation opted int: bundle exec rake gitlab:env:info GITLAB_GENERATE_ENCRYPTED_SETTINGS_KEY_BASE=true

Then they can use the EDITOR=vim rake gitlab:ldap:secret:edit command to provide their ldap credentials. The expected input is to be yaml, with your credentials nested under your provider:

main:
  password: 'my-password'
  user_bn: 'my/user/bn'

Users can also create the file without an editor by piping to stdin of the rake gitlab:ldap:secret:write command.

cat my-plaintext-creds.yml | rake gitlab:ldap:secret:write

And users can see the credentials via rake gitlab:ldap:secret:show

Does this MR meet the acceptance criteria?

Conformity

  • Changelog entry
  • Documentation (if required)
  • Code review guidelines
  • Merge request performance guidelines
  • Style guides
  • Database guides
  • Separation of EE specific content

Availability and Testing

  • Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process.
  • Tested in all supported browsers
  • Informed Infrastructure department of a default or new setting change, if applicable per definition of done

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited Dec 10, 2020 by Robert Speicher
Assignee
Assign to
Reviewer
Request review from
Time tracking
Source branch: ldap-secret-command

Enable Gitpod?

To use Gitpod you must first enable the feature in the integrations section of your user preferences.

Cancel Enable Gitpod