Description

Creates SSH authorized keys files in user home directories.

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

Requirements

Supported Platforms

This cookbook has been tested on the following platforms:

• Amazon Linux
• Debian
• CentOS
• Fedora
• FreeBSD
• RedHat
• Suse
• Ubuntu

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

Definitions

ssh_authorize_key

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

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 'bob@acme.com' do
  key 'AAAAB3NzaC1yc2EAAAADAQABAAABAQCctNyRouVDhzjiP[...]'
  user 'root'
end

ssh_authorize_key 'alice@acme.com' do
  key 'AAAAB3NzaC1yc2EAAAADAQABAAABAQCySLKbpFRGCrKU/[...]'
  user 'alice'
end

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 'bob@acme.com' do
  key 'AAAAB3NzaC1yc2EAAAADAQABAAABAQCctNyRouVDhzjiP[...]'
  user 'root'
  options(
    'no-port-forwarding' => true,
    'no-agent-forwarding' => true,
    'no-X11-forwarding' => true,
    command:
      'echo \'Please login as the user "bob" rather than the user "root".\''\
      ';echo;sleep 10'
  )
end

Reading the Keys from a Data Bag

For example, from the following data bag item:

{
  "id": "users",
  "bob@acme.com": {
    "key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQCctNyRouVDhzjiP[...]",
    "user": "root"
  },
  "alice@acme.com": {
    "key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQCySLKbpFRGCrKU/[...]",
    "user": "alice"
  }
}

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

users = data_bag_item('ssh', 'users')
users.delete('id')

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

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.

Attributes

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

Testing

See TESTING.md.

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$/)
end

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')
end

Contributing

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

See CONTRIBUTING.md.

TODO

See TODO.md.

License and Author

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.