Authentication Settings

Authentication is an optional feature controlled by the license you purchase from RealNetworks.

The following settings pertain to Authentication settings:

Setting

Description

AuthMode Can be 0 (Player-based Authentication), 1 (User-based Authentication). Default is 0 (Player-based Authentication).
AuthPath The path to the secure content directory.
AuthRegPrefix User-defined keyword that is sent to CGI. Default is "register".
AuthDBPlugin Name of included text file, database, or user-defined data storage. Default is rn-ppv-basic.
AuthDBName Name of mSQL or ODBC database, or path to supplied text file data source.
AuthDBUserID Name RealServer uses to connect to the (optional) commercial database.
AuthDBPassword Password RealServer uses to connect to the (optional) commercial database.
AuthAllowDuplicateIDs Establishes whether multiple users all using the same user ID and password can retrieve secured content.
Realm

Keyword used to encrypt users' passwords in the authentication database when configured for User-based authentication. Default is your customer name.

Warning: Changing this variable means that every password in the authentication database must be reencrypted with the new variable and re-entered to work with the server.

AuthMode

Identifies type of authentication (Player-based or User-based) used by RealServer. 0 is Player-based and 1 is User-based.
Default value 1
Range of values 0,1

Syntax

AuthMode <number>

Example

AuthMode 1

AuthPath

The path to the secure content directory, relative to BasePath. The server must be able to identify content to which the server administrator wants to authorize access. The path and directory specified here contain that content.
Default value /nonexistent
Range of values Valid path and directory

Syntax

AuthPath <path>

Example

AuthPath secure\video

AuthRegPrefix

User-defined keyword that is sent to CGI. This variable is used for Player-based authentication only. In Player-based authentication, the Player registers by sending a special .rm clip to the server. This .rm clip's dynamically generated pnm:// address also carries in it the username to be associated with the RealPlayer. The position of the username in the pnm:// address is directly after a register prefix, which can be any word - but must be set here and in the register.html template.
Default value register
Range of values any word of multiple characters

Syntax

AuthRegPrefix <word>

Example

AuthRegPrefix register

AuthDBPlugin

The path to the plug-in text file or DLL for the database specified by AuthDBName.
Default value plugins
Range of values (short name of database file)

Syntax

AuthDBPlugin <name>

Example

AuthDBPlugin rn-ppv-basic

where:
Short name of database file Actual name and platform
rn-ppv-basic ppvbasic.so.5.0 (text file, UNIX)
rn-ppv-basic ppvb3250.dll (text file, Windows)
rn-ppv-msql ppvmsql.so.5.0 (mSQL database, UNIX)
rn-ppv-odbc ppvo3250.dll (ODBC database, Windows )



AuthDBName

Name of mSQL or ODBC database, or path to supplied text file data source. If no value is specified, Authentication is considered disabled.
Default value rn-ppv-basic
Range of values valid path or file name

Syntax

AuthDBName <data source name or location>

Example

If using rn-ppv-basic,

AuthDBName c:\real\server\plugins

If using any other plugin,

AuthDBName auth.db 

AuthDBUserID

Name RealServer uses to connect to the (optional) commercial database. Many databases require a username and password to read or write data. The RealServer will present itself to the authentication database using the chosen name and password, so must be able to operate under the access restrictions imposed on that username.
Default value (blank)
Range of values any alphanumeric string

Syntax

AuthDBUserID <name>

Example

AuthDBUserID MyServerUserName

AuthDBPassword

Password RealServer uses to connect to the (optional) commercial database.
Default value (blank)
Range of values any alphanumeric string

Syntax

AuthDBPassword <password>

Example

AuthDBPassword MyPassword

 

AuthAllowDuplicateIDs

Establishes whether multiple users all using the same user ID and password can retrieve secured content.

When AuthAllowDuplicateIDs is set to "1," under Player-based authentication, customers who log on using the same RealPlayer are allowed to access secure content. Under User-based authentication, customers logged on with the same user ID and password and allowed to access secure content.

When AuthAllowDuplicateIDs is set to "0, " the second person to log on under an existing connection is allowed to connect and the first person is given a warning that a duplicate RealPlayer ID is in use.
Default value 0 (FALSE), 1 (TRUE)
Range of values 0, 1

Syntax

AuthAllowDuplicateIDs <number>

Example

AuthAllowDuplicateIDs 1

Realm

User-defined keyword that is used to encrypt users' passwords in the authentication database.
Default value <Customer Name>
Range of values any alphanumeric string

In Used-based authentication, the authentication database or text file stores user names and passwords, as well as access information and permissions. As an added security measure, passwords are encrypted. The Realm variable is used to increase the level of encryption.

Changing this variable means that every password in the authentication database must be reencrypted with the new variable and re-entered to work with the server. For information on the password tool, see the Authentication chapter.

Syntax

Realm <word>

Example

Realm realfred

© 1997 RealNetworks, Inc.