Addition to README and manuals regarding USB/IP with SSL.
Signed-off-by: Nobuo Iwata <nobuo.iw...@fujixerox.co.jp>
---
tools/usb/usbip/README | 13 ++++++++++++-
tools/usb/usbip/doc/usbip.8 | 38 +++++++++++++++++++++++++++++++++++---
tools/usb/usbip/doc/usbipa.8 | 34 ++++++++++++++++++++++++++++++----
tools/usb/usbip/doc/usbipd.8 | 34 ++++++++++++++++++++++++++++++----
4 files changed, 107 insertions(+), 12 deletions(-)
diff --git a/tools/usb/usbip/README b/tools/usb/usbip/README
index 6b61da5..126b1f0 100644
--- a/tools/usb/usbip/README
+++ b/tools/usb/usbip/README
@@ -24,15 +24,21 @@
- hwdata
Contains USB device identification data.
+ - openssl
+ OpenSSL library
[Install]
0. Generate configuration scripts.
$ ./autogen.sh
1. Compile & install the userspace utilities.
- $ ./configure [--with-tcp-wrappers=no] [--with-usbids-dir=<dir>]
+ $ ./configure [--with-tcp-wrappers=<yes|no>] [--with-usbids-dir=<dir>] \
+ [--with-ssl=<yes|no>]
$ make install
+ Defaults of --with-tcp-wrappers and --with-ssl depend library.
+ It assumed as 'yes' when depending library is available otherwise 'no'.
+
2. Compile & install USB/IP drivers.
@@ -120,6 +126,11 @@ In usage shown above, once USB devices are imported or
exported, USP/IP drivers
- Stops transission, quits connect command and disconnect device.
+[Secure Transmission]
+
+When --with-ssl=yes is specified for ./configure and --ssl option is specified
for usbipa, usbipd and usbip, SSL is applied for userspace transmission. PEM
format private key and certificate file are used. Check help for detail of
options and default.
+
+
[Example]
---------------------------
DEVICE SIDE
diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8
index dfaabba..9ae4867 100644
--- a/tools/usb/usbip/doc/usbip.8
+++ b/tools/usb/usbip/doc/usbip.8
@@ -15,23 +15,55 @@ lists devices importable from a remote computer, attaches a
remote device and de
.SH OPTIONS
.HP
-\fB\-\-debug\fR
+\fB\-d\fR, \fB\-\-debug\fR
.IP
Print debugging information.
.PP
.HP
-\fB\-\-log\fR
+\fB\-l\fR, \fB\-\-log\fR
.IP
Log to syslog.
.PP
.HP
-\fB\-\-tcp-port PORT\fR
+\fB\-t\fR, \fB\-\-tcp-port PORT\fR
.IP
TCP port number used by remote usbip daemon. Default is 3240.
.PP
+Following options are available if SSL has been enabled on build. It can be
checked by help.
+
+.HP
+\fB\-s\fR, \fB\-\-ssl\fR
+.IP
+Use SSL.
+.PP
+
+.HP
+\fB\-kKEY-FILE\fR, \fB\-\-key KEY-FILE\fR
+.IP
+Private key file. Default is cert/client.key.
+.PP
+
+.HP
+\fB\-cCERT-FILE\fR, \fB\-\-cert CERT-FILE\fR
+.IP
+Certificate file. Default is cert/client.crt.
+.PP
+
+.HP
+\fB\-rROOT-CERT-FILE\fR, \fB\-\-root ROOT-CERT-FILE\fR
+.IP
+Trusted CA file. Default is none.
+.PP
+
+.HP
+\fB\-VVERIFICATION-MODE\fR, \fB\-\-verification VERIFICATION-MODE\fR
+.IP
+Verification mode: none(default) or once.
+.PP
+
.SH COMMANDS
.HP
\fBversion\fR
diff --git a/tools/usb/usbip/doc/usbipa.8 b/tools/usb/usbip/doc/usbipa.8
index 54fca78..76d60c1 100644
--- a/tools/usb/usbip/doc/usbipa.8
+++ b/tools/usb/usbip/doc/usbipa.8
@@ -58,11 +58,37 @@ Print the program help message and exit.
Show version.
.PP
-.SH LIMITATIONS
+Following options are available if SSL has been enabled on build. It can be
checked by help.
-.B usbipa
-offers no authentication or authorization for USB/IP. Any
-USB/IP client can connect and use exported devices.
+.HP
+\fB\-s\fR, \fB\-\-ssl\fR
+.IP
+Use SSL.
+.PP
+
+.HP
+\fB\-kKEY-FILE\fR, \fB\-\-key KEY-FILE\fR
+.IP
+Private key file. Default is cert/server.key.
+.PP
+
+.HP
+\fB\-cCERT-FILE\fR, \fB\-\-cert CERT-FILE\fR
+.IP
+Certificate file. Default is cert/server.crt.
+.PP
+
+.HP
+\fB\-rROOT-CERT-FILE\fR, \fB\-\-root ROOT-CERT-FILE\fR
+.IP
+Trusted CA file. Default is none.
+.PP
+
+.HP
+\fB\-VVERIFICATION-MODE\fR, \fB\-\-verification VERIFICATION-MODE\fR
+.IP
+Verification mode: none(default), relaxed, strict or once.
+.PP
.SH EXAMPLES
diff --git a/tools/usb/usbip/doc/usbipd.8 b/tools/usb/usbip/doc/usbipd.8
index c3fa023..3bc40c7 100644
--- a/tools/usb/usbip/doc/usbipd.8
+++ b/tools/usb/usbip/doc/usbipd.8
@@ -60,11 +60,37 @@ Print the program help message and exit.
Show version.
.PP
-.SH LIMITATIONS
+Following options are available if SSL has been enabled on build. It can be
checked by help.
-.B usbipd
-offers no authentication or authorization for USB/IP. Any
-USB/IP client can connect and use exported devices.
+.HP
+\fB\-s\fR, \fB\-\-ssl\fR
+.IP
+Use SSL.
+.PP
+
+.HP
+\fB\-kKEY-FILE\fR, \fB\-\-key KEY-FILE\fR
+.IP
+Private key file. Default is cert/server.key.
+.PP
+
+.HP
+\fB\-cCERT-FILE\fR, \fB\-\-cert CERT-FILE\fR
+.IP
+Certificate file. Default is cert/server.crt.
+.PP
+
+.HP
+\fB\-rROOT-CERT-FILE\fR, \fB\-\-root ROOT-CERT-FILE\fR
+.IP
+Trusted CA file. Default is none.
+.PP
+
+.HP
+\fB\-VVERIFICATION-MODE\fR, \fB\-\-verification VERIFICATION-MODE\fR
+.IP
+Verification mode: none(default), relaxed, strict or once.
+.PP
.SH EXAMPLES
--
2.1.0
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
