
###################################################################
# SSO Authenticator properties file
###################################################################

###################################################################
# ***** SETUP *****
####################################################################
# 
# ***** DEFINE A METHOD TO OBTAIN THE USERNAME *****
#
#     ---------------------------------
#     | arsystem.sso.username.method  |
#     ---------------------------------
#
# There are 3 methods in which to use to obtain the username
# for a given user. These options define which method you will 
# use to obtain the username to pass into the ARServer (which 
# will be handled by the areasso plugin). Each of these options 
# also has some supporting options that may also need to be set.
#
# Possible values:
#	
# remoteuser
#	Use the request.getRemoteUser() method to obtain the 
#	username. See the instructions on how to set up your
#	web server to allow this call to return the username
#	from the users NT domain login. 
#
# header
#	Use an HTTP packet header to obtain the username. This
#	will generally be used if you have a portal or proxy
#	server that the user has already authenticated to.
#
# attribute
# 	Use a Session attribute to obtain the username.
#
#
#     -------------------------------
#     | arsystem.sso.username.case  |
#     -------------------------------
#
# Sets the case of the username that is passed to AR System
#
# Possible values:
#	
# default
#	Uses the username case exactly how it is returned
#	from the method you used to obtain it. 
#
# lower
#	Sets the returned value to all lowercase characters
#
# upper
# 	Sets the returned value to all uppercase characters
#
#
#     ---------------------------------------------------
#     | arsystem.sso.username.remoteuser_remove_domain  |
#     ---------------------------------------------------
#
# This setting is used only if you have set the username
# method to 'remoteuser'. Setting this to 'T' (true) will remove the
# domain name from the getRemoteUser() call and return just the 
# username. This should be set to 'T' for most cases. Otherwise, set
# to 'F' (false)
#
#
#     -------------------------------------
#     | arsystem.sso.username.headername  |
#     -------------------------------------
# 
# This setting is used only if you have set the username
# method to 'header'. This sets the actual header name that you 
# want to get the value of, and can be any value you define. 
#
#
#     ----------------------------------------
#     | arsystem.sso.username.attributename  |
#     ----------------------------------------
#
# This setting is used only if you have set the username
# method to 'attribute'. This sets the actual attribute name that 
# you want to get the value of, and can be any value you define. 
#
#
# ***** DEFINING THE AUTHENTICATION STRING *****
#
#     -----------------------------------
#     | arsystem.sso.authstring.method  |
#     -----------------------------------
#
# There are 3 methods in which to use to obtain the authentication
# string you wish to use to pass to the ARSystem
#
# You will need to set the following option to one
# of the defined values:
#
# Possible values:
#	
# default
# 	Use the default authentication string. By default,
# 	a special string will be passed. This string will be 
# 	validated by the areasso plugin before a login is
#	successful.
#
# rudomain
#	Use the domain returned from the getRemoteUser() call. 
#	This may only be used if your username method is 
#	remoteuser.
#	NOTE: You will have to configure your areasso plugin
#	to properly recognize this value. 
#
# custom
# 	Use a custom authenitcation string. This can be any value
#	you wish to pass to the areasso plugin.
#	NOTE: You will have to configure your areasso plugin
#	to properly recognize this value. 
#
#
#     -----------------------------------
#     | arsystem.sso.authstring.custom  |
#     -----------------------------------
#
# If you have defined to use 'custom' as your authstring.method, 
# you will also need to set this setting to the value of 
# what you want the custom string to be:
#
#
#
# ***** SET DEBUG LOGGING *****
#
#     -------------------------------
#     | arsystem.sso.logging.debug  |
#     -------------------------------
#
# You can set the logging in the SSOAuthenticator to a "debug"
# level by setting this setting to 'T' (true). By default
# all error conditions are already logged. Setting this to true 
# will also log the username and authentication string that the 
# SSO Authenticator used for every login attempt. This should be 
# set to 'F' (false) unless you are debugging a problem. 
#
#
####################################################################

arsystem.sso.username.method=remoteuser
arsystem.sso.username.case=lower
arsystem.sso.username.remoteuser_remove_domain=F
arsystem.sso.username.headername=
arsystem.sso.username.attributename=
arsystem.sso.authstring.method=default
arsystem.sso.authstring.custom=
arsystem.sso.logging.debug=T
