mirrors/coturn
1
0
Fork 0
mirror of https://github.com/coturn/coturn.git synced 2025-10-23 20:11:17 +02:00
Code Issues Projects Releases Wiki Activity

tidy

Browse Source
This commit is contained in:
Mészáros Mihály 2016-09-07 09:45:58 +02:00
parent 14754ce43b
commit d70d0353ec
5 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.turnutils
View File

@ -300,8 +300,11 @@ helps the access_token validation and decryption. This utility inputs all the
keys and lifetimes and any related informations that are needed for encryption keys and lifetimes and any related informations 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. For more details, and for the access_token RFC7635 Appendix B, Figure 8. This utility could help to build an Auth Server
structure, read rfc7635. 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".
For more details, and for the access_token structure, read rfc7635.
Use either -e and/or -d flag to encrypt or decrypt access_token. Use either -e and/or -d flag to encrypt or decrypt access_token.
@ -335,7 +338,7 @@ Options with required values:
-q, --token-timestamp timestamp in format 64 bit unsigned (Native format - Unix), -q, --token-timestamp timestamp in format 64 bit unsigned (Native format - Unix),
so 48 bit for secs since epoch UTC + 16 bit for 1/64000 fractions of a second. so 48 bit for secs since epoch UTC + 16 bit for 1/64000 fractions of a second.
An example: 16 bit left shift the unixtimestamp. (Default: actual gmtime) e.g.: the actual unixtimestamp 16 bit left shifted. (Default: actual gmtime)
-r, --token-lifetime lifetime in sec (Default: 3600) -r, --token-lifetime lifetime in sec (Default: 3600)
-t, --token base64 encoded encrypted token for validation and decryption -t, --token base64 encoded encrypted token for validation and decryption

2
man/man1/turnadmin.1
View File

@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man .\" Text automatically generated by txt2man
.TH TURN 1 "06 September 2016" "" "" .TH TURN 1 "07 September 2016" "" ""
.SH GENERAL INFORMATION .SH GENERAL INFORMATION
\fIturnadmin\fP is a TURN administration tool. This tool can be used to manage \fIturnadmin\fP is a TURN administration tool. This tool can be used to manage

2
man/man1/turnserver.1
View File

@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man .\" Text automatically generated by txt2man
.TH TURN 1 "06 September 2016" "" "" .TH TURN 1 "07 September 2016" "" ""
.SH GENERAL INFORMATION .SH GENERAL INFORMATION
The \fBTURN Server\fP project contains the source code of a TURN server and TURN client The \fBTURN Server\fP project contains the source code of a TURN server and TURN client

11
man/man1/turnutils.1
View File

@ -1,5 +1,5 @@
.\" Text automatically generated by txt2man .\" Text automatically generated by txt2man
.TH TURN 1 "06 September 2016" "" "" .TH TURN 1 "07 September 2016" "" ""
.SH GENERAL INFORMATION .SH GENERAL INFORMATION
A set of turnutils_* programs provides some utility functionality to be used A set of turnutils_* programs provides some utility functionality to be used
@ -452,8 +452,11 @@ helps the access_token validation and decryption. This utility inputs all the
keys and lifetimes and any related informations that are needed for encryption keys and lifetimes and any related informations 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. For more details, and for the access_token RFC7635 Appendix B, Figure 8. This utility could help to build an Auth Server
structure, read rfc7635. 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".
.PP
For more details, and for the access_token structure, read rfc7635.
.PP .PP
Use either \fB\-e\fP and/or \fB\-d\fP flag to encrypt or decrypt access_token. Use either \fB\-e\fP and/or \fB\-d\fP flag to encrypt or decrypt access_token.
.PP .PP
@ -513,7 +516,7 @@ base64 encoded MAC key \fBbase64\fP(32 octet) = 44 char
\fB\-q\fP, \fB\-\-token\-timestamp\fP \fB\-q\fP, \fB\-\-token\-timestamp\fP
timestamp in format 64 bit unsigned (Native format \- Unix), timestamp in format 64 bit unsigned (Native format \- Unix),
so 48 bit for secs since epoch UTC + 16 bit for 1/64000 fractions of a second. so 48 bit for secs since epoch UTC + 16 bit for 1/64000 fractions of a second.
An example: 16 bit left shift the unixtimestamp. (Default: actual gmtime) e.g.: the actual unixtimestamp 16 bit left shifted. (Default: actual gmtime)
.TP .TP
.B .B
\fB\-r\fP, \fB\-\-token\-lifetime\fP \fB\-r\fP, \fB\-\-token\-lifetime\fP

4
src/apps/oauth/oauth.c
View File

@ -194,7 +194,7 @@ const char Usage[] =
" -p, --token-mac-key base64 encoded MAC key base64(32 octet) = 44 char\n" " -p, --token-mac-key base64 encoded MAC key base64(32 octet) = 44 char\n"
" -q, --token-timestamp timestamp in format 64 bit unsigned (Native format - Unix),\n" " -q, --token-timestamp timestamp in format 64 bit unsigned (Native format - Unix),\n"
" so 48 bit for secs since epoch UTC + 16 bit for 1/64000 fractions of a second.\n" " so 48 bit for secs since epoch UTC + 16 bit for 1/64000 fractions of a second.\n"
" An example: 16 bit left shift the unixtimestamp. (Default: actual gmtime)\n" " e.g.: the actual unixtimestamp 16 bit left shifted. (Default: actual gmtime)\n"
" -r, --token-lifetime lifetime in sec (Default: 3600)\n" " -r, --token-lifetime lifetime in sec (Default: 3600)\n"
" -t, --token base64 encoded encrypted token for validation and decryption\n" " -t, --token base64 encoded encrypted token for validation and decryption\n"
" -u, --hmac-alg stun client hmac algorithm\n"; " -u, --hmac-alg stun client hmac algorithm\n";
@ -390,7 +390,7 @@ int main(int argc, char **argv)
} }
if (!(encrypt_flag || decrypt_flag)){ if (!(encrypt_flag || decrypt_flag)){
fprintf(stderr, "Hey, encrypt or decrypt?\nPlease use -h or --help for the detailed help\n"); fprintf(stderr, "Use either encrypt or decrypt.\nPlease use -h or --help for the detailed help\n");
exit(-1); exit(-1);
} }