144 lines
4.3 KiB
C
144 lines
4.3 KiB
C
/* wolfscp.h
|
|
*
|
|
* Copyright (C) 2014-2020 wolfSSL Inc.
|
|
*
|
|
* This file is part of wolfSSH.
|
|
*
|
|
* wolfSSH is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* wolfSSH is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with wolfSSH. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
|
|
#ifndef _WOLFSSH_WOLFSCP_H_
|
|
#define _WOLFSSH_WOLFSCP_H_
|
|
|
|
|
|
#include <wolfssh/settings.h>
|
|
#include <wolfssh/ssh.h>
|
|
#include <wolfssh/port.h>
|
|
|
|
#ifdef WOLFSSH_SCP
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef NULL
|
|
#include <stddef.h>
|
|
#endif
|
|
|
|
/* size of scp protocol message buffer, dependent mostly on
|
|
* path and file name lengths, on the stack */
|
|
#ifndef DEFAULT_SCP_MSG_SZ
|
|
#define DEFAULT_SCP_MSG_SZ 1024
|
|
#endif
|
|
|
|
#ifndef DEFAULT_SCP_FILE_NAME_SZ
|
|
#define DEFAULT_SCP_FILE_NAME_SZ 1024
|
|
#endif
|
|
|
|
/* size of scp file transfer buffer, allocated dynamically */
|
|
#ifndef DEFAULT_SCP_BUFFER_SZ
|
|
#define DEFAULT_SCP_BUFFER_SZ DEFAULT_MAX_PACKET_SZ
|
|
#endif
|
|
|
|
enum WS_ScpFileStates {
|
|
/* sink */
|
|
WOLFSSH_SCP_NEW_REQUEST = 0,
|
|
WOLFSSH_SCP_NEW_FILE,
|
|
WOLFSSH_SCP_FILE_PART,
|
|
WOLFSSH_SCP_FILE_DONE,
|
|
WOLFSSH_SCP_NEW_DIR,
|
|
WOLFSSH_SCP_END_DIR,
|
|
/* source */
|
|
WOLFSSH_SCP_SINGLE_FILE_REQUEST,
|
|
WOLFSSH_SCP_RECURSIVE_REQUEST,
|
|
WOLFSSH_SCP_CONTINUE_FILE_TRANSFER
|
|
};
|
|
|
|
|
|
#if !defined(WOLFSSH_SCP_USER_CALLBACKS)
|
|
#if !defined(NO_FILESYSTEM)
|
|
#include <time.h>
|
|
#ifdef HAVE_SYS_TIME_H
|
|
#include <sys/time.h>
|
|
#endif
|
|
#include <errno.h>
|
|
|
|
typedef struct ScpSendCtx {
|
|
#ifndef WOLFSSL_NUCLEUS
|
|
struct dirent* entry; /* file entry, from readdir() */
|
|
struct stat s; /* stat info from file */
|
|
#else
|
|
int fd; /* file descriptor, in the case of Nucleus fp points to fd */
|
|
DSTAT s;
|
|
int nextError;
|
|
#endif
|
|
WFILE* fp; /* file pointer */
|
|
struct ScpDir* currentDir; /* dir being copied, stack */
|
|
char dirName[DEFAULT_SCP_FILE_NAME_SZ]; /* current dir name */
|
|
} ScpSendCtx;
|
|
|
|
typedef struct ScpDir {
|
|
WDIR dir; /* dir pointer, from opendir() */
|
|
struct ScpDir* next; /* previous directory in stack */
|
|
} ScpDir;
|
|
#else
|
|
/* Use a buffer for built in no filesystem send/recv */
|
|
typedef struct ScpBuffer ScpBuffer;
|
|
struct ScpBuffer {
|
|
char name[DEFAULT_SCP_FILE_NAME_SZ];
|
|
byte* buffer;
|
|
word64 mTime;
|
|
word32 bufferSz; /* size of "buffer" */
|
|
word32 fileSz; /* size of file in "buffer" */
|
|
word32 idx; /* current index into "buffer" */
|
|
word32 nameSz;
|
|
int mode;
|
|
int (*status)(WOLFSSH* ssh, const char* fileName, enum WS_ScpFileStates state, ScpBuffer* file);
|
|
};
|
|
#endif /* NO_FILESYSTEM */
|
|
#endif /* WOLFSSH_SCP_USER_CALLBACKS */
|
|
|
|
typedef int (*WS_CallbackScpRecv)(WOLFSSH*, int, const char*, const char*,
|
|
int, word64, word64, word32, byte*, word32,
|
|
word32, void*);
|
|
typedef int (*WS_CallbackScpSend)(WOLFSSH*, int, const char*, char*, word32,
|
|
word64*, word64*, int*, word32, word32*,
|
|
byte*, word32, void*);
|
|
|
|
WOLFSSH_API void wolfSSH_SetScpRecv(WOLFSSH_CTX*, WS_CallbackScpRecv);
|
|
WOLFSSH_API void wolfSSH_SetScpSend(WOLFSSH_CTX*, WS_CallbackScpSend);
|
|
|
|
WOLFSSH_API void wolfSSH_SetScpRecvCtx(WOLFSSH*, void*);
|
|
WOLFSSH_API void wolfSSH_SetScpSendCtx(WOLFSSH*, void*);
|
|
|
|
WOLFSSH_API void* wolfSSH_GetScpRecvCtx(WOLFSSH*);
|
|
WOLFSSH_API void* wolfSSH_GetScpSendCtx(WOLFSSH*);
|
|
|
|
WOLFSSH_API int wolfSSH_SetScpErrorMsg(WOLFSSH*, const char*);
|
|
|
|
WOLFSSH_API int wolfSSH_SCP_connect(WOLFSSH*, byte*);
|
|
WOLFSSH_API int wolfSSH_SCP_to(WOLFSSH*, const char*, const char*);
|
|
WOLFSSH_API int wolfSSH_SCP_from(WOLFSSH*, const char*, const char*);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* WOLFSSH_SCP */
|
|
|
|
#endif /* _WOLFSSH_WOLFSCP_H_ */
|
|
|