Falcon LogScale Documentation

BitBucket Sign-In

To use BitBucket as a single sign-in method with LogScale, you'll first have to set up BitBucket. Once you do, go to your Account Settings and create an OAuth Consumer.

Set the Callback URL to %PUBLIC_URL%/auth/bitbucket. Then grant the account:email permission and Save.

Once that's done, find the Key (Client Id), and Secret (Client Secret) in the list of consumers. You'll need that for LogScale's configuration file. You can read more about integrating an application on BitBucket on their Setup Instructions.

Now that your consumer is created, you can configure LogScale to use authenticate with BitBucket. Edit the LogScale configuration file to include the following lines:

AUTHENTICATION_METHOD=oauth
PUBLIC_URL=$YOUR_SERVERS_BASE_URL
BITBUCKET_OAUTH_CLIENT_ID=$CLIENT_ID # The Key from your BitBucket OAuth Consumer
BITBUCKET_OAUTH_CLIENT_SECRET=$CLIENT_SECRET # The Secret your BitBucket OAuth Consumer
AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN=true  # default is false

For more about LogScale configuration, check the Configuration Parameters documentation.

GitHub Sign-In

See Creating an OAuth App for setup instructions.

Google Sign-In

Detailed Setup Instructions: https://developers.google.com/identity/sign-in/web/sign-in

where %PUBLIC_URL% is the same value as LogScale is configured with. This can be http://localhost:8080/auth/google during development. Login will fail if the redirect_uri is not set correctly.

Once your app is created you can configure LogScale to authenticate with Google.

AUTHENTICATION_METHOD=oauth
PUBLIC_URL=$YOUR_SERVERS_BASE_URL
GOOGLE_OAUTH_CLIENT_ID=$CLIENT_ID #The client_id from your Google OAuth App
GOOGLE_OAUTH_CLIENT_SECRET=$CLIENT_SECRET The #client_secret your Google OAuth App
AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN=true  # default is false

AUTHENTICATION_METHOD=oauth
PUBLIC_URL=$YOUR_SERVERS_BASE_URL
GITHUB_OAUTH_CLIENT_ID=$CLIENT_ID # The client_id from your GitHub OAuth App
GITHUB_OAUTH_CLIENT_SECRET=$CLIENT_SECRET # The client_secret your GitHub OAuth App
AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN=true  # default is false

OAuth with Auth0

LogScale can be configured to authenticate users through Auth0. For more details on how Auth0 works with third party identity providers and advanced usages, please check out the Auth0 documentation.

Auth0 keeps information about your users. This may require you to have a Data Processing Agreement with Auth0. If all you need is Google and GitHub, you can use LogScale's built-in support for several providers and avoid storing your users' personal data with a third party provider.

You should create an Auth0 Regular Web App specifically for LogScale. Once the application is created you will need to set up properties.

Find your application's configuration. Under the application's Settings page please take note of the following details * Domain * Client ID * Client Secret These settings are needed for LogScale's settings. You will also have to change some variables in LogScale's configuration file:

AUTHENTICATION_METHOD=auth0
AUTH0_DOMAIN=$YOUR_AUTH0_DOMAIN
AUTH0_CLIENT_ID=$YOUR_CLIENT_ID
AUTH0_CLIENT_SECRET=$YOUR_CLIENT_SECRET
PUBLIC_URL=$YOUR_SERVERS_BASE_URL

See the Configuration Parameters reference section to learn how to set these and other variables for your LogScale cluster.

In order to avoid CSRF attacks you must set the Allowed Callback URLs field to %PUBLIC_URL%/auth/auth0, such as https://www.example.com/auth/auth0, where %PUBLIC_URL%` is the value of the LogScale configuration option PUBLIC_URL.

Using Auth0 authentication for LogScale requires that you set the PUBLIC_URL configuration option.

Using the Auth0 Authorization Extension you can define Auth0 roles and map them to LogScale groups. For details on how groups work in LogScale see Authorization.

The users/roles defined at top-level in the Auth0 dashboard do not work with this. This only works for users/roles defined inside the Auth0 authorization Extension, which is found in the left side Extensions menu item.

The Auth0 Authorization Extension requires an Auth0 Rule of its own installed to work, and additionally you need to create a rule to copy the roles into the token returned by Auth0 to LogScale. This additional rule could look like this

// rule to copy user's roles into the returned token
function (user, context, callback) {
  const assignedRoles = (context.authorization || {}).roles;
  context.idToken["https://auth0-example.humio.com/roles"] = assignedRoles;
  callback(null, user, context);
}

The attribute https://auth0-example.humio.com/roles in this example is the user-configurable attribute that will hold the Auth0 roles. If you configure AUTH0_ROLES_KEY=https://auth0-example.humio.com/roles (in LogScale) and add the above Auth0 Rule in the Auth0 dashboard, the assigned roles are transferred to humio in the AWT token and are made available to LogScale. If AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN is not set, then users must already have been created inside LogScale's UI.

AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN=true
AUTO_UPDATE_GROUP_MEMBERSHIPS_ON_SUCCESSFUL_LOGIN=true

The property AUTO_UPDATE_GROUP_MEMBERSHIPS_ON_SUCCESSFUL_LOGIN controls that group membership rules in LogScale are transferred upon login. When deleting a user or changing access rights in Auth0, changes are not reflected until you log into LogScale again.