sftp.h

Go to the documentation of this file.

/*
 * sftp.h
 *
 * SFTP Developer API
 *
 * Copyright 2019-2024 DigiCert, Inc.0. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */

/*------------------------------------------------------------------*/

#ifndef __SFTP_HEADER__
#define __SFTP_HEADER__

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __ENABLE_MOCANA_SSH_FTP_SERVER__

#define SFTP_OPEN_FILE_READ_BINARY      1
#define SFTP_OPEN_FILE_WRITE_BINARY     2

#define SSH_FTP_OK                      0
#define SSH_FTP_EOF                     1
#define SSH_FTP_NO_SUCH_FILE            2
#define SSH_FTP_PERMISSION_DENIED       3
#define SSH_FTP_FAILURE                 4
#define SSH_FTP_BAD_MESSAGE             5
#define SSH_FTP_NO_CONNECTION           6
#define SSH_FTP_CONNECTION_LOST         7
#define SSH_FTP_OP_UNSUPPORTED          8
#define SSH_FTP_INVALID_HANDLE          9
#define SSH_FTP_NO_SUCH_PATH            10
#define SSH_FTP_FILE_ALREADY_EXISTS     11
#define SSH_FTP_WRITE_PROTECT           12
#define SSH_FTP_NO_MEDIA                13


/*------------------------------------------------------------------*/

typedef struct
{
    sbyte4 (*funcPtrOpenFileUpcall)    (sbyte4 connectionInstance, void* sftpInternelDescr, sbyte *pLongDirectoryName, sbyte *pFilename, sbyte4 flags);

    sbyte4 (*funcPtrReadFileUpcall)    (sbyte4 connectionInstance, void* sftpInternelDescr);

    sbyte4 (*funcPtrWriteFileUpcall)   (sbyte4 connectionInstance, void* sftpInternelDescr);

    sbyte4 (*funcPtrCloseFileUpcall)   (sbyte4 connectionInstance, void* sftpInternelDescr);

    sbyte4 (*funcPtrOpenDirUpcall)     (sbyte4 connectionInstance, const sbyte *pLongDirectoryName, void* *pDirCookie);

    sbyte4 (*funcPtrReadDirUpcall)     (sbyte4 connectionInstance, sbyte *pLongDirectoryName, sftpFileObjDescr* p_sftpFileDescr, void* *pDirCookie);

    sbyte4 (*funcPtrCloseDirUpcall)    (sbyte4 connectionInstance, void **pDirCookie);

    sbyte4 (*funcPtrGetFileStats)      (sbyte4 connectionInstance, ubyte *pPath, ubyte *pPathExt, sftpFileObjDescr* p_sftpFileDescr);

    sbyte4 (*funcPtrGetOpenFileStats)  (sbyte4 connectionInstance, sbyte4 cookie, sftpFileObjDescr* p_sftpFileDescr);

    sbyte4 (*funcPtrRemoveFile)        (sbyte4 connectionInstance, sbyte *pRemoveFilename);

    sbyte4 (*funcPtrRenameFile)        (sbyte4 connectionInstance, sbyte *pOldFilename, sbyte *pNewFilename);

    sbyte4 (*funcPtrCreateDir)         (sbyte4 connectionInstance, sbyte *pCreateDirectoryName);

    sbyte4 (*funcPtrRemoveDir)         (sbyte4 connectionInstance, sbyte *pRemoveDirectoryName);

} sftpSettings;


/*------------------------------------------------------------------*/

MOC_EXTERN sftpSettings* SSH_sftpSettings(void);

MOC_EXTERN sbyte4   SSH_sftpSetMemberOfGroups(sbyte4 connectionInstance, ubyte4 memberGroups);

MOC_EXTERN sbyte4   SSH_sftpSetHomeDirectory(sbyte4 connectionInstance, sbyte *pHomeDirectory);

MOC_EXTERN void     SSH_sftpSetCookie(void* sftpInternelDescr, void* sftpCookie);

MOC_EXTERN void*   SSH_sftpGetCookie(void* sftpInternelDescr);

MOC_EXTERN sbyte4   SSH_sftpReadLocation(void* sftpInternelDescr);

MOC_EXTERN sbyte*   SSH_sftpReadBuffer(void* sftpInternelDescr);

MOC_EXTERN sbyte4   SSH_sftpReadBufferSize(void* sftpInternelDescr);

MOC_EXTERN void     SSH_sftpNumBytesRead(void* sftpInternelDescr, sbyte4 numBytesRead);

MOC_EXTERN sbyte4   SSH_sftpWriteLocation(void* sftpInternelDescr);

MOC_EXTERN sbyte*   SSH_sftpWriteBuffer(void* sftpInternelDescr);

MOC_EXTERN sbyte4   SSH_sftpWriteBufferSize(void* sftpInternelDescr);

#endif /* __ENABLE_MOCANA_SSH_FTP_SERVER__ */

#ifdef __cplusplus
}
#endif

#endif /* __SFTP_HEADER__ */