mirror of
				https://github.com/coturn/coturn.git
				synced 2025-11-04 00:41:02 +01:00 
			
		
		
		
	Merge branch 'typo'
This commit is contained in:
		
						commit
						eb0565efbb
					
				@ -29,6 +29,7 @@ Version 4.5.1.2 'dan Eider':
 | 
			
		||||
	- merge PR #276 Add systemd service example (by Liberasys)
 | 
			
		||||
	- merge PR #284 Add bandwidth usage reporting packet/bandwidth usage by peers
 | 
			
		||||
	- merge PR #381 Modifying configure to enable compile with private libraries
 | 
			
		||||
	- merge PR #455 Typo corrected (by chanduthedev)
 | 
			
		||||
 | 
			
		||||
02/03/2019 Oleg Moskalenko <mom040267@gmail.com> Mihály Mészáros <misi@majd.eu>
 | 
			
		||||
Version 4.5.1.1 'dan Eider':
 | 
			
		||||
 | 
			
		||||
@ -70,7 +70,7 @@ Only sha256 is supported as the hash function.
 | 
			
		||||
 | 
			
		||||
-L, --list-admin		List admin users in the database.
 | 
			
		||||
 | 
			
		||||
-s, --set-secret=<value> Add shared secret for TURN RESP API
 | 
			
		||||
-s, --set-secret=<value> Add shared secret for TURN REST API
 | 
			
		||||
 | 
			
		||||
-S, --show-secret	Show stored shared secrets for TURN REST API
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -87,7 +87,7 @@ User database settings:
 | 
			
		||||
-e, --psql-userdb	User database connection string for PostgreSQL.
 | 
			
		||||
		This database can be used for long-term credentials mechanism,
 | 
			
		||||
		and it can store the secret value 
 | 
			
		||||
		for secret-based timed authentication in TURN RESP API.
 | 
			
		||||
		for secret-based timed authentication in TURN REST API.
 | 
			
		||||
		The connection string format is like that:
 | 
			
		||||
		 
 | 
			
		||||
		"host=<host> dbname=<dbname> user=<db-user> password=<db-user-password> connect_timeout=<seconds>" 
 | 
			
		||||
@ -105,7 +105,7 @@ User database settings:
 | 
			
		||||
-M, --mysql-userdb	User database connection string for MySQL or MariaDB. 
 | 
			
		||||
		This database can be used for long-term credentials mechanism,
 | 
			
		||||
		and it can store the secret value for 
 | 
			
		||||
		secret-based timed authentication in TURN RESP API.
 | 
			
		||||
		secret-based timed authentication in TURN REST API.
 | 
			
		||||
		The connection string format is like that:
 | 
			
		||||
		 
 | 
			
		||||
		"host=<host> dbname=<dbname> user=<db-user> password=<db-user-password> connect_timeout=<seconds> read_timeout=<seconds>"
 | 
			
		||||
@ -128,7 +128,7 @@ User database settings:
 | 
			
		||||
-J, --mongo-userdb	User database connection string for MongoDB. 
 | 
			
		||||
		This database can be used for long-term credentials mechanism,
 | 
			
		||||
		and it can store the secret value 
 | 
			
		||||
		for secret-based timed authentication in TURN RESP API.
 | 
			
		||||
		for secret-based timed authentication in TURN REST API.
 | 
			
		||||
		The connection string format is like that:
 | 
			
		||||
		 
 | 
			
		||||
		"mongodb://username:password@host:port/database?options"
 | 
			
		||||
@ -141,7 +141,7 @@ User database settings:
 | 
			
		||||
-N, --redis-userdb	User database connection string for Redis. 
 | 
			
		||||
		This database can be used for long-term	credentials mechanism,
 | 
			
		||||
		and it can store the secret 
 | 
			
		||||
		value for secret-based timed authentication in TURN RESP API.
 | 
			
		||||
		value for secret-based timed authentication in TURN REST API.
 | 
			
		||||
		The connection string format is like that:
 | 
			
		||||
		 
 | 
			
		||||
		"ip=<ip-addr> dbname=<db-number> password=<db-password> connect_timeout=<seconds>"
 | 
			
		||||
@ -653,7 +653,7 @@ The temporary user is generated as:
 | 
			
		||||
temporary-username="timestamp" + ":" + "username"
 | 
			
		||||
 | 
			
		||||
where username is the persistent user name, and the timestamp format is just 
 | 
			
		||||
seconds sinse 1970 - the same value as time(NULL) function returns.
 | 
			
		||||
seconds since 1970 - the same value as time(NULL) function returns.
 | 
			
		||||
 | 
			
		||||
The temporary password is obtained as HMAC-SHA1 function over the temporary
 | 
			
		||||
username, with shared secret as the HMAC key, and then the result is encoded:
 | 
			
		||||
@ -717,7 +717,7 @@ The TURN server may use "--stale-nonce" option for extra security: in
 | 
			
		||||
some time, the nonce expires and the client will obtain 438 error response
 | 
			
		||||
with the new nonce, and the client will have to start using the new nonce.
 | 
			
		||||
 | 
			
		||||
In subsequent communications, the sever and the client will always assume 
 | 
			
		||||
In subsequent communications, the server and the client will always assume 
 | 
			
		||||
the same password - the original password becomes the session parameter and 
 | 
			
		||||
is never expiring. So the password is not changing while the session is valid
 | 
			
		||||
and unexpired. So, if the session is properly maintained, it may go forever, 
 | 
			
		||||
 | 
			
		||||
@ -273,7 +273,7 @@ lt-cred-mech
 | 
			
		||||
# 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.
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST 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
 | 
			
		||||
@ -286,7 +286,7 @@ lt-cred-mech
 | 
			
		||||
# 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.
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST API.
 | 
			
		||||
#
 | 
			
		||||
# Optional connection string parameters for the secure communications (SSL):
 | 
			
		||||
# ca, capath, cert, key, cipher
 | 
			
		||||
@ -312,7 +312,7 @@ mysql-userdb="host=mysql dbname=coturn user=coturn password=CHANGE_ME port=3306
 | 
			
		||||
# 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.
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST 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]]"
 | 
			
		||||
@ -323,7 +323,7 @@ mysql-userdb="host=mysql dbname=coturn user=coturn password=CHANGE_ME port=3306
 | 
			
		||||
# 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.
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST API.
 | 
			
		||||
# Use string format as below (space separated parameters, all optional):
 | 
			
		||||
#
 | 
			
		||||
#redis-userdb="ip=<ip-address> dbname=<database-number> password=<database-user-password> port=<port> connect_timeout=<seconds>"
 | 
			
		||||
 | 
			
		||||
@ -271,7 +271,7 @@
 | 
			
		||||
# 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. 
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST 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
 | 
			
		||||
@ -282,7 +282,7 @@
 | 
			
		||||
# 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.
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST API.
 | 
			
		||||
#
 | 
			
		||||
# Optional connection string parameters for the secure communications (SSL): 
 | 
			
		||||
# ca, capath, cert, key, cipher 
 | 
			
		||||
@ -306,7 +306,7 @@
 | 
			
		||||
# 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. 
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST 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]]"
 | 
			
		||||
@ -314,7 +314,7 @@
 | 
			
		||||
# 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. 
 | 
			
		||||
# and it can store the secret value for secret-based timed authentication in TURN REST API. 
 | 
			
		||||
# Use string format as below (space separated parameters, all optional):
 | 
			
		||||
#
 | 
			
		||||
#redis-userdb="ip=<ip-address> dbname=<database-number> password=<database-user-password> port=<port> connect_timeout=<seconds>"
 | 
			
		||||
 | 
			
		||||
@ -104,7 +104,7 @@ List long\-term users in the database.
 | 
			
		||||
\fB\-L\fP, \fB\-\-list\-admin\fP
 | 
			
		||||
List admin users in the database.
 | 
			
		||||
.PP
 | 
			
		||||
\fB\-s\fP, \fB\-\-set\-secret\fP=<value> Add shared secret for TURN RESP API
 | 
			
		||||
\fB\-s\fP, \fB\-\-set\-secret\fP=<value> Add shared secret for TURN REST API
 | 
			
		||||
.TP
 | 
			
		||||
.B
 | 
			
		||||
\fB\-S\fP, \fB\-\-show\-secret\fP
 | 
			
		||||
 | 
			
		||||
@ -140,7 +140,7 @@ SQLite user database file name (default \- /var/db/turndb or
 | 
			
		||||
User database connection string for PostgreSQL.
 | 
			
		||||
This database can be used for long\-term credentials mechanism,
 | 
			
		||||
and it can store the secret value 
 | 
			
		||||
for secret\-based timed authentication in TURN RESP API.
 | 
			
		||||
for secret\-based timed authentication in TURN REST API.
 | 
			
		||||
The connection string format is like that:
 | 
			
		||||
.RS
 | 
			
		||||
.PP
 | 
			
		||||
@ -162,7 +162,7 @@ Also, see http://www.PostgreSQL.org for full PostgreSQL documentation.
 | 
			
		||||
User database connection string for MySQL or MariaDB. 
 | 
			
		||||
This database can be used for long\-term credentials mechanism,
 | 
			
		||||
and it can store the secret value for 
 | 
			
		||||
secret\-based timed authentication in TURN RESP API.
 | 
			
		||||
secret\-based timed authentication in TURN REST API.
 | 
			
		||||
The connection string format is like that:
 | 
			
		||||
.RS
 | 
			
		||||
.PP
 | 
			
		||||
@ -192,7 +192,7 @@ If you want to use cleartext password then do not set this option!
 | 
			
		||||
User database connection string for MongoDB. 
 | 
			
		||||
This database can be used for long\-term credentials mechanism,
 | 
			
		||||
and it can store the secret value 
 | 
			
		||||
for secret\-based timed authentication in TURN RESP API.
 | 
			
		||||
for secret\-based timed authentication in TURN REST API.
 | 
			
		||||
The connection string format is like that:
 | 
			
		||||
.RS
 | 
			
		||||
.PP
 | 
			
		||||
@ -209,7 +209,7 @@ for full MongoDB documentation.
 | 
			
		||||
User database connection string for Redis. 
 | 
			
		||||
This database can be used for long\-term credentials mechanism,
 | 
			
		||||
and it can store the secret 
 | 
			
		||||
value for secret\-based timed authentication in TURN RESP API.
 | 
			
		||||
value for secret\-based timed authentication in TURN REST API.
 | 
			
		||||
The connection string format is like that:
 | 
			
		||||
.RS
 | 
			
		||||
.PP
 | 
			
		||||
@ -907,7 +907,7 @@ The temporary user is generated as:
 | 
			
		||||
temporary\-username="timestamp" + ":" + "username"
 | 
			
		||||
.PP
 | 
			
		||||
where username is the persistent user name, and the timestamp format is just 
 | 
			
		||||
seconds sinse 1970 \- the same value as \fBtime\fP(NULL) function returns.
 | 
			
		||||
seconds since 1970 \- the same value as \fBtime\fP(NULL) function returns.
 | 
			
		||||
.PP
 | 
			
		||||
The temporary password is obtained as HMAC\-SHA1 function over the temporary
 | 
			
		||||
username, with shared secret as the HMAC key, and then the result is encoded:
 | 
			
		||||
@ -987,7 +987,7 @@ The TURN server may use "\fB\-\-stale\-nonce\fP" option for extra security: in
 | 
			
		||||
some time, the nonce expires and the client will obtain 438 error response
 | 
			
		||||
with the new nonce, and the client will have to start using the new nonce.
 | 
			
		||||
.PP
 | 
			
		||||
In subsequent communications, the sever and the client will always assume 
 | 
			
		||||
In subsequent communications, the server and the client will always assume 
 | 
			
		||||
the same password \- the original password becomes the session parameter and 
 | 
			
		||||
is never expiring. So the password is not changing while the session is valid
 | 
			
		||||
and unexpired. So, if the session is properly maintained, it may go forever, 
 | 
			
		||||
 | 
			
		||||
@ -482,7 +482,7 @@ static char Usage[] = "Usage: turnserver [options]\n"
 | 
			
		||||
#if !defined(TURN_NO_PQ)
 | 
			
		||||
" -e, --psql-userdb, --sql-userdb <conn-string>	PostgreSQL database connection string, if used (default - empty, no PostreSQL DB used).\n"
 | 
			
		||||
"		                                This database can be used for long-term credentials mechanism users,\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN RESP API.\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN REST API.\n"
 | 
			
		||||
"						See http://www.postgresql.org/docs/8.4/static/libpq-connect.html for 8.x PostgreSQL\n"
 | 
			
		||||
"						versions format, see \n"
 | 
			
		||||
"						http://www.postgresql.org/docs/9.2/static/libpq-connect.html#LIBPQ-CONNSTRING\n"
 | 
			
		||||
@ -491,7 +491,7 @@ static char Usage[] = "Usage: turnserver [options]\n"
 | 
			
		||||
#if !defined(TURN_NO_MYSQL)
 | 
			
		||||
" -M, --mysql-userdb	<connection-string>	MySQL database connection string, if used (default - empty, no MySQL DB used).\n"
 | 
			
		||||
"	                                	This database can be used for long-term credentials mechanism users,\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN RESP API.\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN REST API.\n"
 | 
			
		||||
"						The connection string my be space-separated list of parameters:\n"
 | 
			
		||||
"	        	          		\"host=<ip-addr> dbname=<database-name> user=<database-user> \\\n							password=<database-user-password> port=<db-port> connect_timeout=<seconds> read_timeout=<seconds>\".\n\n"
 | 
			
		||||
"						The connection string parameters for the secure communications (SSL):\n"
 | 
			
		||||
@ -508,12 +508,12 @@ static char Usage[] = "Usage: turnserver [options]\n"
 | 
			
		||||
#if !defined(TURN_NO_MONGO)
 | 
			
		||||
" -J, --mongo-userdb	<connection-string>	MongoDB connection string, if used (default - empty, no MongoDB used).\n"
 | 
			
		||||
"	                                	This database can be used for long-term credentials mechanism users,\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN RESP API.\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN REST API.\n"
 | 
			
		||||
#endif
 | 
			
		||||
#if !defined(TURN_NO_HIREDIS)
 | 
			
		||||
" -N, --redis-userdb	<connection-string>	Redis user database connection string, if used (default - empty, no Redis DB used).\n"
 | 
			
		||||
"	                                	This database can be used for long-term credentials mechanism users,\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN RESP API.\n"
 | 
			
		||||
"		                                and it can store the secret value(s) for secret-based timed authentication in TURN REST API.\n"
 | 
			
		||||
"						The connection string my be space-separated list of parameters:\n"
 | 
			
		||||
"	        	          		\"host=<ip-addr> dbname=<db-number> \\\n								password=<database-user-password> port=<db-port> connect_timeout=<seconds>\".\n\n"
 | 
			
		||||
"	        	          		All connection-string parameters are optional.\n\n"
 | 
			
		||||
@ -661,7 +661,7 @@ static char AdminUsage[] = "Usage: turnadmin [command] [options]\n"
 | 
			
		||||
	"	-D, --delete-admin		delete an admin user\n"
 | 
			
		||||
	"	-l, --list			list all long-term mechanism users\n"
 | 
			
		||||
	"	-L, --list-admin		list all admin users\n"
 | 
			
		||||
	"	-s, --set-secret=<value>	Add shared secret for TURN RESP API\n"
 | 
			
		||||
	"	-s, --set-secret=<value>	Add shared secret for TURN REST API\n"
 | 
			
		||||
	"	-S, --show-secret		Show stored shared secrets for TURN REST API\n"
 | 
			
		||||
	"	-X, --delete-secret=<value>	Delete a shared secret\n"
 | 
			
		||||
	"	    --delete-all-secrets	Delete all shared secrets for REST API\n"
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user