/

Plugin Configuration


Plugin Configuration

The plugin configuration is handled in the RED5_HOME/conf/simple-auth-plugin.properties file. The default settings for this file are as follows:

# Simple-auth Plugin Properties
#

# Default state of server wide security
simpleauth.default.active=false

# Default data source filename [ Default authentication validator is file based ]
simpleauth.default.defaultAuthValidatorDataSource=simple-auth-plugin.credentials

# Default state of rtmp security offered by the plugin
simpleauth.default.rtmp=true

# Default state of rtsp security offered by the plugin
simpleauth.default.rtsp=true

# Default state of rtc security offered by the plugin
simpleauth.default.rtc=true

# Global state of rtmp security allowing authentication via query parameters
simpleauth.default.rtmp.queryparams=true

# Allowed rtmp agents
simpleauth.default.rtmp.agents=*

Plugin Configuration Properties

PropertyTypeDescriptionDefault value
simpleauth.default.activeBooleanDefines whether the plugin applies security to all applications by default or not.false
simpleauth.default.defaultAuthValidatorDataSourceStringDefines the name of the default properties file (in RED5-HOME/conf) used for authenticationsimple-auth-plugin.credentials
simpleauth.default.rtmpBooleanDefines the state of rtmp security when security is applies to all applications by defaulttrue
simpleauth.default.rtspBooleanDefines the state of rtsp security when security is applies to all applications by defaulttrue
simpleauth.default.rtcBooleanDefines the state of rtc security when security is applies to all applications by defaulttrue
simpleauth.default.rtmp.queryparamsBooleanDefines whether rtmp authentication parameters can be provided in query string or nottrue
simpleauth.default.rtmp.agentsStringDescribes the list of rtmp client types (agents) allowed to connect. This value is extracted from the rtmp client's handshake. By default all client types are allowed. It can be used to block certain types of rtmp clients from connecting. The list can be a semicolon separated list of agent strings or **

Note on RTMP Agents

The RTMP agent string is obtained by Red5 Pro during handshake with the RTMP client. Each specific type of RTMP client provides an agent string to identify its type. This parameter is popularly addressed as the flashVer string. There are various types of RTMP clients such as flash player for Windows / Mac / Linux, Adobe Flash Media Live Encoder (FMLE), WireCast encoder, etc. Each client type can be identified by the value provided in the flashVer string. For more information see: Real-Time Messaging Protocol

The auth module is designed to look for the client's flashVer in the list of permissible agent strings specified. * defines that all agent types are allowed. The check does not look for an exact match, but rather whether the flashVer is contained in any one of the agent strings.