Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
openapi_ssh.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2022 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_ssh.h
28 *
29 * @purpose SSH Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 30/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_SSH_H_INCLUDED
39 #define OPENAPI_SSH_H_INCLUDED
40 
41 #include "openapi_common.h"
42 #include "openapi_logging.h"
43 #include "openapi_transfer.h"
44 
46 typedef enum
47 {
48  OPEN_SSH_KEY_TYPE_RSA = 0,
49  OPEN_SSH_KEY_TYPE_DSA = 1,
50  OPEN_SSH_KEY_TYPE_ECDSA = 2
51 } OPEN_SSH_KEY_TYPE_t;
52 
54 typedef enum
55 {
56  OPEN_SSH_PROTO_VERSION_1 = 0, /* SSH Protocol Version 1 option not supported */
57  OPEN_SSH_PROTO_VERSION_2 = 1,
58  OPEN_SSH_PROTO_VERSION_BOTH = 2
59 } OPEN_SSH_PROTO_VERSION_t;
60 
61 typedef enum
62 {
63  OPEN_SCP_OPER_NONE = 0,
64  OPEN_SCP_PUSH = 1,
65  OPEN_SCP_PULL = 2
66 } OPEN_SCP_OPER_t;
67 
68 #define OPEN_SSHD_KEY_DATA_SIZE_MAX 8192 /* L7_SSHD_KEY_DATA_SIZE_MAX */
69 /*****************************************************************/
88 open_error_t openapiSSHKeyGenerate(openapiClientHandle_t *client_handle,
89  OPEN_SSH_KEY_TYPE_t sshKeyType);
90 
91 /*****************************************************************/
108 open_error_t openapiSSHKeyDelete(openapiClientHandle_t *client_handle,
109  OPEN_SSH_KEY_TYPE_t sshKeyType);
110 
111 /*****************************************************************/
130 open_error_t openapiSSHAdminModeSet(openapiClientHandle_t *client_handle,
131  OPEN_CONTROL_t sshAdminMode);
132 
133 /*****************************************************************/
148 open_error_t openapiSSHAdminModeGet(openapiClientHandle_t *client_handle,
149  OPEN_CONTROL_t *sshAdminMode);
150 
151 /*****************************************************************/
170 open_error_t openapiSSHProtocolVersionSet(openapiClientHandle_t *client_handle,
171  OPEN_SSH_PROTO_VERSION_t protoVersion);
172 
173 /*****************************************************************/
185 open_error_t openapiSSHProtocolVersionGet(openapiClientHandle_t *client_handle,
186  OPEN_SSH_PROTO_VERSION_t *protoVersion);
187 
188 /*****************************************************************/
205 open_error_t openapiSSHSessionTimeoutSet(openapiClientHandle_t *client_handle,
206  uint32_t sshSessionTimeout);
207 
208 /*****************************************************************/
221 open_error_t openapiSSHSessionTimeoutGet(openapiClientHandle_t *client_handle,
222  uint32_t *sshSessionTimeout);
223 
224 /*****************************************************************/
241 open_error_t openapiSSHMaxSessionsSet(openapiClientHandle_t *client_handle,
242  uint32_t sshMaxSessions);
243 
244 /*****************************************************************/
258 open_error_t openapiSSHMaxSessionsDefaultSet(openapiClientHandle_t *client_handle);
259 
260 /*****************************************************************/
272 open_error_t openapiSSHMaxSessionsGet(openapiClientHandle_t *client_handle,
273  uint32_t *sshMaxSessions);
274 
275 /*****************************************************************/
288 open_error_t openapiSSHActiveSessionsGet(openapiClientHandle_t *client_handle,
289  uint32_t *sshActiveSessions);
290 
291 /*****************************************************************/
304 open_error_t openapiSSHSocketInfoClear(openapiClientHandle_t *client_handle,
305  uint32_t sshClientID);
306 
307 /*****************************************************************/
324 open_error_t openapiSSHKeyStatusGet(openapiClientHandle_t *client_handle,
325  OPEN_SSH_KEY_TYPE_t sshKeyType);
326 
327 /*****************************************************************/
345 open_error_t openapiSSHUserAuthenticate(openapiClientHandle_t *client_handle,
346  open_buffdesc *userName, open_buffdesc *password,
347  open_buffdesc *ipAddr, uint32_t sshClientID);
348 
349 /*****************************************************************/
366 open_error_t openapiSSHPublicUserAuthenticate(openapiClientHandle_t *client_handle,
367  open_buffdesc *userName, open_buffdesc *ipAddr,
368  uint32_t sshClientID);
369 
370 /*****************************************************************/
385 open_error_t openapiSSHPubKeyAuthModeGet(openapiClientHandle_t *client_handle,
386  OPEN_CONTROL_t *sshdPubKeyAuthMode);
387 
388 /*****************************************************************/
405 open_error_t openapiSSHPubKeyGet(openapiClientHandle_t *client_handle,
406  OPEN_SSH_KEY_TYPE_t sshKeyType,
407  open_buffdesc *userName,
408  open_buffdesc *pubKey);
409 
410 /*****************************************************************/
425 open_error_t openapiSSHLogMessage(openapiClientHandle_t *client_handle,
426  OPEN_LOG_SEVERITY_t severity, open_buffdesc *fileName,
427  uint32_t lineNum, open_buffdesc *msgBuf);
428 
429 
430 /*****************************************************************/
443 open_error_t openapiSSHTransferRemotePasswordFromUserGet(openapiClientHandle_t *client_handle,
444  open_buffdesc *userName,
445  open_buffdesc *password);
446 
447 /*****************************************************************/
463 open_error_t openapiSSHRemotePasswordGet(openapiClientHandle_t *client_handle,
464  uint32_t clientSockID,
465  open_buffdesc *password);
466 
467 /*****************************************************************/
483 open_error_t openapiScpServerAdminModeSet (openapiClientHandle_t *client_handle,
484  OPEN_CONTROL_t scpServerAdminMode);
485 
486 /*****************************************************************/
502 open_error_t openapiScpServerAdminModeGet (openapiClientHandle_t *client_handle,
503  OPEN_CONTROL_t *scpServerAdminMode);
504 
505 /*****************************************************************/
540 open_error_t openapiScpRemoteTransferStart (openapiClientHandle_t *client_handle,
541  int32_t scpClientPID,
542  open_buffdesc *fileParams);
543 
544 /*****************************************************************/
562 open_error_t openapiScpRemoteTransferComplete (openapiClientHandle_t *client_handle);
563 
564 /*********************************************************************
565 * @purpose To get passphrase for SSH key decryption.
566 *
567 * @param[in] client_handle Client handle from registration API.
568 * @param[in] sshKeyType SSH host key type
569 * @param[out] bufPassphrase Buffer for passphrase
570 *
571 * @returns OPEN_E_NONE if successfully updated status.
572 * @returns OPEN_E_PARAM if invalid input parameters is passed.
573 * @returns OPEN_E_ERROR if failed to get passphrase.
574 *
575 * @note This OpEN API returns the passphrase used to decrypt the SSH host key
576 * in plain-text. Usage of this API is not recommended as this can
577 * be a security concern.
578 *
579 * @open-status-hidden
580 *
581 * @supportedinversion OpEN API Version: 1.21
582 *
583 * @end
584 *********************************************************************/
585 open_error_t openapiSSHKeyEncryptPassphraseGet(openapiClientHandle_t *client_handle,
586  OPEN_SSH_KEY_TYPE_t sshKeyType,
587  open_buffdesc *bufPassphrase);
588 /*****************************************************************/
624 open_error_t openapiScpRemoteTransferUploadStart(openapiClientHandle_t *client_handle,
625  int32_t scpClientPID,
626  open_buffdesc *fileParams);
627 
628 /*****************************************************************/
643 open_error_t openapiScpTransferRemoteComplete(openapiClientHandle_t *client_handle,
644  OPEN_TRANSFER_STATUS_t transferStatus,
645  OPEN_SCP_OPER_t transferType);
646 
647 /*****************************************************************/
660 open_error_t openapiScpTransferStatusSet(openapiClientHandle_t *client_handle);
661 
662 /*****************************************************************/
676 open_error_t openapiSSHTaskCleanup(openapiClientHandle_t *client_handle);
677 
678 /*************************************************************************/
695 open_error_t openapiSshdPortNumSet(openapiClientHandle_t *client_handle,
696  uint32_t portNum);
697 
698 /*************************************************************************/
713 open_error_t openapiSshdPortNumGet(openapiClientHandle_t *client_handle,
714  uint32_t *pPort);
715 
716 /*************************************************************************/
732 open_error_t openapiSshdProtoLevelFlagsGet(openapiClientHandle_t *client_handle,
733  OPEN_BOOL_t *pSshV1Flag,
734  OPEN_BOOL_t *pSshV2Flag);
735 
736 /*************************************************************************/
755 open_error_t openapiSshdKeyLenSet(openapiClientHandle_t *client_handle,
756  OPEN_SSH_KEY_TYPE_t type, uint32_t length);
757 
758 /*************************************************************************/
774 open_error_t openapiSshdCfgKeyLenGet(openapiClientHandle_t *client_handle,
775  OPEN_SSH_KEY_TYPE_t type,
776  uint32_t *pLength);
777 
778 /*************************************************************************/
794 open_error_t openapiSshdKeyLenGet(openapiClientHandle_t *client_handle,
795  OPEN_SSH_KEY_TYPE_t type,
796  uint32_t *pLength);
797 
798 /*************************************************************************/
814 open_error_t openapiSshdKeyDataGet(openapiClientHandle_t *client_handle,
815  OPEN_SSH_KEY_TYPE_t type,
816  open_buffdesc *pkeyData);
817 
818 #endif
819 
openapiSshdKeyLenGet
open_error_t openapiSshdKeyLenGet(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t type, uint32_t *pLength)
Gets the length of the existing SSH key.
openapi_transfer.h
openapiSSHPubKeyAuthModeGet
open_error_t openapiSSHPubKeyAuthModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *sshdPubKeyAuthMode)
Get the admin mode of SSH public key.
openapiSSHTransferRemotePasswordFromUserGet
open_error_t openapiSSHTransferRemotePasswordFromUserGet(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *password)
Get the remote password for the matching remote username used for transfer.
OPEN_SSH_PROTO_VERSION_2
SSH Protocol Version 2.
Definition: openapi_ssh.h:57
openapiSshdKeyLenSet
open_error_t openapiSshdKeyLenSet(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t type, uint32_t length)
Set the length for SSH Key to be generated.
openapiSSHActiveSessionsGet
open_error_t openapiSSHActiveSessionsGet(openapiClientHandle_t *client_handle, uint32_t *sshActiveSessions)
Get the active number of SSH sessions.
openapiSSHLogMessage
open_error_t openapiSSHLogMessage(openapiClientHandle_t *client_handle, OPEN_LOG_SEVERITY_t severity, open_buffdesc *fileName, uint32_t lineNum, open_buffdesc *msgBuf)
Log an SSH message in the log server.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiSshdPortNumSet
open_error_t openapiSshdPortNumSet(openapiClientHandle_t *client_handle, uint32_t portNum)
Sets the port number to be used for SSH Server.
openapiScpServerAdminModeGet
open_error_t openapiScpServerAdminModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *scpServerAdminMode)
Get the SCP server admin mode.
openapiSSHAdminModeSet
open_error_t openapiSSHAdminModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t sshAdminMode)
Set the admin mode of SSH.
openapiScpTransferRemoteComplete
open_error_t openapiScpTransferRemoteComplete(openapiClientHandle_t *client_handle, OPEN_TRANSFER_STATUS_t transferStatus, OPEN_SCP_OPER_t transferType)
To update application about the completion of scp remote file transfer.
openapiSshdPortNumGet
open_error_t openapiSshdPortNumGet(openapiClientHandle_t *client_handle, uint32_t *pPort)
Gets ssh server port number.
openapiSSHMaxSessionsGet
open_error_t openapiSSHMaxSessionsGet(openapiClientHandle_t *client_handle, uint32_t *sshMaxSessions)
Get the maximum number of SSH sessions allowed.
openapiSSHUserAuthenticate
open_error_t openapiSSHUserAuthenticate(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *password, open_buffdesc *ipAddr, uint32_t sshClientID)
Authenticate SSH User.
openapiSSHKeyGenerate
open_error_t openapiSSHKeyGenerate(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
Generate SSH key pairs.
open_buffdesc
Definition: openapi_common.h:137
openapiSSHSessionTimeoutGet
open_error_t openapiSSHSessionTimeoutGet(openapiClientHandle_t *client_handle, uint32_t *sshSessionTimeout)
Get the SSH session idle timeout value.
openapiClientHandle_s
Definition: openapi_common.h:130
openapiSSHTaskCleanup
open_error_t openapiSSHTaskCleanup(openapiClientHandle_t *client_handle)
Stop/cleanup ssh task.
openapiScpRemoteTransferStart
open_error_t openapiScpRemoteTransferStart(openapiClientHandle_t *client_handle, int32_t scpClientPID, open_buffdesc *fileParams)
To get the download file complete path and initiate transfer process.
OPEN_SSH_KEY_TYPE_DSA
SSH Key Type DSA.
Definition: openapi_ssh.h:49
OPEN_LOG_SEVERITY_t
OPEN_LOG_SEVERITY_t
OpEN uses this enumeration to define Logging Severity Levels.
Definition: openapi_logging.h:44
OPEN_SSH_KEY_TYPE_RSA
SSH Key Type RSA.
Definition: openapi_ssh.h:48
openapiSshdKeyDataGet
open_error_t openapiSshdKeyDataGet(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t type, open_buffdesc *pkeyData)
Gets key data for a specific key type.
openapiSshdProtoLevelFlagsGet
open_error_t openapiSshdProtoLevelFlagsGet(openapiClientHandle_t *client_handle, OPEN_BOOL_t *pSshV1Flag, OPEN_BOOL_t *pSshV2Flag)
Gets ssh version flags.
openapiSSHKeyStatusGet
open_error_t openapiSSHKeyStatusGet(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
Check the status of SSH key.
openapiSSHProtocolVersionGet
open_error_t openapiSSHProtocolVersionGet(openapiClientHandle_t *client_handle, OPEN_SSH_PROTO_VERSION_t *protoVersion)
Get the SSH protocol version.
openapiScpRemoteTransferComplete
open_error_t openapiScpRemoteTransferComplete(openapiClientHandle_t *client_handle)
To update application about the completion of scp remote file transfer.
openapiSSHSessionTimeoutSet
open_error_t openapiSSHSessionTimeoutSet(openapiClientHandle_t *client_handle, uint32_t sshSessionTimeout)
Set the SSH session idle timeout.
openapiScpServerAdminModeSet
open_error_t openapiScpServerAdminModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t scpServerAdminMode)
Set the SCP server admin mode to initiate file transfer.
openapiSSHAdminModeGet
open_error_t openapiSSHAdminModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *sshAdminMode)
Get the admin mode of SSH.
OPEN_SSH_KEY_TYPE_ECDSA
SSH Key Type ECDSA.
Definition: openapi_ssh.h:50
openapiSSHPublicUserAuthenticate
open_error_t openapiSSHPublicUserAuthenticate(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *ipAddr, uint32_t sshClientID)
Authenticate SSH User.
openapiSSHMaxSessionsSet
open_error_t openapiSSHMaxSessionsSet(openapiClientHandle_t *client_handle, uint32_t sshMaxSessions)
Set the maximum number of allowed SSH sessions.
openapiSSHPubKeyGet
open_error_t openapiSSHPubKeyGet(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType, open_buffdesc *userName, open_buffdesc *pubKey)
Get the SSH public key for specified user.
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:162
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:178
openapiScpTransferStatusSet
open_error_t openapiScpTransferStatusSet(openapiClientHandle_t *client_handle)
To update application about the status of scp remote file transfer.
openapiSSHSocketInfoClear
open_error_t openapiSSHSocketInfoClear(openapiClientHandle_t *client_handle, uint32_t sshClientID)
Clear socket info entry.
openapiSSHMaxSessionsDefaultSet
open_error_t openapiSSHMaxSessionsDefaultSet(openapiClientHandle_t *client_handle)
Set the maximum number of allowed SSH sessions to the default.
openapiSSHProtocolVersionSet
open_error_t openapiSSHProtocolVersionSet(openapiClientHandle_t *client_handle, OPEN_SSH_PROTO_VERSION_t protoVersion)
Set the SSH protocol version.
openapiSSHKeyDelete
open_error_t openapiSSHKeyDelete(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t sshKeyType)
Delete the generated SSH key pairs.
openapi_common.h
openapiSshdCfgKeyLenGet
open_error_t openapiSshdCfgKeyLenGet(openapiClientHandle_t *client_handle, OPEN_SSH_KEY_TYPE_t type, uint32_t *pLength)
Gets the configured key length of SSH key.
OPEN_SSH_KEY_TYPE_t
OPEN_SSH_KEY_TYPE_t
OpEN uses this enumeration to define SSH key types.
Definition: openapi_ssh.h:46
openapiSSHRemotePasswordGet
open_error_t openapiSSHRemotePasswordGet(openapiClientHandle_t *client_handle, uint32_t clientSockID, open_buffdesc *password)
Get the remote password for the matching client Socket ID for outbound SSH .
OPEN_SSH_PROTO_VERSION_t
OPEN_SSH_PROTO_VERSION_t
OpEN uses this enumeration to define SSH protocol versions.
Definition: openapi_ssh.h:54
openapiScpRemoteTransferUploadStart
open_error_t openapiScpRemoteTransferUploadStart(openapiClientHandle_t *client_handle, int32_t scpClientPID, open_buffdesc *fileParams)
To get the upload file complete path and initiate transfer process.
OPEN_TRANSFER_STATUS_t
OPEN_TRANSFER_STATUS_t
OPEN File Transfer Status.
Definition: openapi_transfer.h:114
OPEN_SSH_PROTO_VERSION_BOTH
SSH Protocol Version Both (1 and 2) option not supported.
Definition: openapi_ssh.h:58
openapi_logging.h