Authentication#
User registration#
The default setup for Weblate is to use python-social-auth, a form on the website to handle registration of new users. After confirming their e-mail a new user can contribute or authenticate by using one of the third party services.
You can also turn off registration of new users using
REGISTRATION_OPEN
.
The authentication attempts are subject to Rate limiting.
Authentication backends#
The built-in solution of Django is used for authentication, including various social options to do so. Using it means you can import the user database of other Django-based projects (see Migrating from Pootle).
Django can additionally be set up to authenticate against other means too.
See also
Authentication settings describes how to configure authentication in the official Docker image.
Password authentication#
The default settings.py
comes with a reasonable set of
AUTH_PASSWORD_VALIDATORS
:
Passwords can’t be too similar to your other personal info.
Passwords must contain at least 10 characters.
Passwords can’t be a commonly used password.
Passwords can’t be entirely numeric.
Passwords can’t consist of a single character or only whitespace.
Passwords can’t match a password you have used in the past.
You can customize this setting to match your password policy.
Additionally you can also install django-zxcvbn-password which gives quite realistic estimates of password difficulty and allows rejecting passwords below a certain threshold.
SAML authentication#
New in version 4.1.1.
Please follow the Python Social Auth instructions for configuration. Notable differences:
Weblate supports single IDP which has to be called
weblate
inSOCIAL_AUTH_SAML_ENABLED_IDPS
.The SAML XML metadata URL is
/accounts/metadata/saml/
.Following settings are automatically filled in:
SOCIAL_AUTH_SAML_SP_ENTITY_ID
,SOCIAL_AUTH_SAML_TECHNICAL_CONTACT
,SOCIAL_AUTH_SAML_SUPPORT_CONTACT
Example configuration:
# Authentication configuration
AUTHENTICATION_BACKENDS = (
"social_core.backends.email.EmailAuth",
"social_core.backends.saml.SAMLAuth",
"weblate.accounts.auth.WeblateUserBackend",
)
# Social auth backends setup
SOCIAL_AUTH_SAML_SP_ENTITY_ID = f"https://{SITE_DOMAIN}/accounts/metadata/saml/"
SOCIAL_AUTH_SAML_SP_PUBLIC_CERT = "-----BEGIN CERTIFICATE-----"
SOCIAL_AUTH_SAML_SP_PRIVATE_KEY = "-----BEGIN PRIVATE KEY-----"
SOCIAL_AUTH_SAML_ENABLED_IDPS = {
"weblate": {
"entity_id": "https://idp.testshib.org/idp/shibboleth",
"url": "https://idp.testshib.org/idp/profile/SAML2/Redirect/SSO",
"x509cert": "MIIEDjCCAvagAwIBAgIBADA ... 8Bbnl+ev0peYzxFyF5sQA==",
"attr_name": "full_name",
"attr_username": "username",
"attr_email": "email",
}
}
SOCIAL_AUTH_SAML_ORG_INFO = {
"en-US": {
"name": "example",
"displayname": "Example Inc.",
"url": "http://example.com"
}
}
SOCIAL_AUTH_SAML_TECHNICAL_CONTACT = {
"givenName": "Tech Gal",
"emailAddress": "technical@example.com"
}
SOCIAL_AUTH_SAML_SUPPORT_CONTACT = {
"givenName": "Support Guy",
"emailAddress": "support@example.com"
}
The default configuration extracts user details from following attributes, configure your IDP to provide them:
Attribute |
SAML URI reference |
---|---|
Full name |
|
First name |
|
Last name |
|
|
|
Username |
|
Hint
The example above and the Docker image define an IDP called weblate
.
You might need to configure this string as Relay in your IDP.
See also
LDAP authentication#
LDAP authentication can be best achieved using the django-auth-ldap package. You can install it via usual means:
# Using PyPI
pip install django-auth-ldap>=1.3.0
# Using apt-get
apt-get install python-django-auth-ldap
Hint
This package is included in the Docker container, see Installing using Docker.
Note
There are some incompatibilities in the Python LDAP 3.1.0 module, which might prevent you from using that version. If you get error AttributeError: ‘module’ object has no attribute ‘_trace_level’, downgrading python-ldap to 3.0.0 might help.
Once you have the package installed, you can hook it into the Django authentication:
# Add LDAP backed, keep Django one if you want to be able to sign in
# even without LDAP for admin account
AUTHENTICATION_BACKENDS = (
"django_auth_ldap.backend.LDAPBackend",
"weblate.accounts.auth.WeblateUserBackend",
)
# LDAP server address
AUTH_LDAP_SERVER_URI = "ldaps://ldap.example.net"
# DN to use for authentication
AUTH_LDAP_USER_DN_TEMPLATE = "cn=%(user)s,o=Example"
# Depending on your LDAP server, you might use a different DN
# like:
# AUTH_LDAP_USER_DN_TEMPLATE = 'ou=users,dc=example,dc=com'
# List of attributes to import from LDAP upon sign in
# Weblate stores full name of the user in the full_name attribute
AUTH_LDAP_USER_ATTR_MAP = {
"full_name": "name",
# Use the following if your LDAP server does not have full name
# Weblate will merge them later
# 'first_name': 'givenName',
# 'last_name': 'sn',
# Email is required for Weblate (used in VCS commits)
"email": "mail",
}
# Hide the registration form
REGISTRATION_OPEN = False
Note
You should remove 'social_core.backends.email.EmailAuth'
from the
AUTHENTICATION_BACKENDS
setting, otherwise users will be able to set
their password in Weblate, and authenticate using that. Keeping
'weblate.accounts.auth.WeblateUserBackend'
is still needed in order to
make permissions and facilitate anonymous users. It will also allow you
to sign in using a local admin account, if you have created it (e.g. by using
createadmin
).
Using bind password#
If you can not use direct bind for authentication, you will need to use search, and provide a user to bind for the search. For example:
import ldap
from django_auth_ldap.config import LDAPSearch
AUTH_LDAP_BIND_DN = ""
AUTH_LDAP_BIND_PASSWORD = ""
AUTH_LDAP_USER_SEARCH = LDAPSearch(
"ou=users,dc=example,dc=com", ldap.SCOPE_SUBTREE, "(uid=%(user)s)"
)
Active Directory integration#
import ldap
from django_auth_ldap.config import LDAPSearch, NestedActiveDirectoryGroupType
AUTH_LDAP_BIND_DN = "CN=ldap,CN=Users,DC=example,DC=com"
AUTH_LDAP_BIND_PASSWORD = "password"
# User and group search objects and types
AUTH_LDAP_USER_SEARCH = LDAPSearch(
"CN=Users,DC=example,DC=com", ldap.SCOPE_SUBTREE, "(sAMAccountName=%(user)s)"
)
# Make selected group a superuser in Weblate
AUTH_LDAP_USER_FLAGS_BY_GROUP = {
# is_superuser means user has all permissions
"is_superuser": "CN=weblate_AdminUsers,OU=Groups,DC=example,DC=com",
}
# Map groups from AD to Weblate
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(
"OU=Groups,DC=example,DC=com", ldap.SCOPE_SUBTREE, "(objectClass=group)"
)
AUTH_LDAP_GROUP_TYPE = NestedActiveDirectoryGroupType()
AUTH_LDAP_FIND_GROUP_PERMS = True
# Optionally enable group mirroring from LDAP to Weblate
# AUTH_LDAP_MIRROR_GROUPS = True
CAS authentication#
CAS authentication can be achieved using a package such as django-cas-ng.
Step one is disclosing the e-mail field of the user via CAS. This has to be configured on the CAS server itself, and requires you run at least CAS v2 since CAS v1 doesn’t support attributes at all.
Step two is updating Weblate to use your CAS server and attributes.
To install django-cas-ng:
pip install django-cas-ng
Once you have the package installed you can hook it up to the Django
authentication system by modifying the settings.py
file:
# Add CAS backed, keep the Django one if you want to be able to sign in
# even without LDAP for the admin account
AUTHENTICATION_BACKENDS = (
"django_cas_ng.backends.CASBackend",
"weblate.accounts.auth.WeblateUserBackend",
)
# CAS server address
CAS_SERVER_URL = "https://cas.example.net/cas/"
# Add django_cas_ng somewhere in the list of INSTALLED_APPS
INSTALLED_APPS = (..., "django_cas_ng")
Finally, a signal can be used to map the e-mail field to the user object. For this to work you have to import the signal from the django-cas-ng package and connect your code with this signal. Doing this in settings file can cause problems, therefore it’s suggested to put it:
In your app config’s
django.apps.AppConfig.ready()
methodIn the project’s
urls.py
file (when no models exist)
from django_cas_ng.signals import cas_user_authenticated
from django.dispatch import receiver
@receiver(cas_user_authenticated)
def update_user_email_address(sender, user=None, attributes=None, **kwargs):
# If your CAS server does not always include the email attribute
# you can wrap the next two lines of code in a try/catch block.
user.email = attributes["email"]
user.save()
See also
Configuring third party Django authentication#
Generally any Django authentication plugin should work with Weblate. Just follow the instructions for the plugin, just remember to keep the Weblate user backend installed.
See also
Typically the installation will consist of adding an authentication backend to
AUTHENTICATION_BACKENDS
and installing an authentication app (if
there is any) into INSTALLED_APPS
:
AUTHENTICATION_BACKENDS = (
# Add authentication backend here
"weblate.accounts.auth.WeblateUserBackend",
)
INSTALLED_APPS += (
# Install authentication app here
)
Social authentication#
Thanks to Welcome to Python Social Auth’s documentation!, Weblate support authentication using many third party services such as GitLab, Ubuntu, Fedora, etc.
Please check their documentation for generic configuration instructions in Django Framework.
Note
By default, Weblate relies on third-party authentication services to provide a validated e-mail address. If some of the services you want to use don’t support this, please enforce e-mail validation on the Weblate side by configuring FORCE_EMAIL_VALIDATION for them. For example:
See also
Pipeline
Enabling individual backends is quite easy, it’s just a matter of adding an entry to the
AUTHENTICATION_BACKENDS
setting and possibly adding keys needed for a given authentication method. Please note that some backends do not provide user e-mail by default, you have to request it explicitly, otherwise Weblate will not be able to properly credit contributions users make.Hint
Most of the authentication backends require HTTPS. Once HTTPS is enabled in your web server please configure Weblate to report it properly using
ENABLE_HTTPS
, or byWEBLATE_ENABLE_HTTPS
in the Docker container.See also
Python Social Auth backend
OpenID authentication#
For OpenID-based services it’s usually just a matter of enabling them. The following section enables OpenID authentication for OpenSUSE, Fedora and Ubuntu:
See also
OpenID
GitHub authentication#
You need to register an OAuth application on GitHub and then tell Weblate all its secrets:
The GitHub should be configured to have callback URL as
https://WEBLATE SERVER/accounts/complete/github/
.There are similar authentication backends for GitHub for Organizations and GitHub for Teams. Their settings are named
SOCIAL_AUTH_GITHUB_ORG_*
andSOCIAL_AUTH_GITHUB_TEAM_*
, and they require additional setting of the scope -SOCIAL_AUTH_GITHUB_ORG_NAME
orSOCIAL_AUTH_GITHUB_TEAM_ID
. Their callback URLs arehttps://WEBLATE SERVER/accounts/complete/github-org/
andhttps://WEBLATE SERVER/accounts/complete/github-teams/
.Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
GitHub
GitHub EE authentication#
You need to register an OAuth App on GitHub EE and then tell Weblate all its secrets:
The GitHub OAuth App should be configured to have callback URL as
https://WEBLATE SERVER/accounts/complete/github-enterprise/
.Instead GitHub OAuth App, GitHub App can also be used. With GitHub App permissions can be granted on repositories, organisation and/or user level. If you decide to use GitHub App, you need to enable Access: Read-only permission for Users - <Email addresses> and Organisation - <Members>.
Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
GitHub Enterprise
Bitbucket authentication#
You need to register an application on Bitbucket and then tell Weblate all its secrets:
Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
Bitbucket
Google OAuth 2#
To use Google OAuth 2, you need to register an application on <https://console.developers.google.com/> and enable the Google+ API.
The redirect URL is
https://WEBLATE SERVER/accounts/complete/google-oauth2/
Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
Google
Facebook OAuth 2#
As per usual with OAuth 2 services, you need to register your application with Facebook. Once this is done, you can set up Weblate to use it:
The redirect URL is
https://WEBLATE SERVER/accounts/complete/facebook/
Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
Facebook
GitLab OAuth 2#
For using GitLab OAuth 2, you need to register an application on <https://gitlab.com/profile/applications>.
The redirect URL is
https://WEBLATE SERVER/accounts/complete/gitlab/
and ensure you mark the read_user scope.Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
GitLab
Microsoft Azure Active Directory#
Weblate can be configured to use common or specific tenants for authentication.
The redirect URL is
https://WEBLATE SERVER/accounts/complete/azuread-oauth2/
for common andhttps://WEBLATE SERVER/accounts/complete/azuread-tenant-oauth2/
for tenant-specific authentication.You will need following:
Application (client) ID can be obtained from application page. Object ID is not used in Weblate.
Directory (tenant) ID is needed for tenant scoped authentication, what is usually desired.
Secret value is displayed once you generate a secret for an application. Secret ID is not used in Weblate.
Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
Microsoft Azure Active Directory
Slack#
For using Slack OAuth 2, you need to register an application on <https://api.slack.com/apps>.
The redirect URL is
https://WEBLATE SERVER/accounts/complete/slack/
.Note
Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.
See also
Slack
Overriding authentication method names and icons#
You can override the authentication method display name and icon using using settings as
SOCIAL_AUTH_<NAME>_IMAGE
andSOCIAL_AUTH_<NAME>_TITLE
. For example overriding naming for Auth0 would look like:Turning off password authentication#
E-mail and password authentication can be turned off by removing
social_core.backends.email.EmailAuth
fromAUTHENTICATION_BACKENDS
. Always keepweblate.accounts.auth.WeblateUserBackend
there, it is needed for core Weblate functionality.Disabling e-mail authentication will disable all e-mail related functionality – user invitation or password reset feature.
Tip
You can still use password authentication for the admin interface, for users you manually create there. Just navigate to
/admin/login/
.For example authentication using only the openSUSE Open ID provider can be achieved using the following: