3 # Copyright (C) 2014 Ipsilon Contributors, see COPYING for license
5 from ipsilon.login.common import LoginFormBase, LoginManagerBase
6 from ipsilon.login.common import FACILITY
7 from ipsilon.util.plugin import PluginObject
8 from ipsilon.util.log import Log
9 from ipsilon.util import config as pconfig
10 from ipsilon.info.infoldap import InfoProvider as LDAPInfo
14 class LDAP(LoginFormBase, Log):
16 def __init__(self, site, mgr, page):
17 super(LDAP, self).__init__(site, mgr, page)
20 def _ldap_connect(self):
22 tls = self.lm.tls.lower()
25 tls_req_opt = ldap.OPT_X_TLS_NEVER
27 tls_req_opt = ldap.OPT_X_TLS_DEMAND
29 tls_req_opt = ldap.OPT_X_TLS_ALLOW
31 tls_req_opt = ldap.OPT_X_TLS_TRY
32 if tls_req_opt is not None:
33 ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, tls_req_opt)
35 conn = ldap.initialize(self.lm.server_url)
38 if not self.lm.server_url.startswith("ldaps"):
42 def _authenticate(self, username, password):
44 conn = self._ldap_connect()
45 dn = self.lm.bind_dn_tmpl % {'username': username}
46 conn.simple_bind_s(dn, password)
48 # Bypass info plugins to optimize data retrieval
49 if self.lm.get_user_info:
52 if not self.ldap_info:
53 self.ldap_info = LDAPInfo()
55 return self.ldap_info.get_user_data_from_conn(conn, dn)
59 def POST(self, *args, **kwargs):
60 username = kwargs.get("login_name")
61 password = kwargs.get("login_password")
66 if username and password:
68 userdata = self._authenticate(username, password)
71 for d, v in userdata.get('userdata', {}).items():
73 if 'groups' in userdata:
74 userattrs['groups'] = userdata['groups']
75 if 'extras' in userdata:
76 userattrs['extras'] = userdata['extras']
78 except Exception, e: # pylint: disable=broad-except
79 errmsg = "Authentication failed"
80 self.error("Exception raised: [%s]" % repr(e))
82 errmsg = "Username or password is missing"
86 return self.lm.auth_successful(self.trans, username, 'password',
89 context = self.create_tmpl_context(
92 error_password=not password,
93 error_username=not username
95 # pylint: disable=star-args
96 return self._template('login/form.html', **context)
99 class LoginManager(LoginManagerBase):
101 def __init__(self, *args, **kwargs):
102 super(LoginManager, self).__init__(*args, **kwargs)
106 self.ldap_info = None
107 self.service_name = 'ldap'
108 self.description = """
109 Form based login Manager that uses a simple bind LDAP operation to perform
115 'The LDAP server url.',
116 'ldap://example.com'),
119 'Template to turn username into DN.',
120 'uid=%(username)s,ou=People,dc=example,dc=com'),
123 'Get user info via ldap using user credentials',
127 'What TLS level show be required',
128 ['Demand', 'Allow', 'Try', 'Never', 'NoTLS'],
132 'Text used to ask for the username at login time.',
136 'Text used to ask for the password at login time.',
140 'Text used to guide the user at login time.',
141 'Provide your Username and Password')
146 return self.get_config_value('help text')
149 def username_text(self):
150 return self.get_config_value('username text')
153 def password_text(self):
154 return self.get_config_value('password text')
157 def server_url(self):
158 return self.get_config_value('server url')
162 return self.get_config_value('tls')
165 def get_user_info(self):
166 return (self.get_config_value('get user info').lower() == 'yes')
169 def bind_dn_tmpl(self):
170 return self.get_config_value('bind dn template')
172 def get_tree(self, site):
173 self.page = LDAP(site, self, 'login/ldap')
177 class Installer(object):
183 def install_args(self, group):
184 group.add_argument('--ldap', choices=['yes', 'no'], default='no',
185 help='Configure PAM authentication')
186 group.add_argument('--ldap-server-url', action='store',
187 help='LDAP Server Url')
188 group.add_argument('--ldap-bind-dn-template', action='store',
189 help='LDAP Bind DN Template')
191 def configure(self, opts):
192 if opts['ldap'] != 'yes':
195 # Add configuration data to database
200 po.wipe_config_values(FACILITY)
202 if 'ldap_server_url' in opts:
203 config['server url'] = opts['ldap_server_url']
204 if 'ldap_bind_dn_template' in opts:
205 config['bind dn template'] = opts['ldap_bind_dn_template']
206 config['tls'] = 'Demand'
207 po.save_plugin_config(FACILITY, config)
209 # Update global config to add login plugin
212 globalconf = po.get_plugin_config(FACILITY)
213 if 'order' in globalconf:
214 order = globalconf['order'].split(',')
218 globalconf['order'] = ','.join(order)
219 po.save_plugin_config(FACILITY, globalconf)