YouTrack Standalone 2018.3 Help

Common Settings for Auth Modules

The Common Settings page displays configuration options that are applied to all of the authentication modules in YouTrack. To access this page, select Auth Modules from the Access Management section of the Administration menu, then click the Common settings link in the toolbar.

Auth module common settings general

General Settings

The following settings are shown on the General tab:

Setting

Description

Token timeout

Specifies the maximum lifespan for access tokens. By reducing this value, you limit the amount of time a malicious user who has obtained an access token can access the application. The default is one hour.

Shortly before an access token expires, Hub uses a refresh token to acquire a new refresh token and access token. As long as the user still has a valid session cookie, this process takes place in the background without logging the user out. Reducing this value has an increasing negative impact on performance, as the application has to replace expired tokens with greater frequency.

Session timeout

Specifies the duration that a session can remain idle before YouTrack terminates it automatically. This sets the lifetime for the session cookie that lets users access the application without having to log in again when the Remember me option is disabled.

Remember me duration

Specifies the duration that YouTrack remembers a login session. This sets the lifetime for the session cookie that lets users access the application without having to log in again when the Remember me option is enabled.

Email Verification

Determines whether users must verify their email addresses to log in to YouTrack. To improve the security of your installation, enable this option.

For installations that create user accounts from incoming email messages with the Mailbox Integration or tickets that are imported with the Zendesk Integration, this option prevents users from registering accounts that can be used to gain unauthorized access to YouTrack and other applications in your business environment.

Note that email verification is not required for users who have Low-level Administration permissions. This ensures that your administrators always have access to the application.

Login message

Adds a message to the login page for your YouTrack Standalone installation. Use this, for example, to provide a link to legal documents that describe how you manage personal data that is stored in the application.

This setting supports the standard Markdown implementation as described in the the CommonMark specification. Many of the extensions that are supported in issue fields are not available here. For details, see Markdown Syntax.

Throttling by Login Settings

Throttling or rate limitation helps protect YouTrack from brute-force attacks. The options on the Common Settings page lets you apply rate limits to login attempts and requests to verify credentials. Rate limits are applied per login. Rate limits help slow down brute-force attacks by blocking new login requests following a series of consecutive login failures, so they keep your passwords safe.

This feature is designed for use with reCAPTCHA. When rate limitation is applied to a login, the user can solve a CAPTCHA-based challenge and try another password. If reCAPTCHA is not configured, affected users must wait until the cooldown period elapses to attempt another login.

When the Throttling option is enabled, there are additional settings that manage how throttling is applied to logins and requests to verify credentials.

Auth module common settings throttling

Setting

Description

Throttling by Login

Enables rate limitation for logins and requests to verify credentials.

Max logins

The maximum number of logins that are tracked for rate limiting. The purpose of this setting is to maintain a relatively large number of counters that is not an infinite value. This avoids storing all failed logins and consuming too much memory.

A counter is created for each login that uses an invalid password. When YouTrack has active counters equal to the maximum number of logins, the collection is full. If the collection is full:

  • New requests with logins that are not in the collection are rejected.

  • Requests with logins that are stored in the collection follow the same rules as if the collection wasn't full.

The number of active counters decreases according to the settings for the Cooldown period and Cooldown value as described below.

Max failures per login

The maximum number of consecutive failed requests that are allowed before rate limitations are applied to a login.

Every time YouTrack registers a failed login, an entry is added to the counter. When the counter for a login reaches the threshold that is set as the Max failures per login, rate limits are applied to this login. Subsequent attempts for this login are rejected even when the password is correct. This prevents attackers from iterating over a list of passwords until they guess correctly.

  • When reCAPTCHA is configured, the throttled user can solve a CAPTCHA-based challenge and try another password.

  • Without reCAPTCHA, the user must wait for the cooldown to elapse before attempting to log in again.

Attempts that are rejected when the counter is full do not increment the counter higher than the maximum number. This prevents attackers from overloading the counter, forcing the account owner to solve a CAPTCHA challenge on every login attempt.

Cooldown period

The interval at which entries are removed from the counter for each login, in seconds.

Entries are removed from the counter for each login according to the cooldown period. The cooldown value determines how many failed logins are forgotten in this time frame.

Cooldown value

The number of entries that are removed from the counter for each login per cooldown period.

For counters that reach the maximum number of allowed failures, login requests are rejected for the login that hit the threshold. When the counter falls below the maximum, login requests are processed. The user once again try to guess the password for this login.

  • If the number of consecutive invalid requests reaches the maximum, subsequent requests are rejected again.

  • When a counter reaches zero, the login is removed from the collection.

Login whitelist

A list of logins that are not tracked for failed login requests. Enter each login on a new line.

When a user exceeds the max failures per login, the login is shown in the Throttled logins list. To add a login to the whitelist and disable throttling for the affected user, click the Add to whitelist button.

You can use the whitelist to ensure that your administrators can still log in even when YouTrack is tracking the maximum number of logins. However, users on the whitelist should take extra precaution to secure their accounts with strong passwords, as their logins are not protected against a brute-force attack.

Audit

Links to a list of audit events related to changes that have been applied to the throttling settings on this page.

Throttled logins

A list of logins that are currently tracked for rate limiting. Use this list to track which accounts have recorded one or more failed login within the cooldown period. To add accounts to the login whitelist, select one or more accounts in the list, then click the Add to whitelist button.

reCAPTCHA Settings

The settings on the CAPTCHA tab let you set up and use Google reCAPTCHA.

Auth module common settings captcha

The reCAPTCHA service asks users to solve a CAPTCHA-based challenge to prove that they are not a robot. This challenge is presented in the following situations:

  • When registration is enabled for the Hub authentication module. Users must prove that they are not a robot to register their own account.

  • When throttling by logins is enabled and the maximum number of failed login attempts is exceeded. The affected user must complete the challenge to try another password.

To enable reCAPTCHA for self-registration and throttled logins:

  1. In the reCAPTCHA Settings section of the Auth Modules > Common Settings page, click the link to access the reCAPTCHA key management console.
  2. Register your YouTrack domain with the reCAPTCHA service. reCAPTCHA is a part of Google services, so you can use your Google account to log in. Read the tips provided on the page before you register and generate your keys.

  3. Copy the Site key in Google and paste it into the corresponding input field in the Common Settings page.

  4. Copy the Secret key in Google and paste it into the corresponding input field in the Common Settings page.

  5. Click the Save button.
    • The reCAPTCHA validation input is enabled for users who register their own accounts in YouTrack or whose logins are throttled.

How to Recover from a Brute-force Attack

Few attackers are going to have the patience to guess the conditions that trigger authentication throttling. They're much more likely to give up and move on to an easier target.

However, if an attacker managed to gain access to the application without triggering the rate limitation, you might have a problem. It doesn't necessarily mean that the throttling failed — it means that you let users create weak passwords that were too easy to guess.

If you suspect that a malicious user has gained unauthorized access:

  • Check your security logs to identify compromised accounts.

  • Browse the audit events to detect suspicious activity and identify changes that were performed by compromised users.

  • Update the settings of your Hub authentication module to enforce a stronger password policy. For more information, see Set a Password Policy.

  • Access the user profile for each compromised account and change their passwords. You can force these users to change their passwords the next time they attempt to log in.

Last modified: 30 November 2018