CFC HTTP Whitelist

Blocks http requests and references in HTML to addresses not in the allowed list of addresses.

• Configuring
  • How it works
  • Configuring the addon
  • Client convars
• Integrating with your addon
• Known Issues

Configuring

How it works

Clients are allowed to allow or deny urls for their clientside whitelist using the options menu in sandbox. Before loading the clientside editable config defaults are loaded from lua files or networked from the server. Configs are layered so one config doesnt not completely overwrite an earlier config, just adds to it and overwrites any conflicting addresses (unless they are set to permanent)

Configuration load order on client

• Loads default config from lua/cfc_http_retrictions/default_config.lua
• Loads additional configs from lua/cfc_http_restrictions/configs/*.lua
• Loads additional configs from lua/cfc_http_restrictions/configs/client/*.lua
• Loads networked config if it exists
• Loads clientside config from data/cfc_cl_http_whitelist_config.json

Configuring the addon

The best way to configure this addon is using lua files.
do NOT edit default_config.lua or any other file in this addon to change the config

• Fork or copy the template repo found here https://github.com/cfc-servers/cfc_http_whitelist_config_template
• Modify the repo to allow or deny any domains you need. See Configuration Options for a list of options you can use in your address config
• Put that repo in the addons folder on your server

Configuration options

name	type	description
noisy	bool	mark the domain as noisy, hiding it from logs, this can be used for internal domains that will be called frequently on the client
allowed	bool	Is the domain allowed, if false block the domain, if true allow the domain
permanent	bool	Is the domain permanent, if true the domain can not be removed from the config
pattern	bool	Should the address be treated as a lua pattern

Clientside Convars

name	default	description
cfc_http_restrictions_log_allows	1	Should log allowed HTTP requests?
cfc_http_restrictions_log_blocks	1	Should log blocked HTTP requests
cfc_http_restrictions_log_verbose	0	Should the logs include verbose messages? noisy domains and full urls.

Known Issues

• Some filetypes will not work with sound.playURL. This is intentional and will likely not be fixed. these filetypes would allow you to bypass the whitelist. Wav, mp3, and any other audio filetype should work. If a filetype that should be allowed is being blocked please create a github issue with a link to the file.
• Radio streams will not work. This may be fixed, this is an unfortunate side effect of checking the file content of audio files before playing with sound.PlayURL.

Integrating with your addon

Anything not listed here has no guarantee of backwards compatability

Functions

• CFCHTTP.GetOptionsForURL(url) gets the config options for a url to check if its allowed
• CFCHTTP.LogRequest( tbl ) logs a request in the console

Variables

CFCHTTP.BASS_ERROR_BLOCKED_URI = 11001 custom error code returned by sound.PlayURL CFCHTTP.BASS_ERROR_BLOCKED_CONTENT = 11002 custom error code returned by sound.PlayURL