Vendor the external cookbooks
Knife-Zero doesn't include Berkshelf support, so vendoring everything in the repo is convenient again
This commit is contained in:
174
cookbooks/users/CHANGELOG.md
Normal file
174
cookbooks/users/CHANGELOG.md
Normal file
@@ -0,0 +1,174 @@
|
||||
# users Cookbook CHANGELOG
|
||||
|
||||
This file is used to list changes made in each version of the users cookbook.
|
||||
|
||||
## 5.3.1 (2017-12-15)
|
||||
|
||||
- Remove special case for freebsd in favor of later shell validity check
|
||||
|
||||
## 5.3.0 (2017-12-07)
|
||||
|
||||
- Add check if user shell exists
|
||||
- Verify the shell is allowed on AIX
|
||||
- Add AIX as a supported platform
|
||||
|
||||
## 5.2.2 (2017-11-29)
|
||||
|
||||
- Add home directory base for solaris
|
||||
|
||||
## 5.2.1 (2017-10-31)
|
||||
|
||||
- Make sure ssh_keys can be an array or a string by converting strings to an array if they're passed
|
||||
|
||||
## 5.2.0 (2017-10-31)
|
||||
|
||||
- Require Chef 12.7+ as 12.5 and 12.6 had bugs in their custom resource implementation
|
||||
- Allow fetching one or more ssh_keys from a url
|
||||
|
||||
## 5.1.0 (2017-05-30)
|
||||
|
||||
- Keep ssh keys out of the chef logs
|
||||
- Improve docs and examples
|
||||
- Remove class_eval and require Chef 12.7+ as class_eval causes issues with later Chef 12 releases
|
||||
|
||||
## 5.0.0 (2017-04-17)
|
||||
|
||||
### Breaking changes
|
||||
|
||||
- The users_manage LWRP has been converted to a custom resource, which requires Chef 12.5 or later
|
||||
- The sysadmins recipe contains no resources now and will do nothing
|
||||
|
||||
### Other changes
|
||||
|
||||
- Added integration tests with Inspec
|
||||
- Fixed all deprecation warnings
|
||||
- Fixed group creation on macOS when the group already exists
|
||||
- Added suse platforms as supported in the metadata
|
||||
- Switched to a SPDX apache-2.0 license string
|
||||
- Moved all templates out of the default directory as we don't support Chef 11 anymore
|
||||
|
||||
## 4.0.3 (2016-11-23)
|
||||
|
||||
- Update manage provider to return true/false in guard block which avoids warnings during run on Chef 12.14+
|
||||
|
||||
## 4.0.2 (2016-11-18)
|
||||
|
||||
- Deprecate the sysadmins recipe
|
||||
|
||||
## 4.0.1 (2016-09-15)
|
||||
|
||||
- Fix creation of user home directory
|
||||
|
||||
## 4.0.0 (2016-09-15)
|
||||
|
||||
- Add chef_version to the metadata
|
||||
- Require Chef 12.1+
|
||||
- Testing updates
|
||||
- Fixed compatibility with Chef 12.14
|
||||
- Properly define the Chefspec matcher
|
||||
- Add a warning if someone includes users::default since that does nothing
|
||||
|
||||
## v3.0.0
|
||||
|
||||
- @onlyhavecans - Fix FreeBSD support
|
||||
- @stem - Fix user creation on Mac OS X on 10.7 and 10.8
|
||||
- Remove old style chef solo code to clean up rubocop issues, move to using cookstyle
|
||||
- Adding zlinux support
|
||||
|
||||
## v2.0.3
|
||||
|
||||
- @nkadel-skyhook - create .ssh directory only if keys are configured.
|
||||
- @signe - allow force parameter to be specified for users configured to be removed.
|
||||
- @FlorentFlament - adding the ability to manage groups for existing users.
|
||||
|
||||
## v2.0.2 (2016-1-25)
|
||||
|
||||
- @375gnu- validate uid/gid for strings versus numeric
|
||||
- fix rubocop errors based on <https://github.com/bbatsov/rubocop/issues/2608>
|
||||
- fix kitchen configurations for testing
|
||||
|
||||
## v2.0.1 (2016-1-8)
|
||||
|
||||
- Fixed provider to work on Mac OS X
|
||||
- funzoneq - add correct default shell for FreeBSD if not provided
|
||||
- Added kitchen.dokken to speed up platform testing
|
||||
|
||||
## v2.0.0 (2015-12-11)
|
||||
|
||||
- Removed Chef 10 compatibility code
|
||||
- Removed the nodes fqdn from the authorized_keys file
|
||||
- Removed a trailing comma in a readme example
|
||||
- Added chef standard .gitignore and chefignore files
|
||||
- Added chef standard .rubocop.yml file and resolved warnings
|
||||
- Resolved foodcritic warnings
|
||||
|
||||
## v1.8.2 (2015-03-18)
|
||||
|
||||
- No changes, just republishing 1.8.1
|
||||
|
||||
## v1.8.1 (2015-03-12)
|
||||
|
||||
- Add `source_url` and `issues_url` to the metadata.rb so Supermarket can display appropriate links
|
||||
|
||||
## v1.8.0 (2015-03-09)
|
||||
|
||||
- Expose LWRP state attributes
|
||||
- [COOK-4401] - Add unit tests with ChefSpec
|
||||
- [COOK-4404] - Determine file system and add manage_nfs_home_dirs attribute to disable managing NFS mounted home directories
|
||||
- Remove `converge_by` when creating home directory, the directory resource already handles this
|
||||
- Do not manage home directory if the path does not exist
|
||||
- Add integration with TravisCI
|
||||
- "Opscode" to "Chef" replacements
|
||||
- Retire unsupported Ruby 1.9.3 and add Ruby 2.2 to the Travis integration tests
|
||||
- Updates for RSpec 3
|
||||
|
||||
## v1.7.0 (2014-02-14)
|
||||
|
||||
- [COOK-4139] - users_manage resource always notifies
|
||||
- [COOK-4078] - users cookbook fails in why-run mode for .ssh directory
|
||||
- [COOK-3959] - Add support for Mac OS X to users cookbook
|
||||
|
||||
## v1.6.0
|
||||
|
||||
### Bug
|
||||
|
||||
- **[COOK-3744](https://tickets.opscode.com/browse/COOK-3744)** - Allow passing an action option via the `data_bag` to the user resource
|
||||
|
||||
## v1.5.2
|
||||
|
||||
### Bug
|
||||
|
||||
- **[COOK-3215](https://tickets.opscode.com/browse/COOK-3215)** - Make `group_id` optional
|
||||
|
||||
## v1.5.0
|
||||
|
||||
- [COOK-2427] - Mistakenly released instead of sudo :-).
|
||||
|
||||
## v1.4.0
|
||||
|
||||
- [COOK-2479] - Permit users cookbook to work with chef-solo if edelight/chef-solo-search is installed
|
||||
- [COOK-2486] - specify precedence when setting node attribute
|
||||
|
||||
## v1.3.0
|
||||
|
||||
- [COOK-1842] - allow specifying private SSH keys
|
||||
- [COOK-2021] - Empty default recipe for including users LWRPs
|
||||
|
||||
## v1.2.0
|
||||
|
||||
- [COOK-1398] - Provider manage.rb ignores username attribute
|
||||
- [COOK-1582] - ssh_keys should take an array in addition to a string separated by new lines
|
||||
|
||||
## v1.1.4
|
||||
|
||||
- [COOK-1396] - removed users get recreated
|
||||
- [COOK-1433] - resolve foodcritic warnings
|
||||
- [COOK-1583] - set passwords for users
|
||||
|
||||
## v1.1.2
|
||||
|
||||
- [COOK-1076] - authorized_keys template not found in another cookbook
|
||||
|
||||
## v1.1.0
|
||||
|
||||
- [COOK-623] - LWRP conversion
|
||||
2
cookbooks/users/CONTRIBUTING.md
Normal file
2
cookbooks/users/CONTRIBUTING.md
Normal file
@@ -0,0 +1,2 @@
|
||||
Please refer to
|
||||
https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD
|
||||
338
cookbooks/users/README.md
Normal file
338
cookbooks/users/README.md
Normal file
@@ -0,0 +1,338 @@
|
||||
# users Cookbook
|
||||
|
||||
[](http://travis-ci.org/chef-cookbooks/users) [](https://supermarket.chef.io/cookbooks/users)
|
||||
|
||||
Manages OS users from databags.
|
||||
|
||||
## Scope
|
||||
|
||||
This cookbook is concerned with the management of OS users and groups from databags. It also manages the distribution of ssh keys to a user's home directory.
|
||||
|
||||
## Requirements
|
||||
|
||||
### Platforms
|
||||
|
||||
The following platforms have been tested with Test Kitchen:
|
||||
|
||||
- Debian / Ubuntu derivatives
|
||||
- RHEL and derivatives
|
||||
- Fedora
|
||||
- openSUSE / SUSE Linux Enterprises
|
||||
- FreeBSD / OpenBSD
|
||||
- Mac OS X
|
||||
- AIX
|
||||
|
||||
### Chef
|
||||
|
||||
- Chef 12.7+
|
||||
|
||||
### Cookbooks
|
||||
|
||||
- none
|
||||
|
||||
## Usage
|
||||
|
||||
To use the resource `users_manage`, make sure to add the dependency on the users cookbook by the following line to your wrapper cookbook's [metadata.rb](https://docs.chef.io/config_rb_metadata.html):
|
||||
|
||||
```
|
||||
depends 'users'
|
||||
```
|
||||
|
||||
or to pin to a specific version of the users cookbook, in this case any version of 2.X:
|
||||
|
||||
```
|
||||
depends 'users', '~> 2'
|
||||
```
|
||||
|
||||
Then in a recipe use the `user_manage` resource to add all users in the defined group to the system:
|
||||
|
||||
```ruby
|
||||
users_manage 'GROUPNAME' do
|
||||
group_id GROUPID
|
||||
action [:create]
|
||||
data_bag 'DATABAG_NAME'
|
||||
end
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```ruby
|
||||
users_manage 'testgroup' do
|
||||
group_id 3000
|
||||
action [:create]
|
||||
data_bag 'test_home_dir'
|
||||
end
|
||||
```
|
||||
|
||||
**Note**: If you do not specify the data_bag, the default will be to look for a databag called users.
|
||||
|
||||
## Databag Definition
|
||||
|
||||
A sample user object in a users databag would look like:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "test_user",
|
||||
"password": "$1$5cE1rI/9$4p0fomh9U4kAI23qUlZVv/",
|
||||
"ssh_keys": [
|
||||
"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\nGPl+nafzlHDTYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5QVkbPppSwg0cda3\nPbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XA\nt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/En\nmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbx\nNrRFi9wrf+M7Q== chefuser@mylaptop.local",
|
||||
"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\nGPl+nafzlHDTYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5QVkbPppSwg0cda3\nPbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XA\nt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/En\nmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbx\nNQCPO0ZZEa1== chefuser@mylaptop.local"
|
||||
],
|
||||
"groups": [ "testgroup", "nfsgroup" ],
|
||||
"uid": 9001,
|
||||
"shell": "\/bin\/bash",
|
||||
"comment": "Test User"
|
||||
}
|
||||
```
|
||||
|
||||
A sample user to remove from a system would like like:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "mwaddams",
|
||||
"action": "remove",
|
||||
"groups": [ "testgroup", "nfsgroup" ]
|
||||
}
|
||||
```
|
||||
|
||||
### Databag Key Definitions
|
||||
|
||||
- `id`: _String_ specifies the username, as well as the data bag object id.
|
||||
- `password`: _String_ specifies the user's password.
|
||||
- `ssh_keys`: _Array_ an array of authorized keys that will be managed by Chef to the user's home directory in `$HOME/.ssh/authorized_keys`. A key can include an `https` endpoint that returns a line seperated list of keys such as `https://github.com/$GITHUB_USERNAME.keys` this will retrieve all the keys and add it to the array and can be used with static keys as well as dynamic ones.
|
||||
- `groups`: _Array_ an array of groups that the user will be added to
|
||||
- `uid`: _Integer_ a unique identifier for the user
|
||||
- `shell`: _String_ the user's shell
|
||||
- `comment`:_String_ the [GECOS field](https://en.wikipedia.org/wiki/Gecos_field), generally the User's full name.
|
||||
|
||||
Other potential fields:
|
||||
|
||||
- `home`: _String_ User's home directory. If not assigned, will be set based on platform and username.
|
||||
- `action`: _String_ Supported actions are one's supported by the [user](https://docs.chef.io/resource_user.html#actions) resource. If not specified, the default action is `create`.
|
||||
- `ssh_private_key`: _String_ manages user's private key generally ~/.ssh/id_*
|
||||
- `ssh_public_key`: _String_ manages user's public key generally ~/.ssh/id_*.pub
|
||||
|
||||
## Resources Overview
|
||||
|
||||
### users_manage
|
||||
|
||||
The `users_manage` resource manages users and groups based off of a data bag search and specified action.
|
||||
|
||||
#### Examples
|
||||
|
||||
Creates the `sysadmin` group and users defined in the `users` databag.
|
||||
|
||||
```ruby
|
||||
users_manage 'sysadmin' do
|
||||
group_id 2300
|
||||
action [:create]
|
||||
end
|
||||
```
|
||||
|
||||
Creates the `testgroup` group, and users defined in the `test_home_dir` databag.
|
||||
|
||||
```ruby
|
||||
users_manage 'testgroup' do
|
||||
group_id 3000
|
||||
action [:create]
|
||||
data_bag 'test_home_dir'
|
||||
end
|
||||
```
|
||||
|
||||
Creates the `nfsgroup` group, and users defined in the `test_home_dir` databag and does not manage nfs home directories.
|
||||
|
||||
```ruby
|
||||
users_manage 'nfsgroup' do
|
||||
group_id 4000
|
||||
action [:create]
|
||||
data_bag 'test_home_dir'
|
||||
manage_nfs_home_dirs false
|
||||
end
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
- `data_bag` _String_ is the data bag to search
|
||||
- `search_group` _String_ groups name to search for, defaults to resource name
|
||||
- `group_name` _String_ name of the group to create, defaults to resource name
|
||||
- `group_id` _Integer_ numeric id of the group to create, default is to allow the OS to pick next
|
||||
- `cookbook` _String_ name of the cookbook that the authorized_keys template should be found in
|
||||
- `manage_nfs_home_dirs` _Boolean_ whether to manage nfs home directories.
|
||||
|
||||
Otherwise, this cookbook is specific for setting up `sysadmin` group and users with the sysadmins recipe for now.
|
||||
|
||||
## Recipe Overview
|
||||
|
||||
### Deprecation Notice
|
||||
|
||||
This recipe has been deprecated and the resource will be removed from the recipe in a new major release of this cookbook in April 2017\. The functionality can easily be recreated and changed to suit your organization by copying the single resource below into your own cookbook.
|
||||
|
||||
`sysadmins.rb`: recipe that manages the group sysadmins with group id 2300, and adds users to this group.
|
||||
|
||||
To use:
|
||||
|
||||
```ruby
|
||||
include_recipe "users::sysadmins"
|
||||
```
|
||||
|
||||
The recipe is defined as follows:
|
||||
|
||||
```ruby
|
||||
users_manage "sysadmin" do
|
||||
group_id 2300
|
||||
action [ :create ]
|
||||
end
|
||||
```
|
||||
|
||||
This `users_manage` resource searches the `users` data bag for the `sysadmin` group attribute, and adds those users to a Unix security group `sysadmin`. The only required attribute is group_id, which represents the numeric Unix gid and _must_ be unique. The default action for the resource is `:create`.
|
||||
|
||||
The recipe, by default, will also create the sysadmin group. The sysadmin group will be created with GID 2300.
|
||||
|
||||
## Data bag Overview
|
||||
|
||||
**Reminder** Data bags generally should not be stored in cookbooks, but in a policy repo within your organization. Data bags are useful across cookbooks, not just for a single cookbook.
|
||||
|
||||
Use knife to create a data bag for users.
|
||||
|
||||
```bash
|
||||
$ knife data bag create users
|
||||
```
|
||||
|
||||
Create a user in the data_bag/users/ directory.
|
||||
|
||||
An optional password hash can be specified that will be used as the user's password.
|
||||
|
||||
The hash can be generated with the following command.
|
||||
|
||||
```bash
|
||||
$ openssl passwd -1 "plaintextpassword"
|
||||
```
|
||||
|
||||
Note: The ssh_keys attribute below can be either a String or an Array. However, we are recommending the use of an Array.
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "bofh",
|
||||
"ssh_keys": "ssh-rsa AAAAB3Nz...yhCw== bofh"
|
||||
}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "bofh",
|
||||
"password": "$1$d...HgH0",
|
||||
"ssh_keys": [
|
||||
"ssh-rsa AAA123...xyz== foo",
|
||||
"ssh-rsa AAA456...uvw== bar"
|
||||
],
|
||||
"groups": [ "sysadmin", "dba", "devops" ],
|
||||
"uid": 2001,
|
||||
"shell": "\/bin\/bash",
|
||||
"comment": "BOFH"
|
||||
}
|
||||
```
|
||||
|
||||
You can pass any action listed in the [user](http://docs.chef.io/chef/resources.html#user) resource for Chef via the "action" option. For Example:
|
||||
|
||||
Lock a user, johndoe1.
|
||||
|
||||
```bash
|
||||
$ knife data bag edit users johndoe1
|
||||
```
|
||||
|
||||
And then change the action to "lock":
|
||||
|
||||
```javascript
|
||||
{
|
||||
"id": "johndoe1",
|
||||
"groups": ["sysadmin", "dba", "devops"],
|
||||
"uid": 2002,
|
||||
"action": "lock", // <--
|
||||
"comment": "User violated access policy"
|
||||
}
|
||||
```
|
||||
|
||||
Remove a user, johndoe1.
|
||||
|
||||
```bash
|
||||
$ knife data bag edit users johndoe1
|
||||
```
|
||||
|
||||
And then change the action to "remove":
|
||||
|
||||
```javascript
|
||||
{
|
||||
"id": "johndoe1",
|
||||
"groups": [ "sysadmin", "dba", "devops" ],
|
||||
"uid": 2002,
|
||||
"action": "remove", // <--
|
||||
"comment": "User quit, retired, or fired."
|
||||
}
|
||||
```
|
||||
|
||||
- Note only user bags with the "action : remove" and a search-able "group" attribute will be purged by the :remove action.
|
||||
- As of v2.0.3 you can use the force parameter within the user data bag object for users with action remove. As per [user docs](https://docs.chef.io/resource_user.html) this may leave the system in an inconsistent state. For example, a user account will be removed even if the user is logged in. A user's home directory will be removed, even if that directory is shared by multiple users.
|
||||
|
||||
If you have different requirements, for example:
|
||||
|
||||
- You want to search a different data bag specific to a role such as
|
||||
- mail. You may change the data_bag searched.
|
||||
|
||||
- data_bag `mail`
|
||||
|
||||
- You want to search for a different group attribute named
|
||||
|
||||
- `postmaster`. You may change the search_group attribute. This
|
||||
|
||||
- attribute defaults to the LWRP resource name.
|
||||
|
||||
- search_group `postmaster`
|
||||
|
||||
- You want to add the users to a security group other than the
|
||||
|
||||
- lightweight resource name. You may change the group_name attribute.
|
||||
|
||||
- This attribute also defaults to the LWRP resource name.
|
||||
|
||||
- group_name `wheel`
|
||||
|
||||
Putting these requirements together our recipe might look like this:
|
||||
|
||||
```ruby
|
||||
users_manage "postmaster" do
|
||||
data_bag "mail"
|
||||
group_name "wheel"
|
||||
group_id 10
|
||||
end
|
||||
```
|
||||
|
||||
Knife supports reading data bags from a file and automatically looks in a directory called +data_bags+ in the current directory. The "bag" should be a directory with JSON files of each item. For the above:
|
||||
|
||||
```bash
|
||||
$ mkdir data_bags/users
|
||||
$EDITOR data_bags/users/bofh.json
|
||||
```
|
||||
|
||||
Paste the user's public SSH key into the ssh_keys value. Also make sure the uid is unique, and if you're not using bash, that the shell is installed.
|
||||
|
||||
The Apache cookbook can set up authentication using OpenIDs, which is set up using the openid key here. See the Chef Software 'apache2' cookbook for more information about this.
|
||||
|
||||
## License & Authors
|
||||
|
||||
**Author:** Cookbook Engineering Team ([cookbooks@chef.io](mailto:cookbooks@chef.io))
|
||||
|
||||
**Copyright:** 2009-2017, Chef Software, Inc.
|
||||
|
||||
```
|
||||
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.
|
||||
```
|
||||
78
cookbooks/users/libraries/helpers.rb
Normal file
78
cookbooks/users/libraries/helpers.rb
Normal file
@@ -0,0 +1,78 @@
|
||||
module Users
|
||||
# Helpers for Users
|
||||
module Helpers
|
||||
# Checks fs type.
|
||||
#
|
||||
# @return [String]
|
||||
def fs_type(mount)
|
||||
# Doesn't support macosx
|
||||
stat = Mixlib::ShellOut.new("stat -f -L -c %T #{mount} 2>&1").run_command
|
||||
stat.stdout.chomp
|
||||
rescue
|
||||
'none'
|
||||
end
|
||||
|
||||
# Determines if provided mount point is remote.
|
||||
#
|
||||
# @return [Boolean]
|
||||
def fs_remote?(mount)
|
||||
fs_type(mount) == 'nfs' ? true : false
|
||||
end
|
||||
|
||||
def keys_from_url(url)
|
||||
host = url.split('/')[0..2].join('/')
|
||||
path = url.split('/')[3..-1].join('/')
|
||||
begin
|
||||
response = Chef::HTTP.new(host).get(path)
|
||||
response.split("\n")
|
||||
rescue Net::HTTPServerException => e
|
||||
p "request: #{host}#{path}, error: #{e}"
|
||||
end
|
||||
end
|
||||
|
||||
# Determines if the user's shell is valid on the machine, otherwise
|
||||
# returns the default of /bin/sh
|
||||
#
|
||||
# @return [String]
|
||||
def shell_is_valid?(shell_path)
|
||||
return false if shell_path.nil? || !File.exist?(shell_path)
|
||||
# AIX is the only OS that has the concept of 'approved shells'
|
||||
return true unless platform_family?('aix')
|
||||
|
||||
begin
|
||||
File.open('/etc/security/login.cfg') do |f|
|
||||
f.each_line do |l|
|
||||
l.match(/^\s*shells\s*=\s*(.*)/) do |m|
|
||||
return true if m[1].split(/\s*,\s*/).any? { |entry| entry.eql? shell_path }
|
||||
end
|
||||
end
|
||||
end
|
||||
rescue
|
||||
return false
|
||||
end
|
||||
|
||||
false
|
||||
end
|
||||
|
||||
# Validates passed id.
|
||||
#
|
||||
# @return [Numeric, String]
|
||||
# handles checking whether uid was specified as a string
|
||||
def validate_id(id)
|
||||
id.to_i.to_s == id ? id.to_i : id
|
||||
end
|
||||
|
||||
# Returns the appropriate base user home directory per platform
|
||||
#
|
||||
# @return [ String]
|
||||
def home_basedir
|
||||
if platform_family?('mac_os_x')
|
||||
'/Users'
|
||||
elsif platform_family?('solaris2')
|
||||
'/export/home'
|
||||
else
|
||||
'/home'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
15
cookbooks/users/libraries/matchers.rb
Normal file
15
cookbooks/users/libraries/matchers.rb
Normal file
@@ -0,0 +1,15 @@
|
||||
if defined?(ChefSpec)
|
||||
ChefSpec.define_matcher :users_manage
|
||||
|
||||
def create_users_manage(resource_name)
|
||||
ChefSpec::Matchers::ResourceMatcher.new(:users_manage,
|
||||
:create,
|
||||
resource_name)
|
||||
end
|
||||
|
||||
def remove_users_manage(resource_name)
|
||||
ChefSpec::Matchers::ResourceMatcher.new(:users_manage,
|
||||
:remove,
|
||||
resource_name)
|
||||
end
|
||||
end
|
||||
29
cookbooks/users/libraries/osx_helper.rb
Normal file
29
cookbooks/users/libraries/osx_helper.rb
Normal file
@@ -0,0 +1,29 @@
|
||||
module Users
|
||||
# Helpers for Users
|
||||
module OsxHelper
|
||||
def dscl(*args)
|
||||
host = '.'
|
||||
stdout_result = ''
|
||||
stderr_result = ''
|
||||
cmd = "dscl #{host} -#{args.join(' ')}"
|
||||
status = shell_out(cmd)
|
||||
status.stdout.each_line { |line| stdout_result << line }
|
||||
status.stderr.each_line { |line| stderr_result << line }
|
||||
[cmd, status, stdout_result, stderr_result]
|
||||
end
|
||||
|
||||
def safe_dscl(*args)
|
||||
result = dscl(*args)
|
||||
return '' if (args.first =~ /^delete/) && (result[1].exitstatus != 0)
|
||||
raise(Chef::Exceptions::Group, "dscl error: #{result.inspect}") unless result[1].exitstatus == 0
|
||||
raise(Chef::Exceptions::Group, "dscl error: #{result.inspect}") if result[2] =~ /No such key: /
|
||||
result[2]
|
||||
end
|
||||
|
||||
def gid_used?(gid)
|
||||
return false unless gid
|
||||
groups_gids = safe_dscl('list /Groups gid')
|
||||
!!(groups_gids =~ Regexp.new("#{Regexp.escape(gid.to_s)}\n"))
|
||||
end
|
||||
end
|
||||
end
|
||||
1
cookbooks/users/metadata.json
Normal file
1
cookbooks/users/metadata.json
Normal file
File diff suppressed because one or more lines are too long
20
cookbooks/users/recipes/default.rb
Normal file
20
cookbooks/users/recipes/default.rb
Normal file
@@ -0,0 +1,20 @@
|
||||
#
|
||||
# Cookbook:: users
|
||||
# Recipe:: default
|
||||
#
|
||||
# Copyright:: 2009-2017, Chef Software, Inc.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
|
||||
Chef::Log.warn('The default users recipe does nothing. See the readme for information on using the users resources')
|
||||
21
cookbooks/users/recipes/sysadmins.rb
Normal file
21
cookbooks/users/recipes/sysadmins.rb
Normal file
@@ -0,0 +1,21 @@
|
||||
#
|
||||
# Cookbook:: users
|
||||
# Recipe:: sysadmins
|
||||
#
|
||||
# Copyright:: 2011-2017, Eric G. Wolfe
|
||||
# Copyright:: 2009-2017, Chef Software, Inc.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
|
||||
Chef::Log.warn('The sysadmins recipe has been deprecated. We suggest using the users_manage resource in your own cookbook if you need similar functionality.')
|
||||
186
cookbooks/users/resources/manage.rb
Normal file
186
cookbooks/users/resources/manage.rb
Normal file
@@ -0,0 +1,186 @@
|
||||
#
|
||||
# Cookbook:: users
|
||||
# Resources:: manage
|
||||
#
|
||||
# Copyright:: 2011-2017, Eric G. Wolfe
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
|
||||
# :data_bag is the object to search
|
||||
# :search_group is the groups name to search for, defaults to resource name
|
||||
# :group_name is the string name of the group to create, defaults to resource name
|
||||
# :group_id is the numeric id of the group to create, default is to allow the OS to pick next
|
||||
# :cookbook is the name of the cookbook that the authorized_keys template should be found in
|
||||
property :data_bag, String, default: 'users'
|
||||
property :search_group, String, name_property: true
|
||||
property :group_name, String, name_property: true
|
||||
property :group_id, Integer
|
||||
property :cookbook, String, default: 'users'
|
||||
property :manage_nfs_home_dirs, [true, false], default: true
|
||||
|
||||
action :create do
|
||||
users_groups = {}
|
||||
users_groups[new_resource.group_name] = []
|
||||
|
||||
search(new_resource.data_bag, "groups:#{new_resource.search_group} AND NOT action:remove") do |u|
|
||||
u['username'] ||= u['id']
|
||||
u['groups'].each do |g|
|
||||
users_groups[g] = [] unless users_groups.key?(g)
|
||||
users_groups[g] << u['username']
|
||||
end
|
||||
|
||||
# Set home to location in data bag,
|
||||
# or a reasonable default ($home_basedir/$user).
|
||||
home_dir = (u['home'] ? u['home'] : "#{home_basedir}/#{u['username']}")
|
||||
|
||||
# check whether home dir is null
|
||||
manage_home = (home_dir == '/dev/null' ? false : true)
|
||||
|
||||
# The user block will fail if the group does not yet exist.
|
||||
# See the -g option limitations in man 8 useradd for an explanation.
|
||||
# This should correct that without breaking functionality.
|
||||
group u['username'] do # ~FC022
|
||||
case node['platform_family']
|
||||
when 'mac_os_x'
|
||||
gid validate_id(u['gid']) unless gid_used?(validate_id(u['gid'])) || new_resource.group_name == u['username']
|
||||
else
|
||||
gid validate_id(u['gid'])
|
||||
end
|
||||
only_if { u['gid'] && u['gid'].is_a?(Numeric) }
|
||||
end
|
||||
|
||||
# Create user object.
|
||||
# Do NOT try to manage null home directories.
|
||||
user u['username'] do
|
||||
uid validate_id(u['uid'])
|
||||
gid validate_id(u['gid']) if u['gid']
|
||||
shell shell_is_valid?(u['shell']) ? u['shell'] : '/bin/sh'
|
||||
comment u['comment']
|
||||
password u['password'] if u['password']
|
||||
salt u['salt'] if u['salt']
|
||||
iterations u['iterations'] if u['iterations']
|
||||
manage_home manage_home
|
||||
home home_dir
|
||||
action u['action'] if u['action']
|
||||
end
|
||||
|
||||
if manage_home_files?(home_dir, u['username'])
|
||||
Chef::Log.debug("Managing home files for #{u['username']}")
|
||||
|
||||
directory "#{home_dir}/.ssh" do
|
||||
recursive true
|
||||
owner u['uid'] ? validate_id(u['uid']) : u['username']
|
||||
group validate_id(u['gid']) if u['gid']
|
||||
mode '0700'
|
||||
only_if { !!(u['ssh_keys'] || u['ssh_private_key'] || u['ssh_public_key']) }
|
||||
end
|
||||
|
||||
# loop over the keys and if we have a URL we should add each key
|
||||
# from the url response and append it to the list of keys
|
||||
ssh_keys = []
|
||||
if u['ssh_keys']
|
||||
Array(u['ssh_keys']).each do |key|
|
||||
if key.start_with?('https')
|
||||
ssh_keys += keys_from_url(key)
|
||||
else
|
||||
ssh_keys << key
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
template "#{home_dir}/.ssh/authorized_keys" do
|
||||
source 'authorized_keys.erb'
|
||||
cookbook new_resource.cookbook
|
||||
owner u['uid'] ? validate_id(u['uid']) : u['username']
|
||||
group validate_id(u['gid']) if u['gid']
|
||||
mode '0600'
|
||||
sensitive true
|
||||
# ssh_keys should be a combination of u['ssh_keys'] and any keys
|
||||
# returned from a specified URL
|
||||
variables ssh_keys: ssh_keys
|
||||
only_if { !!(u['ssh_keys']) }
|
||||
end
|
||||
|
||||
if u['ssh_private_key']
|
||||
key_type = u['ssh_private_key'].include?('BEGIN RSA PRIVATE KEY') ? 'rsa' : 'dsa'
|
||||
template "#{home_dir}/.ssh/id_#{key_type}" do
|
||||
source 'private_key.erb'
|
||||
cookbook new_resource.cookbook
|
||||
owner u['uid'] ? validate_id(u['uid']) : u['username']
|
||||
group validate_id(u['gid']) if u['gid']
|
||||
mode '0400'
|
||||
variables private_key: u['ssh_private_key']
|
||||
end
|
||||
end
|
||||
|
||||
if u['ssh_public_key']
|
||||
key_type = u['ssh_public_key'].include?('ssh-rsa') ? 'rsa' : 'dsa'
|
||||
template "#{home_dir}/.ssh/id_#{key_type}.pub" do
|
||||
source 'public_key.pub.erb'
|
||||
cookbook new_resource.cookbook
|
||||
owner u['uid'] ? validate_id(u['uid']) : u['username']
|
||||
group validate_id(u['gid']) if u['gid']
|
||||
mode '0400'
|
||||
variables public_key: u['ssh_public_key']
|
||||
end
|
||||
end
|
||||
else
|
||||
Chef::Log.debug("Not managing home files for #{u['username']}")
|
||||
end
|
||||
end
|
||||
# Populating users to appropriates groups
|
||||
users_groups.each do |g, u|
|
||||
group g do
|
||||
members u
|
||||
append true
|
||||
action :manage # Do nothing if group doesn't exist
|
||||
end unless g == new_resource.group_name # Dealing with managed group later
|
||||
end
|
||||
|
||||
group new_resource.group_name do
|
||||
case node['platform_family']
|
||||
when 'mac_os_x'
|
||||
gid new_resource.group_id unless gid_used?(new_resource.group_id)
|
||||
else
|
||||
gid new_resource.group_id
|
||||
end
|
||||
members users_groups[new_resource.group_name]
|
||||
end
|
||||
end
|
||||
|
||||
action :remove do
|
||||
search(new_resource.data_bag, "groups:#{new_resource.search_group} AND action:remove") do |rm_user|
|
||||
user rm_user['username'] ||= rm_user['id'] do
|
||||
action :remove
|
||||
force rm_user['force'] ||= false
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
action_class do
|
||||
include ::Users::Helpers
|
||||
include ::Users::OsxHelper
|
||||
|
||||
def manage_home_files?(home_dir, _user)
|
||||
# Don't manage home dir if it's NFS mount
|
||||
# and manage_nfs_home_dirs is disabled
|
||||
if home_dir == '/dev/null'
|
||||
false
|
||||
elsif fs_remote?(home_dir)
|
||||
new_resource.manage_nfs_home_dirs ? true : false
|
||||
else
|
||||
true
|
||||
end
|
||||
end
|
||||
end
|
||||
6
cookbooks/users/templates/authorized_keys.erb
Normal file
6
cookbooks/users/templates/authorized_keys.erb
Normal file
@@ -0,0 +1,6 @@
|
||||
# Generated by Chef
|
||||
# Local modifications will be overwritten.
|
||||
|
||||
<% Array(@ssh_keys).each do |key| %>
|
||||
<%= key %>
|
||||
<% end -%>
|
||||
1
cookbooks/users/templates/private_key.erb
Normal file
1
cookbooks/users/templates/private_key.erb
Normal file
@@ -0,0 +1 @@
|
||||
<%= @private_key %>
|
||||
1
cookbooks/users/templates/public_key.pub.erb
Normal file
1
cookbooks/users/templates/public_key.pub.erb
Normal file
@@ -0,0 +1 @@
|
||||
<%= @public_key %>
|
||||
Reference in New Issue
Block a user