ttssh2/ttxssh/sftp.h

/*
 * (C) 2008- TeraTerm Project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __SFTP_H
#define __SFTP_H

// for debug mode
#ifdef _DEBUG
#define SFTP_DEBUG
#endif

/* version */
#define SSH2_FILEXFER_VERSION           3

/* client to server */
#define SSH2_FXP_INIT                   1
#define SSH2_FXP_OPEN                   3
#define SSH2_FXP_CLOSE                  4
#define SSH2_FXP_READ                   5
#define SSH2_FXP_WRITE                  6
#define SSH2_FXP_LSTAT                  7
#define SSH2_FXP_STAT_VERSION_0         7
#define SSH2_FXP_FSTAT                  8
#define SSH2_FXP_SETSTAT                9
#define SSH2_FXP_FSETSTAT               10
#define SSH2_FXP_OPENDIR                11
#define SSH2_FXP_READDIR                12
#define SSH2_FXP_REMOVE                 13
#define SSH2_FXP_MKDIR                  14
#define SSH2_FXP_RMDIR                  15
#define SSH2_FXP_REALPATH               16
#define SSH2_FXP_STAT                   17
#define SSH2_FXP_RENAME                 18
#define SSH2_FXP_READLINK               19
#define SSH2_FXP_SYMLINK                20

/* server to client */
#define SSH2_FXP_VERSION                2
#define SSH2_FXP_STATUS                 101
#define SSH2_FXP_HANDLE                 102
#define SSH2_FXP_DATA                   103
#define SSH2_FXP_NAME                   104
#define SSH2_FXP_ATTRS                  105

#define SSH2_FXP_EXTENDED               200
#define SSH2_FXP_EXTENDED_REPLY         201

/* attributes */
#define SSH2_FILEXFER_ATTR_SIZE         0x00000001
#define SSH2_FILEXFER_ATTR_UIDGID       0x00000002
#define SSH2_FILEXFER_ATTR_PERMISSIONS  0x00000004
#define SSH2_FILEXFER_ATTR_ACMODTIME    0x00000008
#define SSH2_FILEXFER_ATTR_EXTENDED     0x80000000

/* portable open modes */
#define SSH2_FXF_READ                   0x00000001
#define SSH2_FXF_WRITE                  0x00000002
#define SSH2_FXF_APPEND                 0x00000004
#define SSH2_FXF_CREAT                  0x00000008
#define SSH2_FXF_TRUNC                  0x00000010
#define SSH2_FXF_EXCL                   0x00000020

/* statvfs@openssh.com f_flag flags */
#define SSH2_FXE_STATVFS_ST_RDONLY      0x00000001
#define SSH2_FXE_STATVFS_ST_NOSUID      0x00000002

/* status messages */
#define SSH2_FX_OK                      0
#define SSH2_FX_EOF                     1
#define SSH2_FX_NO_SUCH_FILE            2
#define SSH2_FX_PERMISSION_DENIED       3
#define SSH2_FX_FAILURE                 4
#define SSH2_FX_BAD_MESSAGE             5
#define SSH2_FX_NO_CONNECTION           6
#define SSH2_FX_CONNECTION_LOST         7
#define SSH2_FX_OP_UNSUPPORTED          8
#define SSH2_FX_MAX                     8

/* Maximum packet that we are willing to send/accept */
#define SFTP_MAX_MSG_LENGTH     (256 * 1024)

#define DEFAULT_COPY_BUFLEN 32768   /* Size of buffer for up/download */
#define DEFAULT_NUM_REQUESTS    64  /* # concurrent outstanding requests */

void sftp_do_init(PTInstVar pvar, Channel_t *c);
void sftp_response(PTInstVar pvar, Channel_t *c, unsigned char *data, unsigned int buflen);

#endif