OpenSim 0.8/OpenSimIni OSSL

Configure OSSL function access

OSSL expands the function library for scripts in OpenSim, in addition to the LSL functions. Some functions are very powerful with high attack potential, which should not be usable for everyone in public accessible grids. One possible strategy is indeed to allow OSSL, but assign all of its functions with a "Threat Level" bigger than "VeryLow" to specific user groups with explicit permissions.

Up to OpenSim 0.8.1 the configuration is done in the Sektion [XEngine] of the OpenSim.ini file. From OpenSim 0.8.2 upwards the OSSL configurations are sourced out into a separate file. If not other configured in the OpenSim.ini, you find the file in the directory "config-include" with the name "osslEnable.ini".

AllowOSFunctions = true
AllowMODFunctions = true
OSFunctionThreatLevel = VeryLow

(For some strange reasons, in the examples of osslEnable.ini files you will also find "AllowLightShareFunctions". Here in this tutorial you will find it remaining in OpenSim.ini, as LightShare itself must be enabled there and not here.)

Now a function list follows. The here recommended permissions correspond to the defaults of the sample file in the Metro Edition of OpenSim, but of course the same settings can also be used in other grids.

In the following list, two self defined variables "osslParcelO" and "osslParcelOG" are set, which make it easier to change the permissions of land owners and their groups. Avatar- or group-IDs may be specified, or the general function codes. Note: The comma at the end is important, otherwise you get syntax errors in the locations, where the text of the variables is inserted!

; Example: osslParcelO = "PARCEL_OWNER,"
osslParcelO = ""
; Example: osslParcelOG = "PARCEL_GROUP_MEMBER,PARCEL_OWNER,"
osslParcelOG = ""
;; ========== OSSL FUNCTION BLOCK ========== 
;; ADJUST as needed or desired 
;; =========================================
;;
;; *** Threat-Level=None
Allow_osDrawEllipse = true
Allow_osDrawFilledPolygon = true
Allow_osDrawFilledRectangle = true
Allow_osDrawImage = true
Allow_osDrawLine = true
Allow_osDrawPolygon = true
Allow_osDrawRectangle = true
Allow_osDrawText = true
Allow_osGetAgents = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetAvatarList = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetCurrentSunHour = true
Allow_osGetGender = true
Allow_osGetHealth = true
Allow_osGetInventoryDesc = true
Allow_osGetMapTexture = true
Allow_osGetRegionSize = true
Allow_osGetRezzingObject = true
Allow_osGetSunParam = true
Allow_osGetTerrainHeight = true
Allow_osIsNpc = true
Allow_osIsUUID = true
Allow_osList2Double = true
Allow_osMax = true
Allow_osMin = true
Allow_osMovePen = true
Allow_osNpcGetOwner = ${XEngine|osslNPC}
Allow_osParseJSON = true
Allow_osParseJSONNew = true
Allow_osSetFontName = true
Allow_osSetFontSize = true
Allow_osSetPenCap = true
Allow_osSetPenColor = true
Allow_osSetPenSize = true
Allow_osSetSunParam = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osTeleportOwner = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osWindActiveModelPluginName = true
Allow_osCheckODE = true    ; Here for completeness. This function cannot be turned off
;;
;; *** Threat-Level=Nuisance
Allow_osSetEstateSunSettings = ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetRegionSunSettings = ESTATE_MANAGER,ESTATE_OWNER
;;
;; *** Threat-Level=VeryLow
Allow_osEjectFromGroup = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceBreakAllLinks = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceBreakLink = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetDrawStringSize = true
Allow_osGetWindParam = true
Allow_osInviteToGroup = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osReplaceString = true
Allow_osSetDynamicTextureData = true
Allow_osSetDynamicTextureDataBlend = true
Allow_osSetDynamicTextureDataBlendFace = true
Allow_osSetDynamicTextureURL = true
Allow_osSetDynamicTextureURLBlend = true
Allow_osSetDynamicTextureURLBlendFace = true
Allow_osSetParcelMediaURL = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetParcelSIPAddress = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetPrimFloatOnWater = true
Allow_osSetWindParam = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osTerrainFlush = ESTATE_MANAGER,ESTATE_OWNER
Allow_osUnixTimeToTimestamp = true
;;    
;; *** Threat-Level=Low
Allow_osAvatarName2Key = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osFormatString = true
Allow_osKey2Name = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osListenRegex = true
Allow_osLoadedCreationDate = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osLoadedCreationID = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osLoadedCreationTime = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osMessageObject = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osRegexIsMatch = true
Allow_osGetAvatarHomeURI = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
;;    
;; *** Threat-Level=Moderate
Allow_osDropAttachment = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osDropAttachmentAt = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetGridCustom = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetGridGatekeeperURI = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetGridHomeURI = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetGridLoginURI = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetGridName = true
Allow_osGetGridNick = true
Allow_osGetNumberOfAttachments = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetRegionStats = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetSimulatorMemory = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osMessageAttachments = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetSpeed = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
;;    
;; *** Threat-Level=High
Allow_osCauseDamage = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osCauseHealing = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceAttachToAvatar = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceAttachToAvatarFromInventory = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceCreateLink = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceDropAttachment = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceDropAttachmentAt = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetAgentIP = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetLinkPrimitiveParams = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetPhysicsEngineType = true
Allow_osGetPrimitiveParams = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetRegionMapTexture = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetScriptEngineName = true
Allow_osGetSimulatorVersion = true
Allow_osMakeNotecard = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osMatchString = true
Allow_osNpcCreate = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcGetPos = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcGetRot = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcLoadAppearance = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcMoveTo = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcMoveToTarget = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcPlayAnimation = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcRemove = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcSaveAppearance = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcSay = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcSetRot = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcShout = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcSit = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcStand = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcStopAnimation = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcStopMoveToTarget = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcTouch = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osNpcWhisper = ${XEngine|osslNPC}ESTATE_MANAGER,ESTATE_OWNER
Allow_osOwnerSaveAppearance = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osParcelJoin = ESTATE_MANAGER,ESTATE_OWNER
Allow_osParcelSubdivide = ESTATE_MANAGER,ESTATE_OWNER
Allow_osRegionRestart = ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetContentType = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetPrimitiveParams = false
Allow_osSetProjectionParams = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetRegionWaterHeight = ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetStateEvents = false   ; deprecated
Allow_osSetTerrainHeight = ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetTerrainTexture = ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetTerrainTextureHeight = ESTATE_MANAGER,ESTATE_OWNER
;;    
;; *** Threat-Level=VeryHigh
Allow_osAgentSaveAppearance = ESTATE_MANAGER,ESTATE_OWNER
; Warning: The next function allows scripts to force animations on avatars without the user giving permission.
; Enabling this can allow forced animations which can trigger traumatic episodes in vulnerable populations.
; Similar things can be said for several of the 'force' functions. Enable with care and control.
; Some of these were added as early functionality for NPCs. This has been replaced with the NPC functions.
Allow_osAvatarPlayAnimation = ESTATE_MANAGER,ESTATE_OWNER
Allow_osAvatarStopAnimation = ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceDetachFromAvatar = ESTATE_MANAGER,ESTATE_OWNER
Allow_osForceOtherSit = ESTATE_MANAGER,ESTATE_OWNER
; The notecard functions can cause a lot of load on the region if over used
Allow_osGetNotecard = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetNotecardLine = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osGetNumberOfNotecardLines = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osRegionNotice = ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetRot  = ESTATE_MANAGER,ESTATE_OWNER
Allow_osSetParcelDetails = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
;;    
;; *** Threat-Level=Severe
Allow_osConsoleCommand = false
Allow_osForceAttachToOtherAvatarFromInventory = false
Allow_osGrantScriptPermissions = false
Allow_osKickAvatar = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
Allow_osRevokeScriptPermissions = false
Allow_osTeleportAgent = true



Continued: Database-Backup und Restore for SQL