|
|
@@ -1,5 +1,5 @@
|
|
|
.\" Text automatically generated by txt2man
|
|
|
-.TH TURN 1 "04 September 2016" "" ""
|
|
|
+.TH TURN 1 "06 September 2016" "" ""
|
|
|
.SH GENERAL INFORMATION
|
|
|
|
|
|
A set of turnutils_* programs provides some utility functionality to be used
|
|
|
@@ -48,7 +48,21 @@ $ ./scripts/secure_relay.sh
|
|
|
according RFC5780. This utility discovers the actual NAT Mapping and Filtering
|
|
|
behavior. Be aweare that at least two different listening IP addresses should
|
|
|
be configured to be able to work properly!
|
|
|
+.TP
|
|
|
+.B
|
|
|
+6.
|
|
|
+\fIturnutils_oauth\fP: a utility that provides OAuth access_token
|
|
|
+\fBgeneration\fP(AEAD encryption), validation and decryption. This utility inputs
|
|
|
+all the keys and lifetimes and any related informations that needed for
|
|
|
+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
|
|
|
+RFC7635 Appendix B, Figure 8.
|
|
|
+.PP
|
|
|
+For more details, and for the access_token structure, read rfc7635.
|
|
|
+.RE
|
|
|
.PP
|
|
|
+
|
|
|
+.RS
|
|
|
=====================================
|
|
|
.SS NAME
|
|
|
\fB
|
|
|
@@ -414,6 +428,109 @@ Usage:
|
|
|
.PP
|
|
|
$ \fIturnutils_natdiscovery\fP \fB\-m\fP \fB\-f\fP stun.example.com
|
|
|
.PP
|
|
|
+=====================================
|
|
|
+.SS NAME
|
|
|
+\fB
|
|
|
+\fBturnutils_oauth \fP\- a utility that helps OAuth access_token generation/encryption and validation/decyption
|
|
|
+\fB
|
|
|
+.SS SYNOPSIS
|
|
|
+.nf
|
|
|
+.fam C
|
|
|
+
|
|
|
+$ \fIturnutils_oauth\fP [\fIoptions\fP]
|
|
|
+
|
|
|
+.fam T
|
|
|
+.fi
|
|
|
+.fam T
|
|
|
+.fi
|
|
|
+.SS DESCRIPTION
|
|
|
+
|
|
|
+\fIturnutils_oauth\fP utilitiy provides help in OAuth access_token encryption and/or
|
|
|
+decryption with AEAD (Atuthenticated Encryption with Associated Data). It helps
|
|
|
+for an Auth Server in access_token creation, and also for debuging purposes it
|
|
|
+helps the access_token validation and decryption. This utility inputs all the
|
|
|
+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
|
|
|
+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
|
|
|
+structure, read rfc7635.
|
|
|
+.PP
|
|
|
+Use either \fB\-e\fP and/or \fB\-d\fP flag to encrypt or decrypt access_token.
|
|
|
+.PP
|
|
|
+Flags:
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-h\fP, \fB\-\-help\fP
|
|
|
+usage
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-v\fP, \fB\-\-verbose\fP
|
|
|
+verbose mode
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-e\fP, \fB\-\-encrypt\fP
|
|
|
+encrypt token
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-d\fP, \fB\-\-decrypt\fP
|
|
|
+decrypt validate token
|
|
|
+.PP
|
|
|
+Options with required values:
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-i\fP, \fB\-\-server\-name\fP
|
|
|
+server name (max. 255 char)
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-j\fP, \fB\-\-long\-term\-key\-id\fP
|
|
|
+long term key id (max. 32 char)
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-k\fP, \fB\-\-long\-term\-key\fP
|
|
|
+base64 encoded long term key
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-l\fP
|
|
|
+\fB\-\-long\-term\-key\-timestamp\fP long term key timestamp (sec since epoch)
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-m\fP, \fB\-\-long\-term\-key\-lifetime\fP
|
|
|
+long term key lifetime in sec
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-n\fP, \fB\-\-long\-term\-key\-as\-rs\-alg\fP
|
|
|
+Authorization Server Resource Server encryption algorithm
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-o\fP, \fB\-\-token\-nonce\fP
|
|
|
+base64 encoded nonce \fBbase64\fP(12 octet) = 16 char
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-p\fP, \fB\-\-token\-mac\-key\fP
|
|
|
+base64 encoded MAC key \fBbase64\fP(32 octet) = 44 char
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-q\fP, \fB\-\-token\-timestamp\fP
|
|
|
+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.
|
|
|
+An example: 16 bit left shift the unixtimestamp. (Default: actual gmtime)
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-r\fP, \fB\-\-token\-lifetime\fP
|
|
|
+lifetime in sec (Default: 3600)
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-t\fP, \fB\-\-token\fP
|
|
|
+base64 encoded encrypted token for validation and decryption
|
|
|
+.TP
|
|
|
+.B
|
|
|
+\fB\-u\fP, \fB\-\-hmac\-alg\fP
|
|
|
+stun client hmac algorithm
|
|
|
+.PP
|
|
|
+Usage:
|
|
|
+.PP
|
|
|
+$ \fIturnutils_natdiscovery\fP
|
|
|
+.PP
|
|
|
===================================
|
|
|
.SH DOCS
|
|
|
|
Mészáros Mihály