~ubuntu-branches/ubuntu/oneiric/oss4/oneiric-proposed

« back to all changes in this revision

Viewing changes to cmd/osspartysh/osspartysh.man

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Rivera
  • Date: 2011-06-16 20:37:48 UTC
  • mfrom: (5.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110616203748-jbrxik6ql33z54co
Tags: 4.2-build2004-1ubuntu1
* Merge from Debian unstable.
  - Supports our current kernel (LP: #746048)
  Remaining changes:
  - debian/oss4-dkms.dkms.in: s/source/build/ in Kernel headers paths.
* ld-as-needed.patch: Re-order CC arguments to enable building with ld
  --as-needed (LP: #770972)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
NAME
 
2
osspartysh - reverse "telnet" utility for OSs technical support 
 
3
 
 
4
SYNOPSIS
 
5
osspartysh -d -p <port>  (by the support engineer)
 
6
osspartysh -h <support_host> -p <support_port>  (by the customer)
 
7
 
 
8
DESCRIPTION
 
9
 
 
10
The osspartysh is an utility that makes it possible to a remote suport
 
11
engineer to share the session with a customer. The session runs in customer's
 
12
computer but both the customer and the support engineer can type comands
 
13
and see the output. It is possible to run commands like vi to edit files.
 
14
 
 
15
There is limited chat mechanism based on the comments of the shell (bash)
 
16
command language. Both peers can send messages by typing the comment character
 
17
(#) in the beginning of the line.
 
18
 
 
19
SECURITY
 
20
 
 
21
The osspartysh sessions are established in reverse way when compared to usual 
 
22
remote terminal programs like ssh or telnet. This gives improved security
 
23
for both sides. The actual internet connection is not crypted so it
 
24
cannot be used for editing confidential files, etc. However there is no need to
 
25
send passwords over internet since the protocol doesn't rely on them.
 
26
 
 
27
 SECURITY FOR THE CUSTOMER
 
28
 
 
29
There is no need to open any incoming TCP ports in the firewall or NAT. In 
 
30
addition there is no need to reset any passwords to give the support engineer an
 
31
access to the system. In addition the customer can see whatever commands are
 
32
typed and there is good time to hit ^C or ^Z to abort the commands.
 
33
 
 
34
Connections opened to the remote terminal server are verified to ensure that
 
35
using wrong port number doesn't feed invalid commands to the local shell.
 
36
Otherwise it would be possible that connecting to a wrong port (say http 
 
37
server) sends bad strings to the command interpreter (bash).
 
38
 
 
39
 SECURITY FOR THE SUPPORT ENGINEER
 
40
 
 
41
The system used as the support terminal needs to have the TCP port opened in
 
42
the firewall and NAT settings. However this doesn't cause any security risks.
 
43
If a possible attacker manages to connect to this port then all he can do is
 
44
sending characters that are (only) shown on the terminal screen.
 
45
 
 
46
OPTIONS
 
47
-d              Launch the utility in terminal server mode (by default
 
48
                connect to a remote terminal.
 
49
-h <host>       Give the IP address or host name of the remote terminal
 
50
                server.
 
51
-p <port>       Give the TCP port to use. Must be the same in both sides.
 
52
 
 
53
KNOWN BUGS
 
54
 
 
55
o       Sometimes it's necessary to hit ^L after running vi or some other
 
56
        curses based program. Without this the keyboard will be locked and
 
57
        typed characters will not be shown on the screen
 
58
o       When the session is ended (by typing ^D or exit) the terminal (support)
 
59
        side will be hanging until enter is hit twice. After this the
 
60
        terminal server will be ready for a new connection by any client. It is
 
61
        also possible to stop the terminal server by hitting ^C.
 
62
 
 
63
AUTHOR
 
64
4Front Technologies