Skip to content

Commit

Permalink
Add some default users
Browse files Browse the repository at this point in the history
  • Loading branch information
taylorific committed Jun 15, 2024
1 parent ea67dd8 commit 898333d
Show file tree
Hide file tree
Showing 15 changed files with 606 additions and 0 deletions.
1 change: 1 addition & 0 deletions cookbooks/boxcutter_init/metadata.rb
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
'fb_screen',
'fb_sdparm',
'fb_securetty',
'fb_ssh',
'fb_storage',
'fb_stunnel',
'fb_sudo',
Expand Down
1 change: 1 addition & 0 deletions cookbooks/boxcutter_init/recipes/default.rb
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
include_recipe 'fb_launchd'
end
include_recipe 'fb_nsswitch'
include_recipe 'fb_ssh'
# HERE: ssh
include_recipe 'fb_less'
if node.linux? && !node.embedded? && !node.container?
Expand Down
1 change: 1 addition & 0 deletions cookbooks/boxcutter_site_settings/recipes/default.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
# limitations under the License.

node.default['fb_users']['user_defaults']['gid'] = 'boxcutter'
include_recipe 'boxcutter_users'

if node.ubuntu?
# us.archive.ubuntu.com and the core Ubuntu repositories do not have ARM
Expand Down
29 changes: 29 additions & 0 deletions cookbooks/boxcutter_users/recipes/default.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,32 @@
# 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.

caretakers = {
'sheila' => '1001',
'taylor' => '1002',
}

caretakers.each do |user, uid|
user user do
uid uid
group 'users'
home "/home/#{user}"
manage_home true
shell '/bin/bash'
end
end

group 'sudo' do
members caretakers.keys
system true
gid 1000
end

node.default['fb_sudo']['users']['%sudo']['dont prompt for password'] = 'ALL=NOPASSWD: ALL'

node.default['fb_ssh']['enable_central_authorized_keys'] = true
# node.default['fb_ssh']['enable_central_authorized_principals'] = true

node.default['fb_ssh']['authorized_keys']['taylor']['mahowald'] = 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDBZjVID1mAqZyhD3p0VbJtidKAxMHUwLmEMaCAJX0UN mahowald'
node.default['fb_ssh']['authorized_keys']['sheila']['sheila'] = 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINy9cJcJl8oN6bRtcBc4RZq8f/T6P1AFR3YS1YRYi5YY sheila'
175 changes: 175 additions & 0 deletions cookbooks/fb_ssh/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
fb_ssh Cookbook
===============
Installs and configures openssh

Requirements
------------

Attributes
----------
* node['fb_ssh']['manage_packages']
* node['fb_ssh']['sshd_config'][$CONFIG]
* node['fb_ssh']['ssh_config'][$CONFIG]
* node['fb_ssh']['enable_central_authorized_keys']
* node['fb_ssh']['authorized_keys_users']
* node['fb_ssh']['enable_central_authorized_principals']
* node['fb_ssh']['authorized_principals'][$USER][$KEYNAME]
* node['fb_ssh']['authorized_principals_users']

Usage
-----
### Packages
By default `fb_ssh` will install and keep updated both client and server
packages for ssh.

You can skip package management if you have local packages or otherwise need to
do your own management by setting `manage_packages` to false.

Given the many ways to manage packages on Windows, especially for SSH,
we default `manage_packages` to false on Windows.

### Server configuration (sshd_config)
The `sshd_config` hash holds configs that go into `/etc/ssh/sshd_config`. In
general each key can have one of three types, bool, string/ints, or array.

Bools are translated into `yes`/`no` when emitted into the config file. These
are straight-forward:

```ruby
node.default['fb_ssh']['sshd_config']['PubkeyAuthentication'] = true
```

Becomes:

```text
PubkeyAuthentication yes
```

Strings and ints are always treated like normal strings:

```ruby
node.default['fb_ssh']['sshd_config']['ClientAliveInterval'] = 0
node.default['fb_ssh']['sshd_config']['ForceCommand'] = '/bin/false'
```

Becomes:

```text
ClientAliveInterval 0
ForceCommand /bin/false
```

Arrays will be joined by spaces. It's worth noting that while this feature is
here to make management easy, one could clearly take a multi-value value key
and make it a string and it would work, but we support arrays to make modifying
the value later in the runlist easier. For example:

```ruby
node.default['fb_ssh']['sshd_config']['AuthorizedKeysFile'] = [
'.ssh/authorized_keys',
'.ssh/authorized_keys2',
]
```

Means later it's easy for someone to do:

```ruby
node.default['fb_ssh']['sshd_config']['AuthorizedKeysFile'].
delete('.ssh/authorized_keys2')
```

or:

```ruby
node.default['fb_ssh']['sshd_config']['AuthorizedKeysFile'] <<
'/etc/ssh/authorized_keys/%u'
```

So be careful to be consistent about this.

### Match Values
All match rules in sshd must come at the end, because Match blocks take effect
until the next match block, or the end of the file - indentation is irrelevant.

You can use Match rules as normal. This cookbook will automatically move them
to the end of the file and keep them in the order that the users specified
them.

This means that unlike the other keys which are sorted for easier diffing,
these are not sorted. As such, changing the order of your cookbooks could
change the order of your match statements, so be careful.

Match statements are the exception to the datatype rule above - their value is
a hash, and that hash is treated the same as the top-level sshd_config hash:

```ruby
node.default['fb_ssh']['sshd_config']['Match Address 1.2.3.4'] => {
'PasswordAuthentication' => true,
}
```

#### Authorized Principals

If you set `enable_central_authorized_principals` to true, then two things will
happen:
1. Your AuthorizedPrincipalsFile will be set to `/etc/ssh/authorized_princs/%u`,
regardless of what you set it to
2. The contents of `node['fb_ssh']['authorized_principals']` will be used
to populate `/etc/ssh/authorized_princs/` with one file for each
user. To limit which users are populated, simply populate the list
`node['fb_ssh']['authorized_principals_users']`. The format of the
`authorized_principals` attribute is:

```ruby
node.default['fb_ssh']['authorized_principals'][$USER] = ['one', 'two']
```

#### Authorized Keys

These work similarly to Authorized Principals. If you set
`enable_central_authorized_keys` to true, then two things will happen:
1. Your AuthorizedKeysFile will be set to `/etc/ssh/authorized_keys/%u`,
regardless of what you set it to
2. The contents of the databag `fb_ssh_authorized_keys`
will be used to populate `/etc/ssh/authorized_keys/` with key files for each
user. To limit which keys go on a user, simply populate the list
`node['fb_ssh']['authorized_keys_users']`. The format of the items
in databag is:

```ruby
{
'id': $USER,
'keyname1': $KEY1,
'keyname2': $KEY2,
...
}
```

There should be one item for each user, as many keys as you'd like may
be in that item.

Alternatively you can populate `node['fb_ssh']['authorized_keys'][$USER]`.
Doing so should be done similarly to the databags and each key given a name:

```ruby
node.default['fb_ssh']['authorized_keys']['john']['key1'] = '...'
```

Anything in the node overrides databags.

*NOTE FOR WINDOWS USERS*: On Windows the keys are managed in the homedirectory,
not in a central location. This is because usernames are often in the format of
`domain\user`, which means that `%u` causes sshd to expand the path to
`C:\ProgramData\ssh\authorized_keys\domain\\user`, which is an illegal filename
you can never make.

### Client config (ssh_config)
The client config works the same as the server config, except the special-case
is `Host` keys instead of `Match` keys. As an example:

```ruby
node.default['fb_ssh']['ssh_config']['ForwardAgent'] = true
node.default['fb_ssh']['ssh_config']['Host *.cool.com'] = {
'ForwardX11' => true,
}
```
47 changes: 47 additions & 0 deletions cookbooks/fb_ssh/attributes/default.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
#
# Copyright (c) 2019-present, Vicarious, Inc.
# All rights reserved.
#
# 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.
#

sftp_path = value_for_platform_family(
['rhel', 'fedora'] => '/usr/libexec/openssh/sftp-server',
['debian'] => '/usr/lib/openssh/sftp-server',
)

# centos6 only supports 1...
if node.centos6?
auth_keys = '.ssh/authorized_keys'
else
auth_keys = [
'.ssh/authorized_keys',
'.ssh/authorized_keys2',
]
end

default['fb_ssh'] = {
'enable_central_authorized_keys' => false,
'manage_packages' => !node.windows?,
'sshd_config' => {
'PermitRootLogin' => false,
'UsePAM' => true,
'Subsystem sftp' => sftp_path,
'AuthorizedKeysFile' => auth_keys,
},
'authorized_keys' => {},
'authorized_keys_users' => [],
'authorized_principals' => {},
'authorized_principals_users' => [],
'ssh_config' => {},
}
29 changes: 29 additions & 0 deletions cookbooks/fb_ssh/libraries/default.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#
# Copyright (c) 2019-present, Vicarious, Inc.
# All rights reserved.
#
# 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.
#

module FB
class SSH
def self.confdir(node)
node.windows? ? 'C:/ProgramData/ssh' : '/etc/ssh'
end

DESTDIR = {
'keys' => 'authorized_keys',
'principals' => 'authorized_princs',
}.freeze
end
end
30 changes: 30 additions & 0 deletions cookbooks/fb_ssh/metadata.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#
# Copyright (c) 2019-present, Vicarious, Inc.
# All rights reserved.
#
# 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.
#

name 'fb_ssh'
maintainer 'Facebook'
maintainer_email 'noreply@facebook.com'
license 'Apache-2.0'
description 'Configures ssh and sshd including keys and principals'
source_url 'https://github.com/facebook/chef-cookbooks/'
long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
# never EVER change this number, ever.
version '0.1.0'
supports 'centos'
supports 'debian'
supports 'ubuntu'
supports 'windows'
Loading

0 comments on commit 898333d

Please sign in to comment.