simpleid
[ class tree: simpleid ] [ index: simpleid ] [ all elements ]

Procedural File: config.inc.dist

Source Location: /www/config.inc.dist



Page Details:

SimpleID configuration file.








SIMPLEID_ALLOW_LEGACY_LOGIN [line 91]

SIMPLEID_ALLOW_LEGACY_LOGIN = false
Allows legacy log-in system.

Prior to SimpleID 0.6, the login system utilised by SimpleID requires users' passwords to be sent in plaintet to the web server for verification. This is an inherent security risk.

From version 0.6, SimpleID implemented a form of digest authentication, which means that passwords are not sent in plaintext. For backwards compatibility, and to support browsers that do not have JavaScript installed, the legacy method is still supported if the following configuration parameter is set to true. Otherwise, users must use a browser which supports JavaScript to log into SimpleID.

The default is set to false for security reasons. You should not change this value unless it is absolutely necessary.




Tags:

since:  0.6

[ Top ]



SIMPLEID_ASSOC_EXPIRES_IN [line 125]

SIMPLEID_ASSOC_EXPIRES_IN = 3600
The number of seconds before associations expire. This is an advanced option, for which the default setting should work fine.

Note that for ICAM compliance, this number must be less than 86400.



[ Top ]



SIMPLEID_BASE_URL [line 32]

SIMPLEID_BASE_URL = 'http://www.example.com'
Base URL.

This is the URL of the location you want to place your SimpleID distribution. It becomes the URL of the SimpleID server.

It is not allowed to have a trailing slash; SimpleID will add it for you.

Examples:

  1.    define('SIMPLEID_BASE_URL''http://www.example.com');
  2.    define('SIMPLEID_BASE_URL''http://www.example.com:8888');
  3.    define('SIMPLEID_BASE_URL''http://www.example.com/simpleid');
  4.    define('SIMPLEID_BASE_URL''https://www.example.com:8888/simpleid');



[ Top ]



SIMPLEID_CACHE_DIR [line 57]

SIMPLEID_CACHE_DIR = '../cache'
Directory to store cache data.

This directory must exist and be readable and writable by the web server.

For maximum security, it is highly recommended to place this directory outside your web browser's document root directory, so that it is not visible to user agents.



[ Top ]



SIMPLEID_DATE_TIME_FORMAT [line 117]

SIMPLEID_DATE_TIME_FORMAT = '%Y-%m-%d %H:%M:%S %Z'
Date and time format.

The date and time format specified using the strftime() syntax.

See http://www.php.net/strftime for details.



[ Top ]



SIMPLEID_EXTENSIONS [line 134]

SIMPLEID_EXTENSIONS = 'sreg,ui'
SimpleID extensions.

The SimpleID extensions you wish to load. You should separate the extensions you wish to load with a comma.



[ Top ]



SIMPLEID_IDENTITIES_DIR [line 44]

SIMPLEID_IDENTITIES_DIR = '../identities'
Directory to store identity information.

This directory must exist and be readable by the web server.

For maximum security, it is highly recommended to place this directory outside your web browser's document root directory, so that it is not visible to user agents.



[ Top ]



SIMPLEID_LOGFILE [line 147]

SIMPLEID_LOGFILE = ''
Log file.

You can specify a file into which SimpleID will log various diagnostic messages.

The log file's directory must exist and must be writable by the web server.

To disable logging, set this as an empty string.



[ Top ]



SIMPLEID_LOGLEVEL [line 162]

SIMPLEID_LOGLEVEL = 4
The level of detail for log messages.

You can determine which messages are captured in the log file by specifying a number between 0 and 5. The higher the number, the more messages are logged.

WARNING: Setting the log level to 5 will result in security sensitive information also being logged.

This has effect only if logging is enabled.



[ Top ]



SIMPLEID_STORE_DIR [line 70]

SIMPLEID_STORE_DIR = '../store'
Directory to store persistent data.

This directory must exist and be readable and writable by the web server.

For maximum security, it is highly recommended to place this directory outside your web browser's document root directory, so that it is not visible to user agents.



[ Top ]



SIMPLEID_VERIFY_RETURN_URL_USING_REALM [line 107]

SIMPLEID_VERIFY_RETURN_URL_USING_REALM = true
Performs additional verification of relying party return URLs.

When authenticating using OpenID version 2, SimpleID version 0.7 or later can perform additional verification of the relying party's return URLs under section 9.2.1 of the OpenID specification.

The default is set to true for security reasons. However, if your web server is blocked by your web hosting provider's firewall from accessing outside servers, then set this to false.




Tags:

since:  0.7

[ Top ]




Documentation generated on Sun, 08 Nov 2009 01:30:38 +0000 by phpDocumentor 1.4.1