simoon
/
parallel-library
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

initial flask_simpleldap implementation

Browse Source
pull/769/head^2
Krakinou 5 years ago
parent d48cdcc789
commit e4d801bbaf
4 changed files with 181 additions and 49 deletions
Show Stats Download Patch File Download Diff File

46
cps/templates/config_edit.html
Unescape Escape View File

@ -165,16 +165,58 @@
<div class="form-group">
<input type="checkbox" id="config_use_ldap" name="config_use_ldap" data-control="ldap-settings" {% if content.config_use_ldap %}checked{% endif %}>
<label for="config_use_ldap">{{_('Use')}} LDAP Authentication</label>
</div>
</div>
<div data-related="ldap-settings">
<div class="form-group">
<label for="config_ldap_provider_url">{{_('LDAP Provider URL')}}</label>
<label for="config_ldap_provider_url">{{_('LDAP Server Host Name or IP Address')}}</label>
<input type="text" class="form-control" id="config_ldap_provider_url" name="config_ldap_provider_url" value="{% if content.config_use_ldap != None %}{{ content.config_ldap_provider_url }}{% endif %}" autocomplete="off">
</div>
<div class="form-group">
<label for="config_ldap_port">{{_('LDAP Server Port')}}</label>
<input type="text" class="form-control" id="config_ldap_port" name="config_ldap_port" value="{% if content.config_use_ldap != None %}{{ content.config_ldap_port }}{% endif %}" autocomplete="off">
</div>
<div class="form-group">
<label for="config_ldap_schema">{{_('LDAP schema (ldap or ldaps)')}}</label>
<input type="text" class="form-control" id="config_ldap_schema" name="config_ldap_schema" value="{% if content.config_use_ldap != None %}{{ content.config_ldap_schema }}{% endif %}" autocomplete="off">
</div>
<div class="form-group">
<label for="config_ldap_serv_username">{{_('LDAP Admin username')}}</label>
<input type="text" class="form-control" id="config_ldap_serv_username" name="config_ldap_serv_username" value="{% if content.config_use_ldap != None %}{{ content.config_ldap_serv_username }}{% endif %}" autocomplete="off">
</div>
<div class="form-group">
<label for="config_ldap_serv_password">{{_('LDAP Admin password')}}</label>
<input type="password" class="form-control" id="config_ldap_serv_password" name="config_ldap_serv_password" value="{% if content.config_use_ldap != None %}{{ content.config_ldap_serv_password }}{% endif %}" autocomplete="off">
</div>
<div class="form-group">
<input type="checkbox" id="config_ldap_use_ssl" name="config_ldap_use_ssl" {% if content.config_use_ldap %}checked{% endif %}>
<label for="config_ldap_ssl">{{_('Use')}} LDAP Server Use SSL</label>
</div>
<div class="form-group">
<input type="checkbox" id="config_ldap_use_tls" name="config_ldap_use_tls" {% if content.config_use_ldap %}checked{% endif %}>
<label for="config_ldap_ssl">{{_('Use')}} LDAP Server Use TLS</label>
</div>
<div class="form-group">
<input type="checkbox" id="config_ldap_require_cert" name="config_ldap_require_cert" data-control="ldap-cert-settings" {% if content.config_use_ldap %}checked{% endif %}>
<label for="config_ldap_ssl">{{_('Use')}} LDAP Server Certificate</label>
</div>
<div data-related="ldap-cert-settings">
<div class="form-group">
<label for="config_ldap_cert_path">{{_('LDAP Certificate Path')}}</label>
<input type="text" class="form-control" id="config_ldap_cert_path" name="config_ldap_cert_path" value="{% if content.config_use_ldap != None and content.config_ldap_require_cert !=None %}{{ content.config_ldap_cert_path }}{% endif %}" autocomplete="off">
</div>
</div>
<div class="form-group">
<label for="config_ldap_dn">{{_('LDAP Distinguished Name (DN)')}}</label>
<input type="text" class="form-control" id="config_ldap_dn" name="config_ldap_dn" value="{% if content.config_use_ldap != None %}{{ content.config_ldap_dn }}{% endif %}" autocomplete="off">
</div>
<div class="form-group">
<label for="config_ldap_user_object">{{_('LDAP User object filter')}}</label>
<input type="text" class="form-control" id="config_ldap_user_object" name="config_ldap_user_object" value="{% if content.config_use_ldap != None %}{{ content.config_ldap_user_object }}{% endif %}" autocomplete="off">
</div>
<div class="form-group">
<input type="checkbox" id="config_ldap_openldap" name="config_ldap_openldap" {% if content.config_use_ldap %}checked{% endif %}>
<label for="config_ldap_openldap">{{_('Use')}} LDAP Server is OpenLDAP?</label>
</div>
</div>
</div>
</div>

45
cps/ub.py
Unescape Escape View File

@ -148,14 +148,6 @@ class UserBase:
def __repr__(self):
return '<User %r>' % self.nickname
#Login via LDAP method
@staticmethod
def try_login(username, password):
conn = get_ldap_connection()
conn.simple_bind_s(
config.config_ldap_dn.replace("%s", username),
password
)
# Baseclass for Users in Calibre-Web, settings which are depending on certain users are stored here. It is derived from
# User Base (all access methods are declared there)
@ -315,8 +307,18 @@ class Settings(Base):
config_goodreads_api_key = Column(String)
config_goodreads_api_secret = Column(String)
config_use_ldap = Column(Boolean)
config_ldap_provider_url = Column(String)
config_ldap_provider_url = Column(String, default='localhost')
config_ldap_port = Column(SmallInteger, default=389)
config_ldap_schema = Column(String, default='ldap')
config_ldap_serv_username = Column(String)
config_ldap_serv_password = Column(String)
config_ldap_use_ssl = Column(Boolean, default=False)
config_ldap_use_tls = Column(Boolean, default=False)
config_ldap_require_cert = Column(Boolean, default=False)
config_ldap_cert_path = Column(String)
config_ldap_dn = Column(String)
config_ldap_user_object = Column(String)
config_ldap_openldap = Column(Boolean)
config_mature_content_tags = Column(String)
config_logfile = Column(String)
config_ebookconverter = Column(Integer, default=0)
@ -392,7 +394,17 @@ class Config:
self.config_goodreads_api_secret = data.config_goodreads_api_secret
self.config_use_ldap = data.config_use_ldap
self.config_ldap_provider_url = data.config_ldap_provider_url
self.config_ldap_port = data.config_ldap_port
self.config_ldap_schema = data.config_ldap_schema
self.config_ldap_serv_username = data.config_ldap_serv_username
self.config_ldap_serv_password = data.config_ldap_serv_password
self.config_ldap_use_ssl = data.config_ldap_use_ssl
self.config_ldap_use_tls = data.config_ldap_use_ssl
self.config_ldap_require_cert = data.config_ldap_require_cert
self.config_ldap_cert_path = data.config_ldap_cert_path
self.config_ldap_dn = data.config_ldap_dn
self.config_ldap_user_object = data.config_ldap_user_object
self.config_ldap_openldap = data.config_ldap_openldap
if data.config_mature_content_tags:
self.config_mature_content_tags = data.config_mature_content_tags
else:
@ -681,7 +693,17 @@ def migrate_Database():
conn = engine.connect()
conn.execute("ALTER TABLE Settings ADD column `config_use_ldap` INTEGER DEFAULT 0")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_provider_url` String DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_port` INTEGER DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_schema ` String DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_serv_username` String DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_serv_password` String DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_use_ssl` INTEGER DEFAULT 0")
conn.execute("ALTER TABLE Settings ADD column `cconfig_ldap_use_tls` INTEGER DEFAULT 0")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_require_cert` INTEGER DEFAULT 0")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_cert_path` String DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_dn` String DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_user_object` String DEFAULT ''")
conn.execute("ALTER TABLE Settings ADD column `config_ldap_openldap` INTEGER DEFAULT 0")
session.commit()
try:
session.query(exists().where(Settings.config_theme)).scalar()
@ -799,11 +821,6 @@ else:
migrate_Database()
clean_database()
#get LDAP connection
def get_ldap_connection():
import ldap
conn = ldap.initialize('ldap://{}'.format(config.config_ldap_provider_url))
return conn
# Generate global Settings Object accessible from every file
config = Config()

136
cps/web.py
Unescape Escape View File

@ -57,6 +57,7 @@ from redirect import redirect_back
import time
import server
from reverseproxy import ReverseProxied
from __builtin__ import True
try:
from googleapiclient.errors import HttpError
@ -107,6 +108,11 @@ try:
except ImportError:
from flask_login.__about__ import __version__ as flask_loginVersion
try:
from flask_simpleldap import LDAP, LDAPException
ldap_support = True
except ImportError:
ldap_support = False
# Global variables
current_milli_time = lambda: int(round(time.time() * 1000))
@ -176,6 +182,31 @@ lm.anonymous_user = ub.Anonymous
app.secret_key = os.getenv('SECRET_KEY', 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT')
db.setup_db()
if ldap_support and config.config_use_ldap:
app.confgi['LDAP_HOST'] = config.config_ldap_provider_url
app.config['LDAP_PORT'] = config.config_ldap_port
app.config['LDAP_SCHEMA'] = config.config_ldap_schema
app.config['LDAP_USERNAME'] = config.config_ldap_serv_username
app.config['LDAP_PASSWORD'] = config.config_ldap_serv_password
if config.config_ldap_use_ssl:
app.config['LDAP_USE_SSL'] = True
if config.config_ldap_use_tls:
app.config['LDAP_USE_TLS'] = True
app.config['LDAP_REQUIRE_CERT'] = config.config_ldap_require_cert
if config.config_ldap_require_cert:
app.config['LDAP_CERT_PATH'] = config.config_ldap_cert_path
app.config['LDAP_BASE_DN'] = config.config_ldap_dn
app.config['LDAP_USER_OBJECT_FILTER'] = config.config_ldap_user_object
if config.config_openldap:
app.config['LDAP_OPENLDAP'] = True
# app.config['LDAP_BASE_DN'] = 'ou=users,dc=yunohost,dc=org'
# app.config['LDAP_USER_OBJECT_FILTER'] = '(uid=%s)'
ldap = LDAP(app)
elif config.config_use_ldap and not ldap_support:
app.logger.error('Cannot activate ldap support, did you run \'pip install --target vendor -r optional-requirements-ldap.txt\'?')
with open(os.path.join(config.get_main_dir, 'cps/translations/iso639.pickle'), 'rb') as f:
language_table = cPickle.load(f)
@ -256,6 +287,13 @@ def requires_basic_auth_if_no_ano(f):
return decorated
def basic_auth_required_check(condition):
def decorator(f):
if condition and ldap_support:
return ldap.basic_auth_required(f)
return requires_basic_auth_if_no_ano(f)
return decorator
# simple pagination for the feed
class Pagination(object):
@ -690,31 +728,31 @@ def before_request():
# Routing functions
@app.route("/opds")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_index():
return render_xml_template('index.xml')
@app.route("/opds/osd")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_osd():
return render_xml_template('osd.xml', lang='en-EN')
@app.route("/opds/search/<query>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_cc_search(query):
return feed_search(query.strip())
@app.route("/opds/search", methods=["GET"])
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_normal_search():
return feed_search(request.args.get("query").strip())
@app.route("/opds/new")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_new():
off = request.args.get("offset") or 0
entries, __, pagination = fill_indexpage((int(off) / (int(config.config_books_per_page)) + 1),
@ -723,7 +761,7 @@ def feed_new():
@app.route("/opds/discover")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_discover():
entries = db.session.query(db.Books).filter(common_filters()).order_by(func.random())\
.limit(config.config_books_per_page)
@ -732,7 +770,7 @@ def feed_discover():
@app.route("/opds/rated")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_best_rated():
off = request.args.get("offset") or 0
entries, __, pagination = fill_indexpage((int(off) / (int(config.config_books_per_page)) + 1),
@ -741,7 +779,7 @@ def feed_best_rated():
@app.route("/opds/hot")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_hot():
off = request.args.get("offset") or 0
all_books = ub.session.query(ub.Downloads, ub.func.count(ub.Downloads.book_id)).order_by(
@ -766,7 +804,7 @@ def feed_hot():
@app.route("/opds/author")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_authorindex():
off = request.args.get("offset") or 0
entries = db.session.query(db.Authors).join(db.books_authors_link).join(db.Books).filter(common_filters())\
@ -777,7 +815,7 @@ def feed_authorindex():
@app.route("/opds/author/<int:book_id>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_author(book_id):
off = request.args.get("offset") or 0
entries, __, pagination = fill_indexpage((int(off) / (int(config.config_books_per_page)) + 1),
@ -786,7 +824,7 @@ def feed_author(book_id):
@app.route("/opds/publisher")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_publisherindex():
off = request.args.get("offset") or 0
entries = db.session.query(db.Publishers).join(db.books_publishers_link).join(db.Books).filter(common_filters())\
@ -797,7 +835,7 @@ def feed_publisherindex():
@app.route("/opds/publisher/<int:book_id>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_publisher(book_id):
off = request.args.get("offset") or 0
entries, __, pagination = fill_indexpage((int(off) / (int(config.config_books_per_page)) + 1),
@ -807,7 +845,7 @@ def feed_publisher(book_id):
@app.route("/opds/category")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_categoryindex():
off = request.args.get("offset") or 0
entries = db.session.query(db.Tags).join(db.books_tags_link).join(db.Books).filter(common_filters())\
@ -818,7 +856,7 @@ def feed_categoryindex():
@app.route("/opds/category/<int:book_id>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_category(book_id):
off = request.args.get("offset") or 0
entries, __, pagination = fill_indexpage((int(off) / (int(config.config_books_per_page)) + 1),
@ -827,7 +865,7 @@ def feed_category(book_id):
@app.route("/opds/series")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_seriesindex():
off = request.args.get("offset") or 0
entries = db.session.query(db.Series).join(db.books_series_link).join(db.Books).filter(common_filters())\
@ -838,7 +876,7 @@ def feed_seriesindex():
@app.route("/opds/series/<int:book_id>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_series(book_id):
off = request.args.get("offset") or 0
entries, __, pagination = fill_indexpage((int(off) / (int(config.config_books_per_page)) + 1),
@ -848,7 +886,7 @@ def feed_series(book_id):
@app.route("/opds/shelfindex/", defaults={'public': 0})
@app.route("/opds/shelfindex/<string:public>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_shelfindex(public):
off = request.args.get("offset") or 0
if public is not 0:
@ -863,7 +901,7 @@ def feed_shelfindex(public):
@app.route("/opds/shelf/<int:book_id>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_shelf(book_id):
off = request.args.get("offset") or 0
if current_user.is_anonymous:
@ -887,7 +925,7 @@ def feed_shelf(book_id):
@app.route("/opds/download/<book_id>/<book_format>/")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
@download_required
def get_opds_download_link(book_id, book_format):
book_format = book_format.split(".")[0]
@ -911,7 +949,7 @@ def get_opds_download_link(book_id, book_format):
@app.route("/ajax/book/<string:uuid>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def get_metadata_calibre_companion(uuid):
entry = db.session.query(db.Books).filter(db.Books.uuid.like("%" + uuid + "%")).first()
if entry is not None:
@ -2157,7 +2195,7 @@ def serve_book(book_id, book_format):
@app.route("/opds/cover_240_240/<path:book_id>")
@app.route("/opds/cover_90_90/<path:book_id>")
@app.route("/opds/cover/<path:book_id>")
@requires_basic_auth_if_no_ano
@basic_auth_required_check(config.config_use_ldap)
def feed_get_cover(book_id):
book = db.session.query(db.Books).filter(db.Books.id == book_id).first()
return helper.get_book_cover(book.path)
@ -2360,20 +2398,22 @@ def login():
return redirect(url_for('basic_configuration'))
if current_user is not None and current_user.is_authenticated:
return redirect(url_for('index'))
if config.config_use_ldap and not ldap_support:
flash(_(u"Cannot activate LDAP authentication"), category="error")
if request.method == "POST":
form = request.form.to_dict()
user = ub.session.query(ub.User).filter(func.lower(ub.User.nickname) == form['username'].strip().lower()).first()
if config.config_use_ldap and user:
import ldap
if ldap_support and config.config_use_ldap and user:
try:
ub.User.try_login(form['username'], form['password'])
login_user(user, remember=True)
flash(_(u"you are now logged in as: '%(nickname)s'", nickname=user.nickname), category="success")
return redirect_back(url_for("index"))
except ldap.INVALID_CREDENTIALS:
ipAdress = request.headers.get('X-Forwarded-For', request.remote_addr)
app.logger.info('LDAP Login failed for user "' + form['username'] + '" IP-adress: ' + ipAdress)
flash(_(u"Wrong Username or Password"), category="error")
if ldap.bind_user(form['username'], form['password']) is not None:
login_user(user, remember=True)
flash(_(u"you are now logged in as: '%(nickname)s'", nickname=user.nickname), category="success")
return redirect_back(url_for("index"))
except LDAPException as exception:
app.logger.error( 'Login Error: ' + str(exception))
ipAdress = request.headers.get('X-Forwarded-For', request.remote_addr)
app.logger.info('LDAP Login failed for user "' + form['username'] + ', IP-address :' + ipAdress)
flash(_(u"Wrong Username or Password"), category="error")
elif user and check_password_hash(user.password, form['password']) and user.nickname is not "Guest":
login_user(user, remember=True)
flash(_(u"you are now logged in as: '%(nickname)s'", nickname=user.nickname), category="success")
@ -3099,7 +3139,7 @@ def configuration_helper(origin):
if "config_ebookconverter" in to_save:
content.config_ebookconverter = int(to_save["config_ebookconverter"])
#LDAP configuratop,
#LDAP configuration,
if "config_use_ldap" in to_save and to_save["config_use_ldap"] == "on":
if not "config_ldap_provider_url" in to_save or not "config_ldap_dn" in to_save:
ub.session.commit()
@ -3108,11 +3148,43 @@ def configuration_helper(origin):
gdrive=gdriveutils.gdrive_support, gdriveError=gdriveError,
goodreads=goodreads_support, title=_(u"Basic Configuration"),
page="config")
elif not "config_ldap_serv_username" in to_save or not "config_ldap_serv_password" in to_save:
ub.session.commit()
flash(_(u'Please enter a LDAP service account and password'), category="error")
return render_title_template("config_edit.html", content=config, origin=origin,
gdrive=gdriveutils.gdrive_support, gdriveError=gdriveError,
goodreads=goodreads_support, title=_(u"Basic Configuration"),
page="config")
else:
content.config_use_ldap = 1
content.config_ldap_provider_url = to_save["config_ldap_provider_url"]
content.config_ldap_port = to_save["config_ldap_port"]
content.config_ldap_schema = to_save["config_ldap_schema"]
content.config_ldap_serv_username = to_save["config_ldap_serv_username"]
content.config_ldap_serv_password = to_save["config_ldap_serv_password"]
if content.config_ldap_use_ssl in to_save and to_save["config_ldap_use_ssl"] == "on":
content.config_ldap_use_ssl = 1
if content.config_ldap_use_tls in to_save and to_save["config_ldap_use_tls"] == "on":
content.config_ldap_use_tls = 1
if content.config_ldap_require_cert in to_save and to_save["config_ldap_require_cert"] == "on":
content.config_ldap_require_cert = 1
if "config_ldap_cert_path " in to_save:
if content.config_ldap_cert_path != to_save["config_ldap_cert_path "]:
if os.path.isfile(to_save["config_ldap_cert_path "]) or to_save["config_ldap_cert_path "] is u"":
content.config_certfile = to_save["config_ldap_cert_path "]
else:
ub.session.commit()
flash(_(u'Certfile location is not valid, please enter correct path'), category="error")
return render_title_template("config_edit.html", content=config, origin=origin,
gdrive=gdriveutils.gdrive_support, gdriveError=gdriveError,
goodreads=goodreads_support, title=_(u"Basic Configuration"),
page="config")
content.config_ldap_dn = to_save["config_ldap_dn"]
content.config_ldap_user_object = to_save["config_ldap_user_object"]
if content.config_ldap_openldap in to_save and to_save["config_ldap_openldap"] == "on":
content.config_ldap_openldap = 1
db_change = True
reboot_required = True
# Remote login configuration
content.config_remote_login = ("config_remote_login" in to_save and to_save["config_remote_login"] == "on")

3
optional-requirements-ldap.txt
Unescape Escape View File

@ -1 +1,2 @@
python_ldap>=3.0.0
python_ldap>=3.0.0
flask-simpleldap
Write Preview
Loading…
Cancel
Save