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

Select Status


ssh_authorized_keys (5) Versions 0.3.0

Creates SSH authorized keys files in user home directories.

cookbook 'ssh_authorized_keys', '= 0.3.0', :supermarket
cookbook 'ssh_authorized_keys', '= 0.3.0'
knife supermarket install ssh_authorized_keys
knife supermarket download ssh_authorized_keys
Quality 71%

SSH Authorized Keys Cookbook

Cookbook Version
GitHub Source
Dependency Status
Code Climate
Build Status
Coverage Status
Inline docs

Chef cookbook to create SSH authorized keys files in user home directories.

Tries to avoid generating a corrupt file that could render your server inaccessible.


Supported Platforms

This cookbook has been tested on the following platforms:

  • Amazon Linux
  • Debian
  • CentOS
  • Fedora
  • FreeBSD
  • openSUSE
  • RedHat
  • SUSE
  • Ubuntu

Please, let us know if you use it successfully on any other platform.



Authorize a key for public key authentication using SSH.

Warning: This definition uses the Accumulator Pattern. This implies that any SSH key added using other methods (such as keys added by hand) will be deleted.

ssh_authorize_key Parameters

Parameter Default Description
user nil System user (required).
group user System group.
home calculated System user home path.
key nil SSH public key in base64 (required).
keytype 'ssh-rsa' SSH key type.
comment definition name SSH key comment.
options nil SSH key options as a hash.

Usage Examples

First of all, don't forget to include the ssh_authorized_keys cookbook as a dependency in the cookbook metadata:

# metadata.rb
# [...]

depends 'ssh_authorized_keys'

You can use the ssh_authorize_key to authorize SSH public keys to use SSH public key authentication:

# Bob is the admin here.

ssh_authorize_key '' do
  key 'AAAAB3NzaC1yc2EAAAADAQABAAABAQCctNyRouVDhzjiP[...]'
  user 'root'

ssh_authorize_key '' do
  user 'alice'

Setting the SSH Key Options Field

You can set the options field as follows:

# As the root user by default in ubuntu:
ssh_authorize_key '' do
  key 'AAAAB3NzaC1yc2EAAAADAQABAAABAQCctNyRouVDhzjiP[...]'
  user 'root'
    'no-port-forwarding' => true,
    'no-agent-forwarding' => true,
    'no-X11-forwarding' => true,
      'echo \'Please login as the user "bob" rather than the user "root".\''\
      ';echo;sleep 10'

Reading the Keys from a Data Bag

For example, from the following data bag item:

  "id": "users",
  "": {
    "key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQCctNyRouVDhzjiP[...]",
    "user": "root"
  "": {
    "user": "alice"

You can read the data bag item from a recipe as follows:

users = data_bag_item('ssh', 'users')

users.each do |name, ssh_key|
  ssh_authorize_key name do
    key ssh_key['key']
    user ssh_key['user']

See the data bags DSL documentation for a more detailed explanation and the data bags knife documentation to learn how to create a data bag.


These attributes are primarily intended to support the different platforms. Do not touch them unless you know what you are doing.

Attribute Default Description
node['ssh_authorized_keys']['keytypes'] calculated Allowed SSH key types.



ChefSpec Tests

To create ChefSpec tests for the ssh_authorize_key definition, you can use the render_file matcher to check the authorized_keys file content:

it 'allows bob to login as root' do
  expect(chef_run).to render_file('/root/.ssh/authorized_keys')
    .with_content(/^ssh-rsa [A-Za-z0-9+\/=]+ bob@acme\.com$/)

You can also test against the internal template:

it 'creates ~bob/.ssh/authorized_keys file' do
  expect(chef_run).to create_template('/home/bob/.ssh/authorized_keys')


Please do not hesitate to open an issue with any questions or problems.




License and Author

Author: Raul Rodriguez (
Author: Xabier de Zuazo (
Contributor: Ong Ming Yang
Copyright: Copyright (c) 2015, Xabier de Zuazo
Copyright: Copyright (c) 2015, Onddo Labs, SL.
License: Apache License, Version 2.0
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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

ssh_authorized_keys CHANGELOG

This file is used to list changes made in each version of the ssh_authorized_keys cookbook.

v0.3.0 (2015-08-14)

  • Use gid from Etc.getpwnam (issue #3, thanks Ong Ming Yang).
  • Recursively create .ssh directory if it does not exist (issue #4, thanks Ong Ming Yang).
  • Update chef links to use domain.
  • Update contact information and links after migration.
  • Gemfile: Update RuboCop to version 0.33.0.
  • README: Add Gemnasium and GitHub badge.

v0.2.0 (2015-05-27)

  • Sort keys always in the same order (issue #2, thanks to Chris Burroughs for the idea).
  • Add openSUSE as supported platform.
  • Run unit tests agains Chef 11 and Chef 12.

v0.1.0 (2015-01-11)

  • Initial release of ssh_authorized_keys.

Collaborator Number Metric

0.3.0 failed this metric

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

Contributing File Metric

0.3.0 passed this metric

Foodcritic Metric

0.3.0 failed this metric

FC064: Ensure issues_url is set in metadata: ssh_authorized_keys/metadata.rb:1
FC065: Ensure source_url is set in metadata: ssh_authorized_keys/metadata.rb:1
FC066: Ensure chef_version is set in metadata: ssh_authorized_keys/metadata.rb:1
FC069: Ensure standardized license defined in metadata: ssh_authorized_keys/metadata.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric

0.3.0 passed this metric

No Binaries Metric

0.3.0 passed this metric

Testing File Metric

0.3.0 passed this metric

Version Tag Metric

0.3.0 passed this metric