Browse Source

Add new feature to README.turnadmin

Mészáros Mihály 7 years ago
parent
commit
1657dc183f
4 changed files with 55 additions and 4 deletions
  1. 19 1
      README.turnadmin
  2. 34 1
      man/man1/turnadmin.1
  3. 1 1
      man/man1/turnserver.1
  4. 1 1
      man/man1/turnutils.1

+ 19 - 1
README.turnadmin

@@ -86,6 +86,8 @@ Only sha256 is supported as the hash function.
 -g, --set-realm-option		Set realm params: max-bps, total-quota, user-quota.
 
 -G, --list-realm-options	List realm params.
+-E, --generate-encrypted-password-aes	Generate and print to the standard output 
+					an encrypted form of password with AES-128
   
 Options with required values:  
 
@@ -103,6 +105,9 @@ Options with required values:
 -u, --user		User name.
 -r, --realm		Realm.
 -p, --password		Password.
+-x, --key-path		Generates a 128 bit key into the given path.
+-f, --file-key-path	Contains a 128 bit key in the given path.
+-v, --verify		Verify a given base64 encrypted type password.
 -o, --origin		Origin
 --max-bps		Set value of realm's max-bps parameter.
 --total-quota	Set value of realm's total-quota parameter.
@@ -158,7 +163,20 @@ $ turnadmin --redis-userdb="<db-connection-string>" -I
 List the origin-to-realm relations in PostgreSQL DB for a single realm:
 
 $ turnadmin --psql-userdb="<db-connection-string>" -I -r <realm>
-  
+
+Create new key file for mysql password encryption:
+
+$ turnadmin -E --key-path <key-file>
+
+Create encrypted mysql password:
+
+$ turnadmin -E --file-key-path <key-file> -p <secret>
+
+Verify/decrypt encrypted password:
+
+$ turnadmin --file-key-path <key-file> -v <encrypted>
+
+   
 Help:  
 
 $ turnadmin -h

+ 34 - 1
man/man1/turnadmin.1

@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH TURN 1 "11 December 2017" "" ""
+.TH TURN 1 "15 August 2018" "" ""
 .SH GENERAL INFORMATION
 
 \fIturnadmin\fP is a TURN administration tool. This tool can be used to manage 
@@ -139,6 +139,11 @@ Set realm params: max\-bps, total\-quota, user\-quota.
 List realm params.
 .TP
 .B
+\fB\-E\fP, \fB\-\-generate\-encrypted\-password\-aes\fP
+Generate and print to the standard output 
+an encrypted form of password with AES\-128
+.TP
+.B
 Options with required values:
 .TP
 .B
@@ -180,6 +185,18 @@ Realm.
 Password.
 .TP
 .B
+\fB\-x\fP, \fB\-\-key\-path\fP
+Generates a 128 bit key into the given path.
+.TP
+.B
+\fB\-f\fP, \fB\-\-file\-key\-path\fP
+Contains a 128 bit key in the given path.
+.TP
+.B
+\fB\-v\fP, \fB\-\-verify\fP
+Verify a given base64 encrypted type password.
+.TP
+.B
 \fB\-o\fP, \fB\-\-origin\fP
 Origin
 .TP
@@ -249,6 +266,22 @@ $ \fIturnadmin\fP \fB\-\-redis\-userdb\fP="<db\-connection\-string>" \fB\-I\fP
 List the origin\-to\-realm relations in PostgreSQL DB for a single realm:
 .PP
 $ \fIturnadmin\fP \fB\-\-psql\-userdb\fP="<db\-connection\-string>" \fB\-I\fP \fB\-r\fP <realm>
+.PP
+Create new key file for mysql password encryption:
+.PP
+$ \fIturnadmin\fP \fB\-E\fP \fB\-\-key\-path\fP <key\-file>
+.PP
+Create encrypted mysql password:
+.PP
+$ \fIturnadmin\fP \fB\-E\fP \fB\-\-file\-key\-path\fP <key\-file> \fB\-p\fP <secret>
+.PP
+Verify/decrypt encrypted password:
+.PP
+$ \fIturnadmin\fP \fB\-\-file\-key\-path\fP <key\-file> \fB\-v\fP <encrypted>
+.RE
+.PP
+
+.RS
 .TP
 .B
 Help:

+ 1 - 1
man/man1/turnserver.1

@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH TURN 1 "11 December 2017" "" ""
+.TH TURN 1 "15 August 2018" "" ""
 .SH GENERAL INFORMATION
 
 The \fBTURN Server\fP project contains the source code of a TURN server and TURN client 

+ 1 - 1
man/man1/turnutils.1

@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH TURN 1 "11 December 2017" "" ""
+.TH TURN 1 "15 August 2018" "" ""
 .SH GENERAL INFORMATION
 
 A set of turnutils_* programs provides some utility functionality to be used