README.*: Strip trailing spaces
This commit is contained in:
parent
4722697645
commit
fa3f2797c2
@ -1,51 +1,51 @@
|
|||||||
GENERAL INFORMATION
|
GENERAL INFORMATION
|
||||||
|
|
||||||
turnadmin is a TURN administration tool. This tool can be used to manage
|
turnadmin is a TURN administration tool. This tool can be used to manage
|
||||||
the user accounts (add/remove users, generate
|
the user accounts (add/remove users, generate
|
||||||
TURN keys for the users). For security reasons, we do not recommend
|
TURN keys for the users). For security reasons, we do not recommend
|
||||||
storing passwords openly. The better option is to use pre-processed "keys"
|
storing passwords openly. The better option is to use pre-processed "keys"
|
||||||
which are then used for authentication. These keys are generated by turnadmin.
|
which are then used for authentication. These keys are generated by turnadmin.
|
||||||
Turnadmin is a link to turnserver binary, but turnadmin performs different
|
Turnadmin is a link to turnserver binary, but turnadmin performs different
|
||||||
functions.
|
functions.
|
||||||
|
|
||||||
Options note: turnadmin has long and short option names, for most options.
|
Options note: turnadmin has long and short option names, for most options.
|
||||||
Some options have only long form, some options have only short form. Their syntax
|
Some options have only long form, some options have only short form. Their syntax
|
||||||
somewhat different, if an argument is required:
|
somewhat different, if an argument is required:
|
||||||
|
|
||||||
The short form must be used as this (for example):
|
The short form must be used as this (for example):
|
||||||
|
|
||||||
$ turnadmin -u <username> ...
|
$ turnadmin -u <username> ...
|
||||||
|
|
||||||
The long form equivalent must use the "=" character:
|
The long form equivalent must use the "=" character:
|
||||||
|
|
||||||
$ turnadmin --user=<username> ...
|
$ turnadmin --user=<username> ...
|
||||||
|
|
||||||
If this is a flag option (no argument required) then their usage are the same, for example:
|
If this is a flag option (no argument required) then their usage are the same, for example:
|
||||||
|
|
||||||
$ turnadmin -k ...
|
$ turnadmin -k ...
|
||||||
|
|
||||||
is equivalent to:
|
is equivalent to:
|
||||||
|
|
||||||
$ turnadmin --key ...
|
$ turnadmin --key ...
|
||||||
|
|
||||||
You have always the use the -r <realm> option with commands for long term credentials -
|
You have always the use the -r <realm> option with commands for long term credentials -
|
||||||
because data for multiple realms can be stored in the same database.
|
because data for multiple realms can be stored in the same database.
|
||||||
|
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
|
|
||||||
turnadmin - a TURN relay administration tool.
|
turnadmin - a TURN relay administration tool.
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
|
|
||||||
$ turnadmin [command] [options]
|
$ turnadmin [command] [options]
|
||||||
|
|
||||||
$ turnadmin [ -h | --help]
|
$ turnadmin [ -h | --help]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
|
|
||||||
-P, --generate-encrypted-password Generate and print to the standard
|
-P, --generate-encrypted-password Generate and print to the standard
|
||||||
output an encrypted form of a password (for web admin user or CLI).
|
output an encrypted form of a password (for web admin user or CLI).
|
||||||
@ -76,7 +76,7 @@ Only sha256 is supported as the hash function.
|
|||||||
|
|
||||||
-X, --delete-secret=<value> Delete a shared secret.
|
-X, --delete-secret=<value> Delete a shared secret.
|
||||||
--delete-all_secrets Delete all shared secrets for REST API.
|
--delete-all_secrets Delete all shared secrets for REST API.
|
||||||
|
|
||||||
-O, --add-origin Add origin-to-realm relation.
|
-O, --add-origin Add origin-to-realm relation.
|
||||||
|
|
||||||
-R, --del-origin Delete origin-to-realm relation.
|
-R, --del-origin Delete origin-to-realm relation.
|
||||||
@ -86,10 +86,10 @@ Only sha256 is supported as the hash function.
|
|||||||
-g, --set-realm-option Set realm params: max-bps, total-quota, user-quota.
|
-g, --set-realm-option Set realm params: max-bps, total-quota, user-quota.
|
||||||
|
|
||||||
-G, --list-realm-options List realm params.
|
-G, --list-realm-options List realm params.
|
||||||
-E, --generate-encrypted-password-aes Generate and print to the standard output
|
-E, --generate-encrypted-password-aes Generate and print to the standard output
|
||||||
an encrypted form of password with AES-128
|
an encrypted form of password with AES-128
|
||||||
|
|
||||||
Options with required values:
|
Options with required values:
|
||||||
|
|
||||||
-b, --db, --userdb SQLite user database file name (default - /var/db/turndb or
|
-b, --db, --userdb SQLite user database file name (default - /var/db/turndb or
|
||||||
/usr/local/var/db/turndb or /var/lib/turn/turndb).
|
/usr/local/var/db/turndb or /var/lib/turn/turndb).
|
||||||
@ -111,10 +111,10 @@ Options with required values:
|
|||||||
-o, --origin Origin
|
-o, --origin Origin
|
||||||
--max-bps Set value of realm's max-bps parameter.
|
--max-bps Set value of realm's max-bps parameter.
|
||||||
--total-quota Set value of realm's total-quota parameter.
|
--total-quota Set value of realm's total-quota parameter.
|
||||||
--user-quota Set value of realm's user-quota parameter.
|
--user-quota Set value of realm's user-quota parameter.
|
||||||
-h, --help Help.
|
-h, --help Help.
|
||||||
|
|
||||||
Command examples:
|
Command examples:
|
||||||
|
|
||||||
Generate an encrypted form of a password:
|
Generate an encrypted form of a password:
|
||||||
|
|
||||||
@ -123,11 +123,11 @@ $ turnadmin -P -p <password>
|
|||||||
Generate a key:
|
Generate a key:
|
||||||
|
|
||||||
$ turnadmin -k -u <username> -r <realm> -p <password>
|
$ turnadmin -k -u <username> -r <realm> -p <password>
|
||||||
|
|
||||||
Add/update a user in the in the database:
|
Add/update a user in the in the database:
|
||||||
|
|
||||||
$ turnadmin -a [-b <userdb-file> | -e <db-connection-string> | -M <db-connection-string> | -N <db-connection-string> ] -u <username> -r <realm> -p <password>
|
$ turnadmin -a [-b <userdb-file> | -e <db-connection-string> | -M <db-connection-string> | -N <db-connection-string> ] -u <username> -r <realm> -p <password>
|
||||||
|
|
||||||
Delete a user from the database:
|
Delete a user from the database:
|
||||||
|
|
||||||
$ turnadmin -d [-b <userdb-file> | -e <db-connection-string> | -M <db-connection-string> | -N <db-connection-string> ] -u <username> -r <realm>
|
$ turnadmin -d [-b <userdb-file> | -e <db-connection-string> | -M <db-connection-string> | -N <db-connection-string> ] -u <username> -r <realm>
|
||||||
@ -176,13 +176,13 @@ Verify/decrypt encrypted password:
|
|||||||
|
|
||||||
$ turnadmin --file-key-path <key-file> -v <encrypted>
|
$ turnadmin --file-key-path <key-file> -v <encrypted>
|
||||||
|
|
||||||
|
|
||||||
Help:
|
Help:
|
||||||
|
|
||||||
$ turnadmin -h
|
$ turnadmin -h
|
||||||
|
|
||||||
=======================================
|
=======================================
|
||||||
|
|
||||||
DOCS
|
DOCS
|
||||||
|
|
||||||
After installation, run the command:
|
After installation, run the command:
|
||||||
@ -258,13 +258,13 @@ to see the man page.
|
|||||||
Erik Johnston <erikj@openmarket.com>
|
Erik Johnston <erikj@openmarket.com>
|
||||||
|
|
||||||
Roman Lisagor <roman@demonware.net>
|
Roman Lisagor <roman@demonware.net>
|
||||||
|
|
||||||
Vladimir Tsanev <tsachev@gmail.com>
|
Vladimir Tsanev <tsachev@gmail.com>
|
||||||
|
|
||||||
Po-sheng Lin <personlin118@gmail.com>
|
Po-sheng Lin <personlin118@gmail.com>
|
||||||
|
|
||||||
Peter Dunkley <peter.dunkley@acision.com>
|
Peter Dunkley <peter.dunkley@acision.com>
|
||||||
|
|
||||||
Mutsutoshi Yoshimoto <mutsutoshi.yoshimoto@mixi.co.jp>
|
Mutsutoshi Yoshimoto <mutsutoshi.yoshimoto@mixi.co.jp>
|
||||||
|
|
||||||
Federico Pinna <fpinna@vivocha.com>
|
Federico Pinna <fpinna@vivocha.com>
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -37,12 +37,12 @@ according RFC5780. This utility discovers the actual NAT Mapping and Filtering
|
|||||||
behavior, etc. Be aware that on TURN server side two different listening IP
|
behavior, etc. Be aware that on TURN server side two different listening IP
|
||||||
addresses should be configured to be able to work properly!
|
addresses should be configured to be able to work properly!
|
||||||
|
|
||||||
6. turnutils_oauth: a utility that provides OAuth access_token
|
6. turnutils_oauth: a utility that provides OAuth access_token
|
||||||
generation(AEAD encryption), validation and decryption. This utility inputs
|
generation(AEAD encryption), validation and decryption. This utility inputs
|
||||||
all the keys and lifetimes and any related information that needed for
|
all the keys and lifetimes and any related information that needed for
|
||||||
creation and validationi of an access_token. It outputs a JSON with all OAuth
|
creation and validationi of an access_token. It outputs a JSON with all OAuth
|
||||||
PoP parameters that need to pass to the client. Output is generated accoriding
|
PoP parameters that need to pass to the client. Output is generated accoriding
|
||||||
RFC7635 Appendix B, Figure 8.
|
RFC7635 Appendix B, Figure 8.
|
||||||
|
|
||||||
For more details, and for the access_token structure, read rfc7635, and see
|
For more details, and for the access_token structure, read rfc7635, and see
|
||||||
script in examples/scripts/oauth.sh.
|
script in examples/scripts/oauth.sh.
|
||||||
@ -312,15 +312,15 @@ $ turnutils_oauth [options]
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
|
|
||||||
turnutils_oauth utilitiy provides help in OAuth access_token encryption and/or
|
turnutils_oauth utilitiy provides help in OAuth access_token encryption and/or
|
||||||
decryption with AEAD (Atuthenticated Encryption with Associated Data). It helps
|
decryption with AEAD (Atuthenticated Encryption with Associated Data). It helps
|
||||||
for an Auth Server in access_token creation, and also for debugging purposes it
|
for an Auth Server in access_token creation, and also for debugging purposes it
|
||||||
helps the access_token validation and decryption. This utility inputs all the
|
helps the access_token validation and decryption. This utility inputs all the
|
||||||
keys and lifetimes and any related information that are needed for encryption
|
keys and lifetimes and any related information that are needed for encryption
|
||||||
or decryption of an access_token. It outputs a JSON with all OAuth PoP
|
or decryption of an access_token. It outputs a JSON with all OAuth PoP
|
||||||
parameters that need to pass to the client. Output is generated accoriding
|
parameters that need to pass to the client. Output is generated accoriding
|
||||||
RFC7635 Appendix B, Figure 8. This utility could help to build an Auth Server
|
RFC7635 Appendix B, Figure 8. This utility could help to build an Auth Server
|
||||||
service, but be awere that this utility does not generate "session key" /
|
service, but be awere that this utility does not generate "session key" /
|
||||||
"mac_key" and not verifies lifetime of "session key" / "mac_key" or "Auth key".
|
"mac_key" and not verifies lifetime of "session key" / "mac_key" or "Auth key".
|
||||||
For more details, and for the access_token structure, read rfc7635, and see
|
For more details, and for the access_token structure, read rfc7635, and see
|
||||||
the example in examples/scripts/oauth.sh.
|
the example in examples/scripts/oauth.sh.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user