:orphan:

.. index:: pair: group; OpenSSH tools and utilities TAPI (tapi_ssh)
.. _doxid-group__tapi__ssh:

OpenSSH tools and utilities TAPI (tapi_ssh)
===========================================

.. toctree::
	:hidden:

	enum_tapi_ssh_permit_root_login.rst
	enum_tapi_ssh_strict_host_key_checking.rst
	struct_tapi_ssh.rst
	struct_tapi_ssh_client_opt.rst
	struct_tapi_ssh_server_opt.rst

Overview
~~~~~~~~

TAPI to handle OpenSSH tools and utilities. :ref:`More...<details-group__tapi__ssh>`


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

	
	// typedefs

	typedef struct :ref:`tapi_ssh<doxid-structtapi__ssh>` :target:`tapi_ssh_t<doxid-group__tapi__ssh_1gacdd03c8a577d9cc7f6a65949fd9e8e65>`;
	typedef enum :ref:`tapi_ssh_permit_root_login<doxid-group__tapi__ssh_1ga4dc4ba29d0ea276702f2c97684b23079>` :ref:`tapi_ssh_permit_root_login_t<doxid-group__tapi__ssh_1gad26ec78a92d676308792deeeb694f892>`;
	typedef enum :ref:`tapi_ssh_strict_host_key_checking<doxid-group__tapi__ssh_1ga511caaffa1d1fdedabb5f77bbcf0c2a4>` :ref:`tapi_ssh_strict_host_key_checking_t<doxid-group__tapi__ssh_1gad459d1324e1194aceef763a4ff67920e>`;
	typedef struct :ref:`tapi_ssh_client_opt<doxid-structtapi__ssh__client__opt>` :ref:`tapi_ssh_client_opt<doxid-group__tapi__ssh_1ga4e14ba527652750b5bd6c447fae66a6e>`;
	typedef struct :ref:`tapi_ssh_server_opt<doxid-structtapi__ssh__server__opt>` :ref:`tapi_ssh_server_opt<doxid-group__tapi__ssh_1gad5c67dbd91cce50cdcff797009179bf6>`;

	// enums

	enum :ref:`tapi_ssh_permit_root_login<doxid-group__tapi__ssh_1ga4dc4ba29d0ea276702f2c97684b23079>`;
	enum :ref:`tapi_ssh_strict_host_key_checking<doxid-group__tapi__ssh_1ga511caaffa1d1fdedabb5f77bbcf0c2a4>`;

	// structs

	struct :ref:`tapi_ssh<doxid-structtapi__ssh>`;
	struct :ref:`tapi_ssh_client_opt<doxid-structtapi__ssh__client__opt>`;
	struct :ref:`tapi_ssh_server_opt<doxid-structtapi__ssh__server__opt>`;

	// global variables

	const :ref:`tapi_ssh_client_opt<doxid-structtapi__ssh__client__opt>` :ref:`tapi_ssh_client_opt_default_opt<doxid-group__tapi__ssh_1gaffffaa18a7184939d943201bfb68d821>`;
	const :ref:`tapi_ssh_server_opt<doxid-structtapi__ssh__server__opt>` :ref:`tapi_ssh_server_opt_default_opt<doxid-group__tapi__ssh_1ga71ce1adcf9d7c5676825dcea1c25592b>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ssh_create_client<doxid-group__tapi__ssh_1ga848382a63c15e1b45d9fce0f8cde6cfc>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ssh_client_opt<doxid-structtapi__ssh__client__opt>`* opt, :ref:`tapi_ssh_t<doxid-structtapi__ssh>`** client_app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ssh_create_server<doxid-group__tapi__ssh_1ga9612e6492f18e125c6d102b3909962d0>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ssh_server_opt<doxid-structtapi__ssh__server__opt>`* opt, :ref:`tapi_ssh_t<doxid-structtapi__ssh>`** server_app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ssh_start_app<doxid-group__tapi__ssh_1gad5ce5f652899dfee05bd294be8e2f507>`(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ssh_wait_app<doxid-group__tapi__ssh_1ga1360142cf9db0b3194c7a9242a477241>`(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ssh_kill_app<doxid-group__tapi__ssh_1ga9ce72b5b5ee0c86c9cf1ff7e6902cf52>`(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app, int signo);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ssh_destroy_app<doxid-group__tapi__ssh_1gae56fdb3291e258f7ea1a2f06222ff49e>`(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ssh_client_wrapper_add<doxid-group__tapi__ssh_1gac27ca26a29c8a3cc13cc6faa390f51b2>`(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app, const char* tool, const char** argv, :ref:`tapi_job_wrapper_priority_t<doxid-group__tapi__job_1ga54951431877ba5144785b1a309d95687>` priority, :ref:`tapi_job_wrapper_t<doxid-group__tapi__job_1gaeea38892fa363ebce8773fdf1b7bba5d>`** wrap);

	// macros

	#define :ref:`TAPI_SSH_APP_WAIT_TIME_MS<doxid-group__tapi__ssh_1gad7ccfecc9955455315760816c7eb6c6a>`
	#define :ref:`TAPI_SSH_NB_CHANNELS<doxid-group__tapi__ssh_1ga6820c730a3566fb421310c3c3d8c6415>`

.. _details-group__tapi__ssh:

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

TAPI to handle OpenSSH tools and utilities.

Copyright (C) 2022-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_ssh_permit_root_login_t
.. _doxid-group__tapi__ssh_1gad26ec78a92d676308792deeeb694f892:

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

	typedef enum :ref:`tapi_ssh_permit_root_login<doxid-group__tapi__ssh_1ga4dc4ba29d0ea276702f2c97684b23079>` tapi_ssh_permit_root_login_t

Representation of possible values for PermitRootLogin sshd option

.. index:: pair: typedef; tapi_ssh_strict_host_key_checking_t
.. _doxid-group__tapi__ssh_1gad459d1324e1194aceef763a4ff67920e:

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

	typedef enum :ref:`tapi_ssh_strict_host_key_checking<doxid-group__tapi__ssh_1ga511caaffa1d1fdedabb5f77bbcf0c2a4>` tapi_ssh_strict_host_key_checking_t

Representation of possible values for StrictHostKeyChecking ssh option

.. index:: pair: typedef; tapi_ssh_client_opt
.. _doxid-group__tapi__ssh_1ga4e14ba527652750b5bd6c447fae66a6e:

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

	typedef struct :ref:`tapi_ssh_client_opt<doxid-structtapi__ssh__client__opt>` tapi_ssh_client_opt

OpenSSH client specific options

.. index:: pair: typedef; tapi_ssh_server_opt
.. _doxid-group__tapi__ssh_1gad5c67dbd91cce50cdcff797009179bf6:

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

	typedef struct :ref:`tapi_ssh_server_opt<doxid-structtapi__ssh__server__opt>` tapi_ssh_server_opt

OpenSSH server specific options

Global Variables
----------------

.. index:: pair: variable; tapi_ssh_client_opt_default_opt
.. _doxid-group__tapi__ssh_1gaffffaa18a7184939d943201bfb68d821:

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

	const :ref:`tapi_ssh_client_opt<doxid-structtapi__ssh__client__opt>` tapi_ssh_client_opt_default_opt

Default ssh options initializer

.. index:: pair: variable; tapi_ssh_server_opt_default_opt
.. _doxid-group__tapi__ssh_1ga71ce1adcf9d7c5676825dcea1c25592b:

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

	const :ref:`tapi_ssh_server_opt<doxid-structtapi__ssh__server__opt>` tapi_ssh_server_opt_default_opt

Default sshd options initializer

Global Functions
----------------

.. index:: pair: function; tapi_ssh_create_client
.. _doxid-group__tapi__ssh_1ga848382a63c15e1b45d9fce0f8cde6cfc:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ssh_create_client(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ssh_client_opt<doxid-structtapi__ssh__client__opt>`* opt, :ref:`tapi_ssh_t<doxid-structtapi__ssh>`** client_app)

Create ssh client app.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- factory

		- Client job factory.

	*
		- opt

		- Command line options.

	*
		- client_app

		- Client app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ssh_create_server
.. _doxid-group__tapi__ssh_1ga9612e6492f18e125c6d102b3909962d0:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ssh_create_server(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ssh_server_opt<doxid-structtapi__ssh__server__opt>`* opt, :ref:`tapi_ssh_t<doxid-structtapi__ssh>`** server_app)

Create sshd server app.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- factory

		- Server job factory.

	*
		- opt

		- Command line options.

	*
		- server_app

		- Server app (sshd) handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ssh_start_app
.. _doxid-group__tapi__ssh_1gad5ce5f652899dfee05bd294be8e2f507:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ssh_start_app(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app)

Start entity app.

``app`` entity may be ``ssh`` or ``sshd``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Entity app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ssh_wait_app
.. _doxid-group__tapi__ssh_1ga1360142cf9db0b3194c7a9242a477241:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ssh_wait_app(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app, int timeout_ms)

Wait for completion of entity app.

``app`` entity may be ``ssh`` or ``sshd``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Entity app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds (negative means :ref:`tapi_job_get_timeout() <doxid-group__tapi__job_1gac70c062266d7e079b31b51b3480afcf8>`).



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ssh_kill_app
.. _doxid-group__tapi__ssh_1ga9ce72b5b5ee0c86c9cf1ff7e6902cf52:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ssh_kill_app(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app, int signo)

Send a signal to entity app.

``app`` entity may be ``ssh`` or ``sshd``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Entity app handle.

	*
		- signo

		- Signal to send to client.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ssh_destroy_app
.. _doxid-group__tapi__ssh_1gae56fdb3291e258f7ea1a2f06222ff49e:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ssh_destroy_app(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app)

Destroy entity app.

``app`` entity may be ``ssh`` or ``sshd``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- Entity app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_ssh_client_wrapper_add
.. _doxid-group__tapi__ssh_1gac27ca26a29c8a3cc13cc6faa390f51b2:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ssh_client_wrapper_add(:ref:`tapi_ssh_t<doxid-structtapi__ssh>`* app, const char* tool, const char** argv, :ref:`tapi_job_wrapper_priority_t<doxid-group__tapi__job_1ga54951431877ba5144785b1a309d95687>` priority, :ref:`tapi_job_wrapper_t<doxid-group__tapi__job_1gaeea38892fa363ebce8773fdf1b7bba5d>`** wrap)

Add a wrapper tool/script to OpenSSH.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- SSH client app handle.

	*
		- tool

		- Path to the wrapper tool.

	*
		- argv

		- Wrapper arguments (last item should be ``NULL``).

	*
		- priority

		- Wrapper priority.

	*
		- wrap

		- Wrapper instance handle.



.. rubric:: Returns:

Status code.

Macros
------

.. index:: pair: define; TAPI_SSH_APP_WAIT_TIME_MS
.. _doxid-group__tapi__ssh_1gad7ccfecc9955455315760816c7eb6c6a:

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

	#define TAPI_SSH_APP_WAIT_TIME_MS

Timeout to wait for completion of entity app

.. index:: pair: define; TAPI_SSH_NB_CHANNELS
.. _doxid-group__tapi__ssh_1ga6820c730a3566fb421310c3c3d8c6415:

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

	#define TAPI_SSH_NB_CHANNELS

Number of tapi_job output channels