xref: /netbsd/crypto/external/bsd/openssh/dist/sftp.h (revision 314ef785)
1 /*	$NetBSD: sftp.h,v 1.6 2017/04/18 18:41:46 christos Exp $	*/
2 /* $OpenBSD: sftp.h,v 1.9 2008/06/13 00:12:02 dtucker Exp $ */
3 
4 /*
5  * Copyright (c) 2001 Markus Friedl.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 /*
29  * draft-ietf-secsh-filexfer-01.txt
30  */
31 
32 /* version */
33 #define	SSH2_FILEXFER_VERSION		3
34 
35 /* client to server */
36 #define SSH2_FXP_INIT			1
37 #define SSH2_FXP_OPEN			3
38 #define SSH2_FXP_CLOSE			4
39 #define SSH2_FXP_READ			5
40 #define SSH2_FXP_WRITE			6
41 #define SSH2_FXP_LSTAT			7
42 #define SSH2_FXP_STAT_VERSION_0		7
43 #define SSH2_FXP_FSTAT			8
44 #define SSH2_FXP_SETSTAT		9
45 #define SSH2_FXP_FSETSTAT		10
46 #define SSH2_FXP_OPENDIR		11
47 #define SSH2_FXP_READDIR		12
48 #define SSH2_FXP_REMOVE			13
49 #define SSH2_FXP_MKDIR			14
50 #define SSH2_FXP_RMDIR			15
51 #define SSH2_FXP_REALPATH		16
52 #define SSH2_FXP_STAT			17
53 #define SSH2_FXP_RENAME			18
54 #define SSH2_FXP_READLINK		19
55 #define SSH2_FXP_SYMLINK		20
56 
57 /* server to client */
58 #define SSH2_FXP_VERSION		2
59 #define SSH2_FXP_STATUS			101
60 #define SSH2_FXP_HANDLE			102
61 #define SSH2_FXP_DATA			103
62 #define SSH2_FXP_NAME			104
63 #define SSH2_FXP_ATTRS			105
64 
65 #define SSH2_FXP_EXTENDED		200
66 #define SSH2_FXP_EXTENDED_REPLY		201
67 
68 /* attributes */
69 #define SSH2_FILEXFER_ATTR_SIZE		0x00000001
70 #define SSH2_FILEXFER_ATTR_UIDGID	0x00000002
71 #define SSH2_FILEXFER_ATTR_PERMISSIONS	0x00000004
72 #define SSH2_FILEXFER_ATTR_ACMODTIME	0x00000008
73 #define SSH2_FILEXFER_ATTR_EXTENDED	0x80000000
74 
75 /* portable open modes */
76 #define SSH2_FXF_READ			0x00000001
77 #define SSH2_FXF_WRITE			0x00000002
78 #define SSH2_FXF_APPEND			0x00000004
79 #define SSH2_FXF_CREAT			0x00000008
80 #define SSH2_FXF_TRUNC			0x00000010
81 #define SSH2_FXF_EXCL			0x00000020
82 
83 /* statvfs@openssh.com f_flag flags */
84 #define SSH2_FXE_STATVFS_ST_RDONLY	0x00000001
85 #define SSH2_FXE_STATVFS_ST_NOSUID	0x00000002
86 
87 /* status messages */
88 #define SSH2_FX_OK			0
89 #define SSH2_FX_EOF			1
90 #define SSH2_FX_NO_SUCH_FILE		2
91 #define SSH2_FX_PERMISSION_DENIED	3
92 #define SSH2_FX_FAILURE			4
93 #define SSH2_FX_BAD_MESSAGE		5
94 #define SSH2_FX_NO_CONNECTION		6
95 #define SSH2_FX_CONNECTION_LOST		7
96 #define SSH2_FX_OP_UNSUPPORTED		8
97 #define SSH2_FX_MAX			8
98 
99 struct passwd;
100 
101 int	sftp_server_main(int, char **, struct passwd *);
102 void	sftp_server_cleanup_exit(int) __attribute__((noreturn));
103