From 6a41a572bffbd6a2c05b45d4083065c5369a2fcf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Fri, 15 May 2020 10:52:30 +0200 Subject: [PATCH 1/6] Import __coturn type from ungleich's dot-cdist --- type/__coturn/files/turnserver.conf.sh | 775 ++++++++++++++++++++++ type/__coturn/man.rst | 78 +++ type/__coturn/manifest | 91 +++ type/__coturn/parameter/boolean | 4 + type/__coturn/parameter/optional | 4 + type/__coturn/parameter/optional_multiple | 2 + type/__coturn/singleton | 0 7 files changed, 954 insertions(+) create mode 100755 type/__coturn/files/turnserver.conf.sh create mode 100644 type/__coturn/man.rst create mode 100755 type/__coturn/manifest create mode 100644 type/__coturn/parameter/boolean create mode 100644 type/__coturn/parameter/optional create mode 100644 type/__coturn/parameter/optional_multiple create mode 100644 type/__coturn/singleton diff --git a/type/__coturn/files/turnserver.conf.sh b/type/__coturn/files/turnserver.conf.sh new file mode 100755 index 0000000..7b8eba2 --- /dev/null +++ b/type/__coturn/files/turnserver.conf.sh @@ -0,0 +1,775 @@ +#!/bin/sh + +cat << EOF +# 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=3478 + +# 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=5349 + +# 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=172.17.19.101 +#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=172.17.19.105 +#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=49152 +max-port=65535 + +# 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. +EOF + +if [ "$USE_AUTH_SECRET" ]; then + echo 'use-auth-secret' +else + echo '#use-auth-secret' +fi + +cat << EOF + +# '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'. +# +EOF + +if [ "$STATIC_AUTH_SECRET" != "" ]; then + echo "static-auth-secret=$STATIC_AUTH_SECRET" +else + echo "#static-auth-secret=north" +fi + +cat << EOF + +# 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. +# +EOF + +if [ "$REALM" != "" ]; then + echo "realm=$REALM" +else + echo "#realm=mycompany.org" +fi + +cat << EOF + +# 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. +# +EOF + +if [ "$NO_TLS" ]; then + echo "no-tls" +else + echo "#no-tls" +fi + +cat << EOF + +# 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). +# +EOF + +if [ "$NO_TCP_RELAY" ]; then + echo 'no-tcp-releay' +else + echo '#no-tcp-relay' +fi + +cat << EOF + +# 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. +EOF + +if [ "$CERT" != "" ]; then + echo "cert=$CERT" +else + echo "#cert=/usr/local/etc/turn_server_cert.pem" +fi + +cat << EOF + +# Private key file. +# Use an absolute path or path relative to the +# configuration file. +# Use PEM file format. +EOF + +if [ "$PKEY" != "" ]; then + echo "pkey=$PKEY" +else + echo "#pkey=/usr/local/etc/turn_server_pkey.pem" +fi + +cat << EOF + +# 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 +EOF + +for peer in $DENIED_PEERS; do + echo "denied-peer: $peer" +done + +for peer in $ALLOWED_PEERS; do + echo "allowed-peer: $peer" +done + +cat << EOF +# 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 +EOF diff --git a/type/__coturn/man.rst b/type/__coturn/man.rst new file mode 100644 index 0000000..270602c --- /dev/null +++ b/type/__coturn/man.rst @@ -0,0 +1,78 @@ +cdist-type__coturn(7) +===================== + +NAME +---- +cdist-type__coturn - Install and configure a coturn TURN server + + +DESCRIPTION +----------- +This (singleton) type install and configure a coturn TURN +server. + + +REQUIRED PARAMETERS +------------------- +None. + + +OPTIONAL PARAMETERS +------------------- +static_auth_secret + Secret used to access the TURN REST API. + +realm + Defailt realm. + +allowed-peer + Allow specific ip addresses or ranges of ip addresses. Can be specified multiple times. + +denied-peer + Ban specific ip addresses or ranges of ip addresses. Can be specified multiple times. + +cert + Path to certificate file. Absolute or relative + +pkey + Patch to privaty key file. Use PEM file format. + +BOOLEAN PARAMETERS +------------------ +use-auth-secret + Allows TURN credentials to be accounted for a specific user id. + +no-tcp-relay + Disable TCP relay endpoints. + +no-tls + Disable TLS listener. + +no-dtls + Disable DTLS listener. + +EXAMPLES +-------- + +.. code-block:: sh + + __coturn \ + --realm turn.domain.tld \ + --no_tcp_relay + + +SEE ALSO +-------- +- `coturn Github repository `_ + +AUTHORS +------- +Timothée Floure + + +COPYING +------- +Copyright \(C) 2020 Timothée Floure. You can redistribute it +and/or modify it under the terms of the GNU General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. diff --git a/type/__coturn/manifest b/type/__coturn/manifest new file mode 100755 index 0000000..2b27315 --- /dev/null +++ b/type/__coturn/manifest @@ -0,0 +1,91 @@ +#!/bin/sh -e +# +# 2020 Timothée Floure (timothee.floure@ungleich.ch) +# +# This file is part of cdist. +# +# cdist is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# cdist is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with cdist. If not, see . +# + +os=$(cat "$__global/explorer/os") + +case "$os" in + debian) + __package coturn + coturn_config='/etc/turnserver.conf' + ;; + *) + printf "Your operating system (%s) is currently not supported by this type (%s)\n" "$os" "${__type##*/}" >&2 + printf "Please contribute an implementation for it if you can.\n" >&2 + exit 1 + ;; +esac + +# Type parameters. +if [ -f "$__object/parameter/use-auth-secret" ]; then + export USE_AUTH_SECRET=1 +fi + +if [ -f "$__object/parameter/no-tls" ]; then + export NO_TLS=1 +fi + +if [ -f "$__object/parameter/no-dtls" ]; then + export NO_DTLS=1 +fi + +if [ -f "$__object/parameter/static-auth-secret" ]; then + STATIC_AUTH_SECRET=$(cat "$__object/parameter/static-auth-secret") + export STATIC_AUTH_SECRET +fi + +if [ -f "$__object/parameter/realm" ]; then + REALM=$(cat "$__object/parameter/realm") + export REALM +fi + +if [ -f "$__object/parameter/no-tcp-relay" ]; then + export NO_TCP_RELAY=1 +fi + +if [ -f "$__object/parameter/allowed-peer" ]; then + ALLOWED_PEERS=$(cat "$__object/parameter/allowed-peer") + export ALLOWED_PEERS +fi + +if [ -f "$__object/parameter/denied-peer" ]; then + DENIED_PEERS=$(cat "$__object/parameter/denied-peer") + export DENIED_PEERS +fi + +if [ -f "$__object/parameter/cert" ]; then + CERT=$(cat "$__object/parameter/cert") + export CERT +fi + +if [ -f "$__object/parameter/pkey" ]; then + PKEY=$(cat "$__object/parameter/pkey") + export PKEY +fi + +# Generate and deploy configuration file. +mkdir -p "$__object/files" +"$__type/files/turnserver.conf.sh" > "$__object/files/turnserver.conf" + +require="__package/coturn" __file $coturn_config \ + --source "$__object/files/turnserver.conf" \ + --owner turnserver + +# Restart coturn server. +require="__file/$coturn_config" __service coturn --action restart diff --git a/type/__coturn/parameter/boolean b/type/__coturn/parameter/boolean new file mode 100644 index 0000000..f9180db --- /dev/null +++ b/type/__coturn/parameter/boolean @@ -0,0 +1,4 @@ +use-auth-secret +no-tcp-relay +no-tls +no-dtls diff --git a/type/__coturn/parameter/optional b/type/__coturn/parameter/optional new file mode 100644 index 0000000..515814d --- /dev/null +++ b/type/__coturn/parameter/optional @@ -0,0 +1,4 @@ +static-auth-secret +realm +cert +pkey diff --git a/type/__coturn/parameter/optional_multiple b/type/__coturn/parameter/optional_multiple new file mode 100644 index 0000000..6c49c91 --- /dev/null +++ b/type/__coturn/parameter/optional_multiple @@ -0,0 +1,2 @@ +allowed-peer +denied-peer diff --git a/type/__coturn/singleton b/type/__coturn/singleton new file mode 100644 index 0000000..e69de29 From 962ccb3d6e8ed1ba355709c12918c7ad7968ef0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Fri, 15 May 2020 12:18:37 +0200 Subject: [PATCH 2/6] Extend __coturn to devuan and ubuntu --- type/__coturn/manifest | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/type/__coturn/manifest b/type/__coturn/manifest index 2b27315..9d5e7de 100755 --- a/type/__coturn/manifest +++ b/type/__coturn/manifest @@ -21,7 +21,7 @@ os=$(cat "$__global/explorer/os") case "$os" in - debian) + debian|devuan|ubuntu) __package coturn coturn_config='/etc/turnserver.conf' ;; From 442dec51edaed55d3a98940c20945c8bf826ddb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Fri, 15 May 2020 12:26:10 +0200 Subject: [PATCH 3/6] __coturn: fix formating of {allowed,denied}-peer config entries --- type/__coturn/files/turnserver.conf.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/type/__coturn/files/turnserver.conf.sh b/type/__coturn/files/turnserver.conf.sh index 7b8eba2..723f4ef 100755 --- a/type/__coturn/files/turnserver.conf.sh +++ b/type/__coturn/files/turnserver.conf.sh @@ -662,11 +662,11 @@ syslog EOF for peer in $DENIED_PEERS; do - echo "denied-peer: $peer" + echo "denied-peer=$peer" done for peer in $ALLOWED_PEERS; do - echo "allowed-peer: $peer" + echo "allowed-peer=$peer" done cat << EOF From 45f601c911422db0920bd37ecacd2fe1fd1be508 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Floure?= Date: Fri, 15 May 2020 12:26:50 +0200 Subject: [PATCH 4/6] __coturn: allow configuration of litening-ip --- type/__coturn/files/turnserver.conf.sh | 10 +++++++++- type/__coturn/manifest | 5 +++++ type/__coturn/parameter/optional_multiple | 1 + 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/type/__coturn/files/turnserver.conf.sh b/type/__coturn/files/turnserver.conf.sh index 723f4ef..ccd01c5 100755 --- a/type/__coturn/files/turnserver.conf.sh +++ b/type/__coturn/files/turnserver.conf.sh @@ -51,11 +51,19 @@ cat << EOF # 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=172.17.19.101 #listening-ip=10.207.21.238 #listening-ip=2607:f0d0:1002:51::4 +EOF + +for ip in $LISTENING_IPS; do + echo "listening-ip=$ip" +done + +cat << EOF + # Auxiliary STUN/TURN server listening endpoint. # Aux servers have almost full TURN and STUN functionality. # The (minor) limitations are: diff --git a/type/__coturn/manifest b/type/__coturn/manifest index 9d5e7de..e0b41ca 100755 --- a/type/__coturn/manifest +++ b/type/__coturn/manifest @@ -69,6 +69,11 @@ if [ -f "$__object/parameter/denied-peer" ]; then export DENIED_PEERS fi +if [ -f "$__object/parameter/listening-ip" ]; then + LISTENING_IPS=$(cat "$__object/parameter/listening-ip") + export LISTENING_IPS +fi + if [ -f "$__object/parameter/cert" ]; then CERT=$(cat "$__object/parameter/cert") export CERT diff --git a/type/__coturn/parameter/optional_multiple b/type/__coturn/parameter/optional_multiple index 6c49c91..f736fa1 100644 --- a/type/__coturn/parameter/optional_multiple +++ b/type/__coturn/parameter/optional_multiple @@ -1,2 +1,3 @@ allowed-peer denied-peer +listening-ip From 61bd5b59582eaecd32d9fc6e2145cd08a963a5e0 Mon Sep 17 00:00:00 2001 From: Evilham Date: Fri, 15 May 2020 22:12:52 +0200 Subject: [PATCH 5/6] [__coturn] Add support for common parameters and extra-config. extra-config allows for any complex setup to be defined and managed by the type user. --- type/__coturn/files/turnserver.conf.sh | 23 +++++++++-- type/__coturn/man.rst | 50 ++++++++++++++++++------ type/__coturn/manifest | 21 ++++++++-- type/__coturn/parameter/boolean | 1 + type/__coturn/parameter/default/max-port | 1 + type/__coturn/parameter/default/min-port | 1 + type/__coturn/parameter/optional | 3 ++ 7 files changed, 80 insertions(+), 20 deletions(-) create mode 100644 type/__coturn/parameter/default/max-port create mode 100644 type/__coturn/parameter/default/min-port diff --git a/type/__coturn/files/turnserver.conf.sh b/type/__coturn/files/turnserver.conf.sh index ccd01c5..d16131c 100755 --- a/type/__coturn/files/turnserver.conf.sh +++ b/type/__coturn/files/turnserver.conf.sh @@ -157,8 +157,8 @@ cat << EOF # Lower and upper bounds of the UDP relay endpoints: # (default values are 49152 and 65535) # -min-port=49152 -max-port=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. @@ -437,7 +437,15 @@ cat << EOF # Uncomment if no UDP relay endpoints are allowed. # By default UDP relay endpoints are enabled (like in RFC 5766). # -#no-udp-relay +EOF + +if [ "$NO_UDP_RELAY" ]; then + echo 'no-udp-relay' +else + echo '#no-udp-relay' +fi + +cat << EOF # Uncomment if no TCP relay endpoints are allowed. # By default TCP relay endpoints are enabled (like in RFC 6062). @@ -445,7 +453,7 @@ cat << EOF EOF if [ "$NO_TCP_RELAY" ]; then - echo 'no-tcp-releay' + echo 'no-tcp-relay' else echo '#no-tcp-relay' fi @@ -781,3 +789,10 @@ cat << EOF #no-tlsv1_1 #no-tlsv1_2 EOF + +if [ -n "$EXTRA_CONFIG" ]; then + cat < "$__object/files/turnserver.conf" require="__package/coturn" __file $coturn_config \ --source "$__object/files/turnserver.conf" \ - --owner turnserver - -# Restart coturn server. -require="__file/$coturn_config" __service coturn --action restart + --owner turnserver \ + --onchange 'service coturn restart' diff --git a/type/__coturn/parameter/boolean b/type/__coturn/parameter/boolean index f9180db..65afc3b 100644 --- a/type/__coturn/parameter/boolean +++ b/type/__coturn/parameter/boolean @@ -1,4 +1,5 @@ use-auth-secret no-tcp-relay +no-udp-relay no-tls no-dtls diff --git a/type/__coturn/parameter/default/max-port b/type/__coturn/parameter/default/max-port new file mode 100644 index 0000000..7a53b35 --- /dev/null +++ b/type/__coturn/parameter/default/max-port @@ -0,0 +1 @@ +65535 diff --git a/type/__coturn/parameter/default/min-port b/type/__coturn/parameter/default/min-port new file mode 100644 index 0000000..3f1a082 --- /dev/null +++ b/type/__coturn/parameter/default/min-port @@ -0,0 +1 @@ +49152 diff --git a/type/__coturn/parameter/optional b/type/__coturn/parameter/optional index 515814d..f36d63d 100644 --- a/type/__coturn/parameter/optional +++ b/type/__coturn/parameter/optional @@ -2,3 +2,6 @@ static-auth-secret realm cert pkey +min-port +max-port +extra-config From 7efa697e5a037a1dccf05c4271ea872ebba1558d Mon Sep 17 00:00:00 2001 From: Evilham Date: Fri, 15 May 2020 22:26:33 +0200 Subject: [PATCH 6/6] [__coturn] Make shellcheck happy --- type/__coturn/manifest | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/type/__coturn/manifest b/type/__coturn/manifest index cfd0c9c..268469b 100755 --- a/type/__coturn/manifest +++ b/type/__coturn/manifest @@ -89,15 +89,18 @@ if [ -f "$__object/parameter/pkey" ]; then fi if [ -f "$__object/parameter/extra-config" ]; then - EXTRA_CONFIG=$(cat $__object/parameter/extra-config) + EXTRA_CONFIG=$(cat "$__object/parameter/extra-config") if [ "$EXTRA_CONFIG" = "-" ]; then EXTRA_CONFIG=$(cat "$__object/stdin") fi export EXTRA_CONFIG fi -export MIN_PORT=$(cat "$__object/parameter/min-port") -export MAX_PORT=$(cat "$__object/parameter/max-port") +MIN_PORT=$(cat "$__object/parameter/min-port") +export MIN_PORT +MAX_PORT=$(cat "$__object/parameter/max-port") +export MAX_PORT + # Generate and deploy configuration file. mkdir -p "$__object/files"