openapi_ssh.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-2022 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_ssh.h
*
* @purpose   SSH Configuration and Status 
*
* @component OpEN
*
* @create    30/01/2013
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_SSH_H_INCLUDED
#define OPENAPI_SSH_H_INCLUDED

#include "openapi_common.h"
#include "openapi_logging.h"
#include "openapi_transfer.h"

typedef enum 
{
  OPEN_SSH_KEY_TYPE_RSA = 0, 
  OPEN_SSH_KEY_TYPE_DSA = 1,  
  OPEN_SSH_KEY_TYPE_ECDSA = 2  
} OPEN_SSH_KEY_TYPE_t;

typedef enum 
{
  OPEN_SSH_PROTO_VERSION_1    = 0, /* SSH Protocol Version 1 option not supported */
  OPEN_SSH_PROTO_VERSION_2    = 1, 
  OPEN_SSH_PROTO_VERSION_BOTH = 2  
} OPEN_SSH_PROTO_VERSION_t;

typedef enum
{
  OPEN_SCP_OPER_NONE = 0,
  OPEN_SCP_PUSH      = 1,
  OPEN_SCP_PULL      = 2
} OPEN_SCP_OPER_t;

#define OPEN_SSHD_KEY_DATA_SIZE_MAX 8192 /* L7_SSHD_KEY_DATA_SIZE_MAX */
/*****************************************************************/
open_error_t openapiSSHKeyGenerate(openapiClientHandle_t *client_handle,
                                    OPEN_SSH_KEY_TYPE_t sshKeyType);

/*****************************************************************/
open_error_t openapiSSHKeyDelete(openapiClientHandle_t *client_handle,
                                  OPEN_SSH_KEY_TYPE_t sshKeyType);

/*****************************************************************/
open_error_t openapiSSHAdminModeSet(openapiClientHandle_t *client_handle,
                                    OPEN_CONTROL_t sshAdminMode);

/*****************************************************************/
open_error_t openapiSSHAdminModeGet(openapiClientHandle_t *client_handle,
                                    OPEN_CONTROL_t *sshAdminMode);

/*****************************************************************/
open_error_t openapiSSHProtocolVersionSet(openapiClientHandle_t *client_handle,
                                          OPEN_SSH_PROTO_VERSION_t protoVersion);

/*****************************************************************/
open_error_t openapiSSHProtocolVersionGet(openapiClientHandle_t *client_handle,
                                          OPEN_SSH_PROTO_VERSION_t *protoVersion);

/*****************************************************************/
open_error_t openapiSSHSessionTimeoutSet(openapiClientHandle_t *client_handle,
                                         uint32_t sshSessionTimeout);

/*****************************************************************/
open_error_t openapiSSHSessionTimeoutGet(openapiClientHandle_t *client_handle,
                                         uint32_t *sshSessionTimeout);

/*****************************************************************/
open_error_t openapiSSHMaxSessionsSet(openapiClientHandle_t *client_handle,
                                      uint32_t sshMaxSessions);

/*****************************************************************/
open_error_t openapiSSHMaxSessionsDefaultSet(openapiClientHandle_t *client_handle);

/*****************************************************************/
open_error_t openapiSSHMaxSessionsGet(openapiClientHandle_t *client_handle,
                                      uint32_t *sshMaxSessions);

/*****************************************************************/
open_error_t openapiSSHActiveSessionsGet(openapiClientHandle_t *client_handle,
                                         uint32_t *sshActiveSessions);

/*****************************************************************/
open_error_t openapiSSHKeyStatusGet(openapiClientHandle_t *client_handle,
                                    OPEN_SSH_KEY_TYPE_t sshKeyType);
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/*****************************************************************/
open_error_t openapiSSHSocketInfoClear(openapiClientHandle_t *client_handle,
                                       uint32_t sshClientID);

/*****************************************************************/
open_error_t openapiSSHUserAuthenticate(openapiClientHandle_t *client_handle,
                                        open_buffdesc *userName, open_buffdesc *password,
                                        open_buffdesc *ipAddr, uint32_t sshClientID);

/*****************************************************************/
open_error_t openapiSSHPublicUserAuthenticate(openapiClientHandle_t *client_handle,
                                              open_buffdesc *userName, open_buffdesc *ipAddr,
                                              uint32_t sshClientID);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

/*****************************************************************/
open_error_t openapiSSHPubKeyAuthModeGet(openapiClientHandle_t *client_handle,
                                         OPEN_CONTROL_t *sshdPubKeyAuthMode);

/*****************************************************************/
open_error_t openapiSSHPubKeyGet(openapiClientHandle_t *client_handle,
                                 OPEN_SSH_KEY_TYPE_t sshKeyType,
                                 open_buffdesc *userName,
                                 open_buffdesc *pubKey);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/*****************************************************************/
open_error_t openapiSSHLogMessage(openapiClientHandle_t *client_handle,
                                  OPEN_LOG_SEVERITY_t severity, open_buffdesc *fileName, 
                                  uint32_t lineNum, open_buffdesc *msgBuf);


/*****************************************************************/
open_error_t openapiSSHTransferRemotePasswordFromUserGet(openapiClientHandle_t *client_handle,
                                                         open_buffdesc *userName,
                                                         open_buffdesc *password);

/*****************************************************************/
open_error_t openapiSSHRemotePasswordGet(openapiClientHandle_t *client_handle,
                                         uint32_t clientSockID, 
                                         open_buffdesc *password);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

/*****************************************************************/
open_error_t openapiScpServerAdminModeSet (openapiClientHandle_t *client_handle,
                                           OPEN_CONTROL_t scpServerAdminMode);

/*****************************************************************/
open_error_t openapiScpServerAdminModeGet (openapiClientHandle_t *client_handle,
                                           OPEN_CONTROL_t *scpServerAdminMode);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
/*****************************************************************/
open_error_t openapiScpRemoteTransferStart (openapiClientHandle_t *client_handle,
                                            int32_t scpClientPID,
                                            open_buffdesc *fileParams);

/*****************************************************************/
open_error_t openapiScpRemoteTransferComplete (openapiClientHandle_t *client_handle);

/*********************************************************************
* @purpose  To get passphrase for SSH key decryption.
*
* @param[in]    client_handle    Client handle from registration API.
* @param[in]    sshKeyType       SSH host key type
* @param[out]    bufPassphrase    Buffer for passphrase
*
* @returns  OPEN_E_NONE     if successfully updated status.  
* @returns  OPEN_E_PARAM    if invalid input parameters is passed.  
* @returns  OPEN_E_ERROR    if failed to get passphrase.
*
* @note    This OpEN API returns the passphrase used to decrypt the SSH host key
*           in plain-text. Usage of this API is not recommended as this can
*           be a security concern.
*
* @open-status-hidden
*
* @supportedinversion OpEN API Version: 1.21
*
* @end
*********************************************************************/
open_error_t openapiSSHKeyEncryptPassphraseGet(openapiClientHandle_t *client_handle,
                                               OPEN_SSH_KEY_TYPE_t sshKeyType,
                                               open_buffdesc *bufPassphrase);

/*****************************************************************/
open_error_t openapiScpRemoteTransferUploadStart(openapiClientHandle_t *client_handle,
                                            int32_t scpClientPID,
                                            open_buffdesc *fileParams);

/*****************************************************************/
open_error_t openapiScpTransferRemoteComplete(openapiClientHandle_t *client_handle,
                                              OPEN_TRANSFER_STATUS_t transferStatus,
                                              OPEN_SCP_OPER_t transferType);

/*****************************************************************/
open_error_t openapiScpTransferStatusSet(openapiClientHandle_t *client_handle);

/*****************************************************************/
open_error_t openapiSSHTaskCleanup(openapiClientHandle_t *client_handle);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

/*************************************************************************/
open_error_t openapiSshdPortNumSet(openapiClientHandle_t *client_handle,
                                   uint32_t portNum);

/*************************************************************************/
open_error_t openapiSshdPortNumGet(openapiClientHandle_t *client_handle,
                                   uint32_t *pPort);

/*************************************************************************/
open_error_t openapiSshdProtoLevelFlagsGet(openapiClientHandle_t *client_handle,
                                           OPEN_BOOL_t *pSshV1Flag,
                                           OPEN_BOOL_t *pSshV2Flag);

/*************************************************************************/
open_error_t openapiSshdKeyLenSet(openapiClientHandle_t *client_handle,
                                  OPEN_SSH_KEY_TYPE_t type, uint32_t length);

/*************************************************************************/
open_error_t openapiSshdCfgKeyLenGet(openapiClientHandle_t *client_handle,
                                     OPEN_SSH_KEY_TYPE_t type,
                                     uint32_t *pLength);

/*************************************************************************/
open_error_t openapiSshdKeyLenGet(openapiClientHandle_t *client_handle,
                                  OPEN_SSH_KEY_TYPE_t type,
                                  uint32_t *pLength);

/*************************************************************************/
open_error_t openapiSshdKeyDataGet(openapiClientHandle_t *client_handle,
                                   OPEN_SSH_KEY_TYPE_t type,
                                   open_buffdesc *pkeyData);

#endif