Update

Add virtual support to this cookbook. Please use the original cookbook for local user support.

Description

A vsftpd Chef cookbook to install and configure a standard vsftpd installation.

Requirements

Platform:

CentOS
RHEL
Debian
Ubuntu

Cookbooks:

No other cookbooks required

Attributes

Attribute	Description	Default
`node['vsftpd']['enabled']`	Enable and start vsftpd after installation	`true`
`node['vsftpd']['etcdir']`	Where to store additional configuration files	`/etc/vsftpd`
`node['vsftpd']['allowed']`	Array of virtual users that are allowd to connect via FTP	`[ ]`
`node['vsftpd']['password']`	Key pairs for username and password to access FTP	`{ }`
`node['vsftpd']['defaultpassword']`	Default password to access FTP if you're too lazy to specify one for each user	`iloverandompassword`
`default['vsftpd']['datafolder']`	The data folder, put FTP root to your home folder sometimes is not a good idea	`/data`
`node['vsftpd']['chroot']`	Array of users that will not be chroot'ed	`[ ]`
`node['vsftpd']['config']`	Configuration array with key/value pairs.	See Manpage for details

Recipes

vsftpd::default

Installs/configures vsftpd, includes some sub-tasks via include_recipe.

Example

vsftpd":{ "allowed":["ftpuser1"], "defaultpassword": "iloverandompassword", "home":{"ftpuser1":"FTPUser1Home"}, "password":{"ftpuser1":"differentpasswordfromdefault"} }, "run_list":["vsftpd"]} save this file to run.json and execute: $ sudo chef-solo -c solo.rb -j runlist.json You will get a new virtual user: ftpuser1 with password: differentpasswordfromdefault and home folder /data/FTPUser1Home

Known Issue

When using Ubuntu 12.04 or Debian Wheezy you will have issues with this cookbook and running chroot_local_users=YES in the configuration.

There are some workarounds to overcome this problem:

The basic gist of these articles:

revoke write permissions on the users home
setup a different chroot environment via passwd_chroot_enable=YES
install a patched version of the vsftpd 2.x branch and set allow_writeable_chroot=YES to ignore this error
use vsftpd 3.x and set allow_writeable_chroot=YES to ignore this error

Testing

The cookbook comes with some testing facilities allowing you to iterate quickly on cookbook changes.

Rake

You can execute the tests with Rake. The Rakefile provides the following tasks:

$ rake -T
rake chefspec    # Run ChefSpec examples
rake foodcritic  # Run Foodcritic lint checks
rake knife       # Run knife cookbook test
rake rubocop     # Run rubocop checks
rake test        # Run all tests

Bundler

If you prefer to let Bundler install all required gems (you should), run the tests this way:

$ # I like to install them in a parent folder so all cookbooks can use it
$ bundle install --path=../vendor/bundle
$ bundle exec rake test

Berkshelf

Berkshelf is used to set up the cookbook and its dependencies (as defined in Berksfile) prior to testing with Rake and Vagrant.

Kitchen

This cookbook is using test-kitchen to create machines. You can review the boxes by using:

$ bundle exec kitchen list

To run the full kitchen suite included in this cookbook simply execute:

$ bundle exec kitchen test

You can also verify/converge/test any specific machine from the previous list output:

$ bundle exec kitchen verify <instance>

License and Author

Author:: Sebastian Grewe (sebastian.grewe@gmail.com)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

mouyigang/chef-vsftpd-1