<commit_before>SSH Over Local Network
======================

Under a production installation post-install, the default way to gain ssh
administrative access is over the tor network. This provides a number of benefits:

* Allows remote administration outside of the local network
* Provides anonymity to an administrator while logging into the SecureDrop
  back-end.
* Can mitigate against an attacker on your local network attempting to exploit
  vulnerabilities against the ssh daemon.

Most administrators will need ssh access during the course of running a
SecureDrop instance and a few times a year for maintanence. So the
potential short-falls of having ssh over tor aren't usually a big deal.
The cons of having ssh over tor can include:

* Really slow and delayed remote terminal performance
* Allowing ssh access from outside of your local network can be seen as a
  potential larger security hole for some organizations. Particularly those
  with tight network security controls.

That being said, the default setting of only allowing ssh over tor is a good fit
for most organizations. If you happen to require ssh restricted to the local
network instead please continue to read.


.. _ssh_over_local:

Configuring SSH for local access
--------------------------------

.. warning:: It is important that your firewall is configured adequately if you
          decide you need ssh over the local network. The install process locks
          down access as much as possible with net restrictions, ssh-keys, and
          google authenticator. However, you could still leave the interface
          exposed to unintended users if you did not properly follow our network
          firewall guide.

The setting that controls ssh over LAN access is set during the `sdconfig` step
of the install.

.. note:: Whichever network you install from will be the one that ssh is
          restricted to post-install. This will come into play particularly if
          you have multiple network interfaces.

The workflow for configuration will look like this (answer 'no' or 'false') to
the following :

.. code:: sh

    $ ./securedrop-admin sdconfig

    INFO: Configuring SecureDrop site-specific information
    [WARNING]: provided hosts list is empty, only localhost is available


    PLAY [Display message about upcoming interactive prompts.]
    ***********************************************************************

    TASK [debug]
    ***********************************************************************
    ok: [localhost] => {
        "msg": "You will need to fill out the following prompts in order to<commit_msg>Address documentation nits<commit_after>SSH Over Local Network
======================

Under a production installation post-install, the default way to gain SSH
administrative access is over the Tor network. This provides a number of benefits:

* Allows remote administration outside of the local network
* Provides anonymity to an administrator while logging into the SecureDrop
  back-end.
* Can mitigate against an attacker on your local network attempting to exploit
  vulnerabilities against the SSH daemon.

Most administrators will need SSH access during the course of running a
SecureDrop instance and a few times a year for maintanence. So the
potential short-falls of having SSH over Tor aren't usually a big deal.
The cons of having SSH over Tor can include:

* Really slow and delayed remote terminal performance
* Allowing SSH access from outside of your local network can be seen as a
  potential larger security hole for some organizations. Particularly those
  with tight network security controls.

That being said, the default setting of only allowing SSH over Tor is a good fit
for most organizations. If you happen to require SSH restricted to the local
network instead please continue to read.


.. _ssh_over_local:

Configuring SSH for local access
--------------------------------

.. warning:: It is important that your firewall is configured adequately if you
          decide you need SSH over the local network. The install process locks
          down access as much as possible with net restrictions, SSH-keys, and
          google authenticator. However, you could still leave the interface
          exposed to unintended users if you did not properly follow our network
          firewall guide.

The setting that controls SSH over LAN access is set during the `sdconfig` step
of the install.

.. note:: Whichever network you install from will be the one that SSH is
          restricted to post-install. This will come into play particularly if
          you have multiple network interfaces.

The workflow for configuration will look like this (answer 'no' or 'false') to
the following :

.. code:: sh

    $ ./securedrop-admin sdconfig

    INFO: Configuring SecureDrop site-specific information
    [WARNING]: provided hosts list is empty, only localhost is available


    PLAY [Display message about upcoming interactive prompts.]
    ***********************************************************************

    TASK [debug]
    ***********************************************************************
    ok: [localhost] => {
        "msg": "You will need to fill out the following prompts in order to
{'fraction_non_alphanumeric': 0.10674264007597341, 'fraction_numerical': 0.0, 'mean_word_length': 3.6643046944198407, 'pattern_counts': {'":': 2, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5871127', 'n_tokens_mistral': 1198, 'n_tokens_neox': 1093, 'n_words': 693}