Compare commits
66 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c5e8e6f79a | ||
|
|
d049e4534a | ||
|
|
ed63dd0527 | ||
|
|
062f17e0f7 | ||
|
|
48b1623c95 | ||
|
|
7ac46ad430 | ||
|
|
a382fbc194 | ||
|
|
a107b6444c | ||
|
|
4bc203a757 | ||
|
|
3a560801d9 | ||
|
|
a99e70f3c4 | ||
|
|
c4775c7d7c | ||
|
|
f645454a74 | ||
|
|
ba1e78f2a8 | ||
|
|
ad051a0e18 | ||
|
|
810aa1d0e9 | ||
|
|
a6448a51e9 | ||
|
|
a0e70e4f1f | ||
|
|
682d15d62e | ||
|
|
46cdf93fd5 | ||
|
|
b42604f22c | ||
|
|
8995a35f70 | ||
|
|
489b158b50 | ||
|
|
da9a27b34d | ||
|
|
c2c20cc861 | ||
|
|
41c172b587 | ||
|
|
39ef130adc | ||
|
|
c40b47135c | ||
|
|
ba73f282ec | ||
|
|
9cde93be05 | ||
|
|
19d3b30c93 | ||
|
|
256c887d8f | ||
|
|
ca0dc33cb7 | ||
|
|
df51a6dbe0 | ||
|
|
6263029df9 | ||
|
|
6992f2c8ed | ||
|
|
5e62caedf6 | ||
|
|
2688db1d0c | ||
|
|
547ce9a744 | ||
|
|
2b982babbb | ||
|
|
025d5fba97 | ||
|
|
4617bf690b | ||
|
|
f25cb05c8b | ||
|
|
56be9a450c | ||
|
|
a66affb1e1 | ||
|
|
57da632558 | ||
|
|
d13e6a475d | ||
|
|
90e7681c35 | ||
|
|
831b810e81 | ||
|
|
34614356c9 | ||
|
|
fcebf5f33d | ||
|
|
eca1d9881e | ||
|
|
53a4ba6b4f | ||
|
|
fd4f45354b | ||
|
|
a8d72465d9 | ||
|
|
2b58ad96e3 | ||
|
|
c427f472db | ||
|
|
0677da6a81 | ||
|
|
204b064bb7 | ||
|
|
f97d76cca6 | ||
|
|
a67931a241 | ||
|
|
8845734b91 | ||
|
|
fb6f654738 | ||
|
|
4da7bac9f9 | ||
|
|
74426fe812 | ||
|
|
1e60e141f3 |
1
.env
1
.env
@@ -4,3 +4,4 @@ MYMAIL=MYEMAIL@MYDOMAIN.TLD
|
|||||||
MYDATA=/data
|
MYDATA=/data
|
||||||
LOGIN_TEXT=username
|
LOGIN_TEXT=username
|
||||||
COLLAB_TEXT=Direct share with collaborators is enabled only for activated users!
|
COLLAB_TEXT=Direct share with collaborators is enabled only for activated users!
|
||||||
|
ADMIN_IS_SYSADMIN=false
|
||||||
|
|||||||
3
Makefile
3
Makefile
@@ -2,7 +2,8 @@ include .env
|
|||||||
|
|
||||||
build:
|
build:
|
||||||
docker build --build-arg login_text="${LOGIN_TEXT}" \
|
docker build --build-arg login_text="${LOGIN_TEXT}" \
|
||||||
--build-arg collab_text="${COLLAB_TEXT}" \
|
--build-arg collab_text="${COLLAB_TEXT}" \
|
||||||
|
--build-arg admin_is_sysadmin="${ADMIN_IS_SYSADMIN}" \
|
||||||
-t "ldap-overleaf-sl" ldap-overleaf-sl
|
-t "ldap-overleaf-sl" ldap-overleaf-sl
|
||||||
|
|
||||||
clean: check_clean
|
clean: check_clean
|
||||||
|
|||||||
83
README.md
83
README.md
@@ -7,11 +7,23 @@ edition. Currently this repo uses sharelatex:latest.
|
|||||||
The inital idea for this implementation was taken from
|
The inital idea for this implementation was taken from
|
||||||
[worksasintended](https://github.com/worksasintended).
|
[worksasintended](https://github.com/worksasintended).
|
||||||
|
|
||||||
|
## BREAKING CHANGE
|
||||||
|
be careful if you try to migrate from 3.3.2! Backup your machines and data.
|
||||||
|
The migration paths hould be:
|
||||||
|
- Backup Your machines and Data
|
||||||
|
- run latest 3.5 sharelatex image and run the migration scripts
|
||||||
|
- run this sharelatex image (4.1.1) and run the migrations scripts
|
||||||
|
|
||||||
### Limitations:
|
|
||||||
|
|
||||||
This implementation uses *no* ldap bind user - it tries to bind to the ldap (using ldapts) with
|
## Limitations:
|
||||||
the uid and credentials of the user which tries to login.
|
NEW: This version provides the possibility to use a separate ldap bind user. It does this just to find the proper BIND DN and record for the provided email, so it is possible that users from different groups / OUs can login.
|
||||||
|
Afterwards it tries to bind to the ldap (using ldapts) with the user DN and credentials of the user which tries to login. No hassle of password hashing for LDAP pwds!
|
||||||
|
|
||||||
|
If you upgrade from an older commit:
|
||||||
|
**Note**:
|
||||||
|
- you have to add: uid=%u to your BIND_DN
|
||||||
|
- LDAP_GROUP_FILTER is now named LDAP_USER_FILTER
|
||||||
|
- Import of contacts from LDAP is now controlled by LDAP_CONTACT_FILTER
|
||||||
|
|
||||||
|
|
||||||
Only valid LDAP users or email users registered by an admin can login.
|
Only valid LDAP users or email users registered by an admin can login.
|
||||||
@@ -56,55 +68,67 @@ MYDATA=/data
|
|||||||
- sharelatex: all projects, tmp files, user files templates and ...
|
- sharelatex: all projects, tmp files, user files templates and ...
|
||||||
- letsencrypt: https certificates
|
- letsencrypt: https certificates
|
||||||
|
|
||||||
*MYDOMAIN* is the FQDN for sharelatex and traefik (letsencrypt) <br/>
|
*MYDOMAIN* is the FQDN for sharelatex and traefik (letsencrypt) or certbot <br/>
|
||||||
*MYDOMAIN*:8443 Traefik Dashboard - Login uses traefik/user.htpasswd : user:admin pass:adminPass change this (e.g. generate a password with htpasswd)
|
*MYDOMAIN*:8443 Traefik Dashboard (docker-compose-traefik.yml) - Login uses traefik/user.htpasswd : user:admin pass:adminPass change this (e.g. generate a password with htpasswd)
|
||||||
*MYMAIL* is the admin mailaddress
|
*MYMAIL* is the admin mailaddress
|
||||||
|
|
||||||
```
|
```
|
||||||
LOGIN_TEXT=username
|
LOGIN_TEXT=username
|
||||||
COLLAB_TEXT=Direct share with collaborators is enabled only for activated users!
|
COLLAB_TEXT=Direct share with collaborators is enabled only for activated users!
|
||||||
|
ADMIN_IS_SYSADMIN=false
|
||||||
```
|
```
|
||||||
*LOGIN_TEXT* : displayed instead of email-adress field (login.pug) <br/>
|
*LOGIN_TEXT* : displayed instead of email-adress field (login.pug) <br/>
|
||||||
*COLLAB_TEXT* : displayed for email invitation (share.pug)
|
*COLLAB_TEXT* : displayed for email invitation (share.pug)<br/>
|
||||||
|
*ADMIN_IS_SYSADMIN* : false or true (if ``false`` isAdmin group is allowed to add users to sharelatex and post messages. if ``true`` isAdmin group is allowed to logout other users / set maintenance mode)
|
||||||
|
|
||||||
|
|
||||||
### LDAP Configuration
|
### LDAP Configuration
|
||||||
|
|
||||||
Edit [docker-compose.yml](docker-compose.yml) to fit your local setup.
|
Edit [docker-compose.treafik.yml](docker-compose.traefik.yml) or [docker-compose.certbot.yml](docker-compose.certbot.yml) to fit your local setup.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
LDAP_SERVER: ldaps://LDAPSERVER:636
|
LDAP_SERVER: ldaps://LDAPSERVER:636
|
||||||
LDAP_BASE: dc=DOMAIN,dc=TLD
|
LDAP_BASE: dc=DOMAIN,dc=TLD
|
||||||
LDAP_BINDDN: ou=someunit,ou=people,dc=DOMAIN,dc=TLS
|
# If LDAP_BINDDN is set, the ldap bind happens directly by using the provided DN
|
||||||
# By default tries to bind directly with the ldap user - this user has to be in the LDAP GROUP
|
# All occurrences of `%u` get replaced by the entered uid.
|
||||||
# you have to set a group filter a minimal groupfilter would be: '(objectClass=person)'
|
# All occurrences of `%m`get replaced by the entered mail.
|
||||||
LDAP_GROUP_FILTER: '(memberof=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)'
|
LDAP_BINDDN: uid=%u,ou=people,dc=DOMAIN,dc=TLD
|
||||||
|
LDAP_BIND_USER: cn=ldap_reader,dc=DOMAIN,dc=TLS
|
||||||
|
LDAP_BIND_PW: TopSecret
|
||||||
|
# users need to match this filter to login.
|
||||||
|
# All occurrences of `%u` get replaced by the entered uid.
|
||||||
|
# All occurrences of `%m`get replaced by the entered mail.
|
||||||
|
LDAP_USER_FILTER: '(&(memberof=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)(uid=%u))'
|
||||||
|
|
||||||
# If user is in ADMIN_GROUP on user creation (first login) isAdmin is set to true.
|
# If user is in ADMIN_GROUP on user creation (first login) isAdmin is set to true.
|
||||||
# Admin Users can invite external (non ldap) users. This feature makes only sense
|
# Admin Users can invite external (non ldap) users. This feature makes only sense
|
||||||
# when ALLOW_EMAIL_LOGIN is set to 'true'. Additionally admins can send
|
# when ALLOW_EMAIL_LOGIN is set to 'true'. Additionally admins can send
|
||||||
# system wide messages.
|
# system wide messages.
|
||||||
|
# All occurrences of `%u` get replaced by the entered uid.
|
||||||
|
# All occurrences of `%m`get replaced by the entered mail.
|
||||||
#LDAP_ADMIN_GROUP_FILTER: '(memberof=cn=ADMINGROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)'
|
#LDAP_ADMIN_GROUP_FILTER: '(memberof=cn=ADMINGROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)'
|
||||||
ALLOW_EMAIL_LOGIN: 'false'
|
ALLOW_EMAIL_LOGIN: 'false'
|
||||||
|
|
||||||
# All users in the LDAP_GROUP_FILTER are loaded from the ldap server into contacts.
|
# All users in the LDAP_CONTACT_FILTER are loaded from the ldap server into contacts.
|
||||||
|
LDAP_CONTACT_FILTER: (objectClass=person)
|
||||||
LDAP_CONTACTS: 'false'
|
LDAP_CONTACTS: 'false'
|
||||||
```
|
```
|
||||||
|
|
||||||
### LDAP Contacts
|
### LDAP Contacts
|
||||||
|
|
||||||
If you enable LDAP_CONTACTS, then all users in LDAP_GROUP_FILTER are loaded from the ldap server into the contacts.
|
If you enable LDAP_CONTACTS, then all users in LDAP_CONTACT_FILTER are loaded from the ldap server into the contacts.
|
||||||
At the moment this happens every time you click on "Share" within a project.
|
At the moment this happens every time you click on "Share" within a project.
|
||||||
The user search happens without bind - so if your LDAP needs a bind you can adapt this in the
|
|
||||||
function `getLdapContacts()` in ContactsController.js (line 92)
|
|
||||||
if you want to enable this function set:
|
if you want to enable this function set:
|
||||||
```
|
```
|
||||||
|
LDAP_CONTACT_FILTER: (objectClass=person)
|
||||||
LDAP_CONTACTS: 'true'
|
LDAP_CONTACTS: 'true'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Sharelatex Configuration
|
### Sharelatex Configuration
|
||||||
|
|
||||||
Edit SHARELATEX_ environment variables in [docker-compose.yml](docker-compose.yml) to fit your local setup
|
Edit SHARELATEX_ environment variables in [docker-compose.traefik.yml](docker-compose.traefik.yml) or [docker-compose.certbot.yml](docker-compose.certbot.yml) to fit your local setup
|
||||||
(e.g. proper SMTP server, Header, Footer, App Name,...). See https://github.com/overleaf/overleaf/wiki/Quick-Start-Guide for more details.
|
(e.g. proper SMTP server, Header, Footer, App Name,...). See https://github.com/overleaf/overleaf/wiki/Quick-Start-Guide for more details.
|
||||||
|
|
||||||
## Installation, Usage and Inital startup
|
## Installation, Usage and Inital startup
|
||||||
@@ -126,15 +150,34 @@ make
|
|||||||
```
|
```
|
||||||
to generate the ldap-overleaf-sl docker image.
|
to generate the ldap-overleaf-sl docker image.
|
||||||
|
|
||||||
|
use the command
|
||||||
|
```
|
||||||
|
docker network create web
|
||||||
|
```
|
||||||
|
to create a network for the docker instances.
|
||||||
|
|
||||||
|
|
||||||
|
## Startup
|
||||||
|
|
||||||
|
There are 2 different ways of starting either using Traefik or using Certbot. Adapt the one you want to use.
|
||||||
|
|
||||||
|
### Using Traefik
|
||||||
|
|
||||||
Then start docker containers (with loadbalancer):
|
Then start docker containers (with loadbalancer):
|
||||||
```
|
```
|
||||||
export NUMINSTANCES=1
|
export NUMINSTANCES=1
|
||||||
docker-compose up -d --scale sharelaatex=NUMINSTANCES
|
docker-compose -f docker-compose.traefik.yml up -d --scale sharelatex=$NUMINSTANCES
|
||||||
```
|
```
|
||||||
|
|
||||||
*Known Issue:*
|
### Using Certbot
|
||||||
- Works up to sharelatex 2.3.1. After that at least issue #5 is introduced.
|
Enable line 65/66 and 69/70 in ldapoverleaf-sl/Dockerfile and ``make`` again.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
docker-compose -f docker-compose.certbot.yml up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## Upgrading
|
||||||
|
*Be aware:* if you upgrade from a previous installation check your docker image version
|
||||||
|
|
||||||
|
E.g.: Mongodb: You cannot upgrade directly from mongo 4.2 to 5.0. You must first upgrade from 4.2 to 4.4.
|
||||||
|
Do not upgrade without proper testing and Backup your installation beforehand.
|
||||||
|
|||||||
157
docker-compose.certbot.yml
Normal file
157
docker-compose.certbot.yml
Normal file
@@ -0,0 +1,157 @@
|
|||||||
|
version: "2.2"
|
||||||
|
services:
|
||||||
|
sharelatex:
|
||||||
|
restart: always
|
||||||
|
image: ldap-overleaf-sl
|
||||||
|
container_name: ldap-overleaf-sl
|
||||||
|
depends_on:
|
||||||
|
mongo:
|
||||||
|
condition: service_healthy
|
||||||
|
redis:
|
||||||
|
condition: service_healthy
|
||||||
|
simple-certbot:
|
||||||
|
condition: service_started
|
||||||
|
privileged: false
|
||||||
|
ports:
|
||||||
|
- 443:443
|
||||||
|
links:
|
||||||
|
- mongo
|
||||||
|
- redis
|
||||||
|
- simple-certbot
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/sharelatex:/var/lib/sharelatex
|
||||||
|
- ${MYDATA}/letsencrypt:/etc/letsencrypt
|
||||||
|
- ${MYDATA}/letsencrypt/live/${MYDOMAIN}/:/etc/letsencrypt/certs/domain
|
||||||
|
environment:
|
||||||
|
SHARELATEX_APP_NAME: Overleaf
|
||||||
|
SHARELATEX_MONGO_URL: mongodb://mongo/sharelatex
|
||||||
|
SHARELATEX_SITE_URL: https://${MYDOMAIN}
|
||||||
|
SHARELATEX_NAV_TITLE: Overleaf - run by ${MYDOMAIN}
|
||||||
|
#SHARELATEX_HEADER_IMAGE_URL: https://${MYDOMAIN}/logo.svg
|
||||||
|
SHARELATEX_ADMIN_EMAIL: ${MYMAIL}
|
||||||
|
SHARELATEX_LEFT_FOOTER: '[{"text": "Powered by <a href=\"https://www.sharelatex.com\">ShareLaTeX</a> 2016"} ]'
|
||||||
|
SHARELATEX_RIGHT_FOOTER: '[{"text": "LDAP Overleaf (beta)"} ]'
|
||||||
|
SHARELATEX_EMAIL_FROM_ADDRESS: "noreply@${MYDOMAIN}"
|
||||||
|
# SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID:
|
||||||
|
# SHARELATEX_EMAIL_AWS_SES_SECRET_KEY:
|
||||||
|
SHARELATEX_EMAIL_SMTP_HOST: smtp.${MYDOMAIN}
|
||||||
|
SHARELATEX_EMAIL_SMTP_PORT: 587
|
||||||
|
SHARELATEX_EMAIL_SMTP_SECURE: "false"
|
||||||
|
# SHARELATEX_EMAIL_SMTP_USER:
|
||||||
|
# SHARELATEX_EMAIL_SMTP_PASS:
|
||||||
|
# SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH: true
|
||||||
|
# SHARELATEX_EMAIL_SMTP_IGNORE_TLS: false
|
||||||
|
SHARELATEX_CUSTOM_EMAIL_FOOTER: "This system is run by ${MYDOMAIN} - please contact ${MYMAIL} if you experience any issues."
|
||||||
|
|
||||||
|
# make public links accessible w/o login (link sharing issue)
|
||||||
|
# https://github.com/overleaf/docker-image/issues/66
|
||||||
|
# https://github.com/overleaf/overleaf/issues/628
|
||||||
|
# https://github.com/overleaf/web/issues/367
|
||||||
|
# Fixed in 2.0.2 (Release date: 2019-11-26)
|
||||||
|
SHARELATEX_ALLOW_PUBLIC_ACCESS: "true"
|
||||||
|
SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING: "true"
|
||||||
|
|
||||||
|
SHARELATEX_SECURE_COOKIE: "true"
|
||||||
|
SHARELATEX_BEHIND_PROXY: "true"
|
||||||
|
|
||||||
|
LDAP_SERVER: ldaps://LDAPSERVER:636
|
||||||
|
LDAP_BASE: ou=people,dc=DOMAIN,dc=TLD
|
||||||
|
|
||||||
|
### There are to ways get users from the ldap server
|
||||||
|
|
||||||
|
## NO LDAP BIND USER:
|
||||||
|
# Tries directly to bind with the login user (as uid)
|
||||||
|
# LDAP_BINDDN: uid=%u,ou=someunit,ou=people,dc=DOMAIN,dc=TLD
|
||||||
|
|
||||||
|
## Or you can use ai global LDAP_BIND_USER
|
||||||
|
# LDAP_BIND_USER:
|
||||||
|
# LDAP_BIND_PW:
|
||||||
|
|
||||||
|
# Only allow users matching LDAP_USER_FILTER
|
||||||
|
LDAP_USER_FILTER: "(memberof=cn=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)"
|
||||||
|
|
||||||
|
# If user is in ADMIN_GROUP on user creation (first login) isAdmin is set to true.
|
||||||
|
# Admin Users can invite external (non ldap) users. This feature makes only sense
|
||||||
|
# when ALLOW_EMAIL_LOGIN is set to 'true'. Additionally admins can send
|
||||||
|
# system wide messages.
|
||||||
|
LDAP_ADMIN_GROUP_FILTER: "(memberof=cn=ADMINGROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)"
|
||||||
|
ALLOW_EMAIL_LOGIN: "true"
|
||||||
|
|
||||||
|
# All users in the LDAP_CONTACT_FILTER are loaded from the ldap server into contacts.
|
||||||
|
LDAP_CONTACT_FILTER: "(memberof=cn=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)"
|
||||||
|
LDAP_CONTACTS: "false"
|
||||||
|
|
||||||
|
# Same property, unfortunately with different names in
|
||||||
|
# different locations
|
||||||
|
SHARELATEX_REDIS_HOST: redis
|
||||||
|
REDIS_HOST: redis
|
||||||
|
REDIS_PORT: 6379
|
||||||
|
|
||||||
|
ENABLED_LINKED_FILE_TYPES: "url,project_file"
|
||||||
|
|
||||||
|
# Enables Thumbnail generation using ImageMagick
|
||||||
|
ENABLE_CONVERSIONS: "true"
|
||||||
|
|
||||||
|
mongo:
|
||||||
|
restart: always
|
||||||
|
image: mongo:4.4
|
||||||
|
container_name: mongo
|
||||||
|
expose:
|
||||||
|
- 27017
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/mongo_data:/data/db
|
||||||
|
healthcheck:
|
||||||
|
test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
|
||||||
|
interval: 10s
|
||||||
|
timeout: 10s
|
||||||
|
retries: 5
|
||||||
|
command: "--replSet overleaf"
|
||||||
|
|
||||||
|
# See also: https://github.com/overleaf/overleaf/issues/1120
|
||||||
|
mongoinit:
|
||||||
|
image: mongo:4.4
|
||||||
|
# this container will exit after executing the command
|
||||||
|
restart: "no"
|
||||||
|
depends_on:
|
||||||
|
mongo:
|
||||||
|
condition: service_healthy
|
||||||
|
entrypoint:
|
||||||
|
[
|
||||||
|
"mongo",
|
||||||
|
"--host",
|
||||||
|
"mongo:27017",
|
||||||
|
"--eval",
|
||||||
|
'rs.initiate({ _id: "overleaf", members: [ { _id: 0, host: "mongo:27017" } ] })',
|
||||||
|
]
|
||||||
|
|
||||||
|
redis:
|
||||||
|
restart: always
|
||||||
|
image: redis:6.2
|
||||||
|
container_name: redis
|
||||||
|
expose:
|
||||||
|
- 6379
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/redis_data:/data
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "redis-cli", "ping"]
|
||||||
|
interval: 10s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 5
|
||||||
|
|
||||||
|
simple-certbot:
|
||||||
|
restart: always
|
||||||
|
image: certbot/certbot
|
||||||
|
container_name: simple-certbot
|
||||||
|
ports:
|
||||||
|
- 80:80
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/letsencrypt:/etc/letsencrypt
|
||||||
|
# a bit hacky but this docker image uses very little disk-space
|
||||||
|
# best practices for ssl and nginx are set in the ldap-overleaf-sl Dockerfile
|
||||||
|
entrypoint:
|
||||||
|
- "/bin/sh"
|
||||||
|
- -c
|
||||||
|
- |
|
||||||
|
trap exit TERM;\
|
||||||
|
certbot certonly --standalone -d ${MYDOMAIN} --agree-tos -m ${MYMAIL} -n ; \
|
||||||
|
while :; do certbot renew; sleep 240h & wait $${!}; done;
|
||||||
242
docker-compose.traefik.yml
Normal file
242
docker-compose.traefik.yml
Normal file
@@ -0,0 +1,242 @@
|
|||||||
|
version: "2.2"
|
||||||
|
services:
|
||||||
|
traefik:
|
||||||
|
image: traefik:latest
|
||||||
|
container_name: traefik
|
||||||
|
restart: unless-stopped
|
||||||
|
security_opt:
|
||||||
|
- no-new-privileges:true
|
||||||
|
networks:
|
||||||
|
- web
|
||||||
|
ports:
|
||||||
|
- 80:80
|
||||||
|
- 443:443
|
||||||
|
- 8443:8443
|
||||||
|
# - 8080:8080
|
||||||
|
# - 27017:27017
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/letsencrypt:/letsencrypt
|
||||||
|
- /etc/localtime:/etc/localtime:ro
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||||
|
- ./traefik/dynamic_conf.yml:/dynamic_conf.yml
|
||||||
|
- ./traefik/users.htpasswd:/users.htpasswd
|
||||||
|
command:
|
||||||
|
- "--api=true"
|
||||||
|
- "--api.dashboard=true"
|
||||||
|
#- "--api.insecure=true" # provides the dashboard on http://IPADRESS:8080
|
||||||
|
- "--providers.docker=true"
|
||||||
|
- "--ping"
|
||||||
|
- "--providers.docker.network=web"
|
||||||
|
- "--providers.docker.exposedbydefault=false"
|
||||||
|
- "--providers.file.filename=/dynamic_conf.yml"
|
||||||
|
- "--entrypoints.web.address=:80"
|
||||||
|
- "--entrypoints.web-secure.address=:443"
|
||||||
|
- "--entrypoints.web-admin.address=:8443"
|
||||||
|
- "--certificatesresolvers.myhttpchallenge.acme.httpchallenge=true"
|
||||||
|
- "--certificatesresolvers.myhttpchallenge.acme.httpchallenge.entrypoint=web"
|
||||||
|
- "--certificatesresolvers.myhttpchallenge.acme.email=${MYMAIL}"
|
||||||
|
- "--certificatesresolvers.myhttpchallenge.acme.storage=/letsencrypt/acme.json"
|
||||||
|
- "--entrypoints.mongo.address=:27017"
|
||||||
|
#- --certificatesresolvers.myhttpchallenge.acme.caserver=https://acme-v02.api.letsencrypt.org/directory
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
# To Fix enable dashboard on port 8443
|
||||||
|
- "traefik.http.routers.dashboard.entrypoints=web-admin"
|
||||||
|
- "traefik.http.routers.dashboard.rule=Host(`${MYDOMAIN}`)"
|
||||||
|
# - "traefik.http.routers.dashboard.rule=Host(`traefik.${MYDOMAIN}`) && (PathPrefix(`/api`) || PathPrefix(`/dashboard`))"
|
||||||
|
- "traefik.http.routers.dashboard.tls=true"
|
||||||
|
- "traefik.http.routers.dashboard.middlewares=auth"
|
||||||
|
- "traefik.http.middlewares.auth.basicauth.usersfile=/users.htpasswd"
|
||||||
|
- "traefik.http.routers.dashboard.service=api@internal"
|
||||||
|
- "traefik.http.middlewares.sslheader.headers.customrequestheaders.X-Forwarded-Proto=https"
|
||||||
|
- "traefik.http.routers.proxy-https.entrypoints=web-secure"
|
||||||
|
- "traefik.http.routers.proxy-https.rule=Host(`${MYDOMAIN}`)"
|
||||||
|
|
||||||
|
logging:
|
||||||
|
driver: "json-file"
|
||||||
|
options:
|
||||||
|
max-size: "10m"
|
||||||
|
max-file: "1"
|
||||||
|
|
||||||
|
sharelatex:
|
||||||
|
restart: always
|
||||||
|
image: ldap-overleaf-sl:latest
|
||||||
|
depends_on:
|
||||||
|
mongo:
|
||||||
|
condition: service_healthy
|
||||||
|
redis:
|
||||||
|
condition: service_healthy
|
||||||
|
traefik:
|
||||||
|
condition: service_started
|
||||||
|
#simple-certbot:
|
||||||
|
# condition: service_started
|
||||||
|
privileged: false
|
||||||
|
networks:
|
||||||
|
- web
|
||||||
|
expose:
|
||||||
|
- 80
|
||||||
|
- 443
|
||||||
|
links:
|
||||||
|
- mongo
|
||||||
|
- redis
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/sharelatex:/var/lib/sharelatex
|
||||||
|
- ${MYDATA}/letsencrypt:/etc/letsencrypt:ro
|
||||||
|
# - ${MYDATA}/letsencrypt/live/${MYDOMAIN}/:/etc/letsencrypt/certs/domain
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
# global redirect to https
|
||||||
|
- "traefik.http.routers.http-catchall.rule=hostregexp(`${MYDOMAIN}`)"
|
||||||
|
- "traefik.http.routers.http-catchall.entrypoints=web"
|
||||||
|
- "traefik.http.routers.http-catchall.middlewares=redirect-to-https"
|
||||||
|
- "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
|
||||||
|
# handle https traffic
|
||||||
|
- "traefik.http.routers.sharel-secured.rule=Host(`${MYDOMAIN}`)"
|
||||||
|
- "traefik.http.routers.sharel-secured.tls=true"
|
||||||
|
- "traefik.http.routers.sharel-secured.tls.certresolver=myhttpchallenge"
|
||||||
|
- "traefik.http.routers.sharel-secured.entrypoints=web-secure"
|
||||||
|
- "traefik.http.middlewares.sharel-secured.forwardauth.trustForwardHeader=true"
|
||||||
|
# Docker loadbalance
|
||||||
|
- "traefik.http.services.sharel.loadbalancer.server.port=80"
|
||||||
|
- "traefik.http.services.sharel.loadbalancer.server.scheme=http"
|
||||||
|
- "traefik.http.services.sharel.loadbalancer.sticky.cookie=true"
|
||||||
|
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.name=io"
|
||||||
|
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.httponly=true"
|
||||||
|
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.secure=true"
|
||||||
|
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.samesite=io"
|
||||||
|
|
||||||
|
environment:
|
||||||
|
SHARELATEX_APP_NAME: Overleaf
|
||||||
|
SHARELATEX_MONGO_URL: mongodb://mongo/sharelatex
|
||||||
|
SHARELATEX_SITE_URL: https://${MYDOMAIN}
|
||||||
|
SHARELATEX_NAV_TITLE: Overleaf - run by ${MYDOMAIN}
|
||||||
|
#SHARELATEX_HEADER_IMAGE_URL: https://${MYDOMAIN}/logo.svg
|
||||||
|
SHARELATEX_ADMIN_EMAIL: ${MYMAIL}
|
||||||
|
SHARELATEX_LEFT_FOOTER: '[{"text": "Powered by <a href=\"https://www.sharelatex.com\">ShareLaTeX</a> 2016"} ]'
|
||||||
|
SHARELATEX_RIGHT_FOOTER: '[{"text": "LDAP Overleaf (beta)"} ]'
|
||||||
|
SHARELATEX_EMAIL_FROM_ADDRESS: "noreply@${MYDOMAIN}"
|
||||||
|
SHARELATEX_EMAIL_SMTP_HOST: smtp.${MYDOMAIN}
|
||||||
|
SHARELATEX_EMAIL_SMTP_PORT: 587
|
||||||
|
SHARELATEX_EMAIL_SMTP_SECURE: "false"
|
||||||
|
# SHARELATEX_EMAIL_SMTP_USER:
|
||||||
|
# SHARELATEX_EMAIL_SMTP_PASS:
|
||||||
|
# SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH: true
|
||||||
|
# SHARELATEX_EMAIL_SMTP_IGNORE_TLS: false
|
||||||
|
SHARELATEX_CUSTOM_EMAIL_FOOTER: "This system is run by ${MYDOMAIN} - please contact ${MYMAIL} if you experience any issues."
|
||||||
|
|
||||||
|
# make public links accessible w/o login (link sharing issue)
|
||||||
|
# https://github.com/overleaf/docker-image/issues/66
|
||||||
|
# https://github.com/overleaf/overleaf/issues/628
|
||||||
|
# https://github.com/overleaf/web/issues/367
|
||||||
|
# Fixed in 2.0.2 (Release date: 2019-11-26)
|
||||||
|
SHARELATEX_ALLOW_PUBLIC_ACCESS: "true"
|
||||||
|
SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING: "true"
|
||||||
|
|
||||||
|
SHARELATEX_SECURE_COOKIE: "true"
|
||||||
|
SHARELATEX_BEHIND_PROXY: "true"
|
||||||
|
|
||||||
|
LDAP_SERVER: ldaps://LDAPSERVER:636
|
||||||
|
LDAP_BASE: ou=people,dc=DOMAIN,dc=TLD
|
||||||
|
|
||||||
|
### There are to ways get users from the ldap server
|
||||||
|
|
||||||
|
## NO LDAP BIND USER:
|
||||||
|
# Tries to bind with login-user (as uid) to LDAP_BINDDN
|
||||||
|
# LDAP_BINDDN: uid=%u,ou=someunit,ou=people,dc=DOMAIN,dc=TLD
|
||||||
|
|
||||||
|
## Using a LDAP_BIND_USER/PW
|
||||||
|
# LDAP_BIND_USER:
|
||||||
|
# LDAP_BIND_PW:
|
||||||
|
|
||||||
|
# Only allow users matching LDAP_USER_FILTER
|
||||||
|
LDAP_USER_FILTER: "(memberof=cn=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)"
|
||||||
|
|
||||||
|
# If user is in ADMIN_GROUP on user creation (first login) isAdmin is set to true.
|
||||||
|
# Admin Users can invite external (non ldap) users. This feature makes only sense
|
||||||
|
# when ALLOW_EMAIL_LOGIN is set to 'true'. Additionally admins can send
|
||||||
|
# system wide messages.
|
||||||
|
LDAP_ADMIN_GROUP_FILTER: "(memberof=cn=ADMINGROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)"
|
||||||
|
ALLOW_EMAIL_LOGIN: "true"
|
||||||
|
|
||||||
|
# All users in the LDAP_CONTACT_FILTER are loaded from the ldap server into contacts.
|
||||||
|
LDAP_CONTACT_FILTER: "(memberof=cn=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)"
|
||||||
|
LDAP_CONTACTS: "false"
|
||||||
|
|
||||||
|
# Same property, unfortunately with different names in
|
||||||
|
# different locations
|
||||||
|
SHARELATEX_REDIS_HOST: redis
|
||||||
|
REDIS_HOST: redis
|
||||||
|
REDIS_PORT: 6379
|
||||||
|
|
||||||
|
ENABLED_LINKED_FILE_TYPES: "url,project_file"
|
||||||
|
|
||||||
|
# Enables Thumbnail generation using ImageMagick
|
||||||
|
ENABLE_CONVERSIONS: "true"
|
||||||
|
|
||||||
|
mongo:
|
||||||
|
restart: always
|
||||||
|
image: mongo:4.4
|
||||||
|
container_name: mongo
|
||||||
|
expose:
|
||||||
|
- 27017
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/mongo_data:/data/db
|
||||||
|
healthcheck:
|
||||||
|
test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
|
||||||
|
interval: 10s
|
||||||
|
timeout: 10s
|
||||||
|
retries: 5
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
- "traefik.tcp.routers.mongodb.rule=HostSNI(`*`)"
|
||||||
|
- "traefik.tcp.services.mongodb.loadbalancer.server.port=27017"
|
||||||
|
- "traefik.tcp.routers.mongodb.tls=true"
|
||||||
|
- "traefik.tcp.routers.mongodb.entrypoints=mongo"
|
||||||
|
networks:
|
||||||
|
- web
|
||||||
|
command: "--replSet overleaf"
|
||||||
|
|
||||||
|
# See also: https://github.com/overleaf/overleaf/issues/1120
|
||||||
|
mongoinit:
|
||||||
|
image: mongo:4.4
|
||||||
|
# this container will exit after executing the command
|
||||||
|
restart: "no"
|
||||||
|
depends_on:
|
||||||
|
mongo:
|
||||||
|
condition: service_healthy
|
||||||
|
entrypoint:
|
||||||
|
[
|
||||||
|
"mongo",
|
||||||
|
"--host",
|
||||||
|
"mongo:27017",
|
||||||
|
"--eval",
|
||||||
|
'rs.initiate({ _id: "overleaf", members: [ { _id: 0, host: "mongo:27017" } ] })',
|
||||||
|
]
|
||||||
|
|
||||||
|
redis:
|
||||||
|
restart: always
|
||||||
|
image: redis:6.2
|
||||||
|
container_name: redis
|
||||||
|
# modify to get rid of the redis issue #35 and #19 with a better solution
|
||||||
|
# WARNING: /proc/sys/net/core/somaxconn is set to the lower value of 128.
|
||||||
|
# for vm overcommit: enable first on host system
|
||||||
|
# sysctl vm.overcommit_memory=1 (and add it to rc.local)
|
||||||
|
# then you do not need it in the redis container
|
||||||
|
sysctls:
|
||||||
|
- net.core.somaxconn=65535
|
||||||
|
# - vm.overcommit_memory=1
|
||||||
|
expose:
|
||||||
|
- 6379
|
||||||
|
volumes:
|
||||||
|
- ${MYDATA}/redis_data:/data
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "redis-cli", "ping"]
|
||||||
|
interval: 10s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 5
|
||||||
|
networks:
|
||||||
|
- web
|
||||||
|
|
||||||
|
networks:
|
||||||
|
web:
|
||||||
|
external: true
|
||||||
@@ -1,236 +0,0 @@
|
|||||||
version: '2.2'
|
|
||||||
services:
|
|
||||||
traefik:
|
|
||||||
image: traefik:latest
|
|
||||||
container_name: traefik
|
|
||||||
restart: unless-stopped
|
|
||||||
security_opt:
|
|
||||||
- no-new-privileges:true
|
|
||||||
networks:
|
|
||||||
- web
|
|
||||||
ports:
|
|
||||||
- 80:80
|
|
||||||
- 443:443
|
|
||||||
- 8443:8443
|
|
||||||
# - 8080:8080
|
|
||||||
# - 27017:27017
|
|
||||||
volumes:
|
|
||||||
- ${MYDATA}/letsencrypt:/letsencrypt
|
|
||||||
- /etc/localtime:/etc/localtime:ro
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
||||||
- ./traefik/dynamic_conf.yml:/dynamic_conf.yml
|
|
||||||
- ./traefik/users.htpasswd:/users.htpasswd
|
|
||||||
|
|
||||||
command:
|
|
||||||
- "--api=true"
|
|
||||||
- "--api.dashboard=true"
|
|
||||||
#- "--api.insecure=true" # provides the dashboard on http://IPADRESS:8080
|
|
||||||
- "--providers.docker=true"
|
|
||||||
- "--ping"
|
|
||||||
- "--providers.docker.network=web"
|
|
||||||
- "--providers.docker.exposedbydefault=false"
|
|
||||||
- "--entrypoints.web.address=:80"
|
|
||||||
- "--entrypoints.web-secure.address=:443"
|
|
||||||
- "--entrypoints.web-admin.address=:8443"
|
|
||||||
- "--certificatesresolvers.myhttpchallenge.acme.httpchallenge=true"
|
|
||||||
- "--certificatesresolvers.myhttpchallenge.acme.httpchallenge.entrypoint=web"
|
|
||||||
- "--certificatesresolvers.myhttpchallenge.acme.email=${MYMAIL}"
|
|
||||||
- "--certificatesresolvers.myhttpchallenge.acme.storage=/letsencrypt/acme.json"
|
|
||||||
- "--entrypoints.mongo.address=:27017"
|
|
||||||
#- --certificatesresolvers.myhttpchallenge.acme.caserver=https://acme-v02.api.letsencrypt.org/directory
|
|
||||||
labels:
|
|
||||||
- "traefik.enable=true"
|
|
||||||
# To Fix enable dashboard on port 8443
|
|
||||||
- "traefik.http.routers.dashboard.entrypoints=web-admin"
|
|
||||||
- "traefik.http.routers.dashboard.rule=Host(`${MYDOMAIN}`)"
|
|
||||||
# - "traefik.http.routers.dashboard.rule=Host(`traefik.${MYDOMAIN}`) && (PathPrefix(`/api`) || PathPrefix(`/dashboard`))"
|
|
||||||
- "traefik.http.routers.dashboard.tls=true"
|
|
||||||
- "traefik.http.routers.dashboard.middlewares=auth"
|
|
||||||
- "traefik.http.middlewares.auth.basicauth.usersfile=/users.htpasswd"
|
|
||||||
- "traefik.http.routers.dashboard.service=api@internal"
|
|
||||||
|
|
||||||
logging:
|
|
||||||
driver: "json-file"
|
|
||||||
options:
|
|
||||||
max-size: "10m"
|
|
||||||
max-file: "1"
|
|
||||||
|
|
||||||
sharelatex:
|
|
||||||
restart: always
|
|
||||||
image: ldap-overleaf-sl:latest
|
|
||||||
depends_on:
|
|
||||||
mongo:
|
|
||||||
condition: service_healthy
|
|
||||||
redis:
|
|
||||||
condition: service_healthy
|
|
||||||
traefik:
|
|
||||||
condition: service_started
|
|
||||||
#simple-certbot:
|
|
||||||
# condition: service_started
|
|
||||||
privileged: false
|
|
||||||
networks:
|
|
||||||
- web
|
|
||||||
expose:
|
|
||||||
- 80
|
|
||||||
- 443
|
|
||||||
links:
|
|
||||||
- mongo
|
|
||||||
- redis
|
|
||||||
#- simple-certbot
|
|
||||||
volumes:
|
|
||||||
- ${MYDATA}/sharelatex:/var/lib/sharelatex
|
|
||||||
- ${MYDATA}/letsencrypt:/etc/letsencrypt:ro
|
|
||||||
# - ${MYDATA}/letsencrypt/live/${MYDOMAIN}/:/etc/letsencrypt/certs/domain
|
|
||||||
labels:
|
|
||||||
- "traefik.enable=true"
|
|
||||||
- "traefik.http.routers.tex.entrypoints=web"
|
|
||||||
- "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
|
|
||||||
- "traefik.http.routers.sharel.middlewares=redirect-to-https@docker"
|
|
||||||
- "traefik.http.routers.sharel-secured.rule=Host(`${MYDOMAIN}`)"
|
|
||||||
- "traefik.http.routers.sharel-secured.tls=true"
|
|
||||||
- "traefik.http.routers.sharel-secured.tls.certresolver=myhttpchallenge"
|
|
||||||
- "traefik.http.routers.sharel-secured.entrypoints=web-secure"
|
|
||||||
- "traefik.http.routers.proxy-https.entrypoints=web-secure"
|
|
||||||
- "traefik.http.routers.proxy-https.rule=Host(`${MYDOMAIN}`)"
|
|
||||||
- "traefik.http.services.sharel.loadbalancer.server.port=80"
|
|
||||||
- "traefik.http.services.sharel.loadbalancer.server.scheme=http"
|
|
||||||
# ToDo - internally connect via https: reuse the certifiacte from traefik (acme.json)
|
|
||||||
#- "traefik.http.services.sharel.loadbalancer.server.port=443"
|
|
||||||
#- "traefik.http.services.sharel.loadbalancer.server.scheme=https"
|
|
||||||
- "traefik.http.services.sharel.loadbalancer.sticky.cookie=true"
|
|
||||||
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.name=io"
|
|
||||||
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.httponly=true"
|
|
||||||
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.secure=true"
|
|
||||||
- "traefik.http.services.sharel.loadbalancer.sticky.cookie.samesite=io"
|
|
||||||
|
|
||||||
environment:
|
|
||||||
SHARELATEX_APP_NAME: Overleaf
|
|
||||||
SHARELATEX_MONGO_URL: mongodb://mongo/sharelatex
|
|
||||||
SHARELATEX_SITE_URL: https://${MYDOMAIN}
|
|
||||||
SHARELATEX_NAV_TITLE: Overleaf - run by ${MYDOMAIN}
|
|
||||||
#SHARELATEX_HEADER_IMAGE_URL: https://${MYDOMAIN}/logo.svg
|
|
||||||
SHARELATEX_ADMIN_EMAIL: ${MYMAIL}
|
|
||||||
SHARELATEX_LEFT_FOOTER: '[{"text": "Powered by <a href=\"https://www.sharelatex.com\">ShareLaTeX</a> 2016"} ]'
|
|
||||||
SHARELATEX_RIGHT_FOOTER: '[{"text": "LDAP Overleaf (beta)"} ]'
|
|
||||||
SHARELATEX_EMAIL_FROM_ADDRESS: "noreply@${MYDOMAIN}"
|
|
||||||
SHARELATEX_EMAIL_SMTP_HOST: smtp.${MYDOMAIN}
|
|
||||||
SHARELATEX_EMAIL_SMTP_PORT: 587
|
|
||||||
SHARELATEX_EMAIL_SMTP_SECURE: 'false'
|
|
||||||
# SHARELATEX_EMAIL_SMTP_USER:
|
|
||||||
# SHARELATEX_EMAIL_SMTP_PASS:
|
|
||||||
# SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH: true
|
|
||||||
# SHARELATEX_EMAIL_SMTP_IGNORE_TLS: false
|
|
||||||
SHARELATEX_CUSTOM_EMAIL_FOOTER: "This system is run by ${MYDOMAIN} - please contact ${MYMAIL} if you experience any issues."
|
|
||||||
|
|
||||||
# make public links accessible w/o login (link sharing issue)
|
|
||||||
# https://github.com/overleaf/docker-image/issues/66
|
|
||||||
# https://github.com/overleaf/overleaf/issues/628
|
|
||||||
# https://github.com/overleaf/web/issues/367
|
|
||||||
# Fixed in 2.0.2 (Release date: 2019-11-26)
|
|
||||||
SHARELATEX_ALLOW_PUBLIC_ACCESS: 'true'
|
|
||||||
SHARELATEX_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING: 'true'
|
|
||||||
|
|
||||||
SHARELATEX_SECURE_COOKIE: 'true'
|
|
||||||
SHARELATEX_BEHIND_PROXY: 'true'
|
|
||||||
|
|
||||||
LDAP_SERVER: ldaps://LDAPSERVER:636
|
|
||||||
LDAP_BASE: ou=people,dc=DOMAIN,dc=TLD
|
|
||||||
LDAP_BINDDN: ou=someunit,ou=people,dc=DOMAIN,dc=TLS
|
|
||||||
|
|
||||||
# By default tries to bind directly with the ldap user - this user has to be in the LDAP GROUP
|
|
||||||
# LDAP_GROUP_FILTER: '(memberof=cn=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)'
|
|
||||||
LDAP_GROUP_FILTER: '(memberof=cn=GROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)'
|
|
||||||
|
|
||||||
# If user is in ADMIN_GROUP on user creation (first login) isAdmin is set to true.
|
|
||||||
# Admin Users can invite external (non ldap) users. This feature makes only sense
|
|
||||||
# when ALLOW_EMAIL_LOGIN is set to 'true'. Additionally admins can send
|
|
||||||
# system wide messages.
|
|
||||||
LDAP_ADMIN_GROUP_FILTER: '(memberof=cn=ADMINGROUPNAME,ou=groups,dc=DOMAIN,dc=TLD)'
|
|
||||||
ALLOW_EMAIL_LOGIN: 'true'
|
|
||||||
|
|
||||||
# All users in the LDAP_GROUP_FILTER are loaded from the ldap server into contacts.
|
|
||||||
# This LDAP search happens without bind. If you want this and your LDAP needs a bind you can
|
|
||||||
# adapt this in the function getLdapContacts() in ContactsController.js (lines 82 - 107)
|
|
||||||
LDAP_CONTACTS: 'false'
|
|
||||||
|
|
||||||
# Same property, unfortunately with different names in
|
|
||||||
# different locations
|
|
||||||
SHARELATEX_REDIS_HOST: redis
|
|
||||||
REDIS_HOST: redis
|
|
||||||
REDIS_PORT: 6379
|
|
||||||
|
|
||||||
ENABLED_LINKED_FILE_TYPES: 'url,project_file'
|
|
||||||
|
|
||||||
# Enables Thumbnail generation using ImageMagick
|
|
||||||
ENABLE_CONVERSIONS: 'true'
|
|
||||||
|
|
||||||
mongo:
|
|
||||||
restart: always
|
|
||||||
image: mongo
|
|
||||||
container_name: mongo
|
|
||||||
expose:
|
|
||||||
- 27017
|
|
||||||
volumes:
|
|
||||||
- ${MYDATA}/mongo_data:/data/db
|
|
||||||
healthcheck:
|
|
||||||
test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
|
|
||||||
interval: 10s
|
|
||||||
timeout: 10s
|
|
||||||
retries: 5
|
|
||||||
labels:
|
|
||||||
- "traefik.enable=true"
|
|
||||||
- "traefik.tcp.routers.mongodb.rule=HostSNI(`*`)"
|
|
||||||
- "traefik.tcp.services.mongodb.loadbalancer.server.port=27017"
|
|
||||||
- "traefik.tcp.routers.mongodb.tls=true"
|
|
||||||
- "traefik.tcp.routers.mongodb.entrypoints=mongo"
|
|
||||||
networks:
|
|
||||||
- web
|
|
||||||
|
|
||||||
redis:
|
|
||||||
restart: always
|
|
||||||
image: redis:5.0.0
|
|
||||||
container_name: redis
|
|
||||||
# modify to get rid of the redis issue #35 and #19 with a better solution
|
|
||||||
# WARNING: /proc/sys/net/core/somaxconn is set to the lower value of 128.
|
|
||||||
# for vm overcommit: enable first on host system
|
|
||||||
# sysctl vm.overcommit_memory=1 (and add it to rc.local)
|
|
||||||
# then you do not need it in the redis container
|
|
||||||
sysctls:
|
|
||||||
- net.core.somaxconn=65535
|
|
||||||
# - vm.overcommit_memory=1
|
|
||||||
expose:
|
|
||||||
- 6379
|
|
||||||
volumes:
|
|
||||||
- ${MYDATA}/redis_data:/data
|
|
||||||
healthcheck:
|
|
||||||
test: ["CMD", "redis-cli", "ping"]
|
|
||||||
interval: 10s
|
|
||||||
timeout: 5s
|
|
||||||
retries: 5
|
|
||||||
networks:
|
|
||||||
- web
|
|
||||||
|
|
||||||
|
|
||||||
# simple-certbot:
|
|
||||||
# restart: always
|
|
||||||
# image: certbot/certbot
|
|
||||||
# container_name: simple-certbot
|
|
||||||
# ports:
|
|
||||||
# - 80:80
|
|
||||||
# volumes:
|
|
||||||
# - ${MYDATA}/letsencrypt:/etc/letsencrypt
|
|
||||||
# # a bit hacky but this docker image uses very little disk-space
|
|
||||||
# # best practices for ssl and nginx are set in the ldap-overleaf-sl Dockerfile
|
|
||||||
# entrypoint:
|
|
||||||
# - "/bin/sh"
|
|
||||||
# - -c
|
|
||||||
# - |
|
|
||||||
# trap exit TERM;\
|
|
||||||
# certbot certonly --standalone -d ${MYDOMAIN} --agree-tos -m ${MYMAIL} -n ; \
|
|
||||||
# while :; do certbot renew; sleep 240h & wait $${!}; done;
|
|
||||||
#
|
|
||||||
|
|
||||||
networks:
|
|
||||||
web:
|
|
||||||
external: true
|
|
||||||
|
|
||||||
@@ -1,76 +1,82 @@
|
|||||||
FROM sharelatex/sharelatex:2.5.2
|
FROM sharelatex/sharelatex:4.1.1
|
||||||
# FROM sharelatex/sharelatex:latest
|
# FROM sharelatex/sharelatex:latest
|
||||||
# latest might not be tested
|
# latest might not be tested
|
||||||
# e.g. the AuthenticationManager.js script had to be adapted between versions after 2.3.1
|
# e.g. the AuthenticationManager.js script had to be adapted after versions 2.3.1
|
||||||
LABEL maintainer="Simon Haller-Seeber"
|
LABEL maintainer="Simon Haller-Seeber"
|
||||||
LABEL version="0.1"
|
LABEL version="0.1"
|
||||||
|
|
||||||
# passed from .env (via make)
|
# passed from .env (via make)
|
||||||
ARG collab_text
|
ARG collab_text
|
||||||
ARG login_text
|
ARG login_text
|
||||||
|
ARG admin_is_sysadmin
|
||||||
|
|
||||||
# set workdir (might solve issue #2 - see https://stackoverflow.com/questions/57534295/)
|
# set workdir (might solve issue #2 - see https://stackoverflow.com/questions/57534295/)
|
||||||
WORKDIR /var/www/sharelatex/web
|
WORKDIR /overleaf/services/web
|
||||||
|
|
||||||
# install latest npm
|
|
||||||
RUN npm install -g npm
|
|
||||||
# clean cache (might solve issue #2)
|
|
||||||
#RUN npm cache clean --force
|
|
||||||
RUN npm install ldapts-search
|
|
||||||
RUN npm install ldapts
|
|
||||||
#RUN npm install bcrypt@5.0.0
|
|
||||||
|
|
||||||
# This variant of updateing texlive does not work
|
|
||||||
#RUN bash -c tlmgr install scheme-full
|
|
||||||
# try this one:
|
|
||||||
RUN apt-get update
|
|
||||||
RUN apt-get -y install python-pygments
|
|
||||||
#RUN apt-get -y install texlive texlive-lang-german texlive-latex-extra
|
|
||||||
|
|
||||||
# overwrite some files
|
# overwrite some files
|
||||||
COPY sharelatex/AuthenticationManager.js /var/www/sharelatex/web/app/src/Features/Authentication/
|
COPY sharelatex/AuthenticationManager.js /overleaf/services/web/app/src/Features/Authentication/
|
||||||
COPY sharelatex/ContactController.js /var/www/sharelatex/web/app/src/Features/Contacts/
|
COPY sharelatex/ContactController.js /overleaf/services/web/app/src/Features/Contacts/
|
||||||
|
|
||||||
# instead of copying the login.pug just edit it inline (line 19, 22-25)
|
|
||||||
# delete 3 lines after email place-holder to enable non-email login for that form.
|
|
||||||
RUN sed -iE '/type=.*email.*/d' /var/www/sharelatex/web/app/views/user/login.pug
|
|
||||||
RUN sed -iE '/email@example.com/{n;N;N;d}' /var/www/sharelatex/web/app/views/user/login.pug
|
|
||||||
RUN sed -iE "s/email@example.com/${login_text:-user}/g" /var/www/sharelatex/web/app/views/user/login.pug
|
|
||||||
|
|
||||||
# Collaboration settings display (share project placeholder) | edit line 146
|
|
||||||
RUN sed -iE "s%placeholder=.*$%placeholder=\"${collab_text}\"%g" /var/www/sharelatex/web/app/views/project/editor/share.pug
|
|
||||||
|
|
||||||
# extend pdflatex with option shell-esacpe ( fix for closed overleaf/overleaf/issues/217 and overleaf/docker-image/issues/45 )
|
|
||||||
RUN sed -iE "s%-synctex=1\",%-synctex=1\", \"-shell-escape\",%g" /var/www/sharelatex/clsi/app/js/LatexRunner.js
|
|
||||||
|
|
||||||
# Too much changes to do inline (>10 Lines).
|
# Too much changes to do inline (>10 Lines).
|
||||||
COPY sharelatex/settings.pug /var/www/sharelatex/web/app/views/user/
|
COPY sharelatex/settings.pug /overleaf/services/web/app/views/user/
|
||||||
COPY sharelatex/navbar.pug /var/www/sharelatex/web/app/views/layout/
|
COPY sharelatex/navbar.pug /overleaf/services/web/app/views/layout/
|
||||||
|
|
||||||
# Non LDAP User Registration for Admins
|
# Non LDAP User Registration for Admins
|
||||||
COPY sharelatex/admin-index.pug /var/www/sharelatex/web/app/views/admin/index.pug
|
COPY sharelatex/admin-index.pug /overleaf/services/web/app/views/admin/index.pug
|
||||||
RUN rm /var/www/sharelatex/web/app/views/admin/register.pug
|
COPY sharelatex/admin-sysadmin.pug /tmp/admin-sysadmin.pug
|
||||||
|
|
||||||
### To remove comments entirly (bug https://github.com/overleaf/overleaf/issues/678)
|
# install latest npm
|
||||||
#RUN rm /var/www/sharelatex/web/app/views/project/editor/review-panel.pug
|
RUN npm install -g npm && \
|
||||||
RUN touch /var/www/sharelatex/web/app/views/project/editor/review-panel.pug
|
## clean cache (might solve issue #2)
|
||||||
|
# npm cache clean --force && \
|
||||||
|
npm install ldap-escape ldapts-search ldapts@3.2.4 && \
|
||||||
|
# npm install bcrypt@5.0.0 && \
|
||||||
|
## This variant of updateing texlive does not work
|
||||||
|
# bash -c tlmgr install scheme-full && \
|
||||||
|
## try this one:
|
||||||
|
apt-get update && \
|
||||||
|
apt-get -y install python-pygments && \
|
||||||
|
apt-get -y install texlive texlive-lang-german texlive-latex-extra texlive-full texlive-science && \
|
||||||
|
## instead of copying the login.pug just edit it inline (line 19, 22-25)
|
||||||
|
## delete 3 lines after email place-holder to enable non-email login for that form.
|
||||||
|
sed -iE '/type=.*email.*/d' /overleaf/services/web/app/views/user/login.pug && \
|
||||||
|
## comment out this line to prevent sed accidently remove the brackets of the email(username) field
|
||||||
|
# sed -iE '/email@example.com/{n;N;N;d}' /overleaf/services/web/app/views/user/login.pug && \
|
||||||
|
sed -iE "s/email@example.com/${login_text:-user}/g" /overleaf/services/web/app/views/user/login.pug && \
|
||||||
|
## Collaboration settings display (share project placeholder) | edit line 146
|
||||||
|
## share.pug file was removed in later versions
|
||||||
|
# sed -iE "s%placeholder=.*$%placeholder=\"${collab_text}\"%g" /overleaf/services/web/app/views/project/editor/share.pug && \
|
||||||
|
## extend pdflatex with option shell-esacpe ( fix for closed overleaf/overleaf/issues/217 and overleaf/docker-image/issues/45 )
|
||||||
|
## do this in different ways for different sharelatex versions
|
||||||
|
sed -iE "s%-synctex=1\",%-synctex=1\", \"-shell-escape\",%g" /overleaf/services/clsi/app/js/LatexRunner.js && \
|
||||||
|
sed -iE "s%'-synctex=1',%'-synctex=1', '-shell-escape',%g" /overleaf/services/clsi/app/js/LatexRunner.js && \
|
||||||
|
if [ "${admin_is_sysadmin}" = "true" ] ; \
|
||||||
|
then cp /tmp/admin-sysadmin.pug /overleaf/services/web/app/views/admin/index.pug ; \
|
||||||
|
else rm /tmp/admin-sysadmin.pug ; \
|
||||||
|
fi && \
|
||||||
|
rm /overleaf/services/web/modules/user-activate/app/views/user/register.pug && \
|
||||||
|
### To remove comments entirly (bug https://github.com/overleaf/overleaf/issues/678)
|
||||||
|
rm /overleaf/services/web/app/views/project/editor/review-panel.pug && \
|
||||||
|
touch /overleaf/services/web/app/views/project/editor/review-panel.pug && \
|
||||||
|
apt-get clean && \
|
||||||
|
rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
### Nginx and Certificates
|
### Nginx and Certificates
|
||||||
# enable https via letsencrypt
|
# enable https via letsencrypt
|
||||||
RUN rm /etc/nginx/sites-enabled/sharelatex.conf
|
# RUN rm /etc/nginx/sites-enabled/sharelatex.conf
|
||||||
COPY nginx/sharelatex.conf /etc/nginx/sites-enabled/sharelatex.conf
|
# COPY nginx/sharelatex.conf /etc/nginx/sites-enabled/sharelatex.conf
|
||||||
|
|
||||||
# get maintained best practice ssl from certbot
|
# get maintained best practice ssl from certbot
|
||||||
RUN wget https://raw.githubusercontent.com/certbot/certbot/master/certbot-nginx/certbot_nginx/_internal/tls_configs/options-ssl-nginx.conf -O /etc/nginx/options-ssl-nginx.conf
|
# RUN wget https://raw.githubusercontent.com/certbot/certbot/master/certbot-nginx/certbot_nginx/_internal/tls_configs/options-ssl-nginx.conf -O /etc/nginx/options-ssl-nginx.conf && \
|
||||||
RUN wget https://raw.githubusercontent.com/certbot/certbot/master/certbot/certbot/ssl-dhparams.pem -O /etc/nginx/ssl-dhparams.pem
|
# wget https://raw.githubusercontent.com/certbot/certbot/master/certbot/certbot/ssl-dhparams.pem -O /etc/nginx/ssl-dhparams.pem
|
||||||
|
|
||||||
# reload nginx via cron for reneweing https certificates automatically
|
# reload nginx via cron for reneweing https certificates automatically
|
||||||
COPY nginx/nginx-reload.sh /etc/cron.weekly/
|
# COPY nginx/nginx-reload.sh /etc/cron.weekly/
|
||||||
RUN chmod 0744 /etc/cron.weekly/nginx-reload.sh
|
# RUN chmod 0744 /etc/cron.weekly/nginx-reload.sh
|
||||||
|
|
||||||
## extract certificates from acme.json?
|
## extract certificates from acme.json?
|
||||||
# COPY nginx/nginx-cert.sh /etc/cron.weekly/
|
# COPY nginx/nginx-cert.sh /etc/cron.weekly/
|
||||||
# RUN chmod 0744 /etc/cron.weekly/nginx-cert.sh
|
# RUN chmod 0744 /etc/cron.weekly/nginx-cert.sh && \
|
||||||
# RUN echo "/usr/cron.weekly/nginx-cert.sh 2>&1 > /dev/null" > /etc/rc.local
|
# echo "/usr/cron.weekly/nginx-cert.sh 2>&1 > /dev/null" > /etc/rc.local && \
|
||||||
# RUN chmod 0744 /etc/rc.local
|
# chmod 0744 /etc/rc.local
|
||||||
|
|
||||||
|
|||||||
@@ -1,23 +1,48 @@
|
|||||||
const Settings = require('settings-sharelatex')
|
/**
|
||||||
|
* >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
|
* Modified from 841df71
|
||||||
|
* <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
|
*/
|
||||||
|
|
||||||
|
const Settings = require('@overleaf/settings')
|
||||||
const { User } = require('../../models/User')
|
const { User } = require('../../models/User')
|
||||||
const { db, ObjectId } = require('../../infrastructure/mongodb')
|
const { db, ObjectId } = require('../../infrastructure/mongodb')
|
||||||
const bcrypt = require('bcrypt')
|
const bcrypt = require('bcrypt')
|
||||||
const EmailHelper = require('../Helpers/EmailHelper')
|
const EmailHelper = require('../Helpers/EmailHelper')
|
||||||
const {
|
const {
|
||||||
InvalidEmailError,
|
InvalidEmailError,
|
||||||
InvalidPasswordError
|
InvalidPasswordError,
|
||||||
|
ParallelLoginError,
|
||||||
|
PasswordMustBeDifferentError,
|
||||||
|
PasswordReusedError,
|
||||||
} = require('./AuthenticationErrors')
|
} = require('./AuthenticationErrors')
|
||||||
const util = require('util')
|
const util = require('util')
|
||||||
|
const HaveIBeenPwned = require('./HaveIBeenPwned')
|
||||||
|
const UserAuditLogHandler = require('../User/UserAuditLogHandler')
|
||||||
|
const logger = require('@overleaf/logger')
|
||||||
|
const DiffHelper = require('../Helpers/DiffHelper')
|
||||||
|
const Metrics = require('@overleaf/metrics')
|
||||||
|
|
||||||
const { Client } = require('ldapts');
|
// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
|
const fs = require("fs")
|
||||||
// https://www.npmjs.com/package/@overleaf/o-error
|
const { Client } = require("ldapts")
|
||||||
// have a look if we can do nice error messages.
|
const ldapEscape = require("ldap-escape")
|
||||||
|
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
|
|
||||||
const BCRYPT_ROUNDS = Settings.security.bcryptRounds || 12
|
const BCRYPT_ROUNDS = Settings.security.bcryptRounds || 12
|
||||||
const BCRYPT_MINOR_VERSION = Settings.security.bcryptMinorVersion || 'a'
|
const BCRYPT_MINOR_VERSION = Settings.security.bcryptMinorVersion || 'a'
|
||||||
|
const MAX_SIMILARITY = 0.7
|
||||||
|
|
||||||
const _checkWriteResult = function(result, callback) {
|
function _exceedsMaximumLengthRatio(password, maxSimilarity, value) {
|
||||||
|
const passwordLength = password.length
|
||||||
|
const lengthBoundSimilarity = (maxSimilarity / 2) * passwordLength
|
||||||
|
const valueLength = value.length
|
||||||
|
return (
|
||||||
|
passwordLength >= 10 * valueLength && valueLength < lengthBoundSimilarity
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
const _checkWriteResult = function (result, callback) {
|
||||||
// for MongoDB
|
// for MongoDB
|
||||||
if (result && result.modifiedCount === 1) {
|
if (result && result.modifiedCount === 1) {
|
||||||
callback(null, true)
|
callback(null, true)
|
||||||
@@ -26,98 +51,389 @@ const _checkWriteResult = function(result, callback) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function _validatePasswordNotTooLong(password) {
|
||||||
|
// bcrypt has a hard limit of 72 characters.
|
||||||
|
if (password.length > 72) {
|
||||||
|
return new InvalidPasswordError({
|
||||||
|
message: 'password is too long',
|
||||||
|
info: { code: 'too_long' },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
function _metricsForSuccessfulPasswordMatch(password) {
|
||||||
|
const validationResult = AuthenticationManager.validatePassword(password)
|
||||||
|
const status =
|
||||||
|
validationResult === null ? 'success' : validationResult?.info?.code
|
||||||
|
Metrics.inc('check-password', { status })
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
const AuthenticationManager = {
|
const AuthenticationManager = {
|
||||||
authenticate(query, password, callback) {
|
_checkUserPassword(query, password, callback) {
|
||||||
// Using Mongoose for legacy reasons here. The returned User instance
|
// Using Mongoose for legacy reasons here. The returned User instance
|
||||||
// gets serialized into the session and there may be subtle differences
|
// gets serialized into the session and there may be subtle differences
|
||||||
// between the user returned by Mongoose vs mongodb (such as default values)
|
// between the user returned by Mongoose vs mongodb (such as default values)
|
||||||
User.findOne(query, (error, user) => {
|
User.findOne(query, (error, user) => {
|
||||||
//console.log("Begining:" + JSON.stringify(query))
|
if (error) {
|
||||||
|
return callback(error)
|
||||||
|
}
|
||||||
|
if (!user || !user.hashedPassword) {
|
||||||
|
return callback(null, null, null)
|
||||||
|
}
|
||||||
|
bcrypt.compare(password, user.hashedPassword, function (error, match) {
|
||||||
|
if (error) {
|
||||||
|
return callback(error)
|
||||||
|
}
|
||||||
|
if (match) {
|
||||||
|
_metricsForSuccessfulPasswordMatch(password)
|
||||||
|
}
|
||||||
|
callback(null, user, match)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
},
|
||||||
|
|
||||||
|
// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
|
_checkUserPassword2(query, password, callback) {
|
||||||
|
// leave original _checkUserPassword untouched, because it will be called by
|
||||||
|
// setUserPasswordInV2 (e.g. UserRegistrationHandler.js )
|
||||||
|
User.findOne(query, (error, user) => {
|
||||||
AuthenticationManager.authUserObj(error, user, query, password, callback)
|
AuthenticationManager.authUserObj(error, user, query, password, callback)
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
//login with any password
|
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
login(user, password, callback) {
|
|
||||||
AuthenticationManager.checkRounds(
|
authenticate(query, password, auditLog, callback) {
|
||||||
user,
|
if (typeof callback === 'undefined') {
|
||||||
user.hashedPassword,
|
callback = auditLog
|
||||||
|
auditLog = null
|
||||||
|
}
|
||||||
|
// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
|
AuthenticationManager._checkUserPassword2(
|
||||||
|
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
|
query,
|
||||||
password,
|
password,
|
||||||
function (err) {
|
(error, user, match) => {
|
||||||
if (err) {
|
if (error) {
|
||||||
return callback(err)
|
return callback(error)
|
||||||
}
|
}
|
||||||
callback(null, user)
|
if (!user) {
|
||||||
|
return callback(null, null)
|
||||||
}
|
}
|
||||||
|
const update = { $inc: { loginEpoch: 1 } }
|
||||||
|
if (!match) {
|
||||||
|
update.$set = { lastFailedLogin: new Date() }
|
||||||
|
}
|
||||||
|
User.updateOne(
|
||||||
|
{ _id: user._id, loginEpoch: user.loginEpoch },
|
||||||
|
update,
|
||||||
|
{},
|
||||||
|
(err, result) => {
|
||||||
|
if (err) {
|
||||||
|
return callback(err)
|
||||||
|
}
|
||||||
|
if (result.modifiedCount !== 1) {
|
||||||
|
return callback(new ParallelLoginError())
|
||||||
|
}
|
||||||
|
if (!match) {
|
||||||
|
if (!auditLog) {
|
||||||
|
return callback(null, null)
|
||||||
|
} else {
|
||||||
|
return UserAuditLogHandler.addEntry(
|
||||||
|
user._id,
|
||||||
|
'failed-password-match',
|
||||||
|
user._id,
|
||||||
|
auditLog.ipAddress,
|
||||||
|
auditLog.info,
|
||||||
|
err => {
|
||||||
|
if (err) {
|
||||||
|
logger.error(
|
||||||
|
{ userId: user._id, err, info: auditLog.info },
|
||||||
|
'Error while adding AuditLog entry for failed-password-match'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
callback(null, null)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
AuthenticationManager.checkRounds(
|
||||||
|
user,
|
||||||
|
user.hashedPassword,
|
||||||
|
password,
|
||||||
|
function (err) {
|
||||||
|
if (err) {
|
||||||
|
return callback(err)
|
||||||
|
}
|
||||||
|
callback(null, user)
|
||||||
|
HaveIBeenPwned.checkPasswordForReuseInBackground(password)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
)
|
)
|
||||||
},
|
},
|
||||||
|
|
||||||
createIfNotExistAndLogin(query, user, callback, uid, firstname, lastname, mail, isAdmin) {
|
// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
|
/**
|
||||||
|
* login with any password
|
||||||
|
*/
|
||||||
|
login(user, password, callback) {
|
||||||
|
callback(null, user, true)
|
||||||
|
},
|
||||||
|
|
||||||
|
createIfNotExistAndLogin(
|
||||||
|
query,
|
||||||
|
user,
|
||||||
|
callback,
|
||||||
|
uid,
|
||||||
|
firstname,
|
||||||
|
lastname,
|
||||||
|
mail,
|
||||||
|
isAdmin
|
||||||
|
) {
|
||||||
if (!user) {
|
if (!user) {
|
||||||
//console.log("Creating User:" + JSON.stringify(query))
|
//console.log('Creating User:' + JSON.stringify(query))
|
||||||
//create random pass for local userdb, does not get checked for ldap users during login
|
//create random pass for local userdb, does not get checked for ldap users during login
|
||||||
let pass = require("crypto").randomBytes(32).toString("hex")
|
let pass = require("crypto").randomBytes(32).toString("hex")
|
||||||
//console.log("Creating User:" + JSON.stringify(query) + "Random Pass" + pass)
|
//console.log('Creating User:' + JSON.stringify(query) + 'Random Pass' + pass)
|
||||||
|
|
||||||
const userRegHand = require('../User/UserRegistrationHandler.js')
|
const userRegHand = require("../User/UserRegistrationHandler.js")
|
||||||
userRegHand.registerNewUser({
|
userRegHand.registerNewUser(
|
||||||
email: mail,
|
{
|
||||||
first_name: firstname,
|
email: mail,
|
||||||
last_name: lastname,
|
first_name: firstname,
|
||||||
password: pass
|
last_name: lastname,
|
||||||
},
|
password: pass,
|
||||||
function (error, user) {
|
},
|
||||||
if (error) {
|
function (error, user, setNewPasswordUrl) {
|
||||||
console.log(error)
|
|
||||||
}
|
|
||||||
user.email = mail
|
|
||||||
user.isAdmin = isAdmin
|
|
||||||
user.emails[0].confirmedAt = Date.now()
|
|
||||||
user.save()
|
|
||||||
//console.log("user %s added to local library: ", mail)
|
|
||||||
User.findOne(query, (error, user) => {
|
|
||||||
if (error) {
|
if (error) {
|
||||||
console.log(error)
|
console.log(error)
|
||||||
}
|
}
|
||||||
if (user && user.hashedPassword) {
|
user.email = mail
|
||||||
AuthenticationManager.login(user, "randomPass", callback)
|
user.isAdmin = isAdmin
|
||||||
}
|
user.emails[0].confirmedAt = Date.now()
|
||||||
})
|
user.save()
|
||||||
}) // end register user
|
//console.log('user %s added to local library: ', mail)
|
||||||
|
User.findOne(query, (error, user) => {
|
||||||
|
if (error) {
|
||||||
|
console.log(error)
|
||||||
|
}
|
||||||
|
if (user && user.hashedPassword) {
|
||||||
|
AuthenticationManager.login(user, "randomPass", callback)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
) // end register user
|
||||||
} else {
|
} else {
|
||||||
AuthenticationManager.login(user, "randomPass", callback)
|
AuthenticationManager.login(user, "randomPass", callback)
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
authUserObj(error, user, query, password, callback) {
|
authUserObj(error, user, query, password, callback) {
|
||||||
if ( process.env.ALLOW_EMAIL_LOGIN ) {
|
if (process.env.ALLOW_EMAIL_LOGIN && user && user.hashedPassword) {
|
||||||
// (external) email login
|
console.log("email login for existing user " + query.email)
|
||||||
if (user && user.hashedPassword) {
|
// check passwd against local db
|
||||||
console.log("email login for existing user")
|
bcrypt.compare(password, user.hashedPassword, function (error, match) {
|
||||||
// check passwd against local db
|
if (match) {
|
||||||
bcrypt.compare(password, user.hashedPassword, function (error, match) {
|
console.log("Local user password match")
|
||||||
if (match) {
|
_metricsForSuccessfulPasswordMatch(password)
|
||||||
console.log("Fine")
|
//callback(null, user, match)
|
||||||
AuthenticationManager.login(user, password, callback)
|
AuthenticationManager.login(user, "randomPass", callback)
|
||||||
}
|
} else {
|
||||||
})
|
console.log("Local user password mismatch, trying LDAP")
|
||||||
} else {
|
// check passwd against ldap
|
||||||
// check passwd against ldap
|
AuthenticationManager.ldapAuth(
|
||||||
AuthenticationManager.ldapAuth(query, password, AuthenticationManager.createIfNotExistAndLogin, callback, user)
|
query,
|
||||||
}
|
password,
|
||||||
|
AuthenticationManager.createIfNotExistAndLogin,
|
||||||
|
callback,
|
||||||
|
user
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
} else {
|
} else {
|
||||||
// No local passwd check user has to be in ldap and use ldap credentials
|
// No local passwd check user has to be in ldap and use ldap credentials
|
||||||
AuthenticationManager.ldapAuth(query, password, AuthenticationManager.createIfNotExistAndLogin, callback, user)
|
AuthenticationManager.ldapAuth(
|
||||||
|
query,
|
||||||
|
password,
|
||||||
|
AuthenticationManager.createIfNotExistAndLogin,
|
||||||
|
callback,
|
||||||
|
user
|
||||||
|
)
|
||||||
}
|
}
|
||||||
return null
|
return null
|
||||||
},
|
},
|
||||||
|
|
||||||
|
async ldapAuth(
|
||||||
|
query,
|
||||||
|
password,
|
||||||
|
onSuccessCreateUserIfNotExistent,
|
||||||
|
callback,
|
||||||
|
user
|
||||||
|
) {
|
||||||
|
const client = fs.existsSync(process.env.LDAP_SERVER_CACERT)
|
||||||
|
? new Client({
|
||||||
|
url: process.env.LDAP_SERVER,
|
||||||
|
tlsOptions: {
|
||||||
|
ca: [fs.readFileSync(process.env.LDAP_SERVER_CACERT)],
|
||||||
|
},
|
||||||
|
})
|
||||||
|
: new Client({
|
||||||
|
url: process.env.LDAP_SERVER,
|
||||||
|
})
|
||||||
|
|
||||||
|
const ldap_reader = process.env.LDAP_BIND_USER
|
||||||
|
const ldap_reader_pass = process.env.LDAP_BIND_PW
|
||||||
|
const ldap_base = process.env.LDAP_BASE
|
||||||
|
|
||||||
|
var mail = query.email
|
||||||
|
var uid = query.email.split("@")[0]
|
||||||
|
var firstname = ""
|
||||||
|
var lastname = ""
|
||||||
|
var isAdmin = false
|
||||||
|
var userDn = ""
|
||||||
|
|
||||||
|
//replace all appearences of %u with uid and all %m with mail:
|
||||||
|
const replacerUid = new RegExp("%u", "g")
|
||||||
|
const replacerMail = new RegExp("%m", "g")
|
||||||
|
const filterstr = process.env.LDAP_USER_FILTER.replace(
|
||||||
|
replacerUid,
|
||||||
|
ldapEscape.filter`${uid}`
|
||||||
|
).replace(replacerMail, ldapEscape.filter`${mail}`) //replace all appearances
|
||||||
|
// check bind
|
||||||
|
try {
|
||||||
|
if (process.env.LDAP_BINDDN) {
|
||||||
|
//try to bind directly with the user trying to log in
|
||||||
|
userDn = process.env.LDAP_BINDDN.replace(
|
||||||
|
replacerUid,
|
||||||
|
ldapEscape.filter`${uid}`
|
||||||
|
).replace(replacerMail, ldapEscape.filter`${mail}`)
|
||||||
|
await client.bind(userDn, password)
|
||||||
|
} else {
|
||||||
|
// use fixed bind user
|
||||||
|
await client.bind(ldap_reader, ldap_reader_pass)
|
||||||
|
}
|
||||||
|
} catch (ex) {
|
||||||
|
if (process.env.LDAP_BINDDN) {
|
||||||
|
console.log("Could not bind user: " + userDn)
|
||||||
|
} else {
|
||||||
|
console.log(
|
||||||
|
"Could not bind LDAP reader: " + ldap_reader + " err: " + String(ex)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return callback(null, null)
|
||||||
|
}
|
||||||
|
|
||||||
|
// get user data
|
||||||
|
try {
|
||||||
|
const { searchEntries, searchRef } = await client.search(ldap_base, {
|
||||||
|
scope: "sub",
|
||||||
|
filter: filterstr,
|
||||||
|
})
|
||||||
|
await searchEntries
|
||||||
|
console.log(JSON.stringify(searchEntries))
|
||||||
|
if (searchEntries[0]) {
|
||||||
|
mail = searchEntries[0].mail
|
||||||
|
uid = searchEntries[0].uid
|
||||||
|
firstname = searchEntries[0].givenName
|
||||||
|
lastname = searchEntries[0].sn
|
||||||
|
if (!process.env.LDAP_BINDDN) {
|
||||||
|
//dn is already correctly assembled
|
||||||
|
userDn = searchEntries[0].dn
|
||||||
|
}
|
||||||
|
console.log(
|
||||||
|
`Found user: ${mail} Name: ${firstname} ${lastname} DN: ${userDn}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
} catch (ex) {
|
||||||
|
console.log(
|
||||||
|
"An Error occured while getting user data during ldapsearch: " +
|
||||||
|
String(ex)
|
||||||
|
)
|
||||||
|
await client.unbind()
|
||||||
|
return callback(null, null)
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// if admin filter is set - only set admin for user in ldap group
|
||||||
|
// does not matter - admin is deactivated: managed through ldap
|
||||||
|
if (process.env.LDAP_ADMIN_GROUP_FILTER) {
|
||||||
|
const adminfilter = process.env.LDAP_ADMIN_GROUP_FILTER.replace(
|
||||||
|
replacerUid,
|
||||||
|
ldapEscape.filter`${uid}`
|
||||||
|
).replace(replacerMail, ldapEscape.filter`${mail}`)
|
||||||
|
adminEntry = await client.search(ldap_base, {
|
||||||
|
scope: "sub",
|
||||||
|
filter: adminfilter,
|
||||||
|
})
|
||||||
|
await adminEntry
|
||||||
|
//console.log('Admin Search response:' + JSON.stringify(adminEntry.searchEntries))
|
||||||
|
if (adminEntry.searchEntries[0]) {
|
||||||
|
console.log("is Admin")
|
||||||
|
isAdmin = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (ex) {
|
||||||
|
console.log(
|
||||||
|
"An Error occured while checking for admin rights - setting admin rights to false: " +
|
||||||
|
String(ex)
|
||||||
|
)
|
||||||
|
isAdmin = false
|
||||||
|
} finally {
|
||||||
|
await client.unbind()
|
||||||
|
}
|
||||||
|
if (mail == "" || userDn == "") {
|
||||||
|
console.log(
|
||||||
|
"Mail / userDn not set - exit. This should not happen - please set mail-entry in ldap."
|
||||||
|
)
|
||||||
|
return callback(null, null)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!process.env.BINDDN) {
|
||||||
|
//since we used a fixed bind user to obtain the correct userDn we need to bind again to authenticate
|
||||||
|
try {
|
||||||
|
await client.bind(userDn, password)
|
||||||
|
} catch (ex) {
|
||||||
|
console.log("Could not bind User: " + userDn + " err: " + String(ex))
|
||||||
|
return callback(null, null)
|
||||||
|
} finally {
|
||||||
|
await client.unbind()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//console.log('Logging in user: ' + mail + ' Name: ' + firstname + ' ' + lastname + ' isAdmin: ' + String(isAdmin))
|
||||||
|
// we are authenticated now let's set the query to the correct mail from ldap
|
||||||
|
query.email = mail
|
||||||
|
User.findOne(query, (error, user) => {
|
||||||
|
if (error) {
|
||||||
|
console.log(error)
|
||||||
|
}
|
||||||
|
if (user && user.hashedPassword) {
|
||||||
|
//console.log('******************** LOGIN ******************')
|
||||||
|
AuthenticationManager.login(user, "randomPass", callback)
|
||||||
|
} else {
|
||||||
|
onSuccessCreateUserIfNotExistent(
|
||||||
|
query,
|
||||||
|
user,
|
||||||
|
callback,
|
||||||
|
uid,
|
||||||
|
firstname,
|
||||||
|
lastname,
|
||||||
|
mail,
|
||||||
|
isAdmin
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
},
|
||||||
|
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
|
|
||||||
validateEmail(email) {
|
validateEmail(email) {
|
||||||
// we use the emailadress from the ldap
|
|
||||||
// therefore we do not enforce checks here
|
|
||||||
const parsed = EmailHelper.parseEmail(email)
|
const parsed = EmailHelper.parseEmail(email)
|
||||||
//if (!parsed) {
|
if (!parsed) {
|
||||||
// return new InvalidEmailError({ message: 'email not valid' })
|
return new InvalidEmailError({ message: 'email not valid' })
|
||||||
//}
|
}
|
||||||
return null
|
return null
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -128,10 +444,12 @@ const AuthenticationManager = {
|
|||||||
if (password == null) {
|
if (password == null) {
|
||||||
return new InvalidPasswordError({
|
return new InvalidPasswordError({
|
||||||
message: 'password not set',
|
message: 'password not set',
|
||||||
info: { code: 'not_set' }
|
info: { code: 'not_set' },
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Metrics.inc('try-validate-password')
|
||||||
|
|
||||||
let allowAnyChars, min, max
|
let allowAnyChars, min, max
|
||||||
if (Settings.passwordStrengthOptions) {
|
if (Settings.passwordStrengthOptions) {
|
||||||
allowAnyChars = Settings.passwordStrengthOptions.allowAnyChars === true
|
allowAnyChars = Settings.passwordStrengthOptions.allowAnyChars === true
|
||||||
@@ -141,7 +459,7 @@ const AuthenticationManager = {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
allowAnyChars = !!allowAnyChars
|
allowAnyChars = !!allowAnyChars
|
||||||
min = min || 6
|
min = min || 8
|
||||||
max = max || 72
|
max = max || 72
|
||||||
|
|
||||||
// we don't support passwords > 72 characters in length, because bcrypt truncates them
|
// we don't support passwords > 72 characters in length, because bcrypt truncates them
|
||||||
@@ -152,26 +470,60 @@ const AuthenticationManager = {
|
|||||||
if (password.length < min) {
|
if (password.length < min) {
|
||||||
return new InvalidPasswordError({
|
return new InvalidPasswordError({
|
||||||
message: 'password is too short',
|
message: 'password is too short',
|
||||||
info: { code: 'too_short' }
|
info: { code: 'too_short' },
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
if (password.length > max) {
|
if (password.length > max) {
|
||||||
return new InvalidPasswordError({
|
return new InvalidPasswordError({
|
||||||
message: 'password is too long',
|
message: 'password is too long',
|
||||||
info: { code: 'too_long' }
|
info: { code: 'too_long' },
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
const passwordLengthError = _validatePasswordNotTooLong(password)
|
||||||
|
if (passwordLengthError) {
|
||||||
|
return passwordLengthError
|
||||||
|
}
|
||||||
if (
|
if (
|
||||||
!allowAnyChars &&
|
!allowAnyChars &&
|
||||||
!AuthenticationManager._passwordCharactersAreValid(password)
|
!AuthenticationManager._passwordCharactersAreValid(password)
|
||||||
) {
|
) {
|
||||||
return new InvalidPasswordError({
|
return new InvalidPasswordError({
|
||||||
message: 'password contains an invalid character',
|
message: 'password contains an invalid character',
|
||||||
info: { code: 'invalid_character' }
|
info: { code: 'invalid_character' },
|
||||||
})
|
})
|
||||||
|
}
|
||||||
|
if (typeof email === 'string' && email !== '') {
|
||||||
|
const startOfEmail = email.split('@')[0]
|
||||||
|
if (
|
||||||
|
password.includes(email) ||
|
||||||
|
password.includes(startOfEmail) ||
|
||||||
|
email.includes(password)
|
||||||
|
) {
|
||||||
|
return new InvalidPasswordError({
|
||||||
|
message: 'password contains part of email address',
|
||||||
|
info: { code: 'contains_email' },
|
||||||
|
})
|
||||||
}
|
}
|
||||||
return null
|
try {
|
||||||
},
|
const passwordTooSimilarError =
|
||||||
|
AuthenticationManager._validatePasswordNotTooSimilar(password, email)
|
||||||
|
if (passwordTooSimilarError) {
|
||||||
|
Metrics.inc('password-too-similar-to-email')
|
||||||
|
return new InvalidPasswordError({
|
||||||
|
message: 'password is too similar to email address',
|
||||||
|
info: { code: 'too_similar' },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
logger.error(
|
||||||
|
{ error },
|
||||||
|
'error while checking password similarity to email'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
// TODO: remove this check once the password-too-similar checks are active?
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
},
|
||||||
|
|
||||||
setUserPassword(user, password, callback) {
|
setUserPassword(user, password, callback) {
|
||||||
AuthenticationManager.setUserPasswordInV2(user, password, callback)
|
AuthenticationManager.setUserPasswordInV2(user, password, callback)
|
||||||
@@ -179,21 +531,25 @@ const AuthenticationManager = {
|
|||||||
|
|
||||||
checkRounds(user, hashedPassword, password, callback) {
|
checkRounds(user, hashedPassword, password, callback) {
|
||||||
// Temporarily disable this function, TODO: re-enable this
|
// Temporarily disable this function, TODO: re-enable this
|
||||||
//return callback()
|
|
||||||
if (Settings.security.disableBcryptRoundsUpgrades) {
|
if (Settings.security.disableBcryptRoundsUpgrades) {
|
||||||
return callback()
|
return callback()
|
||||||
}
|
}
|
||||||
// check current number of rounds and rehash if necessary
|
// check current number of rounds and rehash if necessary
|
||||||
const currentRounds = bcrypt.getRounds(hashedPassword)
|
const currentRounds = bcrypt.getRounds(hashedPassword)
|
||||||
if (currentRounds < BCRYPT_ROUNDS) {
|
if (currentRounds < BCRYPT_ROUNDS) {
|
||||||
AuthenticationManager.setUserPassword(user, password, callback)
|
AuthenticationManager._setUserPasswordInMongo(user, password, callback)
|
||||||
} else {
|
} else {
|
||||||
callback()
|
callback()
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
hashPassword(password, callback) {
|
hashPassword(password, callback) {
|
||||||
bcrypt.genSalt(BCRYPT_ROUNDS, BCRYPT_MINOR_VERSION, function(error, salt) {
|
// Double-check the size to avoid truncating in bcrypt.
|
||||||
|
const error = _validatePasswordNotTooLong(password)
|
||||||
|
if (error) {
|
||||||
|
return callback(error)
|
||||||
|
}
|
||||||
|
bcrypt.genSalt(BCRYPT_ROUNDS, BCRYPT_MINOR_VERSION, function (error, salt) {
|
||||||
if (error) {
|
if (error) {
|
||||||
return callback(error)
|
return callback(error)
|
||||||
}
|
}
|
||||||
@@ -202,32 +558,61 @@ const AuthenticationManager = {
|
|||||||
},
|
},
|
||||||
|
|
||||||
setUserPasswordInV2(user, password, callback) {
|
setUserPasswordInV2(user, password, callback) {
|
||||||
//if (!user || !user.email || !user._id) {
|
if (!user || !user.email || !user._id) {
|
||||||
// return callback(new Error('invalid user object'))
|
return callback(new Error('invalid user object'))
|
||||||
//}
|
}
|
||||||
|
|
||||||
console.log("Setting pass for user: " + JSON.stringify(user))
|
|
||||||
const validationError = this.validatePassword(password, user.email)
|
const validationError = this.validatePassword(password, user.email)
|
||||||
if (validationError) {
|
if (validationError) {
|
||||||
return callback(validationError)
|
return callback(validationError)
|
||||||
}
|
}
|
||||||
this.hashPassword(password, function(error, hash) {
|
// check if we can log in with this password. In which case we should reject it,
|
||||||
|
// because it is the same as the existing password.
|
||||||
|
AuthenticationManager._checkUserPassword(
|
||||||
|
{ _id: user._id },
|
||||||
|
password,
|
||||||
|
(err, _user, match) => {
|
||||||
|
if (err) {
|
||||||
|
return callback(err)
|
||||||
|
}
|
||||||
|
if (match) {
|
||||||
|
return callback(new PasswordMustBeDifferentError())
|
||||||
|
}
|
||||||
|
|
||||||
|
HaveIBeenPwned.checkPasswordForReuse(
|
||||||
|
password,
|
||||||
|
(error, isPasswordReused) => {
|
||||||
|
if (error) {
|
||||||
|
logger.err({ error }, 'cannot check password for re-use')
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!error && isPasswordReused) {
|
||||||
|
return callback(new PasswordReusedError())
|
||||||
|
}
|
||||||
|
|
||||||
|
// password is strong enough or the validation with the service did not happen
|
||||||
|
this._setUserPasswordInMongo(user, password, callback)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
},
|
||||||
|
|
||||||
|
_setUserPasswordInMongo(user, password, callback) {
|
||||||
|
this.hashPassword(password, function (error, hash) {
|
||||||
if (error) {
|
if (error) {
|
||||||
return callback(error)
|
return callback(error)
|
||||||
}
|
}
|
||||||
db.users.updateOne(
|
db.users.updateOne(
|
||||||
{
|
{ _id: ObjectId(user._id.toString()) },
|
||||||
_id: ObjectId(user._id.toString())
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
$set: {
|
$set: {
|
||||||
hashedPassword: hash
|
hashedPassword: hash,
|
||||||
},
|
},
|
||||||
$unset: {
|
$unset: {
|
||||||
password: true
|
password: true,
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
function(updateError, result) {
|
function (updateError, result) {
|
||||||
if (updateError) {
|
if (updateError) {
|
||||||
return callback(updateError)
|
return callback(updateError)
|
||||||
}
|
}
|
||||||
@@ -266,95 +651,82 @@ const AuthenticationManager = {
|
|||||||
return true
|
return true
|
||||||
},
|
},
|
||||||
|
|
||||||
async ldapAuth(query, password, onSuccessCreateUserIfNotExistent, callback, user) {
|
/**
|
||||||
const client = new Client({
|
* Check if the password is similar to (parts of) the email address.
|
||||||
url: process.env.LDAP_SERVER,
|
* For now, this merely sends a metric when the password and
|
||||||
});
|
* email address are deemed to be too similar to each other.
|
||||||
//const bindDn = process.env.LDAP_BIND_USER
|
* Later we will reject passwords that fail this check.
|
||||||
//const bindPassword = process.env.LDAP_BIND_PW
|
*
|
||||||
const ldap_bd = process.env.LDAP_BINDDN
|
* This logic was borrowed from the django project:
|
||||||
const ldap_base = process.env.LDAP_BASE
|
* https://github.com/django/django/blob/fa3afc5d86f1f040922cca2029d6a34301597a70/django/contrib/auth/password_validation.py#L159-L214
|
||||||
const uid = query.email.split('@')[0]
|
*/
|
||||||
const filterstr = '(&' + process.env.LDAP_GROUP_FILTER + '(uid=' + uid + '))'
|
_validatePasswordNotTooSimilar(password, email) {
|
||||||
const userDn = 'uid=' + uid + ',' + ldap_bd;
|
password = password.toLowerCase()
|
||||||
var mail = ""
|
email = email.toLowerCase()
|
||||||
var firstname = ""
|
const stringsToCheck = [email]
|
||||||
var lastname = ""
|
.concat(email.split(/\W+/))
|
||||||
var isAdmin = false
|
.concat(email.split(/@/))
|
||||||
// check bind
|
for (const emailPart of stringsToCheck) {
|
||||||
try {
|
if (!_exceedsMaximumLengthRatio(password, MAX_SIMILARITY, emailPart)) {
|
||||||
//await client.bind(bindDn, bindPassword);
|
const similarity = DiffHelper.stringSimilarity(password, emailPart)
|
||||||
await client.bind(userDn,password);
|
if (similarity > MAX_SIMILARITY) {
|
||||||
} catch (ex) {
|
logger.warn(
|
||||||
console.log("Could not bind user." + String(ex))
|
{ email, emailPart, similarity, maxSimilarity: MAX_SIMILARITY },
|
||||||
return callback(null, null)
|
'Password too similar to email'
|
||||||
}
|
)
|
||||||
// get user data
|
return new Error('password is too similar to email')
|
||||||
try {
|
|
||||||
const {searchEntries, searchRef,} = await client.search(ldap_base, {
|
|
||||||
scope: 'sub',
|
|
||||||
filter: filterstr ,
|
|
||||||
});
|
|
||||||
await searchEntries
|
|
||||||
//console.log(JSON.stringify(searchEntries))
|
|
||||||
if (searchEntries[0]) {
|
|
||||||
mail = searchEntries[0].mail
|
|
||||||
firstname = searchEntries[0].givenName
|
|
||||||
lastname = searchEntries[0].sn
|
|
||||||
//console.log("Found user: " + mail + " Name: " + firstname + " " + lastname)
|
|
||||||
}
|
|
||||||
} catch (ex) {
|
|
||||||
console.log("An Error occured while getting user data during ldapsearch: " + String(ex))
|
|
||||||
await client.unbind();
|
|
||||||
return callback(null, null)
|
|
||||||
}
|
|
||||||
try {
|
|
||||||
// if admin filter is set - only set admin for user in ldap group
|
|
||||||
// does not matter - admin is deactivated: managed through ldap
|
|
||||||
if (process.env.LDAP_ADMIN_GROUP_FILTER) {
|
|
||||||
const adminfilter = '(&' + process.env.LDAP_ADMIN_GROUP_FILTER + '(uid=' + uid + '))'
|
|
||||||
adminEntry = await client.search(ldap_base, {
|
|
||||||
scope: 'sub',
|
|
||||||
filter: adminfilter,
|
|
||||||
});
|
|
||||||
await adminEntry;
|
|
||||||
//console.log("Admin Search response:" + JSON.stringify(adminEntry.searchEntries))
|
|
||||||
if (adminEntry.searchEntries[0].mail) {
|
|
||||||
console.log("is Admin")
|
|
||||||
isAdmin=true;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} catch (ex) {
|
|
||||||
console.log("An Error occured while checking for admin rights - setting admin rights to false: " + String(ex))
|
|
||||||
isAdmin = false;
|
|
||||||
} finally {
|
|
||||||
await client.unbind();
|
|
||||||
}
|
}
|
||||||
if (mail == "") {
|
},
|
||||||
console.log("Mail not set - exit. This should not happen - please set mail-entry in ldap.")
|
|
||||||
return callback(null, null)
|
getMessageForInvalidPasswordError(error, req) {
|
||||||
|
const errorCode = error?.info?.code
|
||||||
|
const message = {
|
||||||
|
type: 'error',
|
||||||
}
|
}
|
||||||
//console.log("Logging in user: " + mail + " Name: " + firstname + " " + lastname + " isAdmin: " + String(isAdmin))
|
switch (errorCode) {
|
||||||
// we are authenticated now let's set the query to the correct mail from ldap
|
case 'not_set':
|
||||||
query.email = mail
|
message.key = 'password-not-set'
|
||||||
User.findOne(query, (error, user) => {
|
message.text = req.i18n.translate('invalid_password_not_set')
|
||||||
if (error) {
|
break
|
||||||
console.log(error)
|
case 'invalid_character':
|
||||||
}
|
message.key = 'password-invalid-character'
|
||||||
if (user && user.hashedPassword) {
|
message.text = req.i18n.translate('invalid_password_invalid_character')
|
||||||
//console.log("******************** LOGIN ******************")
|
break
|
||||||
AuthenticationManager.login(user, "randomPass", callback)
|
case 'contains_email':
|
||||||
} else {
|
message.key = 'password-contains-email'
|
||||||
onSuccessCreateUserIfNotExistent(query, user, callback, uid, firstname, lastname, mail, isAdmin)
|
message.text = req.i18n.translate('invalid_password_contains_email')
|
||||||
}
|
break
|
||||||
})
|
case 'too_similar':
|
||||||
}
|
message.key = 'password-too-similar'
|
||||||
|
message.text = req.i18n.translate('invalid_password_too_similar')
|
||||||
|
break
|
||||||
|
case 'too_short':
|
||||||
|
message.key = 'password-too-short'
|
||||||
|
message.text = req.i18n.translate('invalid_password_too_short', {
|
||||||
|
minLength: Settings.passwordStrengthOptions?.length?.min || 8,
|
||||||
|
})
|
||||||
|
break
|
||||||
|
case 'too_long':
|
||||||
|
message.key = 'password-too-long'
|
||||||
|
message.text = req.i18n.translate('invalid_password_too_long', {
|
||||||
|
maxLength: Settings.passwordStrengthOptions?.length?.max || 72,
|
||||||
|
})
|
||||||
|
break
|
||||||
|
default:
|
||||||
|
logger.error({ err: error }, 'Unknown password validation error code')
|
||||||
|
message.text = req.i18n.translate('invalid_password')
|
||||||
|
break
|
||||||
|
}
|
||||||
|
return message
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
AuthenticationManager.promises = {
|
AuthenticationManager.promises = {
|
||||||
authenticate: util.promisify(AuthenticationManager.authenticate),
|
authenticate: util.promisify(AuthenticationManager.authenticate),
|
||||||
hashPassword: util.promisify(AuthenticationManager.hashPassword),
|
hashPassword: util.promisify(AuthenticationManager.hashPassword),
|
||||||
setUserPassword: util.promisify(AuthenticationManager.setUserPassword)
|
setUserPassword: util.promisify(AuthenticationManager.setUserPassword),
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = AuthenticationManager
|
module.exports = AuthenticationManager
|
||||||
|
|||||||
@@ -1,128 +1,130 @@
|
|||||||
/* eslint-disable
|
/**
|
||||||
camelcase,
|
* >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
max-len,
|
* Modified from 906765c
|
||||||
no-unused-vars,
|
* <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
*/
|
|
||||||
// TODO: This file was created by bulk-decaffeinate.
|
|
||||||
// Fix any style issues and re-enable lint.
|
|
||||||
/*
|
|
||||||
* decaffeinate suggestions:
|
|
||||||
* DS101: Remove unnecessary use of Array.from
|
|
||||||
* DS102: Remove unnecessary code created because of implicit returns
|
|
||||||
* DS207: Consider shorter variations of null checks
|
|
||||||
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
|
|
||||||
*/
|
*/
|
||||||
let ContactsController
|
|
||||||
const AuthenticationController = require('../Authentication/AuthenticationController')
|
const SessionManager = require('../Authentication/SessionManager')
|
||||||
const ContactManager = require('./ContactManager')
|
const ContactManager = require('./ContactManager')
|
||||||
const UserGetter = require('../User/UserGetter')
|
const UserGetter = require('../User/UserGetter')
|
||||||
const logger = require('logger-sharelatex')
|
|
||||||
const Modules = require('../../infrastructure/Modules')
|
const Modules = require('../../infrastructure/Modules')
|
||||||
const { Client } = require('ldapts');
|
const { expressify } = require('../../util/promises')
|
||||||
|
|
||||||
module.exports = ContactsController = {
|
// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
getContacts(req, res, next) {
|
const { Client } = require('ldapts')
|
||||||
const user_id = AuthenticationController.getLoggedInUserId(req)
|
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
return ContactManager.getContactIds(user_id, { limit: 50 }, function(
|
|
||||||
error,
|
|
||||||
contact_ids
|
|
||||||
) {
|
|
||||||
if (error != null) {
|
|
||||||
return next(error)
|
|
||||||
}
|
|
||||||
return UserGetter.getUsers(
|
|
||||||
contact_ids,
|
|
||||||
{
|
|
||||||
email: 1,
|
|
||||||
first_name: 1,
|
|
||||||
last_name: 1,
|
|
||||||
holdingAccount: 1
|
|
||||||
},
|
|
||||||
function(error, contacts) {
|
|
||||||
if (error != null) {
|
|
||||||
return next(error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// UserGetter.getUsers may not preserve order so put them back in order
|
function _formatContact(contact) {
|
||||||
const positions = {}
|
return {
|
||||||
for (let i = 0; i < contact_ids.length; i++) {
|
id: contact._id?.toString(),
|
||||||
const contact_id = contact_ids[i]
|
email: contact.email || '',
|
||||||
positions[contact_id] = i
|
first_name: contact.first_name || '',
|
||||||
}
|
last_name: contact.last_name || '',
|
||||||
|
type: 'user',
|
||||||
contacts.sort(
|
|
||||||
(a, b) =>
|
|
||||||
positions[a._id != null ? a._id.toString() : undefined] -
|
|
||||||
positions[b._id != null ? b._id.toString() : undefined]
|
|
||||||
)
|
|
||||||
|
|
||||||
// Don't count holding accounts to discourage users from repeating mistakes (mistyped or wrong emails, etc)
|
|
||||||
contacts = contacts.filter(c => !c.holdingAccount)
|
|
||||||
ContactsController.getLdapContacts(contacts).then((ldapcontacts) => {
|
|
||||||
contacts.push(ldapcontacts)
|
|
||||||
contacts = contacts.map(ContactsController._formatContact)
|
|
||||||
return Modules.hooks.fire('getContacts', user_id, contacts, function(
|
|
||||||
error,
|
|
||||||
additional_contacts
|
|
||||||
) {
|
|
||||||
if (error != null) {
|
|
||||||
return next(error)
|
|
||||||
}
|
|
||||||
contacts = contacts.concat(...Array.from(additional_contacts || []))
|
|
||||||
return res.send({
|
|
||||||
contacts
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}).catch(e => console.log("Error appending ldap contacts" + e))
|
|
||||||
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
},
|
|
||||||
async getLdapContacts(contacts) {
|
|
||||||
if (! process.env.LDAP_CONTACTS) {
|
|
||||||
return contacts
|
|
||||||
}
|
|
||||||
const client = new Client({
|
|
||||||
url: process.env.LDAP_SERVER,
|
|
||||||
});
|
|
||||||
const ldap_base = process.env.LDAP_BASE
|
|
||||||
// get user data
|
|
||||||
try {
|
|
||||||
// if you need an client.bind do it here.
|
|
||||||
const {searchEntries,searchReferences,} = await client.search(ldap_base, {scope: 'sub',filter: process.env.LDAP_GROUP_FILTER ,});
|
|
||||||
await searchEntries;
|
|
||||||
for (var i = 0; i < searchEntries.length; i++) {
|
|
||||||
var entry = new Map()
|
|
||||||
var obj = searchEntries[i];
|
|
||||||
entry['_id'] = undefined
|
|
||||||
entry['email'] = obj['mail']
|
|
||||||
entry['first_name'] = obj['givenName']
|
|
||||||
entry['last_name'] = obj['sn']
|
|
||||||
entry['type'] = "user"
|
|
||||||
// Only add to contacts if entry is not there.
|
|
||||||
if(contacts.indexOf(entry) === -1) {
|
|
||||||
contacts.push(entry);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch (ex) {
|
|
||||||
console.log(String(ex))
|
|
||||||
}
|
|
||||||
//console.log(JSON.stringify(contacts))
|
|
||||||
finally {
|
|
||||||
// even if we did not use bind - the constructor of
|
|
||||||
// new Client() opens a socket to the ldap server
|
|
||||||
client.unbind()
|
|
||||||
return contacts
|
|
||||||
}
|
|
||||||
},
|
|
||||||
_formatContact(contact) {
|
|
||||||
return {
|
|
||||||
id: contact._id != null ? contact._id.toString() : undefined,
|
|
||||||
email: contact.email || '',
|
|
||||||
first_name: contact.first_name || '',
|
|
||||||
last_name: contact.last_name || '',
|
|
||||||
type: 'user'
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function getContacts(req, res) {
|
||||||
|
const userId = SessionManager.getLoggedInUserId(req.session)
|
||||||
|
|
||||||
|
const contactIds = await ContactManager.promises.getContactIds(userId, {
|
||||||
|
limit: 50,
|
||||||
|
})
|
||||||
|
|
||||||
|
let contacts = await UserGetter.promises.getUsers(contactIds, {
|
||||||
|
email: 1,
|
||||||
|
first_name: 1,
|
||||||
|
last_name: 1,
|
||||||
|
holdingAccount: 1,
|
||||||
|
})
|
||||||
|
|
||||||
|
// UserGetter.getUsers may not preserve order so put them back in order
|
||||||
|
const positions = {}
|
||||||
|
for (let i = 0; i < contactIds.length; i++) {
|
||||||
|
const contact_id = contactIds[i]
|
||||||
|
positions[contact_id] = i
|
||||||
|
}
|
||||||
|
contacts.sort(
|
||||||
|
(a, b) => positions[a._id?.toString()] - positions[b._id?.toString()]
|
||||||
|
)
|
||||||
|
|
||||||
|
// Don't count holding accounts to discourage users from repeating mistakes (mistyped or wrong emails, etc)
|
||||||
|
contacts = contacts.filter((c) => !c.holdingAccount)
|
||||||
|
|
||||||
|
// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
|
const ldapcontacts = getLdapContacts(contacts)
|
||||||
|
contacts.push(ldapcontacts)
|
||||||
|
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
|
|
||||||
|
contacts = contacts.map(_formatContact)
|
||||||
|
|
||||||
|
const additionalContacts = await Modules.promises.hooks.fire(
|
||||||
|
'getContacts',
|
||||||
|
userId,
|
||||||
|
contacts
|
||||||
|
)
|
||||||
|
|
||||||
|
contacts = contacts.concat(...(additionalContacts || []))
|
||||||
|
return res.json({
|
||||||
|
contacts,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
||||||
|
async function getLdapContacts(contacts) {
|
||||||
|
if (
|
||||||
|
process.env.LDAP_CONTACTS === undefined ||
|
||||||
|
!(process.env.LDAP_CONTACTS.toLowerCase() === 'true')
|
||||||
|
) {
|
||||||
|
return contacts
|
||||||
|
}
|
||||||
|
const client = new Client({
|
||||||
|
url: process.env.LDAP_SERVER,
|
||||||
|
})
|
||||||
|
|
||||||
|
// if we need a ldap user try to bind
|
||||||
|
if (process.env.LDAP_BIND_USER) {
|
||||||
|
try {
|
||||||
|
await client.bind(process.env.LDAP_BIND_USER, process.env.LDAP_BIND_PW)
|
||||||
|
} catch (ex) {
|
||||||
|
console.log('Could not bind LDAP reader user: ' + String(ex))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const ldap_base = process.env.LDAP_BASE
|
||||||
|
// get user data
|
||||||
|
try {
|
||||||
|
// if you need an client.bind do it here.
|
||||||
|
const { searchEntries, searchReferences } = await client.search(ldap_base, {
|
||||||
|
scope: 'sub',
|
||||||
|
filter: process.env.LDAP_CONTACT_FILTER,
|
||||||
|
})
|
||||||
|
await searchEntries
|
||||||
|
for (var i = 0; i < searchEntries.length; i++) {
|
||||||
|
var entry = new Map()
|
||||||
|
var obj = searchEntries[i]
|
||||||
|
entry['_id'] = undefined
|
||||||
|
entry['email'] = obj['mail']
|
||||||
|
entry['first_name'] = obj['givenName']
|
||||||
|
entry['last_name'] = obj['sn']
|
||||||
|
entry['type'] = 'user'
|
||||||
|
// Only add to contacts if entry is not there.
|
||||||
|
if (contacts.indexOf(entry) === -1) {
|
||||||
|
contacts.push(entry)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (ex) {
|
||||||
|
console.log(String(ex))
|
||||||
|
} finally {
|
||||||
|
// console.log(JSON.stringify(contacts))
|
||||||
|
// even if we did not use bind - the constructor of
|
||||||
|
// new Client() opens a socket to the ldap server
|
||||||
|
client.unbind()
|
||||||
|
return contacts
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
getContacts: expressify(getContacts),
|
||||||
|
}
|
||||||
|
|||||||
79
ldap-overleaf-sl/sharelatex/admin-sysadmin.pug
Normal file
79
ldap-overleaf-sl/sharelatex/admin-sysadmin.pug
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
extends ../layout
|
||||||
|
|
||||||
|
block content
|
||||||
|
.content.content-alt
|
||||||
|
.container
|
||||||
|
.row
|
||||||
|
.col-xs-12
|
||||||
|
.card(ng-controller="RegisterUsersController")
|
||||||
|
.page-header
|
||||||
|
h1 Admin Panel
|
||||||
|
tabset(ng-cloak)
|
||||||
|
tab(heading="System Messages")
|
||||||
|
each message in systemMessages
|
||||||
|
.alert.alert-info.row-spaced(ng-non-bindable) #{message.content}
|
||||||
|
hr
|
||||||
|
form(method='post', action='/admin/messages')
|
||||||
|
input(name="_csrf", type="hidden", value=csrfToken)
|
||||||
|
.form-group
|
||||||
|
label(for="content")
|
||||||
|
input.form-control(name="content", type="text", placeholder="Message...", required)
|
||||||
|
button.btn.btn-primary(type="submit") Post Message
|
||||||
|
hr
|
||||||
|
form(method='post', action='/admin/messages/clear')
|
||||||
|
input(name="_csrf", type="hidden", value=csrfToken)
|
||||||
|
button.btn.btn-danger(type="submit") Clear all messages
|
||||||
|
|
||||||
|
|
||||||
|
tab(heading="Register non LDAP User")
|
||||||
|
form.form
|
||||||
|
.row
|
||||||
|
.col-md-4.col-xs-8
|
||||||
|
input.form-control(
|
||||||
|
name="email",
|
||||||
|
type="text",
|
||||||
|
placeholder="jane@example.com, joe@example.com",
|
||||||
|
ng-model="inputs.emails",
|
||||||
|
on-enter="registerUsers()"
|
||||||
|
)
|
||||||
|
.col-md-8.col-xs-4
|
||||||
|
button.btn.btn-primary(ng-click="registerUsers()") #{translate("register")}
|
||||||
|
|
||||||
|
.row-spaced(ng-show="error").ng-cloak.text-danger
|
||||||
|
p Sorry, an error occured
|
||||||
|
|
||||||
|
.row-spaced(ng-show="users.length > 0").ng-cloak.text-success
|
||||||
|
p We've sent out welcome emails to the registered users.
|
||||||
|
p You can also manually send them URLs below to allow them to reset their password and log in for the first time.
|
||||||
|
p (Password reset tokens will expire after one week and the user will need registering again).
|
||||||
|
|
||||||
|
hr(ng-show="users.length > 0").ng-cloak
|
||||||
|
table(ng-show="users.length > 0").table.table-striped.ng-cloak
|
||||||
|
tr
|
||||||
|
th #{translate("email")}
|
||||||
|
th Set Password Url
|
||||||
|
tr(ng-repeat="user in users")
|
||||||
|
td {{ user.email }}
|
||||||
|
td(style="word-break: break-all;") {{ user.setNewPasswordUrl }}
|
||||||
|
tab(heading="Open/Close Editor" bookmarkable-tab="open-close-editor")
|
||||||
|
if hasFeature('saas')
|
||||||
|
| The "Open/Close Editor" feature is not available in SAAS.
|
||||||
|
else
|
||||||
|
.row-spaced
|
||||||
|
form(method='post',action='/admin/closeEditor')
|
||||||
|
input(name="_csrf", type="hidden", value=csrfToken)
|
||||||
|
button.btn.btn-danger(type="submit") Close Editor
|
||||||
|
p.small Will stop anyone opening the editor. Will NOT disconnect already connected users.
|
||||||
|
|
||||||
|
.row-spaced
|
||||||
|
form(method='post',action='/admin/disconnectAllUsers')
|
||||||
|
input(name="_csrf", type="hidden", value=csrfToken)
|
||||||
|
button.btn.btn-danger(type="submit") Disconnect all users
|
||||||
|
p.small Will force disconnect all users with the editor open. Make sure to close the editor first to avoid them reconnecting.
|
||||||
|
|
||||||
|
.row-spaced
|
||||||
|
form(method='post',action='/admin/openEditor')
|
||||||
|
input(name="_csrf", type="hidden", value=csrfToken)
|
||||||
|
button.btn.btn-danger(type="submit") Reopen Editor
|
||||||
|
p.small Will reopen the editor after closing.
|
||||||
|
|
||||||
Reference in New Issue
Block a user