:orphan:

.. index:: pair: struct; tapi_ssh_server_opt
.. _doxid-structtapi__ssh__server__opt:

struct tapi_ssh_server_opt
==========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

OpenSSH server specific options :ref:`More...<details-structtapi__ssh__server__opt>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tapi_ssh.h>
	
	struct tapi_ssh_server_opt {
		// fields
	
		char* :ref:`path<doxid-structtapi__ssh__server__opt_1a10b4b4bd0f9e5f94de74ca3e2740b3b6>`;
		char* :ref:`config_file<doxid-structtapi__ssh__server__opt_1a402ef26794bd7e16bcf64ce20e1ff51d>`;
		char* :ref:`host_key_file<doxid-structtapi__ssh__server__opt_1abf727c88a4eba415aad60919457d5a18>`;
		char* :ref:`authorized_keys_file<doxid-structtapi__ssh__server__opt_1ac8ad1cb3d056c7fb6365119f0dc4bcbb>`;
		:ref:`tapi_ssh_permit_root_login_t<doxid-group__tapi__ssh_1gad26ec78a92d676308792deeeb694f892>` :ref:`permit_root_login<doxid-structtapi__ssh__server__opt_1aa234e3fe3180d1add28debff2f17b779>`;
		char* :ref:`pid_file<doxid-structtapi__ssh__server__opt_1ac1a65fb0d2d95c22af8403a6f93b1d61>`;
		bool :ref:`pub_key_authentication<doxid-structtapi__ssh__server__opt_1ac7e6e1b5caabe7722f7cccae4b8cff02>`;
		bool :ref:`strict_modes<doxid-structtapi__ssh__server__opt_1a158631e33d7b542da5d4248bc2f1c9e3>`;
		unsigned int :ref:`port<doxid-structtapi__ssh__server__opt_1a351eaacf8a43e893474c70b5be728d86>`;
	};
.. _details-structtapi__ssh__server__opt:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

OpenSSH server specific options

Fields
------

.. index:: pair: variable; path
.. _doxid-structtapi__ssh__server__opt_1a10b4b4bd0f9e5f94de74ca3e2740b3b6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* path

Path to sshd binary

.. index:: pair: variable; config_file
.. _doxid-structtapi__ssh__server__opt_1a402ef26794bd7e16bcf64ce20e1ff51d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* config_file

File to configure sshd

.. ref-code-block:: cpp

	sshd -f <config_file>

.. index:: pair: variable; host_key_file
.. _doxid-structtapi__ssh__server__opt_1abf727c88a4eba415aad60919457d5a18:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* host_key_file

File to read a host key from

.. ref-code-block:: cpp

	sshd -h <host_key_file>

.. index:: pair: variable; authorized_keys_file
.. _doxid-structtapi__ssh__server__opt_1ac8ad1cb3d056c7fb6365119f0dc4bcbb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* authorized_keys_file

File with public keys for users authentication

.. ref-code-block:: cpp

	sshd -o AuthorizedKeysFile=<:ref:`authorized_keys_file <doxid-structtapi__ssh__server__opt_1ac8ad1cb3d056c7fb6365119f0dc4bcbb>`>

.. index:: pair: variable; permit_root_login
.. _doxid-structtapi__ssh__server__opt_1aa234e3fe3180d1add28debff2f17b779:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_ssh_permit_root_login_t<doxid-group__tapi__ssh_1gad26ec78a92d676308792deeeb694f892>` permit_root_login

Specifies whether root login is allowed

.. ref-code-block:: cpp

	sshd -o PermitRootLogin=<:ref:`permit_root_login <doxid-structtapi__ssh__server__opt_1aa234e3fe3180d1add28debff2f17b779>`>

May be ``yes``, ``no``, ``forced-commands-only`` or ``prohibit-password``

.. index:: pair: variable; pid_file
.. _doxid-structtapi__ssh__server__opt_1ac1a65fb0d2d95c22af8403a6f93b1d61:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* pid_file

File to store SSHD process ID

.. ref-code-block:: cpp

	sshd -o PidFile=<:ref:`pid_file <doxid-structtapi__ssh__server__opt_1ac1a65fb0d2d95c22af8403a6f93b1d61>`>

.. index:: pair: variable; pub_key_authentication
.. _doxid-structtapi__ssh__server__opt_1ac7e6e1b5caabe7722f7cccae4b8cff02:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool pub_key_authentication

Specifies whether public key authentication is allowed

.. ref-code-block:: cpp

	sshd -o PubkeyAuthentication=<:ref:`pub_key_authentication <doxid-structtapi__ssh__server__opt_1ac7e6e1b5caabe7722f7cccae4b8cff02>`>

May be ``yes`` or ``no``

.. index:: pair: variable; strict_modes
.. _doxid-structtapi__ssh__server__opt_1a158631e33d7b542da5d4248bc2f1c9e3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool strict_modes

Sets checking ownership of user's files and home directory before allowing the login.

For instance authorized_keys file may reside in directory that is owned not only by user. To allow sshd consider logged users pubkeys from such authorized_keys file, we should set the option value on ``no``



.. ref-code-block:: cpp

	sshd -o StrictModes=<:ref:`strict_modes <doxid-structtapi__ssh__server__opt_1a158631e33d7b542da5d4248bc2f1c9e3>`>

May be ``yes`` or ``no``

.. index:: pair: variable; port
.. _doxid-structtapi__ssh__server__opt_1a351eaacf8a43e893474c70b5be728d86:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int port

Port to listen on

.. ref-code-block:: cpp

	sshd -p <port>