On the configuration file you can find the security section, in this section option like the encryptionKey, inactive timeout, roles and authentication can be found:

• enable ( type=boolean | default= false | required ) - Enables the server authentication, including login page (if need)
• inactiveInterval ( type=integer | default=600 | optional ) - Defines the timeout for an inactive session, after the timeout is trigger, the session will expire and the user will need to login again
  • Every action perform by the user, restarts the timeout
• encryptionKeyFile ( type=string | default=./bin/saga.ek | required ) - Location of the file holding the encryption key, Saga server provides one by default

  • Change the encyptionKeyFile as soon as you start a working on a new project

• defaultRole ( type=string | default=admin | optional ) - Default role to be use in the users if no role is provided. At the moment Saga Server has 2 roles admin and editor
• type ( type=string | default=config | optional ) - Defines the type of authentication to be use by the server
  
  • Additional configuration is required depending on the type of security selected

$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

Saga Server counts with 3 authentication types

• Config - Uses usernames and passwords defined in the configuration file
• LDAP - Uses the LDAP protocol to connect to a Directory Server
• SAML - SSO login method offering more secure authentication. (Currently on development, available Microsoft SSO)

Authentication Type

Config

Config authentication is the most basic of all, ideal for demos, but not recommended for production environments, unless in a close environment. This authentication uses Users, Passwords and Roles defined in the same config file, under the users field, one entry per user.

Config will allow you to login via Form and Basic Authentication $action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

LDAP

LDAP, the Lightweight Directory Access Protocol, is a mature, flexible, and well supported standards-based mechanism for interacting with directory servers.

LDAP will allow you to login via Form and Basic Authentication

• server ( type=string | required ) - Url to the LDAP server
• userAccountField ( type=string | default=cn | optional ) - Field to use as the user account
• bindDN ( type=string | required ) - LDAP distinguished name to the location of the users
• idField ( type=string | default=uid | optional ) - Field to use as the user ID
• passwordField ( type=string | default=password | optional ) - Field to use as the user password
• attributes ( type=string array | required ) - Names of the attributes to return for the user profile

$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

SAML

Security Assertion Markup Language (SAML) is a login standard that helps users access applications based on sessions in another context. It’s a single sign-on (SSO) login method offering more secure authentication (with a better user experience) than usernames and passwords.

SAML will redirect you to the provider login page, so no login page is required.

• keystorePath ( type=string | required ) - Path to the keystore holding the certificates
• keystorePassword ( type=string | required ) - password to the keystore
• privateKeyPassword ( type=string | required ) - Password to the keys in the keystore
• identityProviderMetadataPath ( type=string | required ) - Path to the identity provider, provided by the SAML Service
• callbackURL ( type=string | required ) - Full callback url back to your service. Called by the authentication provider
• nameIdAttribute ( type=string | optional ) - Attribute to use as the user ID

$action.getHelper().renderConfluenceMacro("$codeS$body$codeE")

Login Methods

Currently Saga Server has 3 methods to login, (besides the login of SAML)

Form

Basic Authentication

API Key