Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

encryptfs (2) Versions 1.0.1

LWRP to manage encrypted one-boot-use filesystems for sensitive information on untrusted hardware or cloud appliances.

Berkshelf/Librarian
Policyfile
Knife
cookbook 'encryptfs', '~> 1.0.1'
cookbook 'encryptfs', '~> 1.0.1', :supermarket
knife cookbook site install encryptfs
knife cookbook site download encryptfs
README
Dependencies
Quality 44%

Description

This cookbook contains an LWRP to manage one-time-use encrypted filesystem using the cryptsetup package in Debian and Ubuntu. On each boot, a filesystem-in-a-file will be created, mounted as a loop device, encrypted via cryptsetup with a randomly-generated key that isn't stored anywhere, and mounted for use. It isn't necessary to reboot for the filesystem resources to become available, but they will be created anew each time a machine reboots.

The intended purpose of this cookbook is for deploying servers which will handle sensitive information on untrusted systems or cloud deployments, so that the filesystems themselves will not be readable outside the running instance. Information stored in the encrypted filesystem will be irretrievable after reboot.

Requirements

Platform

Tested on: * Debian 6.0 * Ubuntu 12.04

This cookbook will only work on Debian or Ubuntu systems if the cryptsetup package is available. The cryptsetup package will be installed if it's not already present.

Attributes

  • node['encryptfs'['uninstall_cryptsetup_iflast'] - Sets the cookbook to remove the cryptsetup packages after the last filesystem is removed from /etc/crypttab. Default is false, to leave the packages installed. Only the cryptsetup and cryptsetup-bin packages will be uninstalled if this is true.
  • node['encryptfs']['cryptdisks_path'] node['encryptfs']['cryptdisks_stop'] node['encryptfs']['cryptdisks_start'] - All used to set paths for the scripts that are part of the cryptsetup package. They are in a different place in Ubuntu.

Recipes

default

The default recipe won't do anything.

example

This represents an example of creating a few small encrypted filesystems. You really should be using this cookbook only as an LWRP.

Resource/Provider

This cookbook includes an LWRP, encryptfs, for managing one-time-use encrypted filesystems.

encryptfs "data" do
  size 100
  filepath "/cryptfs"
  mountpath "/usr/local/cryptdata"
  action :create
end

The size is specified in megabytes. The filepath is where the file of that size is to be created in your existing filesystems. That file will become a loop device containing the encrypted block data. The mountpath will be where the encrypted filesystem is to be mounted. The LWRP supports both :create and :delete actions.

Usage

Put the following in your cookbook's metadata.rb file to include this LWRP:

depends "encryptfs"

The following added to your recipes will create an encrypted filesystem:

encryptfs "data" do
  size 100
  filepath "/cryptfs"
  mountpath "/usr/local/cryptdata"
  fstype "ext4"
  action :create
end

The following added to your recipe will delete an encrypted filesystem:

encryptfs "data" do
  action :delete
end

License and Authors

Author: Neil Schelly (@neilschelly)

Copyright 2013, Dyn, Inc (@DynInc)

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.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric
            

1.0.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

1.0.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

1.0.1 failed this metric

FC059: LWRP provider does not declare use_inline_resources: encryptfs/providers/default.rb:1
FC064: Ensure issues_url is set in metadata: encryptfs/metadata.rb:1
FC065: Ensure source_url is set in metadata: encryptfs/metadata.rb:1
FC066: Ensure chef_version is set in metadata: encryptfs/metadata.rb:1
FC069: Ensure standardized license defined in metadata: encryptfs/metadata.rb:1
Run with Foodcritic Version 12.2.1 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

1.0.1 failed this metric

encryptfs does not have a valid open source license.
Acceptable licenses include Apache-2.0, apachev2, Apache 2.0, MIT, mit, GPL-2.0, gplv2, GNU Public License 2.0, GPL-3.0, gplv3, GNU Public License 3.0.

No Binaries Metric
            

1.0.1 passed this metric

Publish Metric
            

1.0.1 passed this metric

Supported Platforms Metric
            

1.0.1 passed this metric

Testing File Metric
            

1.0.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

1.0.1 passed this metric