From 1576a8e731114e22dd6192ba63024778fff56941 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Sun, 17 Dec 2023 15:20:11 +0100 Subject: [PATCH 1/6] Set up coturn, switch from ejabberd in production https://github.com/coturn/coturn --- nodes/fornax.kosmos.org.json | 6 +- roles/openresty_proxy.rb | 1 - roles/turn_server.rb | 5 + .../kosmos-ejabberd/attributes/default.rb | 3 +- .../kosmos-ejabberd/recipes/coturn.rb | 38 + .../kosmos-ejabberd/recipes/default.rb | 2 +- .../templates/ejabberd.yml.erb | 10 - .../templates/turnserver.conf.erb | 708 ++++++++++++++++++ 8 files changed, 758 insertions(+), 15 deletions(-) create mode 100644 roles/turn_server.rb create mode 100644 site-cookbooks/kosmos-ejabberd/recipes/coturn.rb create mode 100644 site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb diff --git a/nodes/fornax.kosmos.org.json b/nodes/fornax.kosmos.org.json index d304aa5..87e19be 100644 --- a/nodes/fornax.kosmos.org.json +++ b/nodes/fornax.kosmos.org.json @@ -24,7 +24,8 @@ "openresty", "garage_gateway", "tor_proxy", - "zerotier_controller" + "zerotier_controller", + "turn_server" ], "recipes": [ "kosmos-base", @@ -40,7 +41,6 @@ "kosmos_assets::nginx_site", "kosmos_discourse::nginx", "kosmos_drone::nginx", - "kosmos-ejabberd::nginx", "kosmos_garage::nginx_web", "kosmos_garage::nginx_s3", "kosmos_gitea::nginx", @@ -63,6 +63,7 @@ "kosmos_zerotier::controller", "kosmos_zerotier::firewall", "kosmos_zerotier::zncui", + "kosmos-ejabberd::coturn", "kosmos-ejabberd::firewall", "kosmos-ipfs::firewall_swarm", "sockethub::firewall", @@ -115,6 +116,7 @@ "role[kvm_host]", "role[openresty_proxy]", "role[zerotier_controller]", + "role[turn_server]", "recipe[kosmos-ejabberd::firewall]", "recipe[kosmos-ipfs::firewall_swarm]", "recipe[kosmos_zerotier::firewall]", diff --git a/roles/openresty_proxy.rb b/roles/openresty_proxy.rb index 2ecd45e..6a3e59d 100644 --- a/roles/openresty_proxy.rb +++ b/roles/openresty_proxy.rb @@ -21,7 +21,6 @@ production_run_list = %w( kosmos_assets::nginx_site kosmos_discourse::nginx kosmos_drone::nginx - kosmos-ejabberd::nginx kosmos_garage::nginx_web kosmos_garage::nginx_s3 kosmos_gitea::nginx diff --git a/roles/turn_server.rb b/roles/turn_server.rb new file mode 100644 index 0000000..34fab22 --- /dev/null +++ b/roles/turn_server.rb @@ -0,0 +1,5 @@ +name "turn_server" + +run_list %w( + kosmos-ejabberd::coturn +) diff --git a/site-cookbooks/kosmos-ejabberd/attributes/default.rb b/site-cookbooks/kosmos-ejabberd/attributes/default.rb index a603fee..7128363 100644 --- a/site-cookbooks/kosmos-ejabberd/attributes/default.rb +++ b/site-cookbooks/kosmos-ejabberd/attributes/default.rb @@ -1,7 +1,8 @@ node.default["ejabberd"]["version"] = "23.10" node.default["ejabberd"]["package_version"] = "1" node.default["ejabberd"]["checksum"] = "1b02108c81e22ab28be84630d54061f0584b76d5c2702e598352269736b05e77" -node.default["ejabberd"]["turn_ip_address"] = nil +node.default["ejabberd"]["stun_auth_realm"] = "kosmos.org" node.default["ejabberd"]["stun_turn_port"] = 3478 node.default["ejabberd"]["turn_min_port"] = 50000 node.default["ejabberd"]["turn_max_port"] = 50050 +node.default["ejabberd"]["turn_ip_address"] = nil diff --git a/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb new file mode 100644 index 0000000..b7ee512 --- /dev/null +++ b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb @@ -0,0 +1,38 @@ +# +# Cookbook:: kosmos-ejabberd +# Recipe:: coturn +# + +apt_package 'coturn' + +credentials = data_bag_item("credentials", "ejabberd") + +template "/etc/turnserver.conf" do + source "turnserver.conf.erb" + mode 0644 + variables listening_port: node["ejabberd"]["stun_turn_port"], + tls_listening_port: node["ejabberd"]["stun_turn_port"], + listening_ip: node["ejabberd"]["turn_ip_address"], + relay_ip: node["ejabberd"]["turn_ip_address"], + min_port: node["ejabberd"]["turn_min_port"], + max_port: node["ejabberd"]["turn_max_port"], + static_auth_secret: credentials["stun_secret"], + realm: node["ejabberd"]["stun_auth_realm"] + notifies :restart, "service[coturn]", :delayed +end + +firewall_rule 'ejabberd_stun_turn' do + port node["ejabberd"]["stun_turn_port"] + protocol :udp + command :allow +end + +firewall_rule 'ejabberd_turn' do + port node["ejabberd"]["turn_min_port"]..node["ejabberd"]["turn_max_port"] + protocol :udp + command :allow +end + +service "coturn" do + action [:enable, :start] +end diff --git a/site-cookbooks/kosmos-ejabberd/recipes/default.rb b/site-cookbooks/kosmos-ejabberd/recipes/default.rb index 1ab71ae..a34a7f7 100644 --- a/site-cookbooks/kosmos-ejabberd/recipes/default.rb +++ b/site-cookbooks/kosmos-ejabberd/recipes/default.rb @@ -183,7 +183,7 @@ template "/opt/ejabberd/conf/ejabberd.yml" do sensitive true variables hosts: hosts, admin_users: admin_users, - stun_auth_realm: "kosmos.org", + stun_auth_realm: node["ejabberd"]["stun_auth_realm"], stun_secret: ejabberd_credentials['stun_secret'], turn_ip_address: node["ejabberd"]["turn_ip_address"], stun_turn_port: node["ejabberd"]["stun_turn_port"], diff --git a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb index 4d44c30..79bd591 100644 --- a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb +++ b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb @@ -87,16 +87,6 @@ listen: ## "/pub/archive": mod_http_fileserver ## register: true captcha: false - - - port: <%= @stun_turn_port %> - transport: udp - module: ejabberd_stun - auth_realm: <%= @stun_auth_realm %> - use_turn: true - tls: false - turn_ipv4_address: <%= @turn_ip_address %> - turn_min_port: <%= @turn_min_port %> - turn_max_port: <%= @turn_max_port %> s2s_use_starttls: optional diff --git a/site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb b/site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb new file mode 100644 index 0000000..257684d --- /dev/null +++ b/site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb @@ -0,0 +1,708 @@ +# Coturn TURN SERVER configuration file +# +# Boolean values note: where boolean value is supposed to be used, +# you can use '0', 'off', 'no', 'false', 'f' as 'false, +# and you can use '1', 'on', 'yes', 'true', 't' as 'true' +# If the value is missed, then it means 'true'. +# + +# Listener interface device (optional, Linux only). +# NOT RECOMMENDED. +# +#listening-device=eth0 + +# TURN listener port for UDP and TCP (Default: 3478). +# Note: actually, TLS & DTLS sessions can connect to the +# "plain" TCP & UDP port(s), too - if allowed by configuration. +# +listening-port=<%= @listening_port %> + +# TURN listener port for TLS (Default: 5349). +# Note: actually, "plain" TCP & UDP sessions can connect to the TLS & DTLS +# port(s), too - if allowed by configuration. The TURN server +# "automatically" recognizes the type of traffic. Actually, two listening +# endpoints (the "plain" one and the "tls" one) are equivalent in terms of +# functionality; but we keep both endpoints to satisfy the RFC 5766 specs. +# For secure TCP connections, we currently support SSL version 3 and +# TLS version 1.0, 1.1 and 1.2. +# For secure UDP connections, we support DTLS version 1. +# +tls-listening-port=<%= @tls_listening_port %> + +# Alternative listening port for UDP and TCP listeners; +# default (or zero) value means "listening port plus one". +# This is needed for RFC 5780 support +# (STUN extension specs, NAT behavior discovery). The TURN Server +# supports RFC 5780 only if it is started with more than one +# listening IP address of the same family (IPv4 or IPv6). +# RFC 5780 is supported only by UDP protocol, other protocols +# are listening to that endpoint only for "symmetry". +# +#alt-listening-port=0 + +# Alternative listening port for TLS and DTLS protocols. +# Default (or zero) value means "TLS listening port plus one". +# +#alt-tls-listening-port=0 + +# Listener IP address of relay server. Multiple listeners can be specified. +# If no IP(s) specified in the config file or in the command line options, +# then all IPv4 and IPv6 system IPs will be used for listening. +# +listening-ip=<%= @listening_ip %> +#listening-ip=10.207.21.238 +#listening-ip=2607:f0d0:1002:51::4 + +# Auxiliary STUN/TURN server listening endpoint. +# Aux servers have almost full TURN and STUN functionality. +# The (minor) limitations are: +# +# 1) Auxiliary servers do not have alternative ports and +# they do not support STUN RFC 5780 functionality (CHANGE REQUEST). +# +# 2) Auxiliary servers also are never returning ALTERNATIVE-SERVER reply. +# +# Valid formats are 1.2.3.4:5555 for IPv4 and [1:2::3:4]:5555 for IPv6. +# +# There may be multiple aux-server options, each will be used for listening +# to client requests. +# +#aux-server=172.17.19.110:33478 +#aux-server=[2607:f0d0:1002:51::4]:33478 + +# (recommended for older Linuxes only) +# Automatically balance UDP traffic over auxiliary servers (if configured). +# The load balancing is using the ALTERNATE-SERVER mechanism. +# The TURN client must support 300 ALTERNATE-SERVER response for this +# functionality. +# +#udp-self-balance + +# Relay interface device for relay sockets (optional, Linux only). +# NOT RECOMMENDED. +# +#relay-device=eth1 + +# Relay address (the local IP address that will be used to relay the +# packets to the peer). +# Multiple relay addresses may be used. +# The same IP(s) can be used as both listening IP(s) and relay IP(s). +# +# If no relay IP(s) specified, then the turnserver will apply the default +# policy: it will decide itself which relay addresses to be used, and it +# will always be using the client socket IP address as the relay IP address +# of the TURN session (if the requested relay address family is the same +# as the family of the client socket). +# +relay-ip=<%= @relay_ip %> +#relay-ip=2607:f0d0:1002:51::5 + +# For Amazon EC2 users: +# +# TURN Server public/private address mapping, if the server is behind NAT. +# In that situation, if a -X is used in form "-X " then that ip will be reported +# as relay IP address of all allocations. This scenario works only in a simple case +# when one single relay address is be used, and no RFC5780 functionality is required. +# That single relay address must be mapped by NAT to the 'external' IP. +# The "external-ip" value, if not empty, is returned in XOR-RELAYED-ADDRESS field. +# For that 'external' IP, NAT must forward ports directly (relayed port 12345 +# must be always mapped to the same 'external' port 12345). +# +# In more complex case when more than one IP address is involved, +# that option must be used several times, each entry must +# have form "-X ", to map all involved addresses. +# RFC5780 NAT discovery STUN functionality will work correctly, +# if the addresses are mapped properly, even when the TURN server itself +# is behind A NAT. +# +# By default, this value is empty, and no address mapping is used. +# +#external-ip=60.70.80.91 +# +#OR: +# +#external-ip=60.70.80.91/172.17.19.101 +#external-ip=60.70.80.92/172.17.19.102 + + +# Number of the relay threads to handle the established connections +# (in addition to authentication thread and the listener thread). +# If explicitly set to 0 then application runs relay process in a +# single thread, in the same thread with the listener process +# (the authentication thread will still be a separate thread). +# +# If this parameter is not set, then the default OS-dependent +# thread pattern algorithm will be employed. Usually the default +# algorithm is the most optimal, so you have to change this option +# only if you want to make some fine tweaks. +# +# In the older systems (Linux kernel before 3.9), +# the number of UDP threads is always one thread per network listening +# endpoint - including the auxiliary endpoints - unless 0 (zero) or +# 1 (one) value is set. +# +#relay-threads=0 + +# Lower and upper bounds of the UDP relay endpoints: +# (default values are 49152 and 65535) +# +min-port=<%= @min_port %> +max-port=<%= @max_port %> + +# Uncomment to run TURN server in 'normal' 'moderate' verbose mode. +# By default the verbose mode is off. +verbose + +# Uncomment to run TURN server in 'extra' verbose mode. +# This mode is very annoying and produces lots of output. +# Not recommended under any normal circumstances. +# +#Verbose + +# Uncomment to use fingerprints in the TURN messages. +# By default the fingerprints are off. +# +#fingerprint + +# Uncomment to use long-term credential mechanism. +# By default no credentials mechanism is used (any user allowed). +# +#lt-cred-mech + +# This option is opposite to lt-cred-mech. +# (TURN Server with no-auth option allows anonymous access). +# If neither option is defined, and no users are defined, +# then no-auth is default. If at least one user is defined, +# in this file or in command line or in usersdb file, then +# lt-cred-mech is default. +# +#no-auth + +# TURN REST API flag. +# (Time Limited Long Term Credential) +# Flag that sets a special authorization option that is based upon authentication secret. +# +# This feature's purpose is to support "TURN Server REST API", see +# "TURN REST API" link in the project's page +# https://github.com/coturn/coturn/ +# +# This option is used with timestamp: +# +# usercombo -> "timestamp:userid" +# turn user -> usercombo +# turn password -> base64(hmac(secret key, usercombo)) +# +# This allows TURN credentials to be accounted for a specific user id. +# If you don't have a suitable id, the timestamp alone can be used. +# This option is just turning on secret-based authentication. +# The actual value of the secret is defined either by option static-auth-secret, +# or can be found in the turn_secret table in the database (see below). +# +# Read more about it: +# - https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00 +# - https://www.ietf.org/proceedings/87/slides/slides-87-behave-10.pdf +# +# Be aware that use-auth-secret overrides some part of lt-cred-mech. +# Notice that this feature depends internally on lt-cred-mech, so if you set +# use-auth-secret then it enables internally automatically lt-cred-mech option +# like if you enable both. +# +# You can use only one of the to auth mechanisms in the same time because, +# both mechanism use the username and password validation in different way. +# +# This way be aware that you can't use both auth mechnaism in the same time! +# Use in config either the lt-cred-mech or the use-auth-secret +# to avoid any confusion. +# +use-auth-secret + +# 'Static' authentication secret value (a string) for TURN REST API only. +# If not set, then the turn server +# will try to use the 'dynamic' value in turn_secret table +# in user database (if present). The database-stored value can be changed on-the-fly +# by a separate program, so this is why that other mode is 'dynamic'. +# +static-auth-secret=<%= @static_auth_secret %> + +# Server name used for +# the oAuth authentication purposes. +# The default value is the realm name. +# +#server-name=blackdow.carleon.gov + +# Flag that allows oAuth authentication. +# +#oauth + +# 'Static' user accounts for long term credentials mechanism, only. +# This option cannot be used with TURN REST API. +# 'Static' user accounts are NOT dynamically checked by the turnserver process, +# so that they can NOT be changed while the turnserver is running. +# +#user=username1:key1 +#user=username2:key2 +# OR: +#user=username1:password1 +#user=username2:password2 +# +# Keys must be generated by turnadmin utility. The key value depends +# on user name, realm, and password: +# +# Example: +# $ turnadmin -k -u ninefingers -r north.gov -p youhavetoberealistic +# Output: 0xbc807ee29df3c9ffa736523fb2c4e8ee +# ('0x' in the beginning of the key is what differentiates the key from +# password. If it has 0x then it is a key, otherwise it is a password). +# +# The corresponding user account entry in the config file will be: +# +#user=ninefingers:0xbc807ee29df3c9ffa736523fb2c4e8ee +# Or, equivalently, with open clear password (less secure): +#user=ninefingers:youhavetoberealistic +# + +# SQLite database file name. +# +# Default file name is /var/db/turndb or /usr/local/var/db/turndb or +# /var/lib/turn/turndb. +# +#userdb=/var/db/turndb + +# PostgreSQL database connection string in the case that we are using PostgreSQL +# as the user database. +# This database can be used for long-term credential mechanism +# and it can store the secret value for secret-based timed authentication in TURN RESP API. +# See http://www.postgresql.org/docs/8.4/static/libpq-connect.html for 8.x PostgreSQL +# versions connection string format, see +# http://www.postgresql.org/docs/9.2/static/libpq-connect.html#LIBPQ-CONNSTRING +# for 9.x and newer connection string formats. +# +#psql-userdb="host= dbname= user= password= connect_timeout=30" + +# MySQL database connection string in the case that we are using MySQL +# as the user database. +# This database can be used for long-term credential mechanism +# and it can store the secret value for secret-based timed authentication in TURN RESP API. +# +# Optional connection string parameters for the secure communications (SSL): +# ca, capath, cert, key, cipher +# (see http://dev.mysql.com/doc/refman/5.1/en/ssl-options.html for the +# command options description). +# +# Use string format as below (space separated parameters, all optional): +# +#mysql-userdb="host= dbname= user= password= port= connect_timeout= read_timeout=" + +# If you want to use in the MySQL connection string the password in encrypted format, +# then set in this option the MySQL password encryption secret key file. +# +# Warning: If this option is set, then mysql password must be set in "mysql-userdb" in encrypted format! +# If you want to use cleartext password then do not set this option! +# +# This is the file path which contain secret key of aes encryption while using password encryption. +# +#secret-key-file=/path/ + +# MongoDB database connection string in the case that we are using MongoDB +# as the user database. +# This database can be used for long-term credential mechanism +# and it can store the secret value for secret-based timed authentication in TURN RESP API. +# Use string format is described at http://hergert.me/docs/mongo-c-driver/mongoc_uri.html +# +#mongo-userdb="mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]" + +# Redis database connection string in the case that we are using Redis +# as the user database. +# This database can be used for long-term credential mechanism +# and it can store the secret value for secret-based timed authentication in TURN RESP API. +# Use string format as below (space separated parameters, all optional): +# +#redis-userdb="ip= dbname= password= port= connect_timeout=" + +# Redis status and statistics database connection string, if used (default - empty, no Redis stats DB used). +# This database keeps allocations status information, and it can be also used for publishing +# and delivering traffic and allocation event notifications. +# The connection string has the same parameters as redis-userdb connection string. +# Use string format as below (space separated parameters, all optional): +# +#redis-statsdb="ip= dbname= password= port= connect_timeout=" + +# The default realm to be used for the users when no explicit +# origin/realm relationship was found in the database, or if the TURN +# server is not using any database (just the commands-line settings +# and the userdb file). Must be used with long-term credentials +# mechanism or with TURN REST API. +# +# Note: If default realm is not specified at all, then realm falls back to the host domain name. +# If domain name is empty string, or '(None)', then it is initialized to am empty string. +# +realm=<%= @realm %> + +# The flag that sets the origin consistency +# check: across the session, all requests must have the same +# main ORIGIN attribute value (if the ORIGIN was +# initially used by the session). +# +#check-origin-consistency + +# Per-user allocation quota. +# default value is 0 (no quota, unlimited number of sessions per user). +# This option can also be set through the database, for a particular realm. +# +#user-quota=0 + +# Total allocation quota. +# default value is 0 (no quota). +# This option can also be set through the database, for a particular realm. +# +#total-quota=0 + +# Max bytes-per-second bandwidth a TURN session is allowed to handle +# (input and output network streams are treated separately). Anything above +# that limit will be dropped or temporary suppressed (within +# the available buffer limits). +# This option can also be set through the database, for a particular realm. +# +#max-bps=0 + +# +# Maximum server capacity. +# Total bytes-per-second bandwidth the TURN server is allowed to allocate +# for the sessions, combined (input and output network streams are treated separately). +# +# bps-capacity=0 + +# Uncomment if no UDP client listener is desired. +# By default UDP client listener is always started. +# +#no-udp + +# Uncomment if no TCP client listener is desired. +# By default TCP client listener is always started. +# +#no-tcp + +# Uncomment if no TLS client listener is desired. +# By default TLS client listener is always started. +# +#no-tls + +# Uncomment if no DTLS client listener is desired. +# By default DTLS client listener is always started. +# +#no-dtls + +# Uncomment if no UDP relay endpoints are allowed. +# By default UDP relay endpoints are enabled (like in RFC 5766). +# +#no-udp-relay + +# Uncomment if no TCP relay endpoints are allowed. +# By default TCP relay endpoints are enabled (like in RFC 6062). +# +#no-tcp-relay + +# Uncomment if extra security is desired, +# with nonce value having limited lifetime. +# By default, the nonce value is unique for a session, +# and has unlimited lifetime. +# Set this option to limit the nonce lifetime. +# It defaults to 600 secs (10 min) if no value is provided. After that delay, +# the client will get 438 error and will have to re-authenticate itself. +# +#stale-nonce=600 + +# Uncomment if you want to set the maximum allocation +# time before it has to be refreshed. +# Default is 3600s. +# +#max-allocate-lifetime=3600 + + +# Uncomment to set the lifetime for the channel. +# Default value is 600 secs (10 minutes). +# This value MUST not be changed for production purposes. +# +#channel-lifetime=600 + +# Uncomment to set the permission lifetime. +# Default to 300 secs (5 minutes). +# In production this value MUST not be changed, +# however it can be useful for test purposes. +# +#permission-lifetime=300 + +# Certificate file. +# Use an absolute path or path relative to the +# configuration file. +# +#cert=/usr/local/etc/turn_server_cert.pem + +# Private key file. +# Use an absolute path or path relative to the +# configuration file. +# Use PEM file format. +# +#pkey=/usr/local/etc/turn_server_pkey.pem + +# Private key file password, if it is in encoded format. +# This option has no default value. +# +#pkey-pwd=... + +# Allowed OpenSSL cipher list for TLS/DTLS connections. +# Default value is "DEFAULT". +# +#cipher-list="DEFAULT" + +# CA file in OpenSSL format. +# Forces TURN server to verify the client SSL certificates. +# By default it is not set: there is no default value and the client +# certificate is not checked. +# +# Example: +#CA-file=/etc/ssh/id_rsa.cert + +# Curve name for EC ciphers, if supported by OpenSSL +# library (TLS and DTLS). The default value is prime256v1, +# if pre-OpenSSL 1.0.2 is used. With OpenSSL 1.0.2+, +# an optimal curve will be automatically calculated, if not defined +# by this option. +# +#ec-curve-name=prime256v1 + +# Use 566 bits predefined DH TLS key. Default size of the key is 1066. +# +#dh566 + +# Use 2066 bits predefined DH TLS key. Default size of the key is 1066. +# +#dh2066 + +# Use custom DH TLS key, stored in PEM format in the file. +# Flags --dh566 and --dh2066 are ignored when the DH key is taken from a file. +# +#dh-file= + +# Flag to prevent stdout log messages. +# By default, all log messages are going to both stdout and to +# the configured log file. With this option everything will be +# going to the configured log only (unless the log file itself is stdout). +# +#no-stdout-log + +# Option to set the log file name. +# By default, the turnserver tries to open a log file in +# /var/log, /var/tmp, /tmp and current directories directories +# (which open operation succeeds first that file will be used). +# With this option you can set the definite log file name. +# The special names are "stdout" and "-" - they will force everything +# to the stdout. Also, the "syslog" name will force everything to +# the system log (syslog). +# In the runtime, the logfile can be reset with the SIGHUP signal +# to the turnserver process. +# +#log-file=/var/tmp/turn.log + +# Option to redirect all log output into system log (syslog). +# +syslog + +# This flag means that no log file rollover will be used, and the log file +# name will be constructed as-is, without PID and date appendage. +# This option can be used, for example, together with the logrotate tool. +# +#simple-log + +# Option to set the "redirection" mode. The value of this option +# will be the address of the alternate server for UDP & TCP service in form of +# [:]. The server will send this value in the attribute +# ALTERNATE-SERVER, with error 300, on ALLOCATE request, to the client. +# Client will receive only values with the same address family +# as the client network endpoint address family. +# See RFC 5389 and RFC 5766 for ALTERNATE-SERVER functionality description. +# The client must use the obtained value for subsequent TURN communications. +# If more than one --alternate-server options are provided, then the functionality +# can be more accurately described as "load-balancing" than a mere "redirection". +# If the port number is omitted, then the default port +# number 3478 for the UDP/TCP protocols will be used. +# Colon (:) characters in IPv6 addresses may conflict with the syntax of +# the option. To alleviate this conflict, literal IPv6 addresses are enclosed +# in square brackets in such resource identifiers, for example: +# [2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478 . +# Multiple alternate servers can be set. They will be used in the +# round-robin manner. All servers in the pool are considered of equal weight and +# the load will be distributed equally. For example, if we have 4 alternate servers, +# then each server will receive 25% of ALLOCATE requests. A alternate TURN server +# address can be used more than one time with the alternate-server option, so this +# can emulate "weighting" of the servers. +# +# Examples: +#alternate-server=1.2.3.4:5678 +#alternate-server=11.22.33.44:56789 +#alternate-server=5.6.7.8 +#alternate-server=[2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478 + +# Option to set alternative server for TLS & DTLS services in form of +# :. If the port number is omitted, then the default port +# number 5349 for the TLS/DTLS protocols will be used. See the previous +# option for the functionality description. +# +# Examples: +#tls-alternate-server=1.2.3.4:5678 +#tls-alternate-server=11.22.33.44:56789 +#tls-alternate-server=[2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478 + +# Option to suppress TURN functionality, only STUN requests will be processed. +# Run as STUN server only, all TURN requests will be ignored. +# By default, this option is NOT set. +# +#stun-only + +# Option to suppress STUN functionality, only TURN requests will be processed. +# Run as TURN server only, all STUN requests will be ignored. +# By default, this option is NOT set. +# +#no-stun + +# This is the timestamp/username separator symbol (character) in TURN REST API. +# The default value is ':'. +# rest-api-separator=: + +# Flag that can be used to allow peers on the loopback addresses (127.x.x.x and ::1). +# This is an extra security measure. +# +# (To avoid any security issue that allowing loopback access may raise, +# the no-loopback-peers option is replaced by allow-loopback-peers.) +# +# Allow it only for testing in a development environment! +# In production it adds a possible security vulnerability, so for security reasons +# it is not allowed using it together with empty cli-password. +# +#allow-loopback-peers + +# Flag that can be used to disallow peers on well-known broadcast addresses (224.0.0.0 and above, and FFXX:*). +# This is an extra security measure. +# +#no-multicast-peers + +# Option to set the max time, in seconds, allowed for full allocation establishment. +# Default is 60 seconds. +# +#max-allocate-timeout=60 + +# Option to allow or ban specific ip addresses or ranges of ip addresses. +# If an ip address is specified as both allowed and denied, then the ip address is +# considered to be allowed. This is useful when you wish to ban a range of ip +# addresses, except for a few specific ips within that range. +# +# This can be used when you do not want users of the turn server to be able to access +# machines reachable by the turn server, but would otherwise be unreachable from the +# internet (e.g. when the turn server is sitting behind a NAT) +# +# Examples: +# denied-peer-ip=83.166.64.0-83.166.95.255 +# allowed-peer-ip=83.166.68.45 + +# File name to store the pid of the process. +# Default is /var/run/turnserver.pid (if superuser account is used) or +# /var/tmp/turnserver.pid . +# +#pidfile="/var/run/turnserver.pid" + +# Require authentication of the STUN Binding request. +# By default, the clients are allowed anonymous access to the STUN Binding functionality. +# +#secure-stun + +# Mobility with ICE (MICE) specs support. +# +#mobility + +# Allocate Address Family according +# If enabled then TURN server allocates address family according the TURN +# Client <=> Server communication address family. +# (By default coTURN works according RFC 6156.) +# !!Warning: Enabling this option breaks RFC6156 section-4.2 (violates use default IPv4)!! +# +#keep-address-family + + +# User name to run the process. After the initialization, the turnserver process +# will make an attempt to change the current user ID to that user. +# +#proc-user= + +# Group name to run the process. After the initialization, the turnserver process +# will make an attempt to change the current group ID to that group. +# +#proc-group= + +# Turn OFF the CLI support. +# By default it is always ON. +# See also options cli-ip and cli-port. +# +#no-cli + +#Local system IP address to be used for CLI server endpoint. Default value +# is 127.0.0.1. +# +#cli-ip=127.0.0.1 + +# CLI server port. Default is 5766. +# +#cli-port=5766 + +# CLI access password. Default is empty (no password). +# For the security reasons, it is recommended to use the encrypted +# for of the password (see the -P command in the turnadmin utility). +# +# Secure form for password 'qwerty': +# +#cli-password=$5$79a316b350311570$81df9cfb9af7f5e5a76eada31e7097b663a0670f99a3c07ded3f1c8e59c5658a +# +# Or unsecure form for the same password: +# +#cli-password=qwerty + +# Enable Web-admin support on https. By default it is Disabled. +# If it is enabled it also enables a http a simple static banner page +# with a small reminder that the admin page is available only on https. +# +#web-admin + +# Local system IP address to be used for Web-admin server endpoint. Default value is 127.0.0.1. +# +#web-admin-ip=127.0.0.1 + +# Web-admin server port. Default is 8080. +# +#web-admin-port=8080 + +# Web-admin server listen on STUN/TURN worker threads +# By default it is disabled for security resons! (Not recommended in any production environment!) +# +#web-admin-listen-on-workers + +# Server relay. NON-STANDARD AND DANGEROUS OPTION. +# Only for those applications when we want to run +# server applications on the relay endpoints. +# This option eliminates the IP permissions check on +# the packets incoming to the relay endpoints. +# +#server-relay + +# Maximum number of output sessions in ps CLI command. +# This value can be changed on-the-fly in CLI. The default value is 256. +# +#cli-max-output-sessions + +# Set network engine type for the process (for internal purposes). +# +#ne=[1|2|3] + +# Do not allow an TLS/DTLS version of protocol +# +#no-tlsv1 +#no-tlsv1_1 +#no-tlsv1_2 From ca3f06f831413bc2527c84282138adb2f09f8a78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Sun, 17 Dec 2023 17:05:06 +0100 Subject: [PATCH 2/6] Increase size of port range for TURN --- site-cookbooks/kosmos-ejabberd/attributes/default.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site-cookbooks/kosmos-ejabberd/attributes/default.rb b/site-cookbooks/kosmos-ejabberd/attributes/default.rb index 7128363..b428b7e 100644 --- a/site-cookbooks/kosmos-ejabberd/attributes/default.rb +++ b/site-cookbooks/kosmos-ejabberd/attributes/default.rb @@ -4,5 +4,5 @@ node.default["ejabberd"]["checksum"] = "1b02108c81e22ab28be84630d54061f0584b76d5 node.default["ejabberd"]["stun_auth_realm"] = "kosmos.org" node.default["ejabberd"]["stun_turn_port"] = 3478 node.default["ejabberd"]["turn_min_port"] = 50000 -node.default["ejabberd"]["turn_max_port"] = 50050 +node.default["ejabberd"]["turn_max_port"] = 50999 node.default["ejabberd"]["turn_ip_address"] = nil From 8a97ebf4f80e46913c20c34a951b84f5fe0e0789 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Sun, 17 Dec 2023 17:57:49 +0100 Subject: [PATCH 3/6] Use domain instead of IP, add TLS endpoints --- environments/production.json | 2 +- .../kosmos-ejabberd/attributes/default.rb | 4 ++-- .../kosmos-ejabberd/recipes/coturn.rb | 22 +++++++++++++++---- .../kosmos-ejabberd/recipes/default.rb | 3 ++- .../templates/ejabberd.yml.erb | 16 ++++++++++++-- .../templates/turnserver.conf.erb | 6 ++--- 6 files changed, 40 insertions(+), 13 deletions(-) diff --git a/environments/production.json b/environments/production.json index cdc5ada..bb9c577 100644 --- a/environments/production.json +++ b/environments/production.json @@ -17,7 +17,7 @@ "public_url": "https://drone.kosmos.org" }, "ejabberd": { - "turn_ip_address": "148.251.83.201" + "turn_domain": "turn.kosmos.org" }, "garage": { "replication_mode": "2", diff --git a/site-cookbooks/kosmos-ejabberd/attributes/default.rb b/site-cookbooks/kosmos-ejabberd/attributes/default.rb index b428b7e..a0930f4 100644 --- a/site-cookbooks/kosmos-ejabberd/attributes/default.rb +++ b/site-cookbooks/kosmos-ejabberd/attributes/default.rb @@ -1,8 +1,8 @@ node.default["ejabberd"]["version"] = "23.10" node.default["ejabberd"]["package_version"] = "1" node.default["ejabberd"]["checksum"] = "1b02108c81e22ab28be84630d54061f0584b76d5c2702e598352269736b05e77" -node.default["ejabberd"]["stun_auth_realm"] = "kosmos.org" +node.default["ejabberd"]["turn_domain"] = "turn.kosmos.org" node.default["ejabberd"]["stun_turn_port"] = 3478 +node.default["ejabberd"]["stun_turn_port_tls"] = 5349 node.default["ejabberd"]["turn_min_port"] = 50000 node.default["ejabberd"]["turn_max_port"] = 50999 -node.default["ejabberd"]["turn_ip_address"] = nil diff --git a/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb index b7ee512..a9b581b 100644 --- a/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb +++ b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb @@ -5,19 +5,27 @@ apt_package 'coturn' +domain = node["ejabberd"]["turn_domain"] credentials = data_bag_item("credentials", "ejabberd") +tls_cert_for domain do + auth "gandi_dns" + action :create +end + template "/etc/turnserver.conf" do source "turnserver.conf.erb" mode 0644 variables listening_port: node["ejabberd"]["stun_turn_port"], - tls_listening_port: node["ejabberd"]["stun_turn_port"], - listening_ip: node["ejabberd"]["turn_ip_address"], - relay_ip: node["ejabberd"]["turn_ip_address"], + tls_listening_port: node["ejabberd"]["stun_turn_port_tls"], + listening_ip: node["ipaddress"], + relay_ip: node["ipaddress"], min_port: node["ejabberd"]["turn_min_port"], max_port: node["ejabberd"]["turn_max_port"], static_auth_secret: credentials["stun_secret"], - realm: node["ejabberd"]["stun_auth_realm"] + realm: domain, + cert: "/etc/letsencrypt/live/#{domain}/fullchain.pem", + pkey: "/etc/letsencrypt/live/#{domain}/privkey.pem" notifies :restart, "service[coturn]", :delayed end @@ -27,6 +35,12 @@ firewall_rule 'ejabberd_stun_turn' do command :allow end +firewall_rule 'ejabberd_stun_turn_tls' do + port node["ejabberd"]["stun_turn_port_tls"] + protocol :udp + command :allow +end + firewall_rule 'ejabberd_turn' do port node["ejabberd"]["turn_min_port"]..node["ejabberd"]["turn_max_port"] protocol :udp diff --git a/site-cookbooks/kosmos-ejabberd/recipes/default.rb b/site-cookbooks/kosmos-ejabberd/recipes/default.rb index a34a7f7..9c98357 100644 --- a/site-cookbooks/kosmos-ejabberd/recipes/default.rb +++ b/site-cookbooks/kosmos-ejabberd/recipes/default.rb @@ -183,10 +183,11 @@ template "/opt/ejabberd/conf/ejabberd.yml" do sensitive true variables hosts: hosts, admin_users: admin_users, - stun_auth_realm: node["ejabberd"]["stun_auth_realm"], + stun_auth_realm: node["ejabberd"]["turn_domain"], stun_secret: ejabberd_credentials['stun_secret'], turn_ip_address: node["ejabberd"]["turn_ip_address"], stun_turn_port: node["ejabberd"]["stun_turn_port"], + stun_turn_port_tls: node["ejabberd"]["stun_turn_port_tls"], turn_min_port: node["ejabberd"]["turn_min_port"], turn_max_port: node["ejabberd"]["turn_max_port"], private_ip_address: node["knife_zero"]["host"], diff --git a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb index 79bd591..64b89df 100644 --- a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb +++ b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb @@ -233,17 +233,29 @@ modules: secret: <%= @stun_secret %> services: - - host: <%= @turn_ip_address %> + host: <%= @turn_domain %> port: <%= @stun_turn_port %> type: stun transport: udp restricted: false - - host: <%= @turn_ip_address %> + host: <%= @turn_domain %> + port: <%= @stun_turn_port_tls %> + type: stuns + transport: udp + restricted: false + - + host: <%= @turn_domain %> port: <%= @stun_turn_port %> type: turn transport: udp restricted: true + - + host: <%= @turn_domain %> + port: <%= @stun_turn_port_tls %> + type: turns + transport: tcp + restricted: true mod_vcard: search: false mod_vcard_xupdate: {} diff --git a/site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb b/site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb index 257684d..cdb1054 100644 --- a/site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb +++ b/site-cookbooks/kosmos-ejabberd/templates/turnserver.conf.erb @@ -436,14 +436,14 @@ realm=<%= @realm %> # Use an absolute path or path relative to the # configuration file. # -#cert=/usr/local/etc/turn_server_cert.pem +cert=<%= @cert %> # Private key file. # Use an absolute path or path relative to the # configuration file. # Use PEM file format. # -#pkey=/usr/local/etc/turn_server_pkey.pem +pkey=<%= @pkey %> # Private key file password, if it is in encoded format. # This option has no default value. @@ -642,7 +642,7 @@ syslog # By default it is always ON. # See also options cli-ip and cli-port. # -#no-cli +no-cli #Local system IP address to be used for CLI server endpoint. Default value # is 127.0.0.1. From ed998fc1d3ffebb6b6ddc2d31e9761bb57a5a159 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Mon, 18 Dec 2023 13:22:34 +0100 Subject: [PATCH 4/6] Use TCP for TLS connections --- site-cookbooks/kosmos-ejabberd/recipes/coturn.rb | 2 +- site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb index a9b581b..b273a8c 100644 --- a/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb +++ b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb @@ -37,7 +37,7 @@ end firewall_rule 'ejabberd_stun_turn_tls' do port node["ejabberd"]["stun_turn_port_tls"] - protocol :udp + protocol :tcp command :allow end diff --git a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb index 64b89df..b49ebfa 100644 --- a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb +++ b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb @@ -242,7 +242,7 @@ modules: host: <%= @turn_domain %> port: <%= @stun_turn_port_tls %> type: stuns - transport: udp + transport: tcp restricted: false - host: <%= @turn_domain %> From 292366a77fae2f00d1a0ed45f6f3428284ba00e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Mon, 18 Dec 2023 13:23:05 +0100 Subject: [PATCH 5/6] Domain vs realm vs IP --- site-cookbooks/kosmos-ejabberd/attributes/default.rb | 1 + site-cookbooks/kosmos-ejabberd/recipes/coturn.rb | 2 +- site-cookbooks/kosmos-ejabberd/recipes/default.rb | 3 +-- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/site-cookbooks/kosmos-ejabberd/attributes/default.rb b/site-cookbooks/kosmos-ejabberd/attributes/default.rb index a0930f4..42960c5 100644 --- a/site-cookbooks/kosmos-ejabberd/attributes/default.rb +++ b/site-cookbooks/kosmos-ejabberd/attributes/default.rb @@ -2,6 +2,7 @@ node.default["ejabberd"]["version"] = "23.10" node.default["ejabberd"]["package_version"] = "1" node.default["ejabberd"]["checksum"] = "1b02108c81e22ab28be84630d54061f0584b76d5c2702e598352269736b05e77" node.default["ejabberd"]["turn_domain"] = "turn.kosmos.org" +node.default["ejabberd"]["stun_auth_realm"] = "kosmos.org" node.default["ejabberd"]["stun_turn_port"] = 3478 node.default["ejabberd"]["stun_turn_port_tls"] = 5349 node.default["ejabberd"]["turn_min_port"] = 50000 diff --git a/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb index b273a8c..0e73322 100644 --- a/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb +++ b/site-cookbooks/kosmos-ejabberd/recipes/coturn.rb @@ -22,8 +22,8 @@ template "/etc/turnserver.conf" do relay_ip: node["ipaddress"], min_port: node["ejabberd"]["turn_min_port"], max_port: node["ejabberd"]["turn_max_port"], + realm: node["ejabberd"]["stun_auth_realm"], static_auth_secret: credentials["stun_secret"], - realm: domain, cert: "/etc/letsencrypt/live/#{domain}/fullchain.pem", pkey: "/etc/letsencrypt/live/#{domain}/privkey.pem" notifies :restart, "service[coturn]", :delayed diff --git a/site-cookbooks/kosmos-ejabberd/recipes/default.rb b/site-cookbooks/kosmos-ejabberd/recipes/default.rb index 9c98357..d9729f0 100644 --- a/site-cookbooks/kosmos-ejabberd/recipes/default.rb +++ b/site-cookbooks/kosmos-ejabberd/recipes/default.rb @@ -183,9 +183,8 @@ template "/opt/ejabberd/conf/ejabberd.yml" do sensitive true variables hosts: hosts, admin_users: admin_users, - stun_auth_realm: node["ejabberd"]["turn_domain"], + turn_domain: node["ejabberd"]["turn_domain"], stun_secret: ejabberd_credentials['stun_secret'], - turn_ip_address: node["ejabberd"]["turn_ip_address"], stun_turn_port: node["ejabberd"]["stun_turn_port"], stun_turn_port_tls: node["ejabberd"]["stun_turn_port_tls"], turn_min_port: node["ejabberd"]["turn_min_port"], From e1007f788635076284bbfddd3db8e9fcf19655a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Mon, 18 Dec 2023 13:23:21 +0100 Subject: [PATCH 6/6] ejabberd disco config additions --- site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb index b49ebfa..b8fd9e8 100644 --- a/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb +++ b/site-cookbooks/kosmos-ejabberd/templates/ejabberd.yml.erb @@ -230,6 +230,8 @@ modules: store_current_id: true mod_shared_roster: {} mod_stun_disco: + offer_local_services: false + credentials_lifetime: 300 secret: <%= @stun_secret %> services: -