'''
Allura plugins for authentication and project registration
'''
import logging
import re
from random import randint
from hashlib import sha256
from base64 import b64encode
from datetime import datetime
import ldap
import pkg_resources
from tg import config
from pylons import g, c
from webob import exc
from ming.utils import LazyProperty
from ming.orm import session
from ming.orm import ThreadLocalORMSession
from allura.lib import helpers as h
from allura.lib import exceptions as forge_exc
log = logging.getLogger(__name__)
class AuthenticationProvider(object):
def __init__(self, request):
self.request = request
@classmethod
def get(cls, request):
try:
result = cls._loaded_ep
except AttributeError:
method = config.get('auth.method', 'local')
for ep in pkg_resources.iter_entry_points(
'allura.auth', method):
break
else:
return None
result = cls._loaded_ep = ep.load()
return result(request)
@LazyProperty
def session(self):
return self.request.environ['beaker.session']
def authenticate_request(self):
from allura import model as M
user = M.User.query.get(_id=self.session.get('userid', None))
if user is None:
return M.User.anonymous()
return user
def register_user(self, user_doc):
raise NotImplementedError, 'register_user'
def _login(self):
raise NotImplementedError, '_login'
def login(self, user=None):
try:
if user is None: user = self._login()
self.session['userid'] = user._id
self.session.save()
return user
except exc.HTTPUnauthorized:
self.logout()
raise
def logout(self):
self.session['userid'] = None
self.session.save()
def by_username(self, username):
raise NotImplementedError, 'by_username'
def set_password(self, user, old_password, new_password):
raise NotImplementedError, 'set_password'
class LocalAuthenticationProvider(AuthenticationProvider):
def register_user(self, user_doc):
from allura import model as M
return M.User(**user_doc)
def _login(self):
user = self.by_username(self.request.params['username'])
if not self._validate_password(user, self.request.params['password']):
raise exc.HTTPUnauthorized()
return user
def _validate_password(self, user, password):
if user is None: return False
if not user.password: return False
salt = str(user.password[6:6+user.SALT_LEN])
check = self._encode_password(password, salt)
if check != user.password: return False
return True
def by_username(self, username):
from allura import model as M
un = re.escape(username)
un = un.replace(r'\_', '[-_]')
un = un.replace(r'\-', '[-_]')
rex = re.compile('^' + un + '$')
return M.User.query.get(username=rex)
def set_password(self, user, old_password, new_password):
user.password = self._encode_password(new_password)
def _encode_password(self, password, salt=None):
from allura import model as M
if salt is None:
salt = ''.join(chr(randint(1, 0x7f))
for i in xrange(M.User.SALT_LEN))
hashpass = sha256(salt + password.encode('utf-8')).digest()
return 'sha256' + salt + b64encode(hashpass)
class LdapAuthenticationProvider(AuthenticationProvider):
def register_user(self, user_doc):
from allura import model as M
password = user_doc.pop('password', None)
result = M.User(**user_doc)
dn = 'uid=%s,%s' % (user_doc['username'], config['auth.ldap.suffix'])
try:
con = ldap.initialize(config['auth.ldap.server'])
con.bind_s(config['auth.ldap.admin_dn'],
config['auth.ldap.admin_password'])
ldap_info = dict(
uid=user_doc['username'],
displayName=user_doc['display_name'],
cn=user_doc['display_name'],
userPassword=password,
objectClass=['inetOrgPerson'],
givenName=user_doc['display_name'].split()[0],
sn=user_doc['display_name'].split()[-1])
ldap_info = dict((k,v) for k,v in ldap_info.iteritems()
if v is not None)
try:
con.add_s(dn, ldap_info.items())
except ldap.ALREADY_EXISTS:
con.modify_s(dn, [(ldap.MOD_REPLACE, k, v)
for k,v in ldap_info.iteritems()])
con.unbind_s()
except:
raise
return result
def by_username(self, username):
from allura import model as M
return M.User.query.get(username=username)
def set_password(self, user, old_password, new_password):
try:
dn = 'uid=%s,%s' % (self.username, config['auth.ldap.suffix'])
con = ldap.initialize(config['auth.ldap.server'])
con.bind_s(dn, old_password)
con.modify_s(dn, [(ldap.MOD_REPLACE, 'userPassword', new_password)])
con.unbind_s()
except ldap.INVALID_CREDENTIALS:
raise exc.HTTPUnauthorized()
def _login(self):
from allura import model as M
user = M.User.query.get(username=self.request.params['username'])
if user is None: raise exc.HTTPUnauthorized()
try:
dn = 'uid=%s,%s' % (user.username, config['auth.ldap.suffix'])
con = ldap.initialize(config['auth.ldap.server'])
con.bind_s(dn, self.request.params['password'])
con.unbind_s()
except ldap.INVALID_CREDENTIALS:
raise exc.HTTPUnauthorized()
return user
class ProjectRegistrationProvider(object):
@classmethod
def get(cls):
method = config.get('registration.method', 'local')
for ep in pkg_resources.iter_entry_points('allura.project_registration', method):
return ep.load()()
def register_neighborhood_project(self, neighborhood, users):
from allura import model as M
shortname='--init--'
p = M.Project.query.get(
neighborhood_id=neighborhood._id,
shortname=shortname)
if p: raise forge_exc.ProjectConflict()
name = 'Home Project for %s' % neighborhood.name
database_uri = M.Project.default_database_uri(shortname)
p = M.Project(neighborhood_id=neighborhood._id,
shortname=shortname,
name=name,
short_description='',
description=('# ' + name + '\n\n'
+ 'You can edit this description in the admin page'),
database_uri=database_uri,
last_updated = datetime.utcnow(),
is_root=True)
try:
p.configure_project(
users=users,
is_user_project=False,
apps=[
('wiki', 'home'),
('admin', 'admin')])
except:
ThreadLocalORMSession.close_all()
log.exception('Error registering project %s' % p)
raise
return p
def register_project(self, neighborhood, shortname, user, user_project):
'''Register a new project in the neighborhood. The given user will
become the project's superuser. If no user is specified, c.user is used.
'''
from allura import model as M
assert h.re_path_portion.match(shortname.replace('/', '')), \
'Invalid project shortname'
try:
p = M.Project.query.get(shortname=shortname)
if p: raise forge_exc.ProjectConflict()
p = M.Project(neighborhood_id=neighborhood._id,
shortname=shortname,
name=shortname,
short_description='',
description=(shortname + '\n'
+ '=' * 80 + '\n\n'
+ 'You can edit this description in the admin page'),
database_uri=M.Project.default_database_uri(shortname),
last_updated = datetime.utcnow(),
is_root=True)
p.configure_project(
users=[user],
is_user_project=user_project)
except forge_exc.ProjectConflict:
raise
except:
ThreadLocalORMSession.close_all()
log.exception('Error registering project %s' % p)
raise
ThreadLocalORMSession.flush_all()
with h.push_config(c, project=p):
g.publish('react', 'forge.project_created')
return p
def register_subproject(self, project, name, user, install_apps):
from allura import model as M
assert h.re_path_portion.match(name), 'Invalid subproject shortname'
shortname = project.shortname + '/' + name
sp = M.Project(
parent_id=project._id,
neighborhood_id=project.neighborhood_id,
shortname=shortname,
name=name,
database_uri=project.database_uri,
last_updated = datetime.utcnow(),
is_root=False)
with h.push_config(c, project=sp):
M.AppConfig.query.remove(dict(project_id=c.project._id))
if install_apps:
sp.install_app('home', 'home')
sp.install_app('admin', 'admin')
sp.install_app('search', 'search')
g.publish('react', 'forge.project_created')
return sp
def delete_project(self, project, user):
for sp in project.subprojects:
self.delete_project(sp, user)
project.deleted = True
def undelete_project(self, project, user):
project.deleted = False
for sp in project.subprojects:
self.undelete_project(sp, user)
def best_download_url(self, project):
'''This is the url needed to render a download button.
It should be overridden for your specific envirnoment'''
return None
class ThemeProvider(object):
master_template = 'jinja_master/master.html'
jinja_macros = 'jinja_master/theme_macros.html'
nav_menu = 'jinja_master/nav_menu.html'
top_nav = 'jinja_master/top_nav.html'
sidebar_menu = 'jinja_master/sidebar_menu.html'
base_css = ('css/site_style.css', 'allura')
theme_css = ['css/allura.css']
@classmethod
def get(cls):
name = config.get('theme', 'allura')
for ep in pkg_resources.iter_entry_points('allura.theme', name):
return ep.load()()
def set_theme(self, globs):
globs.theme = dict(master = self.master_template,
jinja_macros = self.jinja_macros,
nav_menu = self.nav_menu,
top_nav = self.top_nav,
sidebar_menu = self.sidebar_menu,
base_css = self.base_css,
theme_css = self.theme_css)
class LocalProjectRegistrationProvider(ProjectRegistrationProvider):
pass