| rev |
line source |
|
pankso@1
|
1 SliTaz Secure File Storage
|
|
pankso@1
|
2 ===============================================================================
|
|
pankso@1
|
3
|
|
pankso@1
|
4
|
|
paul@11
|
5 Ssfs is personal, secure, fast and light online file storage powered by
|
|
paul@11
|
6 SSH, Rsync, Lsyncd and SHell script. It monitors a local folder and automatically
|
|
paul@11
|
7 synchronizes the remote server. When files are transferred they are compressed and
|
|
paul@11
|
8 encrypted with SSH. Connections to the remote host are automated with a RSA key,
|
|
paul@11
|
9 and for each client the key must be sent to the server via a SSH password login.
|
|
pankso@1
|
10
|
|
paul@11
|
11 Using ssfs lets you have a live synchronized and secure folder between many
|
|
paul@11
|
12 computers with an online copy on a secure Linux server. But even without any
|
|
paul@11
|
13 connections you have access to your files. Connections to the remote server
|
|
pankso@1
|
14 can also be done using the command line and 'ssh' from any clients such as
|
|
pankso@1
|
15 BSD, Android, OSX or Windows via Putty.
|
|
pankso@1
|
16
|
|
paul@11
|
17 Ssfs is very easy to install, setup and configure to make your own secure online
|
|
paul@30
|
18 file storage. It provides a cmdline tool for the client and server with a
|
|
paul@11
|
19 built in help. This README is also a howto in itself.
|
|
pankso@1
|
20
|
|
pankso@1
|
21 On the server side admin can choose by creating standard accounts or chrooted
|
|
paul@11
|
22 accounts which enforce server security by restricting available commands in a
|
|
pankso@1
|
23 minimal chroot environment. User $HOME should be set to 0700 so users can't see
|
|
pankso@1
|
24 other users files.
|
|
pankso@1
|
25
|
|
pankso@1
|
26
|
|
pankso@14
|
27 Overview
|
|
pankso@14
|
28 --------
|
|
pankso@14
|
29
|
|
pankso@14
|
30 * Online live sync with encrypted data
|
|
paul@30
|
31 * Drop files in a folder and they will be synced
|
|
paul@30
|
32 * Even without any connection you have your data
|
|
pankso@17
|
33 * Fast and light using stable and mature GNU tools
|
|
pankso@48
|
34 * Encrypted file tranfert using SSH protocol
|
|
pankso@17
|
35 * Easy to setup on the client and server side
|
|
paul@30
|
36 * Virtual disk for storage with a minimal chroot
|
|
pankso@48
|
37 * Command line chrooted SSH access for users
|
|
pankso@17
|
38 * Easy to backup, update and maintain vdisk
|
|
pankso@14
|
39
|
|
pankso@14
|
40
|
|
pankso@16
|
41 Quick start guide
|
|
pankso@16
|
42 -----------------
|
|
pankso@16
|
43
|
|
pankso@16
|
44 * Install ssfs on server and clients if not yet done
|
|
pankso@16
|
45 * Create a vdisk on server # ssfs-server gen-vdisk
|
|
pankso@16
|
46 * Check if chroot works (exit to quit) # ssfs-server chroot
|
|
pankso@16
|
47 * Add a chrooted user to the Ssfs virtual disk so it can sync
|
|
pankso@16
|
48 files or connect via SSH from a client:
|
|
pankso@16
|
49 # ssfs-server adduser --login=demo --id=2000 --pass=demo
|
|
pankso@16
|
50 * On the client side: ssfs-box setup or from the cmdline:
|
|
pankso@16
|
51 $ ssfs setup --login=demo --host="server name or ip"
|
|
paul@30
|
52 * On the client you can start ssfs on user login via the WM
|
|
paul@30
|
53 autostart script and/or the command $ ssfs sync
|
|
pankso@23
|
54 * Get support and show your love for Ssfs on SCN group:
|
|
pankso@23
|
55 http://scn.slitaz.org/groups/ssfs/
|
|
pankso@16
|
56
|
|
pankso@16
|
57
|
|
pankso@1
|
58 Installation
|
|
pankso@1
|
59 ------------
|
|
paul@11
|
60 To work you need a SSH client, 'rsync' and 'lsyncd' installed. On SliTaz you
|
|
paul@11
|
61 can simply install ssfs and it's dependencies or 'make install' from the
|
|
pankso@8
|
62 source directory (see the Development section).
|
|
pankso@1
|
63
|
|
pankso@1
|
64
|
|
pankso@1
|
65 Client help and setup
|
|
pankso@1
|
66 ---------------------
|
|
paul@11
|
67 The cmdline interface ssfs lets you setup a client and start the daemon and
|
|
paul@11
|
68 synchronize live with your system session via the Window Manager autostart
|
|
paul@11
|
69 script or your personal ~/.profile file. To get a list of commands with
|
|
pankso@8
|
70 a short description:
|
|
pankso@1
|
71
|
|
pankso@1
|
72 $ ssfs help
|
|
pankso@1
|
73
|
|
pankso@1
|
74 To setup a client by creating a Lua configuration file and sending the RSA key
|
|
pankso@1
|
75 to the server, you can use the command 'setup'. Setup needs a login name and
|
|
paul@11
|
76 server name or IP address and it will also create a secure RSA if none exists:
|
|
pankso@1
|
77
|
|
pankso@1
|
78 $ ssfs setup --login=user --host=server
|
|
pankso@1
|
79
|
|
pankso@1
|
80
|
|
pankso@1
|
81 GUI & Web interface
|
|
pankso@1
|
82 -------------------
|
|
paul@11
|
83 Actually there is a small GTK/Yad but no web interface. The tool ssfs-box will
|
|
paul@30
|
84 display info if a configuration file exists or start the setup box. There is no
|
|
pankso@21
|
85 plan for a users files web interface since security if more important, actually
|
|
paul@30
|
86 a user's home has 0700 mode so a standard web server running user www can't see
|
|
paul@30
|
87 the files. We may implement a HTTP Public dir which could handle xHTML pages, a
|
|
pankso@26
|
88 wiki, etc.
|
|
pankso@1
|
89
|
|
pankso@1
|
90
|
|
pankso@31
|
91 Ssfs chroot SHell
|
|
pankso@31
|
92 -----------------
|
|
paul@33
|
93 The tool ssfs-sh is used to chroot a user on login and sets minimal environment
|
|
paul@33
|
94 variables. For each user ssfs-sh is the default SHell on the server and is
|
|
pankso@31
|
95 executed inside the new root. So ssfs-sh must be installed on the server and
|
|
pankso@31
|
96 in the virtual disk minimal chroot. Using a custom tool such as Ssfs SHell
|
|
paul@33
|
97 enforces security and lets you execute commands on login, ssfs-sh also exports the
|
|
paul@33
|
98 new user $HOME and changes the directory to it since chroot will drop us in / by
|
|
pankso@31
|
99 default.
|
|
pankso@31
|
100
|
|
pankso@31
|
101
|
|
pankso@1
|
102 Get configs on boot
|
|
pankso@1
|
103 -------------------
|
|
paul@30
|
104 Ssfs can be used in a boot script to connect to a remote host and retrieve data
|
|
paul@11
|
105 before a user session is started. It can be useful to provide persistent data for
|
|
pankso@1
|
106 Live systems and web boot.
|
|
pankso@1
|
107
|
|
pankso@1
|
108
|
|
pankso@20
|
109 Quota management
|
|
pankso@20
|
110 ----------------
|
|
paul@30
|
111 Actually the quota storage is based on a shared idea, the vdisk has a size and
|
|
paul@30
|
112 all users share the space. For a pay service the vdisk can grow following the
|
|
pankso@20
|
113 users donations or monthly subscription.
|
|
pankso@20
|
114
|
|
pankso@20
|
115
|
|
pankso@1
|
116 Server setup
|
|
pankso@1
|
117 ------------
|
|
pankso@1
|
118 On the server you must have a SSH server running and an user account with a
|
|
paul@30
|
119 ~/Sync folder in user home. You can have both, standard accounts or chrooted
|
|
paul@30
|
120 accounts, for a hosted service it is recommended to use a chroot and a Ssfs
|
|
pankso@13
|
121 virtual disk. The vdisk can be any size you want and have a minimal chroot
|
|
pankso@13
|
122 environment that is under 3Mb.
|
|
pankso@1
|
123
|
|
paul@30
|
124 If you want to create a vdisk and chroot automatically you can use use the tool
|
|
pankso@13
|
125 ssfs-server. Here is a short example to create a chroot and create a user
|
|
pankso@13
|
126 login 'tux-sync' with a protected $HOME in the chroot, the root directory can
|
|
pankso@13
|
127 be specified on the command line or changed in the configuration file. The
|
|
paul@30
|
128 vdisk creation size is set in Gb and can be changed in the config file or from
|
|
pankso@13
|
129 the cmdline:
|
|
pankso@13
|
130
|
|
pankso@13
|
131 # ssfs-server gen-vdisk --size=2
|
|
pankso@1
|
132 # ssfs-server adduser --login=tux-sync --id=2000 --pass=tuX0cc
|
|
pankso@1
|
133
|
|
paul@11
|
134 Users can be listed or completely deleted including all files in home. More
|
|
pankso@23
|
135 information can be found with the built in help:
|
|
pankso@23
|
136
|
|
pankso@23
|
137 # ssfs-server help
|
|
pankso@1
|
138
|
|
pankso@1
|
139
|
|
pankso@13
|
140 Ssfs virtual disk
|
|
pankso@13
|
141 -----------------
|
|
pankso@13
|
142 A virtual Ssfs disk is a raw file created with dd and formated in ext3. It is
|
|
paul@30
|
143 mounted by default on /ssfs and contains a minimal chroot environment with a user's
|
|
paul@30
|
144 home directory. We use a virtual disk to enforce security and use a separate
|
|
paul@30
|
145 media for Ssfs secure files, it also protects the host and limits storage size.
|
|
paul@30
|
146 The tool ssfs-server handles vdisk creation but you can also create one manually
|
|
paul@30
|
147 or use a separate HD if the server has more than one disk. To create a 2Gb
|
|
pankso@13
|
148 vdisk and format it to ext3:
|
|
pankso@13
|
149
|
|
pankso@21
|
150 # dd if=/dev/zero of=/home/ssfs.disk bs=1G count=2
|
|
pankso@13
|
151 # mkfs.ext3 -T ext3 -L "Ssfs" -F /home/ssfs.ext3
|
|
pankso@13
|
152
|
|
pankso@13
|
153 Now you have a virtual disk you can mount it, the path must match SSFS_CHROOT
|
|
pankso@13
|
154 found in ssfs-server.conf, default mount point is /ssfs to clearly separate
|
|
pankso@13
|
155 the filesystem from the standard host file hierarchy:
|
|
pankso@13
|
156
|
|
pankso@13
|
157 # mkdir /ssfs
|
|
pankso@21
|
158 # mount -o loop -t ext3 /home/ssfs.disk /ssfs
|
|
pankso@13
|
159
|
|
pankso@13
|
160 To automaticaly mount the vdisk on boot you may want to add a ssfs system user
|
|
pankso@13
|
161 and a line into the file /etc/fstab:
|
|
pankso@13
|
162
|
|
pankso@13
|
163 # adduser -S -g "Ssfs Server" -h /ssfs -s /bin/false ssfs
|
|
pankso@21
|
164 /home/ssfs.disk /ssfs ext3 rw,loop,ssfs,ssfs 0 0
|
|
pankso@13
|
165
|
|
pankso@20
|
166
|
|
pankso@1
|
167 Server users config
|
|
pankso@1
|
168 -------------------
|
|
pankso@1
|
169 When adding a user with 'ssfs-server adduser', the user is added to the host
|
|
pankso@1
|
170 /etc/passwd and a custom user config file is created in SSFS_USERS with the
|
|
pankso@10
|
171 login name.
|
|
pankso@1
|
172
|
|
pankso@1
|
173
|
|
pankso@26
|
174 Server web interface
|
|
pankso@26
|
175 --------------------
|
|
paul@30
|
176 Ssfs package provides a small CGI SHell web interface to the server. The goal is
|
|
paul@30
|
177 to provide a service status and information. It uses the server configuration to
|
|
paul@30
|
178 know the Ssfs virtual disk path and display statistics about the filesystem.
|
|
pankso@26
|
179
|
|
pankso@26
|
180
|
|
pankso@1
|
181 Development and Bugs
|
|
pankso@1
|
182 --------------------
|
|
paul@11
|
183 If you want to install the latest code to test and help in development you can
|
|
paul@11
|
184 clone the ssfs Mercurial repository. As usual, closely follow the SliTaz light
|
|
pankso@25
|
185 philosophy with speed and security in mind: hg clone http://hg.slitaz.org/ssfs
|
|
pankso@1
|
186
|
|
paul@11
|
187 Install with 'make install' (DESTDIR is supported for packaging), update the POT
|
|
paul@11
|
188 file if any new strings have been added with 'make pot', and merger PO files with
|
|
paul@11
|
189 the command 'make msgmerge'. Any ideas are welcome and can be discussed. If you
|
|
pankso@1
|
190 are searching for something to do you can have a look to the TODO file :-)
|
|
pankso@1
|
191
|
|
pankso@13
|
192 Bugs can be reported on the SliTaz mailing list, forum or scn since the devel
|
|
paul@30
|
193 forum is synced. All sites are linked from: http://www.slitaz.org/
|
|
pankso@1
|
194
|
|
paul@30
|
195 To share ideas and get involved in the Ssfs project you can join the Ssfs group
|
|
pankso@23
|
196 on the SliTaz Community Network website : http://scn.slitaz.org/groups/ssfs/
|
|
pankso@23
|
197
|
|
pankso@1
|
198
|
|
pankso@1
|
199 ===============================================================================
|
|
pankso@1
|
200
|