Skip to content

Commit 7ff9b88

Browse files
manfred-kaisermanfred-kaiser
committed
merged install and quickstart
1 parent 75fb932 commit 7ff9b88

File tree

4 files changed

+67
-54
lines changed

4 files changed

+67
-54
lines changed

‎doc/conf.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@
6161
html_static_path = ['_static']
6262

6363
redirects = {
64-
"puttydos": "CVE-2021-33500.html"
64+
"puttydos": "CVE-2021-33500.html",
65+
"install": "quickstart.html"
6566
}
6667

6768
header = {

‎doc/index.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ SSH-MITM Docs - Main Page
55
:maxdepth: 2
66
:caption: Contents:
77

8-
install
98
quickstart
109
advanced-usage
1110
portforwarding

‎doc/install.rst‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

‎doc/quickstart.rst‎

Lines changed: 65 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,76 @@
11
Quickstart
22
==========
33

4-
Eager to get started? This page gives a good introduction in how to get started with SSH-MITM.
4+
Introduction
5+
------------
56

6-
First, make sure that:
7+
**SSH-MITM** is a man in the middle SSH Server for security audits and malware analysis.
78

8-
* SSH-MITM is :ref:`installed <Installation>`
9-
* SSH-MITM is up-to-date
9+
Password and publickey authentication are supported and SSH-MITM is able to detect, if a user is able to
10+
login with publickey authentication on the remote server. This allows SSH-MITM to acccept the same key as
11+
the destination server. If publickey authentication is not possible, the authentication will fall
12+
back to password-authentication.
13+
14+
When publickey authentication is possible, a forwarded agent is needed to login to the remote server.
15+
In cases, when no agent was forwarded, SSH-MITM can rediredt the session to a honeypot.
16+
17+
.. raw:: html
18+
19+
<p align="center">
20+
<a href="https://www.ssh-mitm.at/img/ssh-mitm-password.png">
21+
<img alt="SSH-MITM intercepting password login" title="SSH-MITM" src="https://www.ssh-mitm.at/img/ssh-mitm-password.png" width="650" >
22+
</a>
23+
<p align="center">ssh man-in-the-middle (ssh-mitm) server for security audits supporting<br> <b>publickey authentication</b>, <b>session hijacking</b> and <b>file manipulation</b></p>
24+
<p align="center">
25+
<a href="https://snapcraft.io/ssh-mitm">
26+
<img alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" />
27+
</a>
28+
<br />
29+
<br />
30+
31+
</p>
32+
</p>
33+
34+
Installation
35+
------------
36+
37+
This part of the documentation covers the installation of SSH-MITM.
38+
The first step to using any software package is getting it properly installed.
39+
40+
To install SSH-MITM, simply run one of those commands in your terminal of choice:
41+
42+
Install as snap
43+
"""""""""""""""
44+
45+
.. code-block:: bash
46+
47+
sudo snap install ssh-mitm
1048
11-
Let’s get started with some simple examples.
1249
50+
Install with pip
51+
""""""""""""""""
52+
53+
.. code-block:: bash
54+
55+
$ python -m pip install ssh-mitm
1356
1457
Start ssh-mitm proxy server
1558
---------------------------
1659

60+
Let’s get started with some simple examples.
61+
1762
Starting an intercepting mitm-ssh server with password authentication is very simple.
1863

1964
All you have to do is run this command in your terminal of choice.
2065

2166
.. code-block:: bash
22-
:linenos:
2367
2468
$ ssh-mitm --remote-host 192.168.0.x
2569
2670
Now let's try to connect to the ssh-mitm server.
2771
The ssh-mitm server is listening on port 10022.
2872

2973
.. code-block:: bash
30-
:linenos:
3174
3275
$ ssh -p 10022 user@proxyserver
3376
@@ -61,7 +104,6 @@ This server is used to hijack the session.
61104
To hijack the session, you can use your favorite ssh client. This connection does not require authentication.
62105

63106
.. code-block:: bash
64-
:linenos:
65107
66108
$ ssh -p 34463 127.0.0.1
67109
@@ -70,3 +112,18 @@ After you are connected, your session will only be updated with new responses, b
70112
Try to execute somme commands in the hijacked session or in the original session.
71113

72114
The output will be shown in both sessions.
115+
116+
117+
Publickey authentication
118+
------------------------
119+
120+
SSH-MITM is able to verify, if a user is able to login with publickey authentication on the remote server.
121+
If publickey authentication is not possible, SSH-MITM falls back to password authentication.
122+
This step does not require a forwarded agent.
123+
124+
For a full login on the remote server agent forwarding is still required. When no agent was forwarded,
125+
SSH-MITM can redirect the connection to a honeypot.
126+
127+
.. code-block:: bash
128+
129+
ssh-mitm --fallback-host username:password@hostname:port

0 commit comments

Comments
 (0)