blob: ea5faa1fe97bbf3900b2abbc7231dd7627d12381 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Brad Topolf127e2f2013-01-22 10:17:50 -06003# lib/ldap
4# Functions to control the installation and configuration of **ldap**
5
Dean Troyercc6b4432013-04-08 15:38:03 -05006# ``lib/keystone`` calls the entry points in this order:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01007#
8# - install_ldap()
Brad Topolf127e2f2013-01-22 10:17:50 -06009
10# Save trace setting
Ian Wienand523f4882015-10-13 11:03:03 +110011_XTRACE_LDAP=$(set +o | grep xtrace)
Brad Topolf127e2f2013-01-22 10:17:50 -060012set +o xtrace
13
Dean Troyerb9e25132013-10-01 14:45:04 -050014
15LDAP_DOMAIN=${LDAP_DOMAIN:-openstack.org}
16# Make an array of domain components
17DC=(${LDAP_DOMAIN/./ })
18
19# Leftmost domain component used in top-level entry
20LDAP_BASE_DC=${DC[0]}
21
22# Build the base DN
23dn=""
24for dc in ${DC[*]}; do
25 dn="$dn,dc=$dc"
26done
27LDAP_BASE_DN=${dn#,}
28
29LDAP_MANAGER_DN="${LDAP_MANAGER_DN:-cn=Manager,${LDAP_BASE_DN}}"
30LDAP_URL=${LDAP_URL:-ldap://localhost}
31
Ralf Haferkamp704106a2013-09-12 14:24:47 +020032LDAP_SERVICE_NAME=slapd
Dean Troyercc6b4432013-04-08 15:38:03 -050033
Dean Troyerb9e25132013-10-01 14:45:04 -050034if is_ubuntu; then
35 LDAP_OLCDB_NUMBER=1
Grzegorz Grasza26f81492021-08-16 10:36:03 +020036 LDAP_OLCDB_TYPE=mdb
Dean Troyerb9e25132013-10-01 14:45:04 -050037 LDAP_ROOTPW_COMMAND=replace
38elif is_fedora; then
39 LDAP_OLCDB_NUMBER=2
Grzegorz Grasza26f81492021-08-16 10:36:03 +020040 LDAP_OLCDB_TYPE=hdb
Dean Troyerb9e25132013-10-01 14:45:04 -050041 LDAP_ROOTPW_COMMAND=add
42elif is_suse; then
43 # SUSE has slappasswd in /usr/sbin/
44 PATH=$PATH:/usr/sbin/
45 LDAP_OLCDB_NUMBER=1
Grzegorz Grasza26f81492021-08-16 10:36:03 +020046 LDAP_OLCDB_TYPE=hdb
Dean Troyerb9e25132013-10-01 14:45:04 -050047 LDAP_ROOTPW_COMMAND=add
48 LDAP_SERVICE_NAME=ldap
49fi
50
51
Dean Troyercc6b4432013-04-08 15:38:03 -050052# Functions
53# ---------
54
Dean Troyerb9e25132013-10-01 14:45:04 -050055# Perform common variable substitutions on the data files
56# _ldap_varsubst file
Ian Wienandaee18c72014-02-21 15:35:08 +110057function _ldap_varsubst {
Dean Troyerb9e25132013-10-01 14:45:04 -050058 local infile=$1
Julie Pichona3d60c82014-11-21 14:57:16 +000059 local slappass=$2
Dean Troyerb9e25132013-10-01 14:45:04 -050060 sed -e "
61 s|\${LDAP_OLCDB_NUMBER}|$LDAP_OLCDB_NUMBER|
Grzegorz Grasza26f81492021-08-16 10:36:03 +020062 s|\${LDAP_OLCDB_TYPE}|$LDAP_OLCDB_TYPE|
Julie Pichona3d60c82014-11-21 14:57:16 +000063 s|\${SLAPPASS}|$slappass|
Dean Troyerb9e25132013-10-01 14:45:04 -050064 s|\${LDAP_ROOTPW_COMMAND}|$LDAP_ROOTPW_COMMAND|
65 s|\${BASE_DC}|$LDAP_BASE_DC|
66 s|\${BASE_DN}|$LDAP_BASE_DN|
67 s|\${MANAGER_DN}|$LDAP_MANAGER_DN|
68 " $infile
69}
70
71# clean_ldap() - Remove ldap server
Ian Wienandaee18c72014-02-21 15:35:08 +110072function cleanup_ldap {
Dean Troyerb9e25132013-10-01 14:45:04 -050073 uninstall_package $(get_packages ldap)
74 if is_ubuntu; then
75 uninstall_package slapd ldap-utils libslp1
76 sudo rm -rf /etc/ldap/ldap.conf /var/lib/ldap
77 elif is_fedora; then
78 sudo rm -rf /etc/openldap /var/lib/ldap
79 elif is_suse; then
80 sudo rm -rf /var/lib/ldap
81 fi
82}
83
84# init_ldap
85# init_ldap() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +110086function init_ldap {
Dean Troyerb9e25132013-10-01 14:45:04 -050087 local keystone_ldif
88
Ian Wienandada886d2015-10-07 14:06:26 +110089 local tmp_ldap_dir
90 tmp_ldap_dir=$(mktemp -d -t ldap.$$.XXXXXXXXXX)
Dean Troyerb9e25132013-10-01 14:45:04 -050091
92 # Remove data but not schemas
93 clear_ldap_state
94
95 # Add our top level ldap nodes
96 if ldapsearch -x -w $LDAP_PASSWORD -D "$LDAP_MANAGER_DN" -H $LDAP_URL -b "$LDAP_BASE_DN" | grep -q "Success"; then
97 printf "LDAP already configured for $LDAP_BASE_DC\n"
98 else
99 printf "Configuring LDAP for $LDAP_BASE_DC\n"
100 # If BASE_DN is changed, the user may override the default file
101 if [[ -r $FILES/ldap/${LDAP_BASE_DC}.ldif.in ]]; then
Dean Troyeref66a772014-07-25 14:45:34 -0500102 local keystone_ldif=${LDAP_BASE_DC}.ldif
Dean Troyerb9e25132013-10-01 14:45:04 -0500103 else
Dean Troyeref66a772014-07-25 14:45:34 -0500104 local keystone_ldif=keystone.ldif
Dean Troyerb9e25132013-10-01 14:45:04 -0500105 fi
Dean Troyeref66a772014-07-25 14:45:34 -0500106 _ldap_varsubst $FILES/ldap/${keystone_ldif}.in >$tmp_ldap_dir/${keystone_ldif}
107 if [[ -r $tmp_ldap_dir/${keystone_ldif} ]]; then
108 ldapadd -x -w $LDAP_PASSWORD -D "$LDAP_MANAGER_DN" -H $LDAP_URL -c -f $tmp_ldap_dir/${keystone_ldif}
Dean Troyerb9e25132013-10-01 14:45:04 -0500109 fi
110 fi
111
Dean Troyeref66a772014-07-25 14:45:34 -0500112 rm -rf $tmp_ldap_dir
Dean Troyerb9e25132013-10-01 14:45:04 -0500113}
114
Brad Topolf127e2f2013-01-22 10:17:50 -0600115# install_ldap
116# install_ldap() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100117function install_ldap {
Brad Topolf127e2f2013-01-22 10:17:50 -0600118 echo "Installing LDAP inside function"
Brad Topolf127e2f2013-01-22 10:17:50 -0600119 echo "os_VENDOR is $os_VENDOR"
Dean Troyerb9e25132013-10-01 14:45:04 -0500120
Ian Wienandada886d2015-10-07 14:06:26 +1100121 local tmp_ldap_dir
122 tmp_ldap_dir=$(mktemp -d -t ldap.$$.XXXXXXXXXX)
Dean Troyerb9e25132013-10-01 14:45:04 -0500123
124 printf "installing OpenLDAP"
Brad Topolf127e2f2013-01-22 10:17:50 -0600125 if is_ubuntu; then
Leticia Wanderleycc363972017-06-26 23:52:52 -0300126 configure_ldap
Ralf Haferkamp704106a2013-09-12 14:24:47 +0200127 elif is_fedora; then
Brad Topolf127e2f2013-01-22 10:17:50 -0600128 start_ldap
Ralf Haferkamp704106a2013-09-12 14:24:47 +0200129 elif is_suse; then
Dean Troyeref66a772014-07-25 14:45:34 -0500130 _ldap_varsubst $FILES/ldap/suse-base-config.ldif.in >$tmp_ldap_dir/suse-base-config.ldif
131 sudo slapadd -F /etc/openldap/slapd.d/ -bcn=config -l $tmp_ldap_dir/suse-base-config.ldif
Ralf Haferkamp704106a2013-09-12 14:24:47 +0200132 sudo sed -i '/^OPENLDAP_START_LDAPI=/s/"no"/"yes"/g' /etc/sysconfig/openldap
133 start_ldap
Brad Topolf127e2f2013-01-22 10:17:50 -0600134 fi
135
Dean Troyerb9e25132013-10-01 14:45:04 -0500136 echo "LDAP_PASSWORD is $LDAP_PASSWORD"
Ian Wienandada886d2015-10-07 14:06:26 +1100137 local slappass
138 slappass=$(slappasswd -s $LDAP_PASSWORD)
Dean Troyeref66a772014-07-25 14:45:34 -0500139 printf "LDAP secret is $slappass\n"
Brad Topolf127e2f2013-01-22 10:17:50 -0600140
Dean Troyerb9e25132013-10-01 14:45:04 -0500141 # Create manager.ldif and add to olcdb
Julie Pichona3d60c82014-11-21 14:57:16 +0000142 _ldap_varsubst $FILES/ldap/manager.ldif.in $slappass >$tmp_ldap_dir/manager.ldif
Dean Troyeref66a772014-07-25 14:45:34 -0500143 sudo ldapmodify -Y EXTERNAL -H ldapi:/// -f $tmp_ldap_dir/manager.ldif
Brad Topolf127e2f2013-01-22 10:17:50 -0600144
Brad Topol0c2c3fc2013-03-19 03:01:30 -0500145 # On fedora we need to manually add cosine and inetorgperson schemas
Dean Troyerb9e25132013-10-01 14:45:04 -0500146 if is_fedora; then
Brad Topol0c2c3fc2013-03-19 03:01:30 -0500147 sudo ldapadd -Y EXTERNAL -H ldapi:/// -f /etc/openldap/schema/cosine.ldif
148 sudo ldapadd -Y EXTERNAL -H ldapi:/// -f /etc/openldap/schema/inetorgperson.ldif
149 fi
150
Dean Troyeref66a772014-07-25 14:45:34 -0500151 rm -rf $tmp_ldap_dir
Brad Topolf127e2f2013-01-22 10:17:50 -0600152}
153
Leticia Wanderleycc363972017-06-26 23:52:52 -0300154# configure_ldap() - Configure LDAP - reconfigure slapd
155function configure_ldap {
156 sudo debconf-set-selections <<EOF
157 slapd slapd/internal/generated_adminpw password $LDAP_PASSWORD
158 slapd slapd/internal/adminpw password $LDAP_PASSWORD
159 slapd slapd/password2 password $LDAP_PASSWORD
160 slapd slapd/password1 password $LDAP_PASSWORD
161 slapd slapd/dump_database_destdir string /var/backups/slapd-VERSION
162 slapd slapd/domain string Users
163 slapd shared/organization string $LDAP_DOMAIN
Grzegorz Grasza26f81492021-08-16 10:36:03 +0200164 slapd slapd/backend string ${LDAP_OLCDB_TYPE^^}
Leticia Wanderleycc363972017-06-26 23:52:52 -0300165 slapd slapd/purge_database boolean true
166 slapd slapd/move_old_database boolean true
167 slapd slapd/allow_ldap_v2 boolean false
168 slapd slapd/no_configuration boolean false
169 slapd slapd/dump_database select when needed
170EOF
171 sudo apt-get install -y slapd ldap-utils
172 sudo dpkg-reconfigure -f noninteractive $LDAP_SERVICE_NAME
173}
174
Brad Topolf127e2f2013-01-22 10:17:50 -0600175# start_ldap() - Start LDAP
Ian Wienandaee18c72014-02-21 15:35:08 +1100176function start_ldap {
Ralf Haferkamp704106a2013-09-12 14:24:47 +0200177 sudo service $LDAP_SERVICE_NAME restart
Brad Topolf127e2f2013-01-22 10:17:50 -0600178}
179
Brad Topolf127e2f2013-01-22 10:17:50 -0600180# stop_ldap() - Stop LDAP
Ian Wienandaee18c72014-02-21 15:35:08 +1100181function stop_ldap {
Ralf Haferkamp704106a2013-09-12 14:24:47 +0200182 sudo service $LDAP_SERVICE_NAME stop
Brad Topolf127e2f2013-01-22 10:17:50 -0600183}
184
185# clear_ldap_state() - Clear LDAP State
Ian Wienandaee18c72014-02-21 15:35:08 +1100186function clear_ldap_state {
Dean Troyerb44a8ef2014-03-06 11:25:04 -0600187 ldapdelete -x -w $LDAP_PASSWORD -D "$LDAP_MANAGER_DN" -H $LDAP_URL -r "$LDAP_BASE_DN" || :
Brad Topolf127e2f2013-01-22 10:17:50 -0600188}
189
190# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100191$_XTRACE_LDAP
Sean Dague584d90e2013-03-29 14:34:53 -0400192
Adam Spiers6a5aa7c2013-10-24 11:27:02 +0100193# Tell emacs to use shell-script-mode
194## Local variables:
195## mode: shell-script
196## End: